cloud

type Client interface {
	GetUser(ctx context.Context) (*User, error)
	// ListRepositories lists repositories accessible to the current user.
	ListRepositories(ctx context.Context, opts ListRepositoriesOptions) ([]Repo, error)
	GetRepository(ctx context.Context, identifier string) (Repo, error)
	// GetRepoTarball retrieves a .tar.gz tarball of a git repository
	GetRepoTarball(ctx context.Context, opts GetRepoTarballOptions) ([]byte, error)
	// CreateWebhook creates a webhook on the cloud provider, returning the
	// provider's unique ID for the webhook.
	CreateWebhook(ctx context.Context, opts CreateWebhookOptions) (string, error)
	UpdateWebhook(ctx context.Context, opts UpdateWebhookOptions) error
	GetWebhook(ctx context.Context, opts GetWebhookOptions) (Webhook, error)
	DeleteWebhook(ctx context.Context, opts DeleteWebhookOptions) error
	SetStatus(ctx context.Context, opts SetStatusOptions) error
	// ListTags lists git tags on a repository. Each tag should be prefixed with
	// 'tags/'.
	ListTags(ctx context.Context, opts ListTagsOptions) ([]string, error)
}

type ClientOptions struct {
	Hostname            string
	SkipTLSVerification bool

	Credentials
}

type Cloud interface {
	NewClient(context.Context, ClientOptions) (Client, error)
	EventHandler
}

type CloudOAuthConfig struct {
	Config
	OAuthConfig *oauth2.Config
}

type Config struct {
	Name                string
	Hostname            string
	SkipTLSVerification bool

	Cloud
}

type CreateWebhookOptions struct {
	Identifier string // repo identifier, <owner>/<repo>
	Secret     string // secret string for generating signature
	Endpoint   string // otf's external-facing host[:port]
	Events     []VCSEventType
}

type Credentials struct {
	// tokens are mutually-exclusive - at least one must be specified
	OAuthToken    *oauth2.Token
	PersonalToken *string
}

type DeleteWebhookOptions struct {
	Identifier string // Repository identifier, <owner>/<repo>
	ID         string // vcs' webhook ID
}

type EventHandler interface {
	// HandleEvent extracts a cloud-specific event from the http request, converting it into a
	// VCS event. Returns nil if the event is to be ignored.
	HandleEvent(w http.ResponseWriter, r *http.Request, opts HandleEventOptions) VCSEvent
}

type GetRepoTarballOptions struct {
	Identifier string // repo identifier, <owner>/<repo>
	Ref        string // branch/tag/SHA ref
}

type GetWebhookOptions struct {
	Identifier string // Repository identifier, <owner>/<repo>
	ID         string // vcs' webhook ID
}

type HandleEventOptions struct {
	Secret    string
	WebhookID uuid.UUID
}

type ListRepositoriesOptions struct {
	PageSize int
}

type ListTagsOptions struct {
	Identifier string // repo identifier, <owner>/<repo>
	Prefix     string // only list tags that start with this string
}

type OAuthConfigs []*CloudOAuthConfig

type Repo struct {
	Identifier string `schema:"identifier,required"` // <repo_owner>/<repo_name>
	Branch     string `schema:"branch,required"`     // default branch
}

type Service interface {
	GetCloudConfig(name string) (Config, error)
	ListCloudConfigs() []Config
}

type SetStatusOptions struct {
	Workspace   string
	Identifier  string // <owner>/<repo>
	Ref         string // git ref
	Status      VCSStatus
	TargetURL   string
	Description string
}

type Team struct {
	Name         string
	Organization string // team belongs to an organization
}

type UpdateWebhookOptions struct {
	ID string // vcs' webhook ID

	CreateWebhookOptions
}

type User struct {
	Name string

	Organizations []string // org memberships
	Teams         []Team   // team memberships
}

type VCSEvent any

type VCSEventType int

type VCSPullEvent struct {
	WebhookID  uuid.UUID
	Action     VCSPullEventAction
	Identifier string // repo identifier, <owner>/<repo>
	CommitSHA  string
	Branch     string // head branch
}

type VCSPullEventAction string

type VCSPushEvent struct {
	WebhookID  uuid.UUID
	Identifier string // repo identifier, <owner>/<repo>
	CommitSHA  string
	Branch     string
}

type VCSStatus string

type VCSTagEvent struct {
	WebhookID  uuid.UUID
	Identifier string // repo identifier, <owner>/<repo>
	CommitSHA  string
	Tag        string
	Action     VCSTagEventAction
}

type VCSTagEventAction string

type Webhook struct {
	ID         string // vcs' ID
	Identifier string // identifier is <repo_owner>/<repo_name>
	Events     []VCSEventType
	Endpoint   string // the OTF URL that receives events
}