vcs

type Commit interface {
	GetSHA() string
}

type CommitJobStatus interface {
	GetName() string
	GetStatus() string
	GetPipelineID() int
	GetAllowFailure() bool
}

type CommitState string

type CommitStatus interface {
	Info() string
}

type CommitStatusOptions interface {
	GetName() string
	GetContext() string
	GetTargetURL() string
	GetDescription() string
	GetState() string
	GetPipelineID() int
}

type DetailedMR interface {
	HasConflicts() bool
	// IsDraft reports whether the merge request is a Draft, which GitLab and
	// GitHub both refuse to merge.
	IsDraft() bool
	MR
	GetWebURL() string
	GetTitle() string
	GetState() string
}

type GitClient interface {
	SupportsAggregateAutoMerge() bool
	GetAuthenticatedAccountName(ctx context.Context) (string, error)
	GetMergeRequestApprovals(ctx context.Context, id int, project string) (MRApproved, error)
	CreateMergeRequestComment(ctx context.Context, id int, fullPath string, comment string) error
	CreateMergeRequestCommentWithID(ctx context.Context, id int, fullPath string, comment string) (int64, error)
	UpdateMergeRequestComment(ctx context.Context, id int, noteID int64, fullPath string, comment string) error
	CreateMergeRequestDiscussion(ctx context.Context, mrID int, fullPath string, comment string) (MRDiscussionNotes, error)
	GetMergeRequest(context.Context, int, string) (DetailedMR, error)
	GetRepoFile(context.Context, string, string, string) ([]byte, error)
	// ListRepoDirectories returns every directory below dir at ref, recursively,
	// as paths relative to the repo root. A dir that does not exist at ref yields
	// no paths rather than an error.
	ListRepoDirectories(ctx context.Context, project, dir, ref string) ([]string, error)
	GetMergeRequestModifiedFiles(ctx context.Context, mrIID int, projectID string) ([]string, error)
	CloneMergeRequest(context.Context, string, MR, string) (GitRepo, error)
	UpdateMergeRequestDiscussionNote(ctx context.Context, mrIID, noteID int, project, discussionID, comment string) (MRNote, error)
	ResolveMergeRequestDiscussion(context.Context, string, int, string) error
	ResolveMergeRequestDiscussions(ctx context.Context, project string, mrIID int, workspace, action string) error
	AddMergeRequestDiscussionReply(ctx context.Context, mrIID int, project, discussionID, comment string) (MRNote, error)
	SetCommitStatus(ctx context.Context, projectWithNS string, commitSHA string, status CommitStatusOptions) (CommitStatus, error)
	SetWorkspaceStatus(ctx context.Context, status WorkspaceStatus) error
	GetPipelinesForCommit(ctx context.Context, projectWithNS string, commitSHA string) ([]ProjectPipeline, error)
	GetCommitJobStatuses(ctx context.Context, projectWithNS string, commitSHA string) ([]CommitJobStatus, error)
	GetProjectSettings(ctx context.Context, projectWithNS string) (ProjectSettings, error)
	GetOldRunUrls(ctx context.Context, mrIID int, project string, rootCommentID int, workspace string, action string) (string, error)
	MergeMR(ctx context.Context, mrIID int, project string) error
	MergeMRAtSHA(ctx context.Context, mrIID int, project, expectedSHA string) error
}

type GitRepo interface {
	FetchUpstreamBranch(string) error
	GetMergeBase(oldest, newest string) (string, error)
	GetModifiedFileNamesBetweenCommits(oldest, newest string) ([]string, error)
	GetLocalDirectory() string
}

type MR interface {
	MRBranches
	GetAuthor() MRAuthor
	GetInternalID() int
}

type MRApproved interface {
	IsApproved() bool
}

type MRAttributes interface {
	GetNote() string
	GetType() string
	MRDiscussion
}

type MRAuthor interface {
	GetUsername() string
}

type MRBranches interface {
	GetSourceBranch() string
	GetTargetBranch() string
}

type MRCommentEvent interface {
	GetProject() Project
	GetMR() MR
	GetAttributes() MRAttributes
	GetLastCommit() Commit
}

type MRDiscussion interface {
	GetDiscussionID() string
}

type MRDiscussionNotes interface {
	GetMRNotes() []MRNote
	MRDiscussion
}

type MRNote interface {
	GetNoteID() int64
}

type Project interface {
	GetPathWithNamespace() string
}

type ProjectPipeline interface {
	GetSource() string
	GetID() int
	GetStatus() string
	// GetWebURL returns the pipeline's browser URL, which may be empty.
	GetWebURL() string
}

type ProjectSettings interface {
	OnlyAllowMergeIfPipelineSucceeds() bool
}

type WorkspaceStatus struct {
	Project         string // path with namespace
	CommitSHA       string
	MergeRequestIID int
	Workspace       string
	Action          string // "plan" or "apply"
	State           CommitState
	Description     string // optional; falls back to a per-state default
	TargetURL       string // optional; the TFC run URL once one exists
}