run

type Change struct {
	Actions []ChangeAction
}

type ChangeAction string

type Client struct {
	otf.JSONAPIClient
	http.Config
}

type ConfigurationVersionService configversion.Service

type JSONAPIMarshaler struct {
	workspace.Service // for retrieving workspace and workspace permissions
	// contains filtered or unexported fields
}

type Options struct {
	WorkspaceAuthorizer otf.Authorizer

	WorkspaceService
	ConfigurationVersionService
	VCSProviderService

	logr.Logger
	otf.Cache
	otf.DB
	otf.Renderer
	otf.Broker
	otf.Signer
}

type Phase struct {
	RunID string

	otf.PhaseType
	*ResourceReport // report of planned or applied resource changes

	Status           PhaseStatus // current phase status
	StatusTimestamps []PhaseStatusTimestamp
}

type PhaseFinishOptions struct {
	// Errored is true if the phase finished unsuccessfully.
	Errored bool `jsonapi:"attr,errored,omitempty"`
}

type PhaseStartOptions struct {
	AgentID string `jsonapi:"attr,agent-id,omitempty"`
}

type PhaseStatus string

type PhaseStatusTimestamp struct {
	Status    PhaseStatus
	Timestamp time.Time
}

type PlanFile struct {
	ResourceChanges []ResourceChange `json:"resource_changes"`
}

type PlanFormat string

type ReporterOptions struct {
	ConfigurationVersionService configversion.Service
	WorkspaceService            workspace.Service
	VCSProviderService          VCSProviderService

	logr.Logger
	otf.DB
	otf.Subscriber
	otf.HostnameService
}

type ResourceChange struct {
	Change Change
}

type ResourceReport struct {
	Additions    int
	Changes      int
	Destructions int
}

type Run struct {
	ID                     string
	CreatedAt              time.Time
	IsDestroy              bool
	ForceCancelAvailableAt *time.Time
	Message                string
	Organization           string
	Refresh                bool
	RefreshOnly            bool
	ReplaceAddrs           []string
	PositionInQueue        int
	TargetAddrs            []string
	AutoApply              bool
	Speculative            bool
	Status                 otf.RunStatus
	StatusTimestamps       []RunStatusTimestamp
	WorkspaceID            string
	ConfigurationVersionID string
	ExecutionMode          workspace.ExecutionMode
	Plan                   Phase
	Apply                  Phase

	Latest bool    // is latest run for workspace
	Commit *string // commit sha that triggered this run
}

type RunCreateOptions struct {
	IsDestroy              *bool
	Refresh                *bool
	RefreshOnly            *bool
	Message                *string
	ConfigurationVersionID *string
	TargetAddrs            []string
	ReplaceAddrs           []string
	AutoApply              *bool
}

type RunList struct {
	*otf.Pagination
	Items []*Run
}

type RunListOptions struct {
	otf.ListOptions
	// Filter by run statuses (with an implicit OR condition)
	Statuses []otf.RunStatus `schema:"statuses,omitempty"`
	// Filter by workspace ID
	WorkspaceID *string `schema:"workspace_id,omitempty"`
	// Filter by organization name
	Organization *string `schema:"organization_name,omitempty"`
	// Filter by workspace name
	WorkspaceName *string `schema:"workspace_name,omitempty"`
	// Filter by speculative or non-speculative
	Speculative *bool `schema:"-"`
	// A list of relations to include. See available resources:
	// https://www.terraform.io/docs/cloud/api/run.html#available-related-resources
	Include *string `schema:"include,omitempty"`
}

type RunService = Service

type RunStatusTimestamp struct {
	Status    otf.RunStatus
	Timestamp time.Time
}

type Service interface {
	CreateRun(ctx context.Context, workspaceID string, opts RunCreateOptions) (*Run, error)
	GetRun(ctx context.Context, id string) (*Run, error)
	ListRuns(ctx context.Context, opts RunListOptions) (*RunList, error)
	EnqueuePlan(ctx context.Context, runID string) (*Run, error)
	// StartPhase starts a run phase.
	StartPhase(ctx context.Context, runID string, phase otf.PhaseType, _ PhaseStartOptions) (*Run, error)
	// FinishPhase finishes a phase. Creates a report of changes before updating the status of
	// the run.
	FinishPhase(ctx context.Context, runID string, phase otf.PhaseType, opts PhaseFinishOptions) (*Run, error)
	// GetPlanFile returns the plan file for the run.
	GetPlanFile(ctx context.Context, runID string, format PlanFormat) ([]byte, error)
	// UploadPlanFile persists a run's plan file. The plan format should be either
	// be binary or json.
	UploadPlanFile(ctx context.Context, runID string, plan []byte, format PlanFormat) error
	// Watch provides access to a stream of run events. The WatchOptions filters
	// events. Context must be cancelled to close stream.
	//
	// TODO(@leg100): it would be clearer to the caller if the stream is closed by
	// returning a stream object with a Close() method. The calling code would
	// call Watch(), and then defer a Close(), which is more readable IMO.
	Watch(ctx context.Context, opts WatchOptions) (<-chan otf.Event, error)
	// Cancel a run. If a run is in progress then a cancelation signal will be
	// sent out.
	Cancel(ctx context.Context, runID string) (*Run, error)
	// Apply enqueues an Apply for the run.
	Apply(ctx context.Context, runID string) error
	// Delete a run.
	Delete(ctx context.Context, runID string) error

	otf.Authorizer // run authorizer
	// contains filtered or unexported methods
}

type SpawnerOptions struct {
	logr.Logger

	otf.Subscriber

	ConfigurationVersionService
	WorkspaceService
	VCSProviderService
	RunService
}

type VCSProviderService vcsprovider.Service

type WatchOptions struct {
	Organization *string `schema:"organization_name,omitempty"` // filter by organization name
	WorkspaceID  *string `schema:"workspace_id,omitempty"`      // filter by workspace ID; mutually exclusive with organization filter
}

type WorkspaceService workspace.Service