workspace

type Client struct {
	internal.JSONAPIClient
}

type ConnectOptions struct {
	RepoPath      *string
	VCSProviderID *string

	Branch    *string
	TagsRegex *string
}

type Connection struct {
	// Pushes to this VCS branch trigger runs. Empty string means the default
	// branch is used. Ignored if TagsRegex is non-empty.
	Branch string
	// Pushed tags matching this regular expression trigger runs. Mutually
	// exclusive with TriggerPatterns.
	TagsRegex string

	VCSProviderID string
	Repo          string
}

type CreateOptions struct {
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Description                *string
	ExecutionMode              *ExecutionMode
	GlobalRemoteState          *bool
	MigrationEnvironment       *string
	Name                       *string
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	SourceName                 *string
	SourceURL                  *string
	StructuredRunOutputEnabled *bool
	Tags                       []TagSpec
	TerraformVersion           *string
	TriggerPrefixes            []string
	TriggerPatterns            []string
	WorkingDirectory           *string
	Organization               *string

	// Always trigger runs. A value of true is mutually exclusive with
	// setting TriggerPatterns or ConnectOptions.TagsRegex.
	AlwaysTrigger *bool

	*ConnectOptions
}

type ExecutionMode string

type LatestRun struct {
	ID     string
	Status internal.RunStatus
}

type ListOptions struct {
	Search       string
	Tags         []string
	Organization *string

	resource.PageOptions
}

type ListTagsOptions struct {
	resource.PageOptions
}

type ListWorkspaceTagsOptions struct {
	resource.PageOptions
}

type Lock struct {
	LockKind // kind of entity holding lock
	// contains filtered or unexported fields
}

type LockButton struct {
	State    string // locked or unlocked
	Text     string // button text
	Tooltip  string // button tooltip
	Disabled bool   // button greyed out or not
	Message  string // message accompanying button
	Action   string // form URL
}

type LockKind int

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 Options struct {
	*sql.DB
	*pubsub.Broker
	html.Renderer
	organization.OrganizationService
	vcsprovider.VCSProviderService
	state.StateService
	repo.RepoService
	auth.TeamService
	logr.Logger
}

type OrganizationService organization.Service

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

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

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)
	ListWorkspaces(ctx context.Context, opts ListOptions) (*resource.Page[*Workspace], 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
	TagService
}

type Tag struct {
	ID            string // ID of the form 'tag-*'. Globally unique.
	Name          string // Meaningful symbol. Unique to an organization.
	InstanceCount int    // Number of workspaces that have this tag
	Organization  string // Organization this tag belongs to.
}

type TagService interface {
	// ListTags lists tags within an organization
	ListTags(ctx context.Context, organization string, opts ListTagsOptions) (*resource.Page[*Tag], error)

	// DeleteTags deletes tags from an organization
	DeleteTags(ctx context.Context, organization string, tagIDs []string) error

	// TagWorkspaces adds an existing tag to a list of workspaces
	TagWorkspaces(ctx context.Context, tagID string, workspaceIDs []string) error

	// AddTags appends tags to a workspace. Any tag specified by ID must
	// exist. Any tag specified by name is created if it does not
	// exist.
	AddTags(ctx context.Context, workspaceID string, tags []TagSpec) error

	// RemoveTags removes tags from a workspace. The workspace must already
	// exist. Any tag specifying an ID must exist. Any tag specifying a name
	// need not exist and no action is taken. If a tag is no longer
	// associated with any workspaces it is removed.
	RemoveTags(ctx context.Context, workspaceID string, tags []TagSpec) error

	// ListWorkspaceTags lists the tags for a workspace.
	ListWorkspaceTags(ctx context.Context, workspaceID string, options ListWorkspaceTagsOptions) (*resource.Page[*Tag], error)
}

type TagSpec struct {
	ID   string
	Name string
}

type TagSpecs []TagSpec

type UpdateOptions struct {
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Name                       *string
	Description                *string
	ExecutionMode              *ExecutionMode
	GlobalRemoteState          *bool
	Operations                 *bool
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	StructuredRunOutputEnabled *bool
	TerraformVersion           *string
	TriggerPrefixes            []string
	TriggerPatterns            []string
	WorkingDirectory           *string

	// Always trigger runs. A value of true is mutually exclusive with
	// setting TriggerPatterns or ConnectOptions.TagsRegex.
	AlwaysTrigger *bool

	// Disconnect workspace from repo. It is invalid to specify true for an
	// already disconnected workspace.
	Disconnect bool

	// Specifying ConnectOptions either connects a currently
	// disconnected workspace, or modifies a connection if already
	// connected.
	*ConnectOptions
}

type VCSProviderService vcsprovider.Service

type VCSTriggerStrategy string

type Workspace struct {
	ID                         string        `json:"id"`
	CreatedAt                  time.Time     `json:"created_at"`
	UpdatedAt                  time.Time     `json:"updated_at"`
	AllowDestroyPlan           bool          `json:"allow_destroy_plan"`
	AutoApply                  bool          `json:"auto_apply"`
	CanQueueDestroyPlan        bool          `json:"can_queue_destroy_plan"`
	Description                string        `json:"description"`
	Environment                string        `json:"environment"`
	ExecutionMode              ExecutionMode `json:"execution_mode"`
	GlobalRemoteState          bool          `json:"global_remote_state"`
	MigrationEnvironment       string        `json:"migration_environment"`
	Name                       string        `json:"name"`
	QueueAllRuns               bool          `json:"queue_all_runs"`
	SpeculativeEnabled         bool          `json:"speculative_enabled"`
	StructuredRunOutputEnabled bool          `json:"structured_run_output_enabled"`
	SourceName                 string        `json:"source_name"`
	SourceURL                  string        `json:"source_url"`
	TerraformVersion           string        `json:"terraform_version"`
	WorkingDirectory           string        `json:"working_directory"`
	Organization               string        `json:"organization"`
	LatestRun                  *LatestRun    `json:"latest_run"`
	Tags                       []string      `json:"tags"`
	Lock                       *Lock         `json:"lock"`

	// VCS Connection; nil means the workspace is not connected.
	Connection *Connection

	// TriggerPatterns is mutually exclusive with Connection.TagsRegex.
	//
	// Note: TriggerPatterns ought to belong in Connection but it is included at
	// the root of Workspace because the go-tfe integration tests set
	// this field without setting the connection!
	TriggerPatterns []string

	// TriggerPrefixes exists only to pass the go-tfe integration tests and
	// is not used when determining whether to trigger runs. Use
	// TriggerPatterns instead.
	TriggerPrefixes []string
}

type WorkspacePage struct {
	organization.OrganizationPage

	Workspace *Workspace
}

type WorkspaceService = Service