scm

type Service interface {

	// Driver defines a function that outputs
	// the configured scm driver.
	Driver() string

	// Authorize defines a function that uses the
	// given access token to authorize the user.
	Authorize(context.Context, string) (string, error)
	// Authenticate defines a function that completes
	// the OAuth workflow for the session.
	Authenticate(context.Context, http.ResponseWriter, *http.Request, string) (*api.User, error)

	// AuthenticateToken defines a function that completes
	// the OAuth workflow for the session using PAT Token
	AuthenticateToken(context.Context, *http.Request) (*api.User, error)

	// ValidateOAuthToken defines a function that validates
	// an OAuth access token was created by Vela
	ValidateOAuthToken(context.Context, string) (bool, error)

	// Login defines a function that begins
	// the OAuth workflow for the session.
	Login(context.Context, http.ResponseWriter, *http.Request) (string, error)

	// GetUserID defines a function that captures
	// the scm user id attached to the username.
	GetUserID(context.Context, string, string) (string, error)

	// OrgAccess defines a function that captures
	// the user's access level for an org.
	OrgAccess(context.Context, *api.User, string) (string, error)
	// RepoAccess defines a function that captures
	// the user's access level for a repo.
	RepoAccess(context.Context, string, string, string, string) (string, error)
	// TeamAccess defines a function that captures
	// the user's access level for a team.
	TeamAccess(context.Context, *api.User, string, string) (string, error)
	// RepoContributor defines a function that captures
	// whether the user is a contributor for a repo.
	RepoContributor(context.Context, *api.User, string, string, string) (bool, error)

	// ListUsersTeamsForOrg defines a function that captures
	// the user's teams for an org
	ListUsersTeamsForOrg(context.Context, *api.User, string) ([]string, error)

	// Changeset defines a function that captures the list
	// of files changed for a commit.
	//
	// https://en.wikipedia.org/wiki/Changeset.
	Changeset(context.Context, *api.Repo, string) ([]string, error)
	// ChangesetPR defines a function that captures the list
	// of files changed for a pull request.
	//
	// https://en.wikipedia.org/wiki/Changeset.
	ChangesetPR(context.Context, *api.Repo, int) ([]string, error)

	// GetDeployment defines a function that
	// gets a deployment by number and repo.
	GetDeployment(context.Context, *api.User, *api.Repo, int64) (*api.Deployment, error)
	// GetDeploymentCount defines a function that
	// counts a list of all deployment for a repo.
	GetDeploymentCount(context.Context, *api.User, *api.Repo) (int64, error)
	// GetDeploymentList defines a function that gets
	// a list of all deployments for a repo.
	GetDeploymentList(context.Context, *api.User, *api.Repo, int, int) ([]*api.Deployment, error)
	// CreateDeployment defines a function that
	// creates a new deployment.
	CreateDeployment(context.Context, *api.User, *api.Repo, *api.Deployment) error

	// Config defines a function that captures
	// the pipeline configuration from a repo.
	Config(context.Context, *api.User, *api.Repo, string) ([]byte, error)
	// ConfigBackoff is a truncated constant backoff wrapper for Config.
	// Retry again in five seconds if Config fails to retrieve yaml/yml file.
	// Will return an error after five failed attempts.
	ConfigBackoff(context.Context, *api.User, *api.Repo, string) ([]byte, error)
	// Disable defines a function that deactivates
	// a repo by destroying the webhook.
	Disable(context.Context, *api.User, string, string) error
	// Enable defines a function that activates
	// a repo by creating the webhook.
	Enable(context.Context, *api.User, *api.Repo, *api.Hook) (*api.Hook, string, error)
	// Update defines a function that updates
	// a webhook for a specified repo.
	Update(context.Context, *api.User, *api.Repo, int64) (bool, error)
	// Status defines a function that sends the
	// commit status for the given SHA from a repo.
	Status(context.Context, *api.Build, string, string, string) error
	// StepStatus defines a function that sends the
	// commit status for the given SHA for a specified step context.
	StepStatus(context.Context, *api.Build, *api.Step, string, string, string) error
	// ListUserRepos defines a function that retrieves
	// all repos with admin rights for the user.
	ListUserRepos(context.Context, *api.User) ([]string, error)
	// GetBranch defines a function that retrieves
	// a branch for a repo.
	GetBranch(context.Context, *api.Repo, string) (string, string, error)
	// GetPullRequest defines a function that retrieves
	// a pull request for a repo.
	GetPullRequest(context.Context, *api.Repo, int) (string, string, string, string, error)
	// GetRepo defines a function that retrieves
	// details for a repo.
	GetRepo(context.Context, *api.User, *api.Repo) (*api.Repo, int, error)
	// GetOrgAndRepoName defines a function that retrieves
	// the name of the org and repo in the SCM.
	GetOrgAndRepoName(context.Context, *api.User, string, string) (string, string, error)
	// GetOrg defines a function that retrieves
	// the name for an org in the SCM.
	GetOrgName(context.Context, *api.User, string) (string, error)
	// GetHTMLURL defines a function that retrieves
	// a repository file's html_url.
	GetHTMLURL(context.Context, *api.User, string, string, string, string) (string, error)
	// GetNetrcPassword defines a function that returns the netrc
	// password injected into build steps.
	GetNetrcPassword(context.Context, database.Interface, *api.Repo, *api.User, yaml.Git) (string, error)
	// SyncRepoWithInstallation defines a function that syncs
	// a repo with the installation, if it exists.
	SyncRepoWithInstallation(context.Context, *api.Repo) (*api.Repo, error)

	// ProcessWebhook defines a function that
	// parses the webhook from a repo.
	ProcessWebhook(context.Context, *http.Request) (*internal.Webhook, error)
	// VerifyWebhook defines a function that
	// verifies the webhook from a repo.
	VerifyWebhook(context.Context, *http.Request, []byte) error
	// RedeliverWebhook defines a function that
	// redelivers the webhook from the SCM.
	RedeliverWebhook(context.Context, *api.User, *api.Hook) error

	// ProcessInstallation defines a function that
	// processes an installation event.
	ProcessInstallation(context.Context, *http.Request, *internal.Webhook, database.Interface) error
	// FinishInstallation defines a function that
	// finishes an installation event and returns a web redirect.
	FinishInstallation(context.Context, *http.Request, int64) (string, error)

	// GetSettings defines a function that returns
	// scm settings.
	GetSettings() settings.SCM

	// SetSettings defines a function that takes api settings
	// and updates the compiler Engine.
	SetSettings(*settings.Platform)
}

type Setter interface {
	Set(string, interface{})
}

type Setup struct {

	// specifies the driver to use for the scm client
	Driver string
	// specifies the address to use for the scm client
	Address string
	// specifies the OAuth client ID from the scm system to use for the scm client
	ClientID string
	// specifies the OAuth client secret from the scm system to use for the scm client
	ClientSecret string
	// specifies App integration id
	AppID int64
	// specifies App integration private key
	AppPrivateKey string
	// specifies App integration path to private key
	AppPrivateKeyPath string
	// specifies App integration permissions set
	AppPermissions []string
	// specifies the Vela server address to use for the scm client
	ServerAddress string
	// specifies the Vela server address that the scm provider should use to send Vela webhooks
	ServerWebhookAddress string
	// specifies the context for the commit status to use for the scm client
	StatusContext string
	// specifies the Vela web UI address to use for the scm client
	WebUIAddress string
	// specifies the OAuth scopes to use for the scm client
	OAuthScopes []string
	// specifies the repo role map to use for the scm client
	RepoRoleMap map[string]string
	// specifies the org role map to use for the scm client
	OrgRoleMap map[string]string
	// specifies the team role map to use for the scm client
	TeamRoleMap map[string]string
	// specifies OTel tracing configurations
	Tracing *tracing.Client
}