workspace

type Client struct {
	otf.JSONAPIClient
}

type ConnectOptions struct {
	RepoPath      string `schema:"identifier,required"` // repo id: <owner>/<repo>
	VCSProviderID string `schema:"vcs_provider_id,required"`
}

type CreateOptions struct {
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Branch                     *string
	Description                *string
	ExecutionMode              *ExecutionMode
	FileTriggersEnabled        *bool
	GlobalRemoteState          *bool
	MigrationEnvironment       *string
	Name                       *string `schema:"name,required"`
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	SourceName                 *string
	SourceURL                  *string
	StructuredRunOutputEnabled *bool
	TerraformVersion           *string
	TriggerPrefixes            []string
	WorkingDirectory           *string
	Organization               *string `schema:"organization_name,required"`

	*ConnectOptions
}

type ExecutionMode string

type ListOptions struct {
	otf.ListOptions         // Pagination
	Prefix          string  `schema:"search[name],omitempty"`
	Organization    *string `schema:"organization_name,required"`
}

type Lock struct {
	LockedState // nil means unlocked
}

type LockService interface {
	LockWorkspace(ctx context.Context, workspaceID string, runID *string) (*Workspace, error)
	UnlockWorkspace(ctx context.Context, workspaceID string, runID *string, force bool) (*Workspace, error)
}

type LockedState interface {
	// CanLock checks whether it can be replaced with the given locked state
	CanLock(lock LockedState) error
	// CanUnlock checks whether subject is permitted to transfer it into the,
	// unlocked state, forceably or not.
	CanUnlock(lock LockedState, force bool) error
}

type Options struct {
	otf.DB
	pubsub.Broker
	otf.Renderer
	organization.OrganizationService
	vcsprovider.VCSProviderService
	repo.RepoService
	auth.TeamService
	logr.Logger
}

type OrganizationService organization.Service

type PermissionsService interface {
	GetPolicy(ctx context.Context, workspaceID string) (otf.WorkspacePolicy, error)

	SetPermission(ctx context.Context, workspaceID, team string, role rbac.Role) error
	UnsetPermission(ctx context.Context, workspaceID, team string) error
}

type QualifiedName struct {
	Organization string
	Name         string
}

type RunLock struct {
	ID string
}

type Service interface {
	CreateWorkspace(ctx context.Context, opts CreateOptions) (*Workspace, error)
	UpdateWorkspace(ctx context.Context, workspaceID string, opts UpdateOptions) (*Workspace, error)
	GetWorkspace(ctx context.Context, workspaceID string) (*Workspace, error)
	GetWorkspaceByName(ctx context.Context, organization, workspace string) (*Workspace, error)
	GetWorkspaceJSONAPI(ctx context.Context, workspaceID string, r *http.Request) (*jsonapi.Workspace, error)
	ListWorkspaces(ctx context.Context, opts ListOptions) (*WorkspaceList, error)
	// ListWorkspacesByWebhookID retrieves workspaces by webhook ID.
	//
	// TODO: rename to ListConnectedWorkspaces
	ListWorkspacesByRepoID(ctx context.Context, repoID uuid.UUID) ([]*Workspace, error)
	DeleteWorkspace(ctx context.Context, workspaceID string) (*Workspace, error)

	SetCurrentRun(ctx context.Context, workspaceID, runID string) (*Workspace, error)

	LockService
	PermissionsService
	// contains filtered or unexported methods
}

type UpdateOptions struct {
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Name                       *string
	Description                *string
	ExecutionMode              *ExecutionMode `schema:"execution_mode"`
	FileTriggersEnabled        *bool
	GlobalRemoteState          *bool
	Operations                 *bool
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	StructuredRunOutputEnabled *bool
	TerraformVersion           *string `schema:"terraform_version"`
	TriggerPrefixes            []string
	WorkingDirectory           *string
}

type UserLock struct {
	ID, Username string
}

type VCSProviderService vcsprovider.Service

type Workspace struct {
	ID                         string
	CreatedAt                  time.Time
	UpdatedAt                  time.Time
	AllowDestroyPlan           bool
	AutoApply                  bool
	Branch                     string
	CanQueueDestroyPlan        bool
	Description                string
	Environment                string
	ExecutionMode              ExecutionMode
	FileTriggersEnabled        bool
	GlobalRemoteState          bool
	MigrationEnvironment       string
	Name                       string
	QueueAllRuns               bool
	SpeculativeEnabled         bool
	StructuredRunOutputEnabled bool
	SourceName                 string
	SourceURL                  string
	TerraformVersion           string
	TriggerPrefixes            []string
	WorkingDirectory           string
	Organization               string
	LatestRunID                *string
	Connection                 *repo.Connection
	Permissions                []otf.WorkspacePermission

	Lock
}

type WorkspaceList struct {
	*otf.Pagination
	Items []*Workspace
}

type WorkspaceService = Service