run

type Change struct {
	Actions []ChangeAction
}

type ChangeAction string

type Client struct {
	internal.JSONAPIClient
	http.Config
}

type ConfigurationVersionService configversion.Service

type Operation string

type Options struct {
	WorkspaceAuthorizer internal.Authorizer

	WorkspaceService
	ConfigurationVersionService
	VCSProviderService

	logr.Logger
	internal.Cache
	*sql.DB
	html.Renderer
	*pubsub.Broker
	repo.Subscriber
}

type Phase struct {
	RunID              string `json:"run_id"`
	internal.PhaseType `json:"phase"`
	Status             PhaseStatus            `json:"status"`
	StatusTimestamps   []PhaseStatusTimestamp `json:"status_timestamps"`

	// report of planned or applied resource changes
	ResourceReport *Report `json:"resource_report"`
	// report of planned or applied output changes
	OutputReport *Report `json:"output_report"`
}

type PhaseFinishOptions struct {
	Type string `jsonapi:"primary,phase"`
	// Errored is true if the phase finished unsuccessfully.
	Errored bool `jsonapi:"attribute" json:"errored,omitempty"`
}

type PhaseStartOptions struct {
	Type    string `jsonapi:"primary,phase"`
	AgentID string `jsonapi:"attribute" json:"agent-id,omitempty"`
}

type PhaseStatus string

type PhaseStatusTimestamp struct {
	Status    PhaseStatus `json:"status"`
	Timestamp time.Time   `json:"timestamp"`
}

type PlanFile struct {
	ResourceChanges []ResourceChange  `json:"resource_changes"`
	OutputChanges   map[string]Change `json:"output_changes"`
}

type PlanFileOptions struct {
	Format PlanFormat `schema:"format,required"`
}

type PlanFormat string

type Report struct {
	Additions    int `json:"additions"`
	Changes      int `json:"changes"`
	Destructions int `json:"destructions"`
}

type Reporter struct {
	logr.Logger
	pubsub.Subscriber
	VCSProviderService
	ConfigurationVersionService
	WorkspaceService
	internal.HostnameService
}

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

	logr.Logger
}

type ResourceChange struct {
	Change Change
}

type Run struct {
	ID                     string                  `json:"id"`
	CreatedAt              time.Time               `json:"created_at"`
	IsDestroy              bool                    `json:"is_destroy"`
	ForceCancelAvailableAt *time.Time              `json:"force_cancel_available_at"`
	Message                string                  `json:"message"`
	Organization           string                  `json:"organization"`
	Refresh                bool                    `json:"refresh"`
	RefreshOnly            bool                    `json:"refresh_only"`
	ReplaceAddrs           []string                `json:"replace_addrs"`
	PositionInQueue        int                     `json:"position_in_queue"`
	TargetAddrs            []string                `json:"target_addrs"`
	AutoApply              bool                    `json:"auto_apply"`
	PlanOnly               bool                    `json:"plan_only"`
	Status                 internal.RunStatus      `json:"status"`
	StatusTimestamps       []RunStatusTimestamp    `json:"status_timestamps"`
	WorkspaceID            string                  `json:"workspace_id"`
	ConfigurationVersionID string                  `json:"configuration_version_id"`
	ExecutionMode          workspace.ExecutionMode `json:"execution_mode"`
	Plan                   Phase                   `json:"plan"`
	Apply                  Phase                   `json:"apply"`

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

type RunCreateOptions struct {
	IsDestroy   *bool
	Refresh     *bool
	RefreshOnly *bool
	Message     *string
	// Specifies the configuration version to use for this run. If the
	// configuration version object is omitted, the run will be created using the
	// workspace's latest configuration version.
	//
	// Alternatively, if PullVCSMagicString is specified, and the workspace
	// is connected to a vcs repo, then a configuration version is
	// automatically created from the vcs repo and the run uses that
	// configuration version. If the workspace is not connected to a
	// workspace then an error is returned.
	ConfigurationVersionID *string
	TargetAddrs            []string
	ReplaceAddrs           []string
	AutoApply              *bool
	// PlanOnly specifies if this is a speculative, plan-only run that
	// Terraform cannot apply. Takes precedence over whether the
	// configuration version is marked as speculative or not.
	PlanOnly *bool
}

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

type RunListOptions struct {
	resource.PageOptions
	// Filter by run statuses (with an implicit OR condition)
	Statuses []internal.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 plan-only runs
	PlanOnly *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    internal.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) (*resource.Page[*Run], error)
	EnqueuePlan(ctx context.Context, runID string) (*Run, error)
	// StartPhase starts a run phase.
	StartPhase(ctx context.Context, runID string, phase internal.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 internal.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 pubsub.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

	// RetryRun retries a run, creating a new run with the same config
	// version.
	RetryRun(ctx context.Context, id string) (*Run, error)

	// DiscardRun discards a run. Run must be in the planned state.
	DiscardRun(ctx context.Context, runID string) error
	// ForceCancelRun forcefully cancels a run.
	ForceCancelRun(ctx context.Context, runID string) error

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

type Spawner struct {
	logr.Logger

	ConfigurationVersionService
	WorkspaceService
	VCSProviderService
	RunService
	repo.Subscriber
}

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