runstream

type AutoMergeRef struct {
	// VcsProvider, Project, MergeRequest, and CommitSHA locate aggregate state.
	VcsProvider  string
	Project      string
	MergeRequest int
	CommitSHA    string
	// Organization and Workspace select one workspace within the aggregate.
	Organization string
	Workspace    string
	// RunID identifies the TFC apply reporting an event.
	RunID string
	// Generation identifies the apply command that dispatched RunID.
	Generation string
	// Sequence rejects events from an older apply command.
	Sequence int64
}

type AutoMergeResult string

type AutoMergeState struct {
	// VcsProvider and Project identify the repository containing the change.
	VcsProvider string `json:"vcs_provider"`
	Project     string `json:"project"`
	// MergeRequest and CommitSHA pin this state to one immutable change revision.
	MergeRequest int    `json:"merge_request"`
	CommitSHA    string `json:"commit_sha"`
	// Eligible is true only when every affected workspace opted into auto-merge.
	Eligible bool `json:"eligible"`
	// Workspaces tracks the current apply state of every affected workspace.
	Workspaces map[string]*AutoMergeWorkspaceState `json:"workspaces"`
	// MergeClaimed atomically grants one worker permission to request the merge.
	MergeClaimed bool `json:"merge_claimed"`
	// MergeRequested records that the VCS accepted TFBuddy's merge request.
	MergeRequested bool `json:"merge_requested"`
	// Finalized prevents duplicate terminal VCS webhooks from recording a result twice.
	Finalized bool `json:"finalized"`
}

type AutoMergeWorkspaceState struct {
	// Generation identifies the apply command that dispatched this workspace run.
	Generation string `json:"generation,omitempty"`
	// Sequence orders apply commands so older deliveries cannot replace newer state.
	Sequence int64 `json:"sequence,omitempty"`
	// RunID identifies the current non-targeted TFC apply for this generation.
	RunID string `json:"run_id,omitempty"`
	// Applied records whether RunID completed successfully.
	Applied bool `json:"applied"`
}

type RunEvent interface {
	GetRunID() string
	GetContext() context.Context
	SetContext(context.Context)
	SetCarrier(map[string]string)
	GetNewStatus() string
	GetMetadata() RunMetadata
	SetMetadata(RunMetadata)
}

type RunMetadata interface {
	GetAction() string
	GetMRInternalID() int
	GetRootNoteID() int64
	GetMRProjectNameWithNamespace() string
	GetDiscussionID() string
	GetRunID() string
	GetWorkspace() string
	GetCommitSHA() string
	GetOrganization() string
	GetVcsProvider() string
	GetAutoMerge() bool
	GetAutoMergeGeneration() string
	GetAutoMergeSequence() int64
}

type RunPollingTask interface {
	Schedule(ctx context.Context) error
	Reschedule(ctx context.Context) error
	Completed() error
	GetRunID() string
	GetContext() context.Context
	SetCarrier(map[string]string)
	GetLastStatus() string
	SetLastStatus(string)
	GetRunMetaData() RunMetadata
}

type Stream struct {
	// contains filtered or unexported fields
}

type StreamClient interface {
	HealthCheck() error
	PublishTFRunEvent(ctx context.Context, re RunEvent) error
	AddRunMeta(rmd RunMetadata) error
	GetRunMeta(runID string) (RunMetadata, error)
	EnsureAutoMergeState(state *AutoMergeState) error
	BeginAutoMergeApply(ref AutoMergeRef, workspaces []string) error
	RegisterAutoMergeRun(ref AutoMergeRef) error
	RecordAutoMergeSuccess(ref AutoMergeRef) (bool, error)
	ReleaseAutoMergeClaim(ref AutoMergeRef) error
	RecordAutoMergeRequested(ref AutoMergeRef) error
	FinalizeAutoMerge(ref AutoMergeRef, merged bool) (AutoMergeResult, bool, error)
	NewTFRunPollingTask(meta RunMetadata, delay time.Duration) RunPollingTask
	SubscribeTFRunPollingTasks(cb func(task RunPollingTask) bool) (closer func(), err error)
	SubscribeTFRunEvents(queue string, cb func(run RunEvent) bool) (closer func(), err error)
}

type TFRunEvent struct {
	RunID        string
	Organization string
	Workspace    string
	NewStatus    string
	Metadata     RunMetadata
	Carrier      propagation.MapCarrier `json:"Carrier"`
	// contains filtered or unexported fields
}

type TFRunMetadata struct {
	// RunID is the ID generated by TFC for the run
	RunID string
	// Organization is the TFC organization name
	Organization string
	// Workspace is the TFC workspace name
	Workspace string

	// Source is the trigger source of the TFC run
	// options include:
	// "merge_request" - for runs started via MR push or comment
	// "merge" - for runs started when MR is merged (apply after merge repos) (NOT IMPLEMENTED)
	// "slack" - for runs started via ChatOps (NOT IMPLEMENTED)
	Source string

	// Action is the triggered action (i.e. plan / apply)
	Action string

	// The git Commit SHA for which the run has been triggered
	CommitSHA string

	// MergeRequestProjectNameWithNamespace is the fully qualified Gitlab project name (e.g. /group/subgroup/project)
	MergeRequestProjectNameWithNamespace string

	// MergeRequestIID is the Gitlab Merge Request IID for which the Run has been triggered
	MergeRequestIID int

	// DiscussionID is the MergeRequest discussion thread where status updates should be written (optional)
	DiscussionID string
	// RootNoteID is the top level note of the discussion thread. It will be updated with progress info.
	RootNoteID int64

	VcsProvider string

	AutoMerge           bool
	AutoMergeGeneration string
	AutoMergeSequence   int64
}

type TFRunPollingTask struct {
	RunMetadata

	LastStatus string
	NextPoll   time.Time
	Processing bool
	LastUpdate time.Time

	// Revision is the NATS KV entry revision
	Revision uint64

	Carrier propagation.MapCarrier `json:"Carrier"`
	// contains filtered or unexported fields
}