otf

module

Go to main page

Versions in this module

v0

v0.3.13

Jan 23, 2025

v0.3.12

Jan 21, 2025

v0.3.11

Jan 21, 2025

v0.3.10

Jan 20, 2025

v0.3.9

Jan 16, 2025

v0.3.8

Jan 10, 2025

v0.3.7

Jan 3, 2025

v0.3.6

Nov 22, 2024

v0.3.5

Oct 30, 2024

v0.3.4

Oct 30, 2024

v0.3.3

Oct 23, 2024

v0.3.2

Oct 22, 2024

v0.3.1

Oct 22, 2024

v0.3.0

Oct 22, 2024

v0.2.4

Dec 16, 2023

v0.2.3

Dec 12, 2023

v0.2.2

Dec 11, 2023

v0.2.1

Dec 7, 2023

v0.2.0

Dec 5, 2023

v0.1.18

Oct 30, 2023

v0.1.17

Oct 29, 2023

v0.1.16

Oct 27, 2023

v0.1.15

Oct 27, 2023

v0.1.14

Oct 20, 2023

v0.1.13

Sep 13, 2023

v0.1.12

Sep 12, 2023

v0.1.11

Sep 11, 2023

v0.1.10

Sep 6, 2023

v0.1.9

Sep 2, 2023

v0.1.8

Aug 13, 2023

v0.1.7

Aug 5, 2023

v0.1.6

Aug 2, 2023

v0.1.5

Aug 2, 2023

v0.1.4

Aug 1, 2023

v0.1.3

Jul 27, 2023

v0.1.2

Jul 26, 2023

v0.1.1

Jul 24, 2023

v0.1.0

Jul 24, 2023

v0.0.53

Jul 12, 2023

v0.0.52

Jul 8, 2023

v0.0.51

Jul 8, 2023

v0.0.50

Jul 2, 2023

v0.0.49

Jun 28, 2023

v0.0.48

Jun 27, 2023

v0.0.47

Jun 25, 2023

v0.0.46

Apr 17, 2023

v0.0.45

Apr 17, 2023

v0.0.44

Apr 17, 2023

v0.0.43

Apr 17, 2023

v0.0.42

Apr 17, 2023

v0.0.41

Apr 16, 2023

v0.0.40

Apr 16, 2023

v0.0.39

Apr 16, 2023

v0.0.38

Apr 16, 2023

v0.0.37

Apr 16, 2023

v0.0.36

Apr 16, 2023

v0.0.35

Apr 16, 2023

v0.0.34

Apr 16, 2023

v0.0.33

Apr 12, 2023

Changes in this version

+ var ErrUploadTooLarge = errors.New("upload is too large")

+ func CredentialEnv(hostname string, token []byte) string

+ func CredentialEnvKey(hostname string) string

+ type Broker interface

+ Register func(t reflect.Type, getter Getter)

+ type Getter interface

+ GetByID func(context.Context, string) (any, error)

+ type HTTPError struct

+ Code int

+ Message string

+ func (e *HTTPError) Error() string

+ type MissingParameterError struct

+ Parameter string

+ func (e *MissingParameterError) Error() string

type Pagination

+ Count int

+ Opts ListOptions

type Subject

+ Organizations func() []string

type Superuser

+ func (s *Superuser) Organizations() []string

v0.0.32

Mar 30, 2023

Changes in this version

+ const ETX

+ const STX

+ var ErrInvalidRepo = errors.New("repository path is invalid")

+ var ReSemanticVersion = regexp.MustCompile(`^[0-9]+\.[0-9]+\.[0-9]+$`)

+ var ReStringID = regexp.MustCompile(`^[a-zA-Z0-9\-\._]+$`)

+ func GetID(s any) (string, bool)

+ func NewAllowAllAuthorizer() *allowAllAuthorizer

+ func NewHostnameService(hostname string) *hostnameService

+ func NewSigner(secret string) *surl.Signer

+ func NormalizeAddress(addr *net.TCPAddr) string

+ func RemoveBackendBlock(f *hclwrite.File) bool

+ func RewriteHCL(modulePath string, operations ...hclOperation) error

+ func ValidSemanticVersion(v string) bool

+ func VerifySignedURL(v Verifier) mux.MiddlewareFunc

+ func WriteSSEEvent(w io.Writer, data []byte, event EventType, base64encode bool)

type Authorizer

+ CanAccess func(ctx context.Context, action rbac.Action, id string) (Subject, error)

type Chunk

+ ID string

+ func (c Chunk) ToHTML() template.HTML

type DB

+ Acquire func(ctx context.Context) (*pgxpool.Conn, error)

+ Exec func(ctx context.Context, sql string, arguments ...interface{}) (pgconn.CommandTag, error)

+ GetLogs func(ctx context.Context, runID string, phase PhaseType) ([]byte, error)

+ SendBatch func(ctx context.Context, b *pgx.Batch) pgx.BatchResults

type Event

+ Local bool

type EventType

+ const EventLogFinished

+ const EventVCS

+ type FakeHostnameService struct

+ Host string

+ func (s FakeHostnameService) Hostname() string

+ type FakePublisher struct

+ func (f *FakePublisher) Publish(Event)

+ type Handlers interface

+ AddHandlers func(*mux.Router)

type HostnameService

+ SetHostname func(string)

type Pagination

+ func NewPaginationFromJSONAPI(json *jsonapi.Pagination) *Pagination

type Publisher

+ Publish func(Event)

type PutChunkOptions

+ Data []byte

+ Offset int

+ Phase PhaseType

+ RunID string

+ type PutChunkService interface

+ PutChunk func(ctx context.Context, opts PutChunkOptions) error

type Renderer

+ RenderTemplate func(path string, w io.Writer, content any) error

+ type Signer interface

+ Sign func(string, time.Duration) (string, error)

+ type SiteAuthorizer struct

+ func (a *SiteAuthorizer) CanAccess(ctx context.Context, action rbac.Action, _ string) (Subject, error)

type Subject

+ IsOwner func(organization string) bool

+ IsSiteAdmin func() bool

+ ListOrganizations func() []string

+ String func() string

+ type Subscriber interface

+ Subscribe func(ctx context.Context, name string) (<-chan Event, error)

type Superuser

+ func (s *Superuser) IsOwner(string) bool

+ func (s *Superuser) IsSiteAdmin() bool

+ func (s *Superuser) ListOrganizations() []string

+ type Verifier interface

+ Verify func(string) error

v0.0.31

Mar 1, 2023

Changes in this version

+ var ErrWarning = errors.New("warning")

type NewTestWorkspaceOption

+ func WorkspaceName(name string) NewTestWorkspaceOption

v0.0.30

Feb 23, 2023

v0.0.29

Feb 22, 2023

v0.0.28

Feb 8, 2023

v0.0.27

Feb 8, 2023

Changes in this version

+ func NewAuthorizer(logger logr.Logger, db DB) *authorizer

+ type Authorizer interface

+ CanAccessConfigurationVersion func(ctx context.Context, action rbac.Action, cvID string) (Subject, error)

+ CanAccessOrganization func(ctx context.Context, action rbac.Action, name string) (Subject, error)

+ CanAccessRun func(ctx context.Context, action rbac.Action, runID string) (Subject, error)

+ CanAccessSite func(ctx context.Context, action rbac.Action) (Subject, error)

+ CanAccessStateVersion func(ctx context.Context, action rbac.Action, svID string) (Subject, error)

+ CanAccessWorkspaceByID func(ctx context.Context, action rbac.Action, workspaceID string) (Subject, error)

+ CanAccessWorkspaceByName func(ctx context.Context, action rbac.Action, organization, workspace string) (Subject, error)

+ type Client interface

+ CreateAgentToken func(ctx context.Context, opts CreateAgentTokenOptions) (*AgentToken, error)

+ CreateOrganization func(ctx context.Context, opts OrganizationCreateOptions) (*Organization, error)

+ CreateRegistrySession func(ctx context.Context, organization string) (RegistrySession, error)

+ CreateWorkspace func(ctx context.Context, opts CreateWorkspaceOptions) (*Workspace, error)

+ DownloadConfig func(ctx context.Context, id string) ([]byte, error)

+ FinishPhase func(ctx context.Context, id string, phase PhaseType, opts PhaseFinishOptions) (*Run, error)

+ GetAgentToken func(ctx context.Context, token string) (*AgentToken, error)

+ GetLockFile func(ctx context.Context, id string) ([]byte, error)

+ GetPlanFile func(ctx context.Context, id string, format PlanFormat) ([]byte, error)

+ GetRun func(ctx context.Context, id string) (*Run, error)

+ GetWorkspace func(ctx context.Context, workspaceID string) (*Workspace, error)

+ GetWorkspaceByName func(ctx context.Context, organization, workspace string) (*Workspace, error)

+ ListRuns func(ctx context.Context, opts RunListOptions) (*RunList, error)

+ ListVariables func(ctx context.Context, workspaceID string) ([]Variable, error)

+ ListWorkspaces func(ctx context.Context, opts WorkspaceListOptions) (*WorkspaceList, error)

+ PutChunk func(ctx context.Context, chunk Chunk) error

+ StartPhase func(ctx context.Context, id string, phase PhaseType, opts PhaseStartOptions) (*Run, error)

+ UpdateWorkspace func(ctx context.Context, workspaceID string, opts UpdateWorkspaceOptions) (*Workspace, error)

+ UploadLockFile func(ctx context.Context, id string, lockFile []byte) error

+ UploadPlanFile func(ctx context.Context, id string, plan []byte, format PlanFormat) error

+ Watch func(context.Context, WatchOptions) (<-chan Event, error)

+ type CreateStateVersionOptions struct

+ Serial *int64

+ State []byte

+ WorkspaceID *string

type Database

+ SendBatch func(ctx context.Context, b *pgx.Batch) pgx.BatchResults

+ type JSONAPIClient interface

+ Do func(ctx context.Context, req *retryablehttp.Request, v any) error

+ NewRequest func(method, path string, params any) (*retryablehttp.Request, error)

type ModuleRow

+ OrganizationName pgtype.Text

+ type RegistrySessionApp interface

+ CreateRegistrySession func(ctx context.Context, organization string) (RegistrySession, error)

+ GetRegistrySession func(ctx context.Context, token string) (RegistrySession, error)

type RegistrySessionService

+ AddHandlers func(*mux.Router)

+ type Renderer interface

+ Render func(path string, w http.ResponseWriter, r *http.Request, content any)

+ type StateVersionApp interface

+ CreateStateVersion func(ctx context.Context, opts CreateStateVersionOptions) error

+ DownloadCurrentState func(ctx context.Context, workspaceID string) ([]byte, error)

type StateVersionService

+ AddHandlers func(*mux.Router)

+ type VariableApp interface

+ ListVariables func(ctx context.Context, workspaceID string) ([]Variable, error)

type VariableService

+ AddHTMLHandlers func(*mux.Router)

+ AddHandlers func(*mux.Router)

v0.0.26

Jan 30, 2023

v0.0.25

Jan 29, 2023

v0.0.24

Jan 27, 2023

Changes in this version

type Environment

+ WorkingDir func() string

type NewTestWorkspaceOption

+ func WorkingDirectory(relativePath string) NewTestWorkspaceOption

v0.0.23

Jan 25, 2023

Changes in this version

+ func UUID(u uuid.UUID) *uuid.UUID

+ type Database interface

+ Transaction func(ctx context.Context, tx func(Database) error) error

+ WaitAndLock func(ctx context.Context, id int64, cb func(DB) error) error

+ type HookCallback func(ctx context.Context, tx Database, hookID uuid.UUID) error

+ type HookOptions struct

+ Cloud string

+ Identifier string

+ type HookService interface

+ Hook func(ctx context.Context, opts HookOptions) error

+ Unhook func(ctx context.Context, opts UnhookOptions) error

+ type ModuleDeleter interface

+ Delete func(ctx context.Context, moduleID string) error

+ type NewTestRegistrySessionOption func(*RegistrySession)

+ func OverrideTestRegistrySessionExpiry(expiry time.Time) NewTestRegistrySessionOption

type RegistrySession

+ func NewTestRegistrySession(t *testing.T, org *Organization, opts ...NewTestRegistrySessionOption) *RegistrySession

type TestRunCreateOptions

+ Workspace *Workspace

+ type UnhookCallback func(ctx context.Context, tx Database) error

+ type UnhookOptions struct

+ HookID uuid.UUID

type VCSProviderService

+ GetVCSClient func(ctx context.Context, providerID string) (cloud.Client, error)

type Workspace

+ func (ws *Workspace) SetLatestRun(runID string)

type WorkspaceRepo

+ WorkspaceID string

v0.0.22

Jan 20, 2023

Changes in this version

+ const MinTerraformVersion

+ var ErrUnsupportedTerraformVersion = fmt.Errorf("only terraform versions >= %s are supported", MinTerraformVersion)

type Action

+ func (i Action) String() string

v0.0.21

Jan 19, 2023

Changes in this version

+ const DefaultSSLCertsDir

+ var ErrRequiredOrg = errors.New("organization is required")

+ func Contains(s []E, v E) bool

+ func Index(s []E, v E) int

+ func SSLCertsDir() string

type AgentToken

+ func (t *AgentToken) Organization() string

type CreateAgentTokenOptions

+ Organization string

+ type CreateWorkspaceOptions struct

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *ExecutionMode

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ MigrationEnvironment *string

+ Name *string

+ Organization *string

+ QueueAllRuns *bool

+ Repo *WorkspaceRepo

+ SourceName *string

+ SourceURL *string

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TerraformVersion *string

+ TriggerPrefixes []string

+ WorkingDirectory *string

type OrganizationStore

+ ListOrganizationsByUser func(ctx context.Context, userID string) ([]*Organization, error)

type Run

+ func (r *Run) AutoApply() bool

+ func (r *Run) Organization() string

type RunCreateOptions

+ AutoApply *bool

type RunListOptions

+ Organization *string

type TeamResult

+ OrganizationName pgtype.Text

type TeamSpec

+ Organization string

+ type UpdateWorkspaceOptions struct

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *ExecutionMode

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ Name *string

+ Operations *bool

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TerraformVersion *string

+ TriggerPrefixes []string

+ WorkingDirectory *string

type UserListOptions

+ Organization *string

type VCSProvider

+ func (t *VCSProvider) Organization() string

type VCSProviderCreateOptions

+ Organization string

type WatchOptions

+ Organization *string

+ WorkspaceID *string

type Workspace

+ func (ws *Workspace) Update(opts UpdateWorkspaceOptions) error

type WorkspaceListOptions

+ Organization *string

type WorkspacePolicy

+ Organization string

type WorkspaceResult

+ OrganizationName pgtype.Text

type WorkspaceService

+ GetWorkspaceByName func(ctx context.Context, organization, workspace string) (*Workspace, error)

type WorkspaceStore

+ GetWorkspaceByName func(ctx context.Context, organization, workspace string) (*Workspace, error)

v0.0.20

Jan 13, 2023

Changes in this version

+ const CategoryEnv

+ const CategoryTerraform

+ const VariableDescriptionMaxChars

+ const VariableKeyMaxChars

+ const VariableValueMaxKB

+ var ErrVariableDescriptionMaxExceeded = fmt.Errorf("maximum variable description size (%d chars) exceeded", ...)

+ var ErrVariableKeyMaxExceeded = fmt.Errorf("maximum variable key size (%d chars) exceeded", VariableKeyMaxChars)

+ var ErrVariableValueMaxExceeded = fmt.Errorf("maximum variable value size of %d KB exceeded", VariableValueMaxKB)

type Action

+ const CreateRegistrySessionAction

+ const CreateVariableAction

+ const DeleteVariableAction

+ const GetVariableAction

+ const ListVariablesAction

+ const UpdateVariableAction

+ type CreateVariableOptions struct

+ Category *VariableCategory

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Value *string

type ExecutionMode

+ func ExecutionModePtr(m ExecutionMode) *ExecutionMode

type TestRunCreateOptions

+ ExecutionMode *ExecutionMode

+ type UpdateVariableOptions struct

+ Category *VariableCategory

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Value *string

+ type Variable struct

+ func NewTestVariable(t *testing.T, ws *Workspace, opts CreateVariableOptions) *Variable

+ func NewVariable(workspaceID string, opts CreateVariableOptions) (*Variable, error)

+ func UnmarshalVariableJSONAPI(json *dto.Variable) *Variable

+ func UnmarshalVariableListJSONAPI(json *dto.VariableList) []*Variable

+ func UnmarshalVariableRow(result VariableRow) *Variable

+ func (v *Variable) Category() VariableCategory

+ func (v *Variable) Description() string

+ func (v *Variable) HCL() bool

+ func (v *Variable) ID() string

+ func (v *Variable) Key() string

+ func (v *Variable) MarshalLog() any

+ func (v *Variable) Sensitive() bool

+ func (v *Variable) Update(opts UpdateVariableOptions) error

+ func (v *Variable) Value() string

+ func (v *Variable) WorkspaceID() string

+ type VariableCategory string

+ func VariableCategoryPtr(v VariableCategory) *VariableCategory

+ type VariableRow struct

+ Category pgtype.Text

+ Description pgtype.Text

+ HCL bool

+ Key pgtype.Text

+ Sensitive bool

+ Value pgtype.Text

+ VariableID pgtype.Text

+ WorkspaceID pgtype.Text

+ type VariableService interface

+ CreateVariable func(ctx context.Context, workspaceID string, opts CreateVariableOptions) (*Variable, error)

+ DeleteVariable func(ctx context.Context, variableID string) (*Variable, error)

+ GetVariable func(ctx context.Context, variableID string) (*Variable, error)

+ ListVariables func(ctx context.Context, workspaceID string) ([]*Variable, error)

+ UpdateVariable func(ctx context.Context, variableID string, opts UpdateVariableOptions) (*Variable, error)

+ type VariableStore interface

+ CreateVariable func(ctx context.Context, variable *Variable) error

+ DeleteVariable func(ctx context.Context, variableID string) (*Variable, error)

+ GetVariable func(ctx context.Context, variableID string) (*Variable, error)

+ ListVariables func(ctx context.Context, workspaceID string) ([]*Variable, error)

+ UpdateVariable func(ctx context.Context, variableID string, updateFn func(*Variable) error) (*Variable, error)

type Workspace

+ func (ws *Workspace) MarshalLog() any

v0.0.19

Jan 11, 2023

Changes in this version

+ const DefaultRegistrySessionExpiry

+ const ReporterLockID

+ var ErrForeignKeyViolation = errors.New("foreign key constraint violation")

+ var OrganizationGuestRole = Role

+ var RegistryManagerRole = Role

+ var VCSManagerRole = Role

+ var WebhookEvents = []cloud.VCSEventType

+ func ExclusiveReporter(ctx context.Context, logger logr.Logger, hostname string, ...) error

+ func HostnameCredentialEnv(hostname string) string

+ func ListModuleRepositories(ctx context.Context, app Application, providerID string) ([]cloud.Repo, error)

+ func NewTestCloudConfig(c cloud.Cloud) cloud.Config

+ func ParseBranchRef(ref string) (string, bool)

+ func ParseRef(ref string) (string, bool)

+ func SetHostname(hostname string, listen *net.TCPAddr) (string, error)

+ func UpdateModuleVersionStatus(ctx context.Context, app Application, opts UpdateModuleVersionStatusOptions) (*Module, *ModuleVersion, error)

type Action

+ const CreateModuleAction

+ const CreateModuleVersionAction

+ const DeleteModuleAction

+ const GetModuleAction

+ const ListModulesAction

+ const UpdateModuleAction

type AgentToken

+ func NewTestAgentToken(t *testing.T, org *Organization) *AgentToken

+ func (t *AgentToken) MarshalLog() any

type AgentTokenStore

+ GetAgentTokenByID func(ctx context.Context, id string) (*AgentToken, error)

+ GetAgentTokenByToken func(ctx context.Context, token string) (*AgentToken, error)

type Application

+ DB func() DB

+ Tx func(ctx context.Context, tx func(Application) error) error

type ConfigurationVersion

+ func (cv *ConfigurationVersion) IngressAttributes() *IngressAttributes

type ConfigurationVersionResult

+ IngressAttributes *pggen.IngressAttributes

+ type ConnectWorkspaceOptions struct

+ Cloud string

+ Identifier string

+ ProviderID string

+ type CreateAgentTokenOptions struct

+ Description string

+ OrganizationName string

+ type CreateModuleOptions struct

+ Name string

+ Organization *Organization

+ Provider string

+ Repo *ModuleRepo

+ type CreateModuleVersionOptions struct

+ ModuleID string

+ Version string

+ type CreateTeamOptions struct

+ Name string

+ Organization string

+ type DownloadModuleOptions struct

+ ModuleVersionID string

+ type GetModuleOptions struct

+ Name string

+ Organization string

+ Provider string

+ type HostnameService interface

+ Hostname func() string

+ type IngressAttributes struct

+ Branch string

+ CommitSHA string

+ Identifier string

+ IsPullRequest bool

+ OnDefaultBranch bool

+ type ListModulesOptions struct

+ Organization string

+ type Module struct

+ func NewModule(opts CreateModuleOptions) *Module

+ func NewTestModule(org *Organization, opts ...NewTestModuleOption) *Module

+ func UnmarshalModuleRow(row ModuleRow) *Module

+ func (m *Module) Add(modver *ModuleVersion)

+ func (m *Module) CreatedAt() time.Time

+ func (m *Module) ID() string

+ func (m *Module) Latest() *ModuleVersion

+ func (m *Module) MarshalLog() any

+ func (m *Module) Name() string

+ func (m *Module) Organization() *Organization

+ func (m *Module) Provider() string

+ func (m *Module) Repo() *ModuleRepo

+ func (m *Module) Status() ModuleStatus

+ func (m *Module) UpdateStatus(status ModuleStatus)

+ func (m *Module) UpdatedAt() time.Time

+ func (m *Module) Version(version string) *ModuleVersion

+ func (m *Module) Versions() SortedModuleVersions

+ type ModuleList struct

+ Items []*Module

+ type ModuleRepo struct

+ Identifier string

+ ProviderID string

+ WebhookID uuid.UUID

+ type ModuleRow struct

+ CreatedAt pgtype.Timestamptz

+ ModuleID pgtype.Text

+ ModuleRepo *pggen.ModuleRepos

+ Name pgtype.Text

+ Organization *pggen.Organizations

+ Provider pgtype.Text

+ Status pgtype.Text

+ UpdatedAt pgtype.Timestamptz

+ Versions []pggen.ModuleVersions

+ Webhook *pggen.Webhooks

+ type ModuleService interface

+ CreateModule func(context.Context, CreateModuleOptions) (*Module, error)

+ DeleteModule func(ctx context.Context, id string) (*Module, error)

+ GetModule func(ctx context.Context, opts GetModuleOptions) (*Module, error)

+ GetModuleByID func(ctx context.Context, id string) (*Module, error)

+ GetModuleByWebhookID func(ctx context.Context, id uuid.UUID) (*Module, error)

+ ListModules func(context.Context, ListModulesOptions) ([]*Module, error)

+ PublishModule func(context.Context, PublishModuleOptions) (*Module, error)

+ UpdateModuleStatus func(ctx context.Context, opts UpdateModuleStatusOptions) (*Module, error)

+ type ModuleStatus string

+ const ModuleStatusNoVersionTags

+ const ModuleStatusPending

+ const ModuleStatusSetupComplete

+ const ModuleStatusSetupFailed

+ func NextModuleStatus(current ModuleStatus, versionStatus ModuleVersionStatus) ModuleStatus

+ type ModuleStore interface

+ CreateModule func(context.Context, *Module) error

+ DeleteModule func(ctx context.Context, id string) error

+ GetModule func(ctx context.Context, opts GetModuleOptions) (*Module, error)

+ GetModuleByID func(ctx context.Context, id string) (*Module, error)

+ GetModuleByWebhookID func(ctx context.Context, id uuid.UUID) (*Module, error)

+ ListModules func(context.Context, ListModulesOptions) ([]*Module, error)

+ UpdateModuleStatus func(ctx context.Context, opts UpdateModuleStatusOptions) error

+ type ModuleVersion struct

+ func NewModuleVersion(opts CreateModuleVersionOptions) *ModuleVersion

+ func NewTestModuleVersion(mod *Module, version string, status ModuleVersionStatus) *ModuleVersion

+ func UnmarshalModuleVersionRow(row ModuleVersionRow) *ModuleVersion

+ func (v *ModuleVersion) CreatedAt() time.Time

+ func (v *ModuleVersion) ID() string

+ func (v *ModuleVersion) MarshalLog() any

+ func (v *ModuleVersion) ModuleID() string

+ func (v *ModuleVersion) Status() ModuleVersionStatus

+ func (v *ModuleVersion) StatusError() string

+ func (v *ModuleVersion) UpdatedAt() time.Time

+ func (v *ModuleVersion) Version() string

+ type ModuleVersionRow struct

+ CreatedAt pgtype.Timestamptz

+ ModuleID pgtype.Text

+ ModuleVersionID pgtype.Text

+ Status pgtype.Text

+ StatusError pgtype.Text

+ UpdatedAt pgtype.Timestamptz

+ Version pgtype.Text

+ type ModuleVersionService interface

+ CreateModuleVersion func(context.Context, CreateModuleVersionOptions) (*ModuleVersion, error)

+ DownloadModuleVersion func(ctx context.Context, opts DownloadModuleOptions) ([]byte, error)

+ UploadModuleVersion func(ctx context.Context, opts UploadModuleVersionOptions) (*ModuleVersion, error)

+ type ModuleVersionStatus string

+ const ModuleVersionStatusCloneFailed

+ const ModuleVersionStatusCloning

+ const ModuleVersionStatusOk

+ const ModuleVersionStatusPending

+ const ModuleVersionStatusRegIngressFailed

+ const ModuleVersionStatusRegIngressReqFailed

+ const ModuleVersionStatusRegIngressing

+ type ModuleVersionStore interface

+ CreateModuleVersion func(context.Context, *ModuleVersion) error

+ DownloadModuleVersion func(ctx context.Context, opts DownloadModuleOptions) ([]byte, error)

+ UpdateModuleVersionStatus func(ctx context.Context, opts UpdateModuleVersionStatusOptions) (*ModuleVersion, error)

+ UploadModuleVersion func(ctx context.Context, opts UploadModuleVersionOptions) error

+ type ModuleVersionUploader struct

+ func (u *ModuleVersionUploader) Upload(ctx context.Context, opts UploadModuleVersionOptions) (*Module, *ModuleVersion, error)

+ type NewTestModuleOption func(*Module)

+ func WithModuleRepo() NewTestModuleOption

+ func WithModuleStatus(status ModuleStatus) NewTestModuleOption

+ func WithModuleVersion(version string, status ModuleVersionStatus) NewTestModuleOption

+ type NewTestWorkspaceOption func(*WorkspaceCreateOptions)

+ func AutoApply() NewTestWorkspaceOption

+ func WithRepo(repo *WorkspaceRepo) NewTestWorkspaceOption

+ type NewWorkspaceRepoOptions struct

+ Branch string

+ ProviderID string

type OrganizationAccess

+ ManageRegistry bool

+ ManageVCS bool

type OrganizationStore

+ GetOrganizationByID func(ctx context.Context, id string) (*Organization, error)

+ type PublishModuleOptions struct

+ Identifier string

+ Organization *Organization

+ ProviderID string

+ type PublishModuleVersionOptions struct

+ Identifier string

+ ModuleID string

+ ProviderID string

+ Ref string

+ Version string

+ type Publisher struct

+ func NewPublisher(app Application) *Publisher

+ func (p *Publisher) PublishFromEvent(ctx context.Context, event cloud.VCSEvent) error

+ func (p *Publisher) PublishModule(ctx context.Context, opts PublishModuleOptions) (*Module, error)

+ func (p *Publisher) PublishVersion(ctx context.Context, opts PublishModuleVersionOptions) (*Module, *ModuleVersion, error)

+ type RegistrySession struct

+ func NewRegistrySession(organization string) (*RegistrySession, error)

+ func UnmarshalRegistrySessionJSONAPI(dto *jsonapi.RegistrySession) *RegistrySession

+ func UnmarshalRegistrySessionRow(result RegistrySessionRow) *RegistrySession

+ func (*RegistrySession) CanAccessSite(action Action) bool

+ func (t *RegistrySession) CanAccessOrganization(action Action, name string) bool

+ func (t *RegistrySession) CanAccessWorkspace(action Action, policy *WorkspacePolicy) bool

+ func (t *RegistrySession) Expiry() time.Time

+ func (t *RegistrySession) ID() string

+ func (t *RegistrySession) MarshalLog() any

+ func (t *RegistrySession) Organization() string

+ func (t *RegistrySession) String() string

+ func (t *RegistrySession) Token() string

+ type RegistrySessionRow struct

+ Expiry pgtype.Timestamptz

+ OrganizationName pgtype.Text

+ Token pgtype.Text

+ type RegistrySessionService interface

+ CreateRegistrySession func(ctx context.Context, organization string) (*RegistrySession, error)

+ GetRegistrySession func(ctx context.Context, token string) (*RegistrySession, error)

+ type RegistrySessionStore interface

+ CreateRegistrySession func(ctx context.Context, session *RegistrySession) error

+ GetRegistrySession func(ctx context.Context, token string) (*RegistrySession, error)

+ type Reporter struct

+ func NewReporter(logger logr.Logger, app Application) *Reporter

+ func (r *Reporter) Start(ctx context.Context) error

type ResourceReport

+ func (r ResourceReport) String() string

+ type Role struct

+ func (r Role) IsAllowed(action Action) bool

+ func (r Role) String() string

type Run

+ func (r *Run) Commit() *string

type RunResult

+ IngressAttributes *pggen.IngressAttributes

type RunService

+ StartRun func(ctx context.Context, spec WorkspaceSpec, ...) (*Run, error)

+ type RunStarter struct

+ func (rs *RunStarter) StartRun(ctx context.Context, spec WorkspaceSpec, ...) (*Run, error)

+ type SortedModuleVersions []*ModuleVersion

+ func (l SortedModuleVersions) Len() int

+ func (l SortedModuleVersions) Less(i, j int) bool

+ func (l SortedModuleVersions) Swap(i, j int)

+ type Superuser struct

+ Username string

+ func (*Superuser) CanAccessOrganization(Action, string) bool

+ func (*Superuser) CanAccessSite(action Action) bool

+ func (*Superuser) CanAccessWorkspace(Action, *WorkspacePolicy) bool

+ func (s *Superuser) ID() string

+ func (s *Superuser) String() string

+ type SyncWebhookOptions struct

+ Cloud string

+ CreateWebhookFunc func(context.Context, WebhookCreatorOptions) (*Webhook, error)

+ Identifier string

+ ProviderID string

+ UpdateWebhookFunc func(context.Context, WebhookUpdaterOptions) (string, error)

type Team

+ func NewTestOwners(t *testing.T, org *Organization, opts ...NewTeamOption) *Team

type TeamResult

+ PermissionManageRegistry bool

+ PermissionManageVCS bool

type TeamService

+ ListTeamMembers func(ctx context.Context, teamID string) ([]*User, error)

type TeamStore

+ GetTeamByID func(ctx context.Context, teamID string) (*Team, error)

+ ListTeamMembers func(ctx context.Context, teamID string) ([]*User, error)

+ type TerraformModule struct

+ func UnmarshalTerraformModule(tarball []byte) (*TerraformModule, error)

+ func (m *TerraformModule) Readme() []byte

type TestRunCreateOptions

+ IngressAttributes *IngressAttributes

+ Repo *WorkspaceRepo

+ type Triggerer struct

+ func NewTriggerer(app Application, logger logr.Logger, events <-chan cloud.VCSEvent) *Triggerer

+ func (h *Triggerer) Start(ctx context.Context)

+ type Unmarshaler struct

+ func (u *Unmarshaler) UnmarshalVCSProviderRow(row VCSProviderRow) (*VCSProvider, error)

+ func (u *Unmarshaler) UnmarshalWebhookRow(row WebhookRow) (*Webhook, error)

+ type UpdateModuleStatusOptions struct

+ ID string

+ Status ModuleStatus

+ type UpdateModuleVersionStatusOptions struct

+ Error string

+ ID string

+ Status ModuleVersionStatus

+ type UpdateTeamOptions struct

+ type UploadModuleVersionOptions struct

+ ModuleVersionID string

+ Tarball []byte

type User

+ func (u *User) IsTeamMember(teamID string) bool

type VCSProvider

+ func (t *VCSProvider) CloudConfig() cloud.Config

+ func (t *VCSProvider) MarshalLog() any

+ func (t *VCSProvider) VCSProviderID() string

+ type VCSProviderFactory struct

+ func (f *VCSProviderFactory) NewVCSProvider(opts VCSProviderCreateOptions) (*VCSProvider, error)

type VCSProviderService

+ CreateWebhook func(ctx context.Context, providerID string, opts cloud.CreateWebhookOptions) (string, error)

+ DeleteWebhook func(ctx context.Context, providerID string, opts cloud.DeleteWebhookOptions) error

+ GetRepoTarball func(ctx context.Context, providerID string, opts cloud.GetRepoTarballOptions) ([]byte, error)

+ GetRepository func(ctx context.Context, providerID string, identifier string) (cloud.Repo, error)

+ GetWebhook func(ctx context.Context, providerID string, opts cloud.GetWebhookOptions) (cloud.Webhook, error)

+ ListRepositories func(ctx context.Context, providerID string, opts cloud.ListRepositoriesOptions) ([]cloud.Repo, error)

+ ListTags func(ctx context.Context, providerID string, opts cloud.ListTagsOptions) ([]string, error)

+ SetStatus func(ctx context.Context, providerID string, opts cloud.SetStatusOptions) error

+ UpdateWebhook func(ctx context.Context, providerID string, opts cloud.UpdateWebhookOptions) error

+ type Webhook struct

+ Identifier string

+ Secret string

+ VCSID string

+ WebhookID uuid.UUID

+ func NewTestWebhook(repo cloud.Repo, cloudConfig cloud.Config) *Webhook

+ func (h *Webhook) CloudName() string

+ func (h *Webhook) HandleEvent(w http.ResponseWriter, r *http.Request) cloud.VCSEvent

+ func (h *Webhook) ID() string

+ func (h *Webhook) Owner() string

+ func (h *Webhook) Repo() string

+ type WebhookCreator struct

+ func (wc *WebhookCreator) Create(ctx context.Context, opts WebhookCreatorOptions) (*Webhook, error)

+ type WebhookCreatorOptions struct

+ Cloud string

+ Identifier string

+ ProviderID string

+ type WebhookRow struct

+ Cloud pgtype.Text

+ Identifier pgtype.Text

+ Secret pgtype.Text

+ VCSID pgtype.Text

+ WebhookID pgtype.UUID

+ type WebhookStore interface

+ DeleteWebhook func(ctx context.Context, id uuid.UUID) error

+ GetWebhook func(ctx context.Context, id uuid.UUID) (*Webhook, error)

+ SyncWebhook func(ctx context.Context, opts SyncWebhookOptions) (*Webhook, error)

+ type WebhookUpdater struct

+ func (wc *WebhookUpdater) Update(ctx context.Context, opts WebhookUpdaterOptions) (string, error)

+ type WebhookUpdaterOptions struct

+ ProviderID string

type Workspace

+ func (ws *Workspace) Repo() *WorkspaceRepo

+ type WorkspaceConnectionService interface

+ ConnectWorkspace func(ctx context.Context, spec WorkspaceSpec, opts ConnectWorkspaceOptions) (*Workspace, error)

+ DisconnectWorkspace func(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

+ UpdateWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec, repo WorkspaceRepo) (*Workspace, error)

+ type WorkspaceConnector struct

+ func (wc *WorkspaceConnector) Connect(ctx context.Context, spec WorkspaceSpec, opts ConnectWorkspaceOptions) (*Workspace, error)

+ func (wc *WorkspaceConnector) Disconnect(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

type WorkspaceCreateOptions

+ Repo *WorkspaceRepo

+ type WorkspaceRepo struct

+ Branch string

+ Identifier string

+ ProviderID string

+ WebhookID uuid.UUID

+ func NewTestWorkspaceRepo(provider *VCSProvider, hook *Webhook) *WorkspaceRepo

+ func NewWorkspaceRepo(opts NewWorkspaceRepoOptions) WorkspaceRepo

type WorkspaceResult

+ Webhook *pggen.Webhooks

+ WorkspaceRepo *pggen.WorkspaceRepos

type WorkspaceService

+ ListWorkspacesByWebhookID func(ctx context.Context, id uuid.UUID) ([]*Workspace, error)

type WorkspaceStore

+ CreateWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec, repo WorkspaceRepo) (*Workspace, error)

+ DeleteWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

+ ListWorkspacesByWebhookID func(ctx context.Context, id uuid.UUID) ([]*Workspace, error)

+ UpdateWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec, repo WorkspaceRepo) (*Workspace, error)

+ type WorkspaceUpdateRepoOptions struct

+ Branch *string

v0.0.18

Nov 18, 2022

Changes in this version

+ const DefaultConfigMaxSize

+ const GithubCloudName

+ type ClientConfig struct

+ Hostname string

+ OAuthToken *oauth2.Token

+ PersonalToken *string

+ SkipTLSVerification bool

type Cloud

+ NewClient func(context.Context, ClientConfig) (CloudClient, error)

+ type CloudClient interface

+ GetRepoTarball func(ctx context.Context, repo *VCSRepo) ([]byte, error)

+ GetRepository func(ctx context.Context, identifier string) (*Repo, error)

+ GetUser func(ctx context.Context) (*User, error)

+ ListRepositories func(ctx context.Context, opts ListOptions) (*RepoList, error)

type CloudConfig

+ Cloud Cloud

+ Name CloudName

+ func GithubDefaultConfig() *CloudConfig

+ func GitlabDefaultConfig() *CloudConfig

+ func (cfg *CloudConfig) String() string

+ func (cfg *CloudConfig) UpdateEndpoint() (err error)

+ func (cfg *CloudConfig) Validate() error

+ type CloudName string

+ const GitlabCloudName

+ type GithubClient struct

+ func NewGithubClient(ctx context.Context, cfg ClientConfig) (*GithubClient, error)

+ func (g *GithubClient) GetRepoTarball(ctx context.Context, repo *VCSRepo) ([]byte, error)

+ func (g *GithubClient) GetRepository(ctx context.Context, identifier string) (*Repo, error)

+ func (g *GithubClient) GetUser(ctx context.Context) (*User, error)

+ func (g *GithubClient) ListRepositories(ctx context.Context, opts ListOptions) (*RepoList, error)

type GithubCloud

+ func (GithubCloud) NewClient(ctx context.Context, cfg ClientConfig) (CloudClient, error)

+ type GitlabClient struct

+ func NewGitlabClient(ctx context.Context, cfg ClientConfig) (*GitlabClient, error)

+ func (g *GitlabClient) GetRepoTarball(ctx context.Context, repo *VCSRepo) ([]byte, error)

+ func (g *GitlabClient) GetRepository(ctx context.Context, identifier string) (*Repo, error)

+ func (g *GitlabClient) GetUser(ctx context.Context) (*User, error)

+ func (g *GitlabClient) ListRepositories(ctx context.Context, lopts ListOptions) (*RepoList, error)

+ type GitlabCloud struct

+ func (GitlabCloud) NewClient(ctx context.Context, cfg ClientConfig) (CloudClient, error)

+ type TestClient struct

+ Repos []*Repo

+ User *User

+ func (f *TestClient) GetRepoTarball(context.Context, *VCSRepo) ([]byte, error)

+ func (f *TestClient) GetRepository(context.Context, string) (*Repo, error)

+ func (f *TestClient) GetUser(context.Context) (*User, error)

+ func (f *TestClient) ListRepositories(ctx context.Context, opts ListOptions) (*RepoList, error)

type VCSProvider

+ func (t *VCSProvider) CloudName() CloudName

+ func (t *VCSProvider) Hostname() string

+ func (t *VCSProvider) NewClient(ctx context.Context) (CloudClient, error)

+ func (t *VCSProvider) SkipTLSVerification() bool

type VCSProviderCreateOptions

+ Cloud Cloud

+ CloudName CloudName

+ Hostname string

+ SkipTLSVerification bool

v0.0.17

Nov 12, 2022

Changes in this version

+ func Pack(src string) ([]byte, error)

v0.0.16

Nov 9, 2022

Changes in this version

+ const DefaultGithubHostname

+ const DefaultGitlabHostname

+ var ErrOAuthCredentialsIncomplete = errors.New("must specify both client ID and client secret")

+ var ErrOAuthCredentialsUnspecified = errors.New("no oauth credentials have been specified")

+ func NewGithubEnterpriseClient(hostname string, httpClient *http.Client) (*github.Client, error)

+ func NewGitlabCloud(opts *cloudConfigOptions) *gitlabCloud

+ func NewTestCloud(opts ...TestCloudOption) *testCloud

+ func NewTestGithubServer(t *testing.T, opts ...TestGithubServerOption) *httptest.Server

+ func NewTestGitlabServer(t *testing.T, opts ...TestGitlabServerOption) *httptest.Server

+ func NewTestTarGZ(t *testing.T, contents ...string) []byte

+ func NewTestTarball(t *testing.T, contents ...string) []byte

type Action

+ const CreateVCSProviderAction

+ const DeleteVCSProviderAction

+ const GetVCSProviderAction

+ const ListAgentTokensAction

+ const ListVCSProvidersAction

+ type Cloud interface

+ NewDirectoryClient func(context.Context, DirectoryClientOptions) (DirectoryClient, error)

+ type CloudConfig interface

+ ClientID func() string

+ ClientSecret func() string

+ CloudName func() string

+ Endpoint func() (oauth2.Endpoint, error)

+ Hostname func() string

+ NewCloud func() (Cloud, error)

+ Scopes func() []string

+ SkipTLSVerification func() bool

+ Valid func() error

type ConfigurationVersionService

+ CloneConfigurationVersion func(ctx context.Context, cvID string, opts ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)

+ type DirectoryClient interface

+ GetRepoTarball func(ctx context.Context, repo *VCSRepo) ([]byte, error)

+ GetRepository func(ctx context.Context, identifier string) (*Repo, error)

+ GetUser func(ctx context.Context) (*User, error)

+ ListRepositories func(ctx context.Context, opts ListOptions) (*RepoList, error)

+ type DirectoryClientOptions struct

+ OAuthToken *oauth2.Token

+ PersonalToken *string

+ type GithubCloud struct

+ func NewGithubCloud(opts *cloudConfigOptions) *GithubCloud

+ func (g *GithubCloud) NewDirectoryClient(ctx context.Context, opts DirectoryClientOptions) (DirectoryClient, error)

+ func (g GithubCloud) CloudName() string

+ func (g GithubCloud) Endpoint() (oauth2.Endpoint, error)

+ func (g GithubCloud) Hostname() string

+ func (g GithubCloud) Scopes() []string

+ func (g GithubCloud) SkipTLSVerification() bool

+ type GithubConfig struct

+ func NewGithubConfigFromFlags(flags *pflag.FlagSet) *GithubConfig

+ func (cfg *GithubConfig) NewCloud() (Cloud, error)

+ func (g GithubConfig) CloudName() string

+ func (g GithubConfig) Endpoint() (oauth2.Endpoint, error)

+ func (g GithubConfig) Hostname() string

+ func (g GithubConfig) Scopes() []string

+ func (g GithubConfig) SkipTLSVerification() bool

+ type GitlabConfig struct

+ func NewGitlabConfigFromFlags(flags *pflag.FlagSet) *GitlabConfig

+ func (cfg *GitlabConfig) NewCloud() (Cloud, error)

+ func (g GitlabConfig) CloudName() string

+ func (g GitlabConfig) Endpoint() (oauth2.Endpoint, error)

+ func (g GitlabConfig) Hostname() string

+ func (g GitlabConfig) Scopes() []string

+ func (g GitlabConfig) SkipTLSVerification() bool

type ListOptions

+ func (o ListOptions) SanitizedPageNumber() int

+ func (o ListOptions) SanitizedPageSize() int

+ type OAuthCredentials struct

+ func (a *OAuthCredentials) AddFlags(flags *pflag.FlagSet)

+ func (a *OAuthCredentials) ClientID() string

+ func (a *OAuthCredentials) ClientSecret() string

+ func (a *OAuthCredentials) Valid() error

type Pagination

+ func (p *Pagination) NextPageQuery() string

+ func (p *Pagination) PrevPageQuery() string

+ type Repo struct

+ Branch string

+ HTTPURL string

+ Identifier string

+ func NewTestRepo() *Repo

+ func (r Repo) ID() string

+ type RepoList struct

+ Items []*Repo

+ type TestCloudOption func(*testCloud)

+ func WithHostname(hostname string) TestCloudOption

+ func WithRepos(repos ...*Repo) TestCloudOption

+ func WithUser(user *User) TestCloudOption

+ type TestDirectoryClient struct

+ Repos []*Repo

+ User *User

+ func (f *TestDirectoryClient) GetRepoTarball(context.Context, *VCSRepo) ([]byte, error)

+ func (f *TestDirectoryClient) GetRepository(context.Context, string) (*Repo, error)

+ func (f *TestDirectoryClient) GetUser(context.Context) (*User, error)

+ func (f *TestDirectoryClient) ListRepositories(ctx context.Context, opts ListOptions) (*RepoList, error)

+ type TestGithubServerOption func(*testGithubServerDB)

+ func WithGithubArchive(tarball []byte) TestGithubServerOption

+ func WithGithubRepo(repo *Repo) TestGithubServerOption

+ func WithGithubUser(user *User) TestGithubServerOption

+ type TestGitlabServerOption func(*testGitlabServerDB)

+ func WithGitlabRepo(repo *Repo) TestGitlabServerOption

+ func WithGitlabTarball(tarball []byte) TestGitlabServerOption

+ func WithGitlabUser(user *User) TestGitlabServerOption

+ type VCSProvider struct

+ func NewTestVCSProvider(t *testing.T, organization *Organization, cloud Cloud) *VCSProvider

+ func NewVCSProvider(cloud Cloud, opts VCSProviderCreateOptions) (*VCSProvider, error)

+ func UnmarshalVCSProviderRow(row VCSProviderRow) (*VCSProvider, error)

+ func (t *VCSProvider) Cloud() Cloud

+ func (t *VCSProvider) CreatedAt() time.Time

+ func (t *VCSProvider) ID() string

+ func (t *VCSProvider) Name() string

+ func (t *VCSProvider) NewDirectoryClient(ctx context.Context, opts DirectoryClientOptions) (DirectoryClient, error)

+ func (t *VCSProvider) OrganizationName() string

+ func (t *VCSProvider) String() string

+ func (t *VCSProvider) Token() string

+ type VCSProviderCloud string

+ const VCSProviderGithub

+ const VCSProviderGitlab

+ type VCSProviderCreateOptions struct

+ Name string

+ OrganizationName string

+ Token string

+ type VCSProviderRow struct

+ Cloud pgtype.Text

+ CreatedAt pgtype.Timestamptz

+ Hostname pgtype.Text

+ Name pgtype.Text

+ OrganizationName pgtype.Text

+ SkipTLSVerification bool

+ Token pgtype.Text

+ VCSProviderID pgtype.Text

+ type VCSProviderService interface

+ CreateVCSProvider func(ctx context.Context, cloud Cloud, opts VCSProviderCreateOptions) (*VCSProvider, error)

+ DeleteVCSProvider func(ctx context.Context, id, organization string) error

+ GetVCSProvider func(ctx context.Context, id, organization string) (*VCSProvider, error)

+ ListVCSProviders func(ctx context.Context, organization string) ([]*VCSProvider, error)

+ type VCSProviderStore interface

+ CreateVCSProvider func(ctx context.Context, provider *VCSProvider) error

+ DeleteVCSProvider func(ctx context.Context, id string) error

+ GetVCSProvider func(ctx context.Context, id string) (*VCSProvider, error)

+ ListVCSProviders func(ctx context.Context, organization string) ([]*VCSProvider, error)

type VCSRepo

+ HTTPURL string

+ ProviderID string

+ func NewTestVCSRepo(provider *VCSProvider) *VCSRepo

+ func NewVCSRepo(cloud Cloud) *VCSRepo

+ func (r VCSRepo) Owner() string

+ func (r VCSRepo) Repo() string

+ func (r VCSRepo) String() string

+ type WorkspaceRepoService interface

+ ConnectWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec, repo VCSRepo) (*Workspace, error)

+ DisconnectWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

+ UpdateWorkspaceRepo func(ctx context.Context, spec WorkspaceSpec, repo VCSRepo) (*Workspace, error)

type WorkspaceResult

+ VCSRepo *pggen.VCSRepos

v0.0.15

Nov 2, 2022

v0.0.14

Oct 31, 2022

v0.0.13

Oct 30, 2022

v0.0.12

Oct 30, 2022

Changes in this version

+ const AgentExecutionMode

+ const ApplyPhase

+ const ConfigMaxSize

+ const DefaultSessionExpiry

+ const DefaultStateVersion

+ const FinalPhase

+ const LocalExecutionMode

+ const LockFilename

+ const PendingPhase

+ const PhaseCanceled

+ const PhaseErrored

+ const PhaseFinished

+ const PhasePending

+ const PhaseQueued

+ const PhaseRunning

+ const PhaseUnreachable

+ const PlanPhase

+ const RemoteExecutionMode

+ const SchedulerLockID

+ const UnknownPhase

+ var ActiveRun = []RunStatus

+ var Built = "unknown"

+ var BuiltInt int

+ var CompletedRun = []RunStatus

+ var ErrAccessNotPermitted = errors.New("access to the resource is not permitted")

+ var ErrInvalidRunStateTransition = errors.New("invalid run state transition")

+ var ErrInvalidTeamSpec = errors.New("invalid team spec options")

+ var ErrInvalidWorkspaceSpec = errors.New("invalid workspace spec options")

+ var ErrPhaseAlreadyStarted = errors.New("phase already started")

+ var ErrResourceAlreadyExists = errors.New("resource already exists")

+ var ErrStatusTimestampNotFound = errors.New("corresponding status timestamp not found")

+ var ErrWorkspaceInvalidLock = errors.New("invalid workspace lock")

+ var ErrWorkspaceInvalidSpec = errors.New("invalid workspace specification")

+ var ErrWorkspaceLockedByDifferentUser = errors.New("workspace locked by different user")

+ var ErrWorkspaceUnlockDenied = errors.New("unauthorized to unlock workspace")

+ var EventWorkspaceLocked EventType = "workspace_locked"

+ var EventWorkspaceUnlocked EventType = "workspace_unlocked"

+ var IncompleteRun = append(ActiveRun, RunPending)

+ var SiteAdmin = User

+ var SiteAdminID = "user-site-admin"

+ var WorkspaceAdminRole = WorkspaceRole

+ var WorkspaceManagerRole = WorkspaceRole

+ var WorkspacePlanRole = WorkspaceRole

+ var WorkspaceReadRole = WorkspaceRole

+ var WorkspaceWriteRole = WorkspaceRole

+ func Absolute(r *http.Request, path string) string

+ func AddSubjectToContext(ctx context.Context, subj Subject) context.Context

+ func Bool(b bool) *bool

+ func ContainsRunStatus(statuses []RunStatus, status RunStatus) bool

+ func ConvertID(id, resource string) string

+ func CurrentTimestamp() time.Time

+ func ExclusiveScheduler(ctx context.Context, logger logr.Logger, app LockableApplication)

+ func Exists(path string) bool

+ func GenerateAuthToken(accountType string) (string, error)

+ func GenerateToken() (string, error)

+ func LockFileCacheKey(id string) string

+ func MarshalWorkspaceLockParams(ws *Workspace) (pggen.UpdateWorkspaceLockByIDParams, error)

+ func Time(t time.Time) *time.Time

+ func UpdateHost(u, host string) (string, error)

+ func UpdateOrganizationFromOpts(org *Organization, opts OrganizationUpdateOptions) error

+ func ValidateExecutionMode(m ExecutionMode) error

+ type Action string

+ const ApplyRunAction

+ const CancelRunAction

+ const CreateAgentTokenAction

+ const CreateConfigurationVersionAction

+ const CreateOrganizationAction

+ const CreateRunAction

+ const CreateStateVersionAction

+ const CreateTeamAction

+ const CreateWorkspaceAction

+ const DeleteAgentTokenAction

+ const DeleteOrganizationAction

+ const DeleteRunAction

+ const DeleteWorkspaceAction

+ const DiscardRunAction

+ const DownloadConfigurationVersionAction

+ const DownloadStateAction

+ const EnqueuePlanAction

+ const FinishPhaseAction

+ const GetConfigurationVersionAction

+ const GetEntitlementsAction

+ const GetLockFileAction

+ const GetOrganizationAction

+ const GetPlanFileAction

+ const GetRunAction

+ const GetStateVersionAction

+ const GetTeamAction

+ const GetWorkspaceAction

+ const ListAgentTokenActions

+ const ListConfigurationVersionsAction

+ const ListRunsAction

+ const ListStateVersionsAction

+ const ListTeamsAction

+ const ListUsersAction

+ const ListWorkspacesAction

+ const LockWorkspaceAction

+ const PutChunkAction

+ const SetWorkspacePermissionAction

+ const StartPhaseAction

+ const TailLogsAction

+ const UnlockWorkspaceAction

+ const UnsetWorkspacePermissionAction

+ const UpdateOrganizationAction

+ const UpdateTeamAction

+ const UpdateWorkspaceAction

+ const UploadLockFileAction

+ const UploadPlanFileAction

+ const WatchAction

+ type AgentToken struct

+ func AgentFromContext(ctx context.Context) (*AgentToken, error)

+ func NewAgentToken(opts AgentTokenCreateOptions) (*AgentToken, error)

+ func UnmarshalAgentTokenJSONAPI(dto *jsonapi.AgentToken) *AgentToken

+ func UnmarshalAgentTokenResult(row AgentTokenRow) *AgentToken

+ func (*AgentToken) CanAccessSite(action Action) bool

+ func (t *AgentToken) CanAccessOrganization(action Action, name string) bool

+ func (t *AgentToken) CanAccessWorkspace(action Action, policy *WorkspacePolicy) bool

+ func (t *AgentToken) CreatedAt() time.Time

+ func (t *AgentToken) Description() string

+ func (t *AgentToken) HideToken()

+ func (t *AgentToken) ID() string

+ func (t *AgentToken) OrganizationName() string

+ func (t *AgentToken) String() string

+ func (t *AgentToken) Token() *string

+ type AgentTokenCreateOptions struct

+ Description string

+ OrganizationName string

+ type AgentTokenRow struct

+ CreatedAt pgtype.Timestamptz

+ Description pgtype.Text

+ OrganizationName pgtype.Text

+ Token pgtype.Text

+ TokenID pgtype.Text

+ type AgentTokenService interface

+ CreateAgentToken func(ctx context.Context, opts AgentTokenCreateOptions) (*AgentToken, error)

+ DeleteAgentToken func(ctx context.Context, id string, organizationName string) error

+ GetAgentToken func(ctx context.Context, token string) (*AgentToken, error)

+ ListAgentTokens func(ctx context.Context, organizationName string) ([]*AgentToken, error)

+ type AgentTokenStore interface

+ CreateAgentToken func(ctx context.Context, at *AgentToken) error

+ DeleteAgentToken func(ctx context.Context, id string) error

+ GetAgentToken func(ctx context.Context, token string) (*AgentToken, error)

+ ListAgentTokens func(ctx context.Context, organizationName string) ([]*AgentToken, error)

+ type AllowAllSubject struct

+ func (*AllowAllSubject) CanAccessOrganization(Action, string) bool

+ func (*AllowAllSubject) CanAccessSite(action Action) bool

+ func (*AllowAllSubject) CanAccessWorkspace(Action, *WorkspacePolicy) bool

+ func (*AllowAllSubject) ID() string

+ func (*AllowAllSubject) String() string

+ type AppUser struct

+ func (*AppUser) CanAccessOrganization(Action, string) bool

+ func (*AppUser) CanAccessSite(action Action) bool

+ func (*AppUser) CanAccessWorkspace(Action, *WorkspacePolicy) bool

+ func (*AppUser) ID() string

+ func (*AppUser) String() string

+ type Application interface

type Apply

+ func (a *Apply) Phase() PhaseType

+ func (p Apply) StatusTimestamp(status PhaseStatus) (time.Time, error)

type ChangeAction

+ const PlanFormatBinary

+ const PlanFormatJSON

+ type Chunk struct

+ Data []byte

+ Offset int

+ Phase PhaseType

+ RunID string

+ func (c Chunk) AddEndMarker() Chunk

+ func (c Chunk) AddStartMarker() Chunk

+ func (c Chunk) Cut(opts GetChunkOptions) Chunk

+ func (c Chunk) IsEnd() bool

+ func (c Chunk) IsStart() bool

+ func (c Chunk) Key() string

+ func (c Chunk) NextOffset() int

+ func (c Chunk) RemoveEndMarker() Chunk

+ func (c Chunk) RemoveStartMarker() Chunk

+ type ChunkService interface

+ GetChunk func(ctx context.Context, opts GetChunkOptions) (Chunk, error)

+ PutChunk func(ctx context.Context, chunk Chunk) error

type ChunkStore

+ GetChunkByID func(ctx context.Context, id int) (PersistedChunk, error)

+ type ConfigUploader interface

+ SetErrored func(ctx context.Context) error

+ Upload func(ctx context.Context, config []byte) (ConfigurationStatus, error)

type ConfigurationVersion

+ func NewConfigurationVersion(workspaceID string, opts ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)

+ func NewTestConfigurationVersion(t *testing.T, ws *Workspace, opts ConfigurationVersionCreateOptions) *ConfigurationVersion

+ func UnmarshalConfigurationVersionResult(result ConfigurationVersionResult) (*ConfigurationVersion, error)

+ func (cv *ConfigurationVersion) AddStatusTimestamp(status ConfigurationStatus, timestamp time.Time)

+ func (cv *ConfigurationVersion) CreatedAt() time.Time

+ func (cv *ConfigurationVersion) StatusTimestamp(status ConfigurationStatus) (time.Time, error)

+ func (cv *ConfigurationVersion) Upload(ctx context.Context, config []byte, uploader ConfigUploader) error

+ func (cv *ConfigurationVersion) WorkspaceID() string

type ConfigurationVersionGetOptions

+ Include *string

+ type ConfigurationVersionResult struct

+ AutoQueueRuns bool

+ ConfigurationVersionID pgtype.Text

+ ConfigurationVersionStatusTimestamps []pggen.ConfigurationVersionStatusTimestamps

+ CreatedAt pgtype.Timestamptz

+ Source pgtype.Text

+ Speculative bool

+ Status pgtype.Text

+ WorkspaceID pgtype.Text

type ConfigurationVersionService

+ CreateConfigurationVersion func(ctx context.Context, workspaceID string, ...) (*ConfigurationVersion, error)

+ DownloadConfig func(ctx context.Context, id string) ([]byte, error)

+ GetConfigurationVersion func(ctx context.Context, id string) (*ConfigurationVersion, error)

+ GetLatestConfigurationVersion func(ctx context.Context, workspaceID string) (*ConfigurationVersion, error)

+ ListConfigurationVersions func(ctx context.Context, workspaceID string, opts ConfigurationVersionListOptions) (*ConfigurationVersionList, error)

+ UploadConfig func(ctx context.Context, id string, config []byte) error

+ type ConfigurationVersionStatusTimestamp struct

+ Status ConfigurationStatus

+ Timestamp time.Time

type ConfigurationVersionStore

+ CreateConfigurationVersion func(ctx context.Context, cv *ConfigurationVersion) error

+ DeleteConfigurationVersion func(ctx context.Context, id string) error

+ GetConfig func(ctx context.Context, id string) ([]byte, error)

+ GetConfigurationVersion func(ctx context.Context, opts ConfigurationVersionGetOptions) (*ConfigurationVersion, error)

+ ListConfigurationVersions func(ctx context.Context, workspaceID string, opts ConfigurationVersionListOptions) (*ConfigurationVersionList, error)

+ UploadConfigurationVersion func(ctx context.Context, id string, ...) error

+ type CurrentRunService interface

+ SetCurrentRun func(ctx context.Context, workspaceID, runID string) error

+ type DB interface

+ Close func()

+ Tx func(ctx context.Context, tx func(DB) error) error

+ WaitAndLock func(ctx context.Context, id int64, cb func(DB) error) error

+ type Downloader interface

+ Download func(ctx context.Context, version string, w io.Writer) (path string, err error)

type Environment

+ Path func() string

+ RunTerraform func(cmd string, args ...string) error

+ TerraformPath func() string

type EventService

+ Watch func(context.Context, WatchOptions) (<-chan Event, error)

+ WatchLogs func(context.Context, WatchLogsOptions) (<-chan Chunk, error)

type EventType

+ const EventInfo

+ const EventLogChunk

+ const EventRunCancel

+ const EventRunDeleted

+ const EventRunForceCancel

+ const EventRunStatusUpdate

+ const EventWorkspaceRenamed

+ type ExecutionMode string

+ type FakeWorkspaceLockService struct

+ func (f *FakeWorkspaceLockService) LockWorkspace(context.Context, WorkspaceSpec, WorkspaceLockOptions) (*Workspace, error)

type GetChunkOptions

+ Phase PhaseType

+ RunID string

+ func (c GetChunkOptions) Key() string

+ type Identity interface

+ ID func() string

+ String func() string

type JobWriter

+ Phase PhaseType

+ func NewJobWriter(ctx context.Context, app Application, logger logr.Logger, run *Run) *JobWriter

type ListOptions

+ func (o ListOptions) NextPageQuery() string

+ func (o ListOptions) PrevPageQuery() string

+ type LocalAgent struct

+ func (*LocalAgent) CanAccessOrganization(Action, string) bool

+ func (*LocalAgent) CanAccessSite(action Action) bool

+ func (*LocalAgent) CanAccessWorkspace(Action, *WorkspacePolicy) bool

+ func (*LocalAgent) ID() string

+ func (*LocalAgent) String() string

+ type LockableApplication interface

+ WithLock func(ctx context.Context, id int64, cb func(Application) error) error

+ type LogService ChunkService

+ type NewSessionOption func(*Session)

+ func SessionExpiry(expiry time.Time) NewSessionOption

+ type NewTeamOption func(*Team)

+ type NewUserOption func(*User)

+ func WithOrganizationMemberships(memberships ...*Organization) NewUserOption

+ func WithTeamMemberships(memberships ...*Team) NewUserOption

type Organization

+ func NewTestOrganization(t *testing.T) *Organization

+ func UnmarshalOrganizationJSONAPI(model *dto.Organization) *Organization

+ func UnmarshalOrganizationRow(row pggen.Organizations) *Organization

+ func (org *Organization) CreatedAt() time.Time

+ func (org *Organization) OrganizationName() string

+ func (org *Organization) UpdatedAt() time.Time

+ type OrganizationAccess struct

+ ManageWorkspaces bool

type OrganizationCreateOptions

+ func (opts *OrganizationCreateOptions) Validate() error

type OrganizationService

+ CreateOrganization func(ctx context.Context, opts OrganizationCreateOptions) (*Organization, error)

+ DeleteOrganization func(ctx context.Context, name string) error

+ EnsureCreatedOrganization func(ctx context.Context, opts OrganizationCreateOptions) (*Organization, error)

+ GetOrganization func(ctx context.Context, name string) (*Organization, error)

+ ListOrganizations func(ctx context.Context, opts OrganizationListOptions) (*OrganizationList, error)

+ UpdateOrganization func(ctx context.Context, name string, opts *OrganizationUpdateOptions) (*Organization, error)

type OrganizationStore

+ CreateOrganization func(ctx context.Context, org *Organization) error

+ DeleteOrganization func(ctx context.Context, name string) error

+ GetOrganization func(ctx context.Context, name string) (*Organization, error)

+ GetOrganizationNameByWorkspaceID func(ctx context.Context, workspaceID string) (string, error)

+ ListOrganizations func(ctx context.Context, opts OrganizationListOptions) (*OrganizationList, error)

+ UpdateOrganization func(ctx context.Context, name string, fn func(*Organization) error) (*Organization, error)

type Pagination

+ func UnmarshalPaginationJSONAPI(json *jsonapi.Pagination) *Pagination

+ func (p *Pagination) PrevPage() *int

+ func (p *Pagination) ToJSONAPI() *jsonapi.Pagination

+ type PersistedChunk struct

+ ChunkID int

+ func (c PersistedChunk) ID() string

+ func (c PersistedChunk) String() string

type Phase

+ ID func() string

+ Phase func() PhaseType

+ Status func() PhaseStatus

+ StatusTimestamp func(PhaseStatus) (time.Time, error)

+ StatusTimestamps func() []PhaseStatusTimestamp

+ type PhaseFinishOptions struct

+ Errored bool

+ type PhaseSpec struct

+ Phase PhaseType

+ RunID string

+ type PhaseStartOptions struct

+ AgentID string

+ type PhaseStatus string

+ func (r PhaseStatus) String() string

+ type PhaseStatusTimestamp struct

+ Status PhaseStatus

+ Timestamp time.Time

+ type PhaseType string

type Plan

+ func (p *Plan) Phase() PhaseType

+ func (p Plan) StatusTimestamp(status PhaseStatus) (time.Time, error)

type PlanFile

+ ResourceChanges []ResourceChange

+ type PlanFormat string

+ func (f PlanFormat) CacheKey(id string) string

+ func (f PlanFormat) SQLColumn() string

+ type PubSubService interface

+ Publish func(Event)

+ Subscribe func(ctx context.Context, name string) (<-chan Event, error)

+ type ResourceReport struct

+ Additions int

+ Changes int

+ Destructions int

+ func CompilePlanReport(planJSON []byte) (ResourceReport, error)

+ func (r ResourceReport) HasChanges() bool

type Run

+ func NewRun(cv *ConfigurationVersion, ws *Workspace, opts RunCreateOptions) *Run

+ func NewTestRun(t *testing.T, opts TestRunCreateOptions) *Run

+ func UnmarshalRunJSONAPI(d *dto.Run) *Run

+ func UnmarshalRunResult(result RunResult) (*Run, error)

+ func (*Run) CanAccessSite(action Action) bool

+ func (r *Run) CanAccessOrganization(action Action, name string) bool

+ func (r *Run) CanAccessWorkspace(action Action, policy *WorkspacePolicy) bool

+ func (r *Run) CanLock(requestor Identity) error

+ func (r *Run) CanUnlock(requestor Identity, force bool) error

+ func (r *Run) Cancelable() bool

+ func (r *Run) ConfigurationVersionID() string

+ func (r *Run) Confirmable() bool

+ func (r *Run) CreatedAt() time.Time

+ func (r *Run) Discardable() bool

+ func (r *Run) Done() bool

+ func (r *Run) EnqueueApply() error

+ func (r *Run) EnqueuePlan(ctx context.Context, svc WorkspaceLockService) error

+ func (r *Run) ExecutionMode() ExecutionMode

+ func (r *Run) HasApply() bool

+ func (r *Run) HasChanges() bool

+ func (r *Run) IncludeWorkspace(ws *Workspace)

+ func (r *Run) Latest() bool

+ func (r *Run) OrganizationName() string

+ func (r *Run) Phase() PhaseType

+ func (r *Run) PlanOnly() bool

+ func (r *Run) Queued() bool

+ func (r *Run) RunID() string

+ func (r *Run) Speculative() bool

+ func (r *Run) StatusTimestamp(status RunStatus) (time.Time, error)

+ func (r *Run) WorkspaceID() string

+ func (r *Run) WorkspaceName() string

type RunCreateOptions

+ ConfigurationVersionID *string

+ WorkspaceID *string

+ WorkspaceSpec WorkspaceSpec

type RunList

+ func UnmarshalRunListJSONAPI(json *dto.RunList) *RunList

type RunListOptions

+ OrganizationName *string

+ Speculative *bool

+ WorkspaceName *string

+ func (opts RunListOptions) LogFields() (fields []interface{})

+ type RunResult struct

+ AppliedChanges *pggen.Report

+ ApplyStatus pgtype.Text

+ ApplyStatusTimestamps []pggen.PhaseStatusTimestamps

+ AutoApply bool

+ ConfigurationVersionID pgtype.Text

+ CreatedAt pgtype.Timestamptz

+ ExecutionMode pgtype.Text

+ ForceCancelAvailableAt pgtype.Timestamptz

+ IsDestroy bool

+ Latest bool

+ OrganizationName pgtype.Text

+ PlanStatus pgtype.Text

+ PlanStatusTimestamps []pggen.PhaseStatusTimestamps

+ PlannedChanges *pggen.Report

+ PositionInQueue int

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

+ RunID pgtype.Text

+ RunStatusTimestamps []pggen.RunStatusTimestamps

+ Speculative bool

+ Status pgtype.Text

+ TargetAddrs []string

+ WorkspaceID pgtype.Text

+ WorkspaceName pgtype.Text

type RunService

+ ApplyRun func(ctx context.Context, id string, opts RunApplyOptions) error

+ CancelRun func(ctx context.Context, id string, opts RunCancelOptions) error

+ CreateRun func(ctx context.Context, ws WorkspaceSpec, opts RunCreateOptions) (*Run, error)

+ DeleteRun func(ctx context.Context, id string) error

+ DiscardRun func(ctx context.Context, id string, opts RunDiscardOptions) error

+ FinishPhase func(ctx context.Context, id string, phase PhaseType, opts PhaseFinishOptions) (*Run, error)

+ ForceCancelRun func(ctx context.Context, id string, opts RunForceCancelOptions) error

+ GetLockFile func(ctx context.Context, id string) ([]byte, error)

+ GetRun func(ctx context.Context, id string) (*Run, error)

+ ListRuns func(ctx context.Context, opts RunListOptions) (*RunList, error)

+ StartPhase func(ctx context.Context, id string, phase PhaseType, opts PhaseStartOptions) (*Run, error)

+ Tail func(ctx context.Context, opts GetChunkOptions) (<-chan Chunk, error)

+ UploadLockFile func(ctx context.Context, id string, lockFile []byte) error

type RunStatus

+ func (r RunStatus) String() string

type RunStore

+ CreateApplyReport func(ctx context.Context, id string, report ResourceReport) error

+ CreatePlanReport func(ctx context.Context, id string, report ResourceReport) error

+ CreateRun func(ctx context.Context, run *Run) error

+ DeleteRun func(ctx context.Context, id string) error

+ GetLockFile func(ctx context.Context, id string) ([]byte, error)

+ GetPlanFile func(ctx context.Context, id string, format PlanFormat) ([]byte, error)

+ GetRun func(ctx context.Context, id string) (*Run, error)

+ ListRuns func(ctx context.Context, opts RunListOptions) (*RunList, error)

+ SetLockFile func(ctx context.Context, id string, file []byte) error

+ SetPlanFile func(ctx context.Context, id string, file []byte, format PlanFormat) error

+ UpdateStatus func(ctx context.Context, id string, fn func(*Run) error) (*Run, error)

+ type Scheduler struct

+ func NewScheduler(logger logr.Logger, app Application) *Scheduler

+ func (s *Scheduler) Start(ctx context.Context) error

+ type Session struct

+ func NewSession(uid, address string) (*Session, error)

+ func NewTestSession(t *testing.T, userID string, opts ...NewSessionOption) *Session

+ func UnmarshalSessionResult(result SessionResult) *Session

+ func (s *Session) Address() string

+ func (s *Session) CreatedAt() time.Time

+ func (s *Session) Expiry() time.Time

+ func (s *Session) ID() string

+ func (s *Session) Token() string

+ func (s *Session) UserID() string

+ type SessionResult struct

+ Address pgtype.Text

+ CreatedAt pgtype.Timestamptz

+ Expiry pgtype.Timestamptz

+ Token pgtype.Text

+ UserID pgtype.Text

+ type SessionService interface

+ CreateSession func(ctx context.Context, userID, address string) (*Session, error)

+ DeleteSession func(ctx context.Context, token string) error

+ GetSessionByToken func(ctx context.Context, token string) (*Session, error)

+ ListSessions func(ctx context.Context, userID string) ([]*Session, error)

+ type SessionStore interface

+ CreateSession func(ctx context.Context, session *Session) error

+ DeleteSession func(ctx context.Context, token string) error

+ GetSessionByToken func(ctx context.Context, token string) (*Session, error)

+ ListSessions func(ctx context.Context, userID string) ([]*Session, error)

type State

+ func NewState(opts StateCreateOptions, outputs ...StateOutput) *State

+ func UnmarshalState(data []byte) (*State, error)

+ func (s *State) Marshal() (string, error)

+ type StateCreateOptions struct

+ Lineage *string

+ Serial *int64

+ Version *int

type StateOutput

+ Name string

+ Sensitive bool

type StateVersion

+ func NewStateVersion(opts StateVersionCreateOptions) (*StateVersion, error)

+ func NewTestStateVersion(t *testing.T, outputs ...StateOutput) *StateVersion

+ func UnmarshalStateVersionJSONAPI(dto *jsonapi.StateVersion) *StateVersion

+ func UnmarshalStateVersionResult(row StateVersionResult) (*StateVersion, error)

+ func (sv *StateVersion) CreatedAt() time.Time

type StateVersionCreateOptions

+ func (opts *StateVersionCreateOptions) Valid() error

type StateVersionOutput

+ func UnmarshalStateVersionOutputRow(row pggen.StateVersionOutputs) *StateVersionOutput

+ type StateVersionResult struct

+ CreatedAt pgtype.Timestamptz

+ Serial int

+ State []byte

+ StateVersionID pgtype.Text

+ StateVersionOutputs []pggen.StateVersionOutputs

+ WorkspaceID pgtype.Text

type StateVersionService

+ CreateStateVersion func(ctx context.Context, workspaceID string, opts StateVersionCreateOptions) (*StateVersion, error)

+ CurrentStateVersion func(ctx context.Context, workspaceID string) (*StateVersion, error)

+ DownloadState func(ctx context.Context, id string) ([]byte, error)

+ GetStateVersion func(ctx context.Context, id string) (*StateVersion, error)

+ ListStateVersions func(ctx context.Context, opts StateVersionListOptions) (*StateVersionList, error)

type StateVersionStore

+ CreateStateVersion func(ctx context.Context, workspaceID string, sv *StateVersion) error

+ DeleteStateVersion func(ctx context.Context, id string) error

+ GetState func(ctx context.Context, id string) ([]byte, error)

+ GetStateVersion func(ctx context.Context, opts StateVersionGetOptions) (*StateVersion, error)

+ ListStateVersions func(ctx context.Context, opts StateVersionListOptions) (*StateVersionList, error)

+ type Subject interface

+ CanAccessOrganization func(action Action, name string) bool

+ CanAccessSite func(action Action) bool

+ CanAccessWorkspace func(action Action, policy *WorkspacePolicy) bool

+ func SubjectFromContext(ctx context.Context) (Subject, error)

+ type Team struct

+ func NewTeam(name string, org *Organization, opts ...NewTeamOption) *Team

+ func NewTestTeam(t *testing.T, org *Organization, opts ...NewTeamOption) *Team

+ func UnmarshalTeamResult(row TeamResult, opts ...NewTeamOption) *Team

+ func (u *Team) CreatedAt() time.Time

+ func (u *Team) ID() string

+ func (u *Team) IsOwners() bool

+ func (u *Team) Name() string

+ func (u *Team) Organization() *Organization

+ func (u *Team) OrganizationAccess() OrganizationAccess

+ func (u *Team) OrganizationName() string

+ func (u *Team) String() string

+ func (u *Team) TeamName() string

+ func (u *Team) Update(opts TeamUpdateOptions) error

+ type TeamResult struct

+ CreatedAt pgtype.Timestamptz

+ Name pgtype.Text

+ Organization *pggen.Organizations

+ OrganizationID pgtype.Text

+ PermissionManageWorkspaces bool

+ TeamID pgtype.Text

+ type TeamService interface

+ CreateTeam func(ctx context.Context, name, organization string) (*Team, error)

+ EnsureCreatedTeam func(ctx context.Context, name, organization string) (*Team, error)

+ GetTeam func(ctx context.Context, name, organization string) (*Team, error)

+ ListTeams func(ctx context.Context, organization string) ([]*Team, error)

+ UpdateTeam func(ctx context.Context, name, organization string, opts TeamUpdateOptions) (*Team, error)

+ type TeamSpec struct

+ Name string

+ OrganizationName string

+ type TeamStore interface

+ CreateTeam func(ctx context.Context, team *Team) error

+ DeleteTeam func(ctx context.Context, name, organization string) error

+ GetTeam func(ctx context.Context, name, organization string) (*Team, error)

+ ListTeams func(ctx context.Context, organization string) ([]*Team, error)

+ UpdateTeam func(ctx context.Context, name, organization string, fn func(*Team) error) (*Team, error)

+ type TeamUpdateOptions struct

+ ManageWorkspaces bool

+ type TestRunCreateOptions struct

+ AutoApply bool

+ ID *string

+ Speculative bool

+ Status RunStatus

+ type Token struct

+ func NewToken(uid, description string) (*Token, error)

+ func UnmarshalTokenResult(result pggen.FindTokensByUserIDRow) *Token

+ func (t *Token) CreatedAt() time.Time

+ func (t *Token) Description() string

+ func (t *Token) ID() string

+ func (t *Token) Token() string

+ func (t *Token) UserID() string

+ type TokenCreateOptions struct

+ Description string

+ type TokenService interface

+ CreateToken func(ctx context.Context, userID string, opts *TokenCreateOptions) (*Token, error)

+ DeleteToken func(ctx context.Context, userID string, tokenID string) error

+ ListTokens func(ctx context.Context, userID string) ([]*Token, error)

+ type TokenStore interface

+ CreateToken func(ctx context.Context, token *Token) error

+ DeleteToken func(ctx context.Context, id string) error

+ ListTokens func(ctx context.Context, userID string) ([]*Token, error)

+ type Unlocked struct

+ func (u *Unlocked) CanLock(Identity) error

+ func (u *Unlocked) CanUnlock(Identity, bool) error

+ type User struct

+ func NewTestUser(t *testing.T, opts ...NewUserOption) *User

+ func NewUser(username string, opts ...NewUserOption) *User

+ func UnmarshalUserResult(row UserResult, opts ...NewUserOption) (*User, error)

+ func UserFromContext(ctx context.Context) (*User, error)

+ func (u *User) CanAccessOrganization(action Action, name string) bool

+ func (u *User) CanAccessSite(action Action) bool

+ func (u *User) CanAccessWorkspace(action Action, policy *WorkspacePolicy) bool

+ func (u *User) CanLock(requestor Identity) error

+ func (u *User) CanUnlock(requestor Identity, force bool) error

+ func (u *User) CreatedAt() time.Time

+ func (u *User) ID() string

+ func (u *User) IsOwner(organization string) bool

+ func (u *User) IsSiteAdmin() bool

+ func (u *User) IsUnprivilegedUser(organization string) bool

+ func (u *User) Organizations() []*Organization

+ func (u *User) String() string

+ func (u *User) SyncMemberships(ctx context.Context, store UserStore, orgs []*Organization, teams []*Team) error

+ func (u *User) Team(name, organization string) (*Team, error)

+ func (u *User) Teams() []*Team

+ func (u *User) TeamsByOrganization(organization string) []*Team

+ func (u *User) UpdatedAt() time.Time

+ func (u *User) Username() string

+ type UserListOptions struct

+ OrganizationName *string

+ TeamName *string

+ type UserResult struct

+ CreatedAt pgtype.Timestamptz

+ Organizations []pggen.Organizations

+ Teams []pggen.Teams

+ UpdatedAt pgtype.Timestamptz

+ UserID pgtype.Text

+ Username pgtype.Text

+ type UserService interface

+ CreateUser func(ctx context.Context, username string) (*User, error)

+ EnsureCreatedUser func(ctx context.Context, username string) (*User, error)

+ GetUser func(ctx context.Context, spec UserSpec) (*User, error)

+ ListUsers func(ctx context.Context, opts UserListOptions) ([]*User, error)

+ SyncUserMemberships func(ctx context.Context, user *User, orgs []*Organization, teams []*Team) (*User, error)

+ type UserSpec struct

+ AuthenticationToken *string

+ SessionToken *string

+ UserID *string

+ Username *string

+ func (spec *UserSpec) KeyValue() []interface{}

+ type UserStore interface

+ AddOrganizationMembership func(ctx context.Context, id, orgID string) error

+ AddTeamMembership func(ctx context.Context, id, teamID string) error

+ CreateUser func(ctx context.Context, user *User) error

+ DeleteUser func(ctx context.Context, spec UserSpec) error

+ GetUser func(ctx context.Context, spec UserSpec) (*User, error)

+ ListUsers func(ctx context.Context, opts UserListOptions) ([]*User, error)

+ RemoveOrganizationMembership func(ctx context.Context, id, orgID string) error

+ RemoveTeamMembership func(ctx context.Context, id, teamID string) error

+ type WatchLogsOptions WatchOptions

+ type WatchOptions struct

+ Name *string

+ OrganizationName *string

+ WorkspaceName *string

type Workspace

+ func NewTestWorkspace(t *testing.T, org *Organization, opts WorkspaceCreateOptions) *Workspace

+ func UnmarshalWorkspaceJSONAPI(w *dto.Workspace) *Workspace

+ func UnmarshalWorkspaceResult(result WorkspaceResult) (*Workspace, error)

+ func (ws *Workspace) CreatedAt() time.Time

+ func (ws *Workspace) ExecutionModes() []string

+ func (ws *Workspace) GetLock() WorkspaceLockState

+ func (ws *Workspace) LatestRunID() *string

+ func (ws *Workspace) Lock(lock WorkspaceLockState) error

+ func (ws *Workspace) OrganizationID() string

+ func (ws *Workspace) OrganizationName() string

+ func (ws *Workspace) QualifiedName() WorkspaceQualifiedName

+ func (ws *Workspace) SpecID() WorkspaceSpec

+ func (ws *Workspace) SpecName() WorkspaceSpec

+ func (ws *Workspace) Unlock(iden Identity, force bool) error

+ func (ws *Workspace) UpdateWithOptions(ctx context.Context, opts WorkspaceUpdateOptions) error

+ func (ws *Workspace) UpdatedAt() time.Time

+ func (ws *Workspace) WorkspaceName() string

type WorkspaceCreateOptions

+ LatestRunID *string

+ OrganizationName string

+ type WorkspaceFactory struct

+ OrganizationService OrganizationService

+ func (f *WorkspaceFactory) NewWorkspace(ctx context.Context, opts WorkspaceCreateOptions) (*Workspace, error)

type WorkspaceList

+ func UnmarshalWorkspaceListJSONAPI(json *dto.WorkspaceList) *WorkspaceList

type WorkspaceListOptions

+ UserID *string

+ type WorkspaceLockService interface

+ LockWorkspace func(ctx context.Context, spec WorkspaceSpec, opts WorkspaceLockOptions) (*Workspace, error)

+ UnlockWorkspace func(ctx context.Context, spec WorkspaceSpec, opts WorkspaceUnlockOptions) (*Workspace, error)

+ type WorkspaceLockState interface

+ CanLock func(subject Identity) error

+ CanUnlock func(subject Identity, force bool) error

+ func LockFromContext(ctx context.Context) (WorkspaceLockState, error)

+ type WorkspacePermission struct

+ Role WorkspaceRole

+ Team *Team

+ func UnmarshalWorkspacePermissionResult(row WorkspacePermissionResult) (*WorkspacePermission, error)

+ type WorkspacePermissionResult struct

+ Organization *pggen.Organizations

+ Role pgtype.Text

+ Team *pggen.Teams

+ type WorkspacePermissionService interface

+ ListWorkspacePermissions func(ctx context.Context, spec WorkspaceSpec) ([]*WorkspacePermission, error)

+ SetWorkspacePermission func(ctx context.Context, spec WorkspaceSpec, team string, role WorkspaceRole) error

+ UnsetWorkspacePermission func(ctx context.Context, spec WorkspaceSpec, team string) error

+ type WorkspacePolicy struct

+ OrganizationName string

+ Permissions []*WorkspacePermission

+ WorkspaceID string

+ type WorkspaceQualifiedName struct

+ Name string

+ Organization string

+ type WorkspaceResult struct

+ AllowDestroyPlan bool

+ AutoApply bool

+ CanQueueDestroyPlan bool

+ CreatedAt pgtype.Timestamptz

+ Description pgtype.Text

+ Environment pgtype.Text

+ ExecutionMode pgtype.Text

+ FileTriggersEnabled bool

+ GlobalRemoteState bool

+ LatestRunID pgtype.Text

+ LockRunID pgtype.Text

+ LockUserID pgtype.Text

+ MigrationEnvironment pgtype.Text

+ Name pgtype.Text

+ Organization *pggen.Organizations

+ OrganizationID pgtype.Text

+ QueueAllRuns bool

+ RunLock *pggen.Runs

+ SourceName pgtype.Text

+ SourceURL pgtype.Text

+ SpeculativeEnabled bool

+ StructuredRunOutputEnabled bool

+ TerraformVersion pgtype.Text

+ TriggerPrefixes []string

+ UpdatedAt pgtype.Timestamptz

+ UserLock *pggen.Users

+ WorkingDirectory pgtype.Text

+ WorkspaceID pgtype.Text

+ type WorkspaceRole struct

+ func WorkspaceRoleFromString(role string) (WorkspaceRole, error)

+ func (r WorkspaceRole) IsAllowed(action Action) bool

+ func (r WorkspaceRole) String() string

type WorkspaceService

+ CreateWorkspace func(ctx context.Context, opts WorkspaceCreateOptions) (*Workspace, error)

+ DeleteWorkspace func(ctx context.Context, spec WorkspaceSpec) error

+ GetWorkspace func(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

+ ListWorkspaces func(ctx context.Context, opts WorkspaceListOptions) (*WorkspaceList, error)

+ UpdateWorkspace func(ctx context.Context, spec WorkspaceSpec, opts WorkspaceUpdateOptions) (*Workspace, error)

+ type WorkspaceSpec struct

+ ID *string

+ Name *string

+ OrganizationName *string

+ func (spec *WorkspaceSpec) String() string

+ func (spec *WorkspaceSpec) Valid() error

+ func (spec WorkspaceSpec) LogFields() (fields []interface{})

type WorkspaceStore

+ CreateWorkspace func(ctx context.Context, ws *Workspace) error

+ DeleteWorkspace func(ctx context.Context, spec WorkspaceSpec) error

+ GetWorkspace func(ctx context.Context, spec WorkspaceSpec) (*Workspace, error)

+ GetWorkspaceID func(ctx context.Context, spec WorkspaceSpec) (string, error)

+ GetWorkspaceIDByCVID func(ctx context.Context, cvID string) (string, error)

+ GetWorkspaceIDByRunID func(ctx context.Context, runID string) (string, error)

+ GetWorkspaceIDByStateVersionID func(ctx context.Context, svID string) (string, error)

+ ListWorkspaces func(ctx context.Context, opts WorkspaceListOptions) (*WorkspaceList, error)

+ ListWorkspacesByUserID func(ctx context.Context, userID string, organization string, opts ListOptions) (*WorkspaceList, error)

+ UpdateWorkspace func(ctx context.Context, spec WorkspaceSpec, ws func(ws *Workspace) error) (*Workspace, error)

+ type WorkspaceUnlockOptions struct

+ Force bool

+ Reason *string

v0.0.11

Nov 7, 2021

Changes in this version

+ var DefaultCacheTTL = 10 * time.Minute

+ func BinaryPlanCacheKey(id string) string

+ func ConfigVersionCacheKey(id string) string

+ func JSONPlanCacheKey(id string) string

+ func LogCacheKey(id string) string

+ func StateVersionCacheKey(id string) string

+ type Cache interface

+ Get func(key string) ([]byte, error)

+ Set func(key string, val []byte) error

+ type RunStreamer struct

+ func NewRunStreamer(run *Run, planLogsStore, applyLogsStore ChunkStore, interval time.Duration) *RunStreamer

+ func (s *RunStreamer) Read(p []byte) (int, error)

+ func (s *RunStreamer) Stream(ctx context.Context)

v0.0.10

Nov 2, 2021

Changes in this version

+ func Stream(ctx context.Context, id string, store ChunkStore, w io.Writer, ...) error

type EventType

+ const EventOrganizationCreated

+ const EventOrganizationDeleted

+ const EventRunCompleted

+ const EventRunCreated

+ const EventWorkspaceCreated

+ const EventWorkspaceDeleted

type RunService

+ GetLogs func(ctx context.Context, runID string) (io.ReadCloser, error)

v0.0.9

Oct 31, 2021

v0.0.8

Oct 31, 2021

Changes in this version

+ var ErrInvalidName = errors.New("invalid value for name")

+ var ErrInvalidOrg = errors.New("invalid value for organization")

+ var ErrInvalidTerraformVersion = errors.New("invalid terraform version")

+ var ErrInvalidWorkspaceID = errors.New("invalid value for workspace ID")

+ var ErrInvalidWorkspaceValue = errors.New("invalid value for workspace")

+ var ErrRequiredName = errors.New("name is required")

+ var ErrResourceNotFound = errors.New("resource not found")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var ErrWorkspaceLocked = errors.New("workspace already locked")

+ var ErrWorkspaceNotLocked = errors.New("workspace already unlocked")

+ func GetMapKeys(m map[string]interface{}) []string

+ func NewID(rtype string) string

+ func PrefixSlice(slice []string, prefix string) (ret []string)

+ func ValidStringID(v *string) bool

type Apply

+ RunID string

+ func (a *Apply) Finish(run *Run) (*Event, error)

+ func (a *Apply) GetID() string

+ func (a *Apply) GetStatus() string

+ func (a *Apply) Start(run *Run) error

+ func (a *Apply) String() string

+ type ApplyStatus string

+ const ApplyCanceled

+ const ApplyCreated

+ const ApplyErrored

+ const ApplyFinished

+ const ApplyPending

+ const ApplyRunning

+ const ApplyUnreachable

+ type CSV []string

+ func (c *CSV) Scan(src interface{}) error

+ func (c CSV) Value() (driver.Value, error)

+ type ChunkStore interface

+ GetChunk func(ctx context.Context, id string, opts GetChunkOptions) ([]byte, error)

+ PutChunk func(ctx context.Context, id string, chunk []byte, opts PutChunkOptions) error

+ type ConfigurationSource string

+ type ConfigurationStatus string

+ const ConfigurationErrored

+ const ConfigurationPending

+ const ConfigurationUploaded

type ConfigurationVersion

+ Config []byte

+ func (cv *ConfigurationVersion) GetID() string

+ func (cv *ConfigurationVersion) String() string

+ type ConfigurationVersionCreateOptions struct

+ AutoQueueRuns *bool

+ Speculative *bool

+ Type string

type ConfigurationVersionGetOptions

+ Config bool

type ConfigurationVersionListOptions

+ Include *string

type Entitlements

+ Agents bool

+ AuditLogging bool

+ CostEstimation bool

+ ID string

+ Operations bool

+ PrivateModuleRegistry bool

+ SSO bool

+ Sentinel bool

+ StateStorage bool

+ Teams bool

+ VCSIntegrations bool

+ type Environment interface

+ GetConfigurationVersionService func() ConfigurationVersionService

+ GetPath func() string

+ GetRunService func() RunService

+ GetStateVersionService func() StateVersionService

+ RunCLI func(name string, args ...string) error

+ RunFunc func(fn EnvironmentFunc) error

+ type EnvironmentFunc func(context.Context, Environment) error

type EventType

+ const EventApplyQueued

+ const EventError

+ const EventPlanQueued

+ const EventRunApplied

+ const EventRunCanceled

+ const EventRunPlanned

+ const EventRunPlannedAndFinished

+ type JobSelector struct

+ ApplyService ApplyService

+ PlanService PlanService

+ func (jsp *JobSelector) GetJob(run *Run) (Job, JobService, error)

+ type ListOptions struct

+ PageNumber int

+ PageSize int

+ func (o *ListOptions) GetLimit() uint64

+ func (o *ListOptions) GetOffset() uint64

type Organization

+ func (org *Organization) GetID() string

+ func (org *Organization) String() string

+ type OrganizationCreateOptions struct

+ Email *string

+ Name *string

+ SessionRemember *int

+ SessionTimeout *int

+ Type string

+ func (o OrganizationCreateOptions) Valid() error

+ type OrganizationListOptions struct

+ type OrganizationPermissions struct

+ CanCreateTeam bool

+ CanCreateWorkspace bool

+ CanCreateWorkspaceMigration bool

+ CanDestroy bool

+ CanTraverse bool

+ CanUpdate bool

+ CanUpdateAPIToken bool

+ CanUpdateOAuth bool

+ CanUpdateSentinel bool

+ type OrganizationUpdateOptions struct

+ Email *string

+ Name *string

+ SessionRemember *int

+ SessionTimeout *int

+ Type string

+ type Pagination struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

+ TotalCount int

+ TotalPages int

type Plan

+ PlanFile []byte

+ PlanJSON []byte

+ RunID string

+ func (p *Plan) CalculateTotals() error

+ func (p *Plan) Finish(run *Run) (*Event, error)

+ func (p *Plan) GetID() string

+ func (p *Plan) GetStatus() string

+ func (p *Plan) Start(run *Run) error

+ func (p *Plan) String() string

+ type PlanFileOptions struct

+ Format string

+ type PlanStatus string

+ const PlanCanceled

+ const PlanCreated

+ const PlanErrored

+ const PlanFinished

+ const PlanMFAWaiting

+ const PlanPending

+ const PlanRunning

+ const PlanUnreachable

type PutChunkOptions

+ Start bool

+ type Resources struct

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ func ParseApplyOutput(output string) (Resources, error)

type Run

+ func (r *Run) String() string

+ type RunApplyOptions struct

+ Comment *string

+ type RunCancelOptions struct

+ Comment *string

+ type RunCreateOptions struct

+ ConfigurationVersion *ConfigurationVersion

+ IsDestroy *bool

+ Message *string

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

+ TargetAddrs []string

+ Type string

+ Workspace *Workspace

+ func (o RunCreateOptions) Valid() error

+ type RunDiscardOptions struct

+ Comment *string

+ type RunForceCancelOptions struct

+ Comment *string

type RunGetOptions

+ IncludePlanFile bool

+ IncludePlanJSON bool

type RunListOptions

+ Include *string

+ type RunPermissions struct

+ CanApply bool

+ CanCancel bool

+ CanDiscard bool

+ CanForceCancel bool

+ CanForceExecute bool

type RunService

+ UploadPlanFile func(ctx context.Context, runID string, plan []byte, opts PlanFileOptions) error

+ type RunStatus string

+ const PlanBinaryFormat

+ const PlanJSONFormat

+ const RunApplyQueued

+ const RunApplying

+ const RunConfirmed

+ const RunDiscarded

+ const RunErrored

+ const RunForceCanceled

+ const RunPending

+ const RunPlanQueued

+ const RunPlanning

+ type RunStatusTimestamp struct

+ Status RunStatus

+ Timestamp time.Time

type StateVersion

+ State []byte

+ func (sv *StateVersion) GetID() string

+ func (sv *StateVersion) String() string

+ type StateVersionCreateOptions struct

+ Force *bool

+ Lineage *string

+ MD5 *string

+ Run *Run

+ Serial *int64

+ State *string

+ Type string

type StateVersionGetOptions

+ State bool

+ type StateVersionListOptions struct

+ Organization *string

+ Workspace *string

type StateVersionOutput

+ func (svo *StateVersionOutput) String() string

+ type TimestampMap map[string]time.Time

+ func (m TimestampMap) Scan(src interface{}) error

+ func (m TimestampMap) Value() (driver.Value, error)

+ type Timestamps struct

+ CreatedAt time.Time

+ UpdatedAt time.Time

+ func NewTimestamps() Timestamps

+ func (m *Timestamps) SetUpdatedAt(t time.Time)

+ type Updateable interface

+ GetID func() string

+ SetUpdatedAt func(time.Time)

+ type VCSRepo struct

+ Branch string

+ DisplayIdentifier string

+ Identifier string

+ IngressSubmodules bool

+ OAuthTokenID string

+ RepositoryHTTPURL string

+ ServiceProvider string

+ type VCSRepoOptions struct

+ Branch *string

+ Identifier *string

+ IngressSubmodules *bool

+ OAuthTokenID *string

type Workspace

+ func (ws *Workspace) GetID() string

+ func (ws *Workspace) String() string

+ type WorkspaceActions struct

+ IsDestroyable bool

+ type WorkspaceCreateOptions struct

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ MigrationEnvironment *string

+ Name *string

+ Operations *bool

+ QueueAllRuns *bool

+ SourceName *string

+ SourceURL *string

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TerraformVersion *string

+ TriggerPrefixes []string

+ Type string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ func (o WorkspaceCreateOptions) Valid() error

+ type WorkspaceLockOptions struct

+ Reason *string

+ type WorkspacePermissions struct

+ CanDestroy bool

+ CanForceUnlock bool

+ CanLock bool

+ CanQueueApply bool

+ CanQueueDestroy bool

+ CanQueueRun bool

+ CanReadSettings bool

+ CanUnlock bool

+ CanUpdate bool

+ CanUpdateVariable bool

type WorkspaceSpecifier

+ func (spec *WorkspaceSpecifier) String() string

+ func (spec *WorkspaceSpecifier) Valid() error

+ type WorkspaceUpdateOptions struct

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ Name *string

+ Operations *bool

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TerraformVersion *string

+ TriggerPrefixes []string

+ Type string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ func (o WorkspaceUpdateOptions) Valid() error

v0.0.7

Sep 19, 2021

Changes in this version

+ const ApplyOutputFilename

+ const ChunkEndMarker

+ const ChunkMaxLimit

+ const ChunkStartMarker

+ const DefaultAllowDestroyPlan

+ const DefaultAutoQueueRuns

+ const DefaultCollaboratorAuthPolicy

+ const DefaultConfigurationSource

+ const DefaultCostEstimationEnabled

+ const DefaultExecutionMode

+ const DefaultFileTriggersEnabled

+ const DefaultPageNumber

+ const DefaultPageSize

+ const DefaultRefresh

+ const DefaultSessionExpiration

+ const DefaultSessionTimeout

+ const DefaultTerraformVersion

+ const DefaultUserID

+ const DefaultUsername

+ const JSONPlanFilename

+ const LocalStateFilename

+ const MaxPageSize

+ const PlanFilename

+ var ActiveRunStatuses = []tfe.RunStatus

+ var Commit = "unknown"

+ var DefaultOrganizationPermissions = tfe.OrganizationPermissions

+ var ErrInvalidConfigurationVersionGetOptions = errors.New("invalid configuration version get options")

+ var ErrInvalidRunGetOptions = errors.New("invalid run get options")

+ var ErrInvalidStateVersionGetOptions = errors.New("invalid state version get options")

+ var ErrInvalidWorkspaceSpecifier = errors.New("invalid workspace specifier options")

+ var ErrRunCancelNotAllowed = errors.New("run was not planning or applying; cancel not allowed")

+ var ErrRunDiscardNotAllowed = errors.New("run was not paused for confirmation or priority; discard not allowed")

+ var ErrRunForceCancelNotAllowed = errors.New(...)

+ var ErrWorkspaceAlreadyLocked = errors.New("workspace already locked")

+ var ErrWorkspaceAlreadyUnlocked = errors.New("workspace already unlocked")

+ var Version = "unknown"

+ func GenerateID(prefix string) string

+ func GenerateRandomString(size int) string

+ func GetChunk(p []byte, opts GetChunkOptions, complete bool) ([]byte, error)

+ func Int(i int) *int

+ func Int64(i int64) *int64

+ func IsNotFound(err error) bool

+ func NewBlobID() string

+ func NewPagination(opts tfe.ListOptions, count int) *tfe.Pagination

+ func SanitizeListOptions(opts *tfe.ListOptions)

+ func String(str string) *string

+ func TimeNow() *time.Time

+ func UInt(i uint) *uint

+ func Unpack(r io.Reader, dst string) error

+ func UpdateOrganization(org *Organization, opts *tfe.OrganizationUpdateOptions) error

+ type Apply struct

+ ID string

+ LogsBlobID string

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Status tfe.ApplyStatus

+ StatusTimestamps *tfe.ApplyStatusTimestamps

+ func (a *Apply) Do(run *Run, exe *Executor) error

+ func (a *Apply) GetLogsBlobID() string

+ func (a *Apply) UpdateResources(bs BlobStore) error

+ func (a *Apply) UpdateStatus(status tfe.ApplyStatus)

+ type ApplyFinishOptions struct

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Type string

+ type ApplyService interface

+ Get func(id string) (*Apply, error)

+ type BlobStore interface

+ Get func(string) ([]byte, error)

+ GetChunk func(string, GetChunkOptions) ([]byte, error)

+ Put func(string, []byte) error

+ PutChunk func(string, []byte, PutChunkOptions) error

+ type Change struct

+ Actions []ChangeAction

+ type ChangeAction string

+ const CreateAction

+ const DeleteAction

+ const UpdateAction

+ type ConfigurationVersion struct

+ AutoQueueRuns bool

+ BlobID string

+ Error string

+ ErrorMessage string

+ ID string

+ Source tfe.ConfigurationSource

+ Speculative bool

+ Status tfe.ConfigurationStatus

+ StatusTimestamps *tfe.CVStatusTimestamps

+ Workspace *Workspace

+ type ConfigurationVersionFactory struct

+ WorkspaceService WorkspaceService

+ func (f *ConfigurationVersionFactory) NewConfigurationVersion(workspaceID string, opts *tfe.ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)

+ type ConfigurationVersionGetOptions struct

+ ID *string

+ WorkspaceID *string

+ type ConfigurationVersionList struct

+ Items []*ConfigurationVersion

+ type ConfigurationVersionListOptions struct

+ Statuses []tfe.ConfigurationStatus

+ WorkspaceID *string

+ type ConfigurationVersionService interface

+ Create func(workspaceID string, opts *tfe.ConfigurationVersionCreateOptions) (*ConfigurationVersion, error)

+ Download func(id string) ([]byte, error)

+ Get func(id string) (*ConfigurationVersion, error)

+ GetLatest func(workspaceID string) (*ConfigurationVersion, error)

+ List func(workspaceID string, opts tfe.ConfigurationVersionListOptions) (*ConfigurationVersionList, error)

+ Upload func(id string, payload []byte) error

+ type ConfigurationVersionStore interface

+ Create func(run *ConfigurationVersion) (*ConfigurationVersion, error)

+ Get func(opts ConfigurationVersionGetOptions) (*ConfigurationVersion, error)

+ List func(workspaceID string, opts ConfigurationVersionListOptions) (*ConfigurationVersionList, error)

+ Update func(id string, fn func(*ConfigurationVersion) error) (*ConfigurationVersion, error)

+ type Entitlements struct

+ func DefaultEntitlements(organizationID string) *Entitlements

+ type ErrInvalidRunStatusTransition struct

+ From tfe.RunStatus

+ To tfe.RunStatus

+ func (e ErrInvalidRunStatusTransition) Error() string

+ type ErrJobAlreadyStarted error

+ type Event struct

+ Payload interface{}

+ Type EventType

+ type EventService interface

+ Publish func(Event)

+ Subscribe func(id string) Subscription

+ type EventType string

+ const ApplyQueued

+ const OrganizationCreated

+ const OrganizationDeleted

+ const PlanQueued

+ const RunApplied

+ const RunCanceled

+ const RunCompleted

+ const RunCreated

+ const RunPlanned

+ const RunPlannedAndFinished

+ const WorkspaceCreated

+ const WorkspaceDeleted

+ type Executor struct

+ ConfigurationVersionService ConfigurationVersionService

+ Path string

+ RunService RunService

+ StateVersionService StateVersionService

+ func NewExecutor(logger logr.Logger, rs RunService, cvs ConfigurationVersionService, ...) (*Executor, error)

+ func (e *Executor) Cancel(force bool)

+ func (e *Executor) Execute(job Job) (err error)

+ func (e *Executor) RunCLI(name string, args ...string) error

+ func (e *Executor) RunFunc(fn ExecutorFunc) error

+ type ExecutorFunc func(context.Context, *Executor) error

+ type GetChunkOptions struct

+ Limit int

+ Offset int

+ type Job interface

+ Do func(*Executor) error

+ GetID func() string

+ GetStatus func() string

+ type JobFinishOptions struct

+ Errored bool

+ type JobLogsUploader interface

+ UploadLogs func(id string, logs []byte, opts PutChunkOptions) error

+ type JobService interface

+ Finish func(id string, opts JobFinishOptions) (Job, error)

+ Start func(id string, opts JobStartOptions) (Job, error)

+ type JobStartOptions struct

+ AgentID string

+ type JobWriter struct

+ ID string

+ func (jw *JobWriter) Close() error

+ func (jw *JobWriter) Write(p []byte) (int, error)

+ type Organization struct

+ CollaboratorAuthPolicy tfe.AuthPolicyType

+ CostEstimationEnabled bool

+ Email string

+ ID string

+ Name string

+ OwnersTeamSAMLRoleID string

+ Permissions *tfe.OrganizationPermissions

+ SAMLEnabled bool

+ SessionRemember int

+ SessionTimeout int

+ TrialExpiresAt time.Time

+ TwoFactorConformant bool

+ func NewOrganization(opts *tfe.OrganizationCreateOptions) (*Organization, error)

+ type OrganizationList struct

+ Items []*Organization

+ type OrganizationService interface

+ Create func(opts *tfe.OrganizationCreateOptions) (*Organization, error)

+ Delete func(name string) error

+ Get func(name string) (*Organization, error)

+ GetEntitlements func(name string) (*Entitlements, error)

+ List func(opts tfe.OrganizationListOptions) (*OrganizationList, error)

+ Update func(name string, opts *tfe.OrganizationUpdateOptions) (*Organization, error)

+ type OrganizationStore interface

+ Create func(org *Organization) (*Organization, error)

+ Delete func(name string) error

+ Get func(name string) (*Organization, error)

+ List func(opts tfe.OrganizationListOptions) (*OrganizationList, error)

+ Update func(name string, fn func(*Organization) error) (*Organization, error)

+ type Phase interface

+ Do func(*Run, *Executor) error

+ GetLogsBlobID func() string

+ type Plan struct

+ ID string

+ LogsBlobID string

+ PlanFileBlobID string

+ PlanJSONBlobID string

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Status tfe.PlanStatus

+ StatusTimestamps *tfe.PlanStatusTimestamps

+ func (p *Plan) Do(run *Run, exe *Executor) error

+ func (p *Plan) GetLogsBlobID() string

+ func (p *Plan) HasChanges() bool

+ func (p *Plan) UpdateResources(bs BlobStore) error

+ func (p *Plan) UpdateStatus(status tfe.PlanStatus)

+ type PlanEnqueuer interface

+ EnqueuePlan func(id string) error

+ type PlanFile struct

+ ResourcesChanges []ResourceChange

+ func (pf *PlanFile) Changes() (adds int, updates int, deletes int)

+ type PlanFinishOptions struct

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Type string

+ type PlanService interface

+ Get func(id string) (*Plan, error)

+ GetPlanJSON func(id string) ([]byte, error)

+ type PutChunkOptions struct

+ End bool

+ type Queue interface

+ Add func(*Run) error

+ Remove func(*Run) error

+ type ResourceChange struct

+ Change Change

+ type Run struct

+ Apply *Apply

+ ConfigurationVersion *ConfigurationVersion

+ ForceCancelAvailableAt time.Time

+ ID string

+ IsDestroy bool

+ Message string

+ Permissions *tfe.RunPermissions

+ Plan *Plan

+ PositionInQueue int

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

+ Status tfe.RunStatus

+ StatusTimestamps *tfe.RunStatusTimestamps

+ TargetAddrs []string

+ Workspace *Workspace

+ func (r *Run) Actions() *tfe.RunActions

+ func (r *Run) ActivePhase() (Phase, error)

+ func (r *Run) Cancel() error

+ func (r *Run) Discard() error

+ func (r *Run) Do(exe *Executor) error

+ func (r *Run) Finish(bs BlobStore) (*Event, error)

+ func (r *Run) ForceCancel() error

+ func (r *Run) GetID() string

+ func (r *Run) GetStatus() string

+ func (r *Run) IsActive() bool

+ func (r *Run) IsCancelable() bool

+ func (r *Run) IsConfirmable() bool

+ func (r *Run) IsDiscardable() bool

+ func (r *Run) IsDone() bool

+ func (r *Run) IsForceCancelable() bool

+ func (r *Run) IsSpeculative() bool

+ func (r *Run) Start() error

+ func (r *Run) UpdateStatus(status tfe.RunStatus)

+ type RunFactory struct

+ ConfigurationVersionService ConfigurationVersionService

+ WorkspaceService WorkspaceService

+ func (f *RunFactory) NewRun(opts *tfe.RunCreateOptions) (*Run, error)

+ type RunGetOptions struct

+ ApplyID *string

+ ID *string

+ PlanID *string

+ type RunList struct

+ Items []*Run

+ type RunListOptions struct

+ Statuses []tfe.RunStatus

+ WorkspaceID *string

+ type RunService interface

+ Apply func(id string, opts *tfe.RunApplyOptions) error

+ Cancel func(id string, opts *tfe.RunCancelOptions) error

+ Create func(opts *tfe.RunCreateOptions) (*Run, error)

+ Discard func(id string, opts *tfe.RunDiscardOptions) error

+ EnqueuePlan func(id string) error

+ ForceCancel func(id string, opts *tfe.RunForceCancelOptions) error

+ Get func(id string) (*Run, error)

+ GetApplyLogs func(id string, opts GetChunkOptions) ([]byte, error)

+ GetPlanFile func(id string) ([]byte, error)

+ GetPlanJSON func(id string) ([]byte, error)

+ GetPlanLogs func(id string, opts GetChunkOptions) ([]byte, error)

+ List func(opts RunListOptions) (*RunList, error)

+ UploadPlan func(runID string, plan []byte, json bool) error

+ type RunStore interface

+ Create func(run *Run) (*Run, error)

+ Get func(opts RunGetOptions) (*Run, error)

+ List func(opts RunListOptions) (*RunList, error)

+ Update func(id string, fn func(*Run) error) (*Run, error)

+ type State struct

+ Lineage string

+ Outputs map[string]StateOutput

+ Serial int64

+ Version int

+ func Parse(data []byte) (*State, error)

+ type StateOutput struct

+ Type string

+ Value string

+ type StateVersion struct

+ BlobID string

+ ID string

+ Outputs []*StateVersionOutput

+ Serial int64

+ StateVersionOutputs []StateVersionOutput

+ VCSCommitSHA string

+ VCSCommitURL string

+ Workspace *Workspace

+ func (r *StateVersion) DownloadURL() string

+ type StateVersionFactory struct

+ BlobStore BlobStore

+ WorkspaceService WorkspaceService

+ func (f *StateVersionFactory) NewStateVersion(workspaceID string, opts tfe.StateVersionCreateOptions) (*StateVersion, error)

+ type StateVersionGetOptions struct

+ ID *string

+ WorkspaceID *string

+ type StateVersionList struct

+ Items []*StateVersion

+ type StateVersionOutput struct

+ ID string

+ Name string

+ Sensitive bool

+ StateVersionID uint

+ Type string

+ Value string

+ type StateVersionOutputList []*StateVersionOutput

+ type StateVersionService interface

+ Create func(workspaceID string, opts tfe.StateVersionCreateOptions) (*StateVersion, error)

+ Current func(workspaceID string) (*StateVersion, error)

+ Download func(id string) ([]byte, error)

+ Get func(id string) (*StateVersion, error)

+ List func(opts tfe.StateVersionListOptions) (*StateVersionList, error)

+ type StateVersionStore interface

+ Create func(sv *StateVersion) (*StateVersion, error)

+ Get func(opts StateVersionGetOptions) (*StateVersion, error)

+ List func(opts tfe.StateVersionListOptions) (*StateVersionList, error)

+ type Subscription interface

+ C func() <-chan Event

+ Close func() error

+ type Workspace struct

+ AllowDestroyPlan bool

+ ApplyDurationAverage time.Duration

+ AutoApply bool

+ CanQueueDestroyPlan bool

+ Description string

+ Environment string

+ ExecutionMode string

+ FileTriggersEnabled bool

+ GlobalRemoteState bool

+ ID string

+ Locked bool

+ MigrationEnvironment string

+ Name string

+ Organization *Organization

+ Permissions *tfe.WorkspacePermissions

+ PlanDurationAverage time.Duration

+ PolicyCheckFailures int

+ QueueAllRuns bool

+ ResourceCount int

+ RunFailures int

+ RunsCount int

+ SourceName string

+ SourceURL string

+ SpeculativeEnabled bool

+ StructuredRunOutputEnabled bool

+ TerraformVersion string

+ TriggerPrefixes []string

+ VCSRepo *tfe.VCSRepo

+ WorkingDirectory string

+ func NewWorkspace(opts *tfe.WorkspaceCreateOptions, org *Organization) *Workspace

+ func UpdateWorkspace(ws *Workspace, opts *tfe.WorkspaceUpdateOptions) (*Workspace, error)

+ func (ws *Workspace) Actions() *tfe.WorkspaceActions

+ func (ws *Workspace) ToggleLock(lock bool) error

+ type WorkspaceList struct

+ Items []*Workspace

+ type WorkspaceListOptions struct

+ Include *string

+ OrganizationName *string

+ Prefix *string

+ type WorkspaceQueue struct

+ Active *Run

+ Pending []*Run

+ func (q *WorkspaceQueue) Add(run *Run) error

+ func (q *WorkspaceQueue) Remove(run *Run) error

+ type WorkspaceService interface

+ Create func(org string, opts *tfe.WorkspaceCreateOptions) (*Workspace, error)

+ Delete func(spec WorkspaceSpecifier) error

+ Get func(spec WorkspaceSpecifier) (*Workspace, error)

+ List func(opts WorkspaceListOptions) (*WorkspaceList, error)

+ Lock func(id string, opts tfe.WorkspaceLockOptions) (*Workspace, error)

+ Unlock func(id string) (*Workspace, error)

+ Update func(spec WorkspaceSpecifier, opts *tfe.WorkspaceUpdateOptions) (*Workspace, error)

+ type WorkspaceSpecifier struct

+ ID *string

+ Name *string

+ OrganizationName *string

+ type WorkspaceStore interface

+ Create func(ws *Workspace) (*Workspace, error)

+ Delete func(spec WorkspaceSpecifier) error

+ Get func(spec WorkspaceSpecifier) (*Workspace, error)

+ List func(opts WorkspaceListOptions) (*WorkspaceList, error)

+ Update func(spec WorkspaceSpecifier, fn func(*Workspace) error) (*Workspace, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL