vcs

type Action string

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

type Callback func(event Event)

type Client interface {
	// ListRepositories lists repositories accessible to the current user.
	ListRepositories(ctx context.Context, opts ListRepositoriesOptions) ([]string, error)
	GetRepository(ctx context.Context, identifier string) (Repository, error)
	// GetRepoTarball retrieves a .tar.gz tarball of a git repository
	GetRepoTarball(ctx context.Context, opts GetRepoTarballOptions) ([]byte, string, 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, id string, 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)
	// ListPullRequestFiles returns the paths of files that are modified in the pull request
	ListPullRequestFiles(ctx context.Context, repo string, pull int) ([]string, error)
	// GetCommit retrieves commit from the repo with the given git ref
	GetCommit(ctx context.Context, repo, ref string) (Commit, error)
}

type Commit struct {
	SHA    string
	URL    string
	Author CommitAuthor
}

type CommitAuthor struct {
	Username   string
	ProfileURL string
	AvatarURL  string
}

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

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

type ErrIgnoreEvent struct {
	Reason string
}

type Event struct {
	EventHeader
	EventPayload
}

type EventHeader struct {
	VCSProviderID resource.TfeID
}

type EventPayload struct {
	RepoPath string

	VCSKind Kind

	Type          EventType
	Action        Action
	Tag           string
	CommitSHA     string
	CommitURL     string
	Branch        string // head branch
	DefaultBranch string

	PullRequestNumber int
	PullRequestURL    string
	PullRequestTitle  string

	SenderUsername  string
	SenderAvatarURL string
	SenderHTMLURL   string

	// Paths of files that have been added/modified/removed. Only applicable
	// to Push and Tag events types.
	Paths []string

	// Only set if event is from a github app
	GithubAppInstallID *int64
}

type EventType string

type GetRepoTarballOptions struct {
	Repo string  // repo identifier, <owner>/<repo>
	Ref  *string // branch/tag/SHA ref, nil means default branch
}

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

type Kind string

type ListRepositoriesOptions struct {
	PageSize int
}

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

type NewTokenClientOptions struct {
	Token               string
	Hostname            string
	SkipTLSVerification bool
}

type Publisher interface {
	Publish(Event)
}

type Repository struct {
	Path          string
	DefaultBranch string
}

type SetStatusOptions struct {
	Workspace   string // workspace name
	Repo        string // <owner>/<repo>
	Ref         string // git ref
	Status      Status
	TargetURL   string
	Description string
}

type Status string

type Subscriber interface {
	Subscribe(cb Callback)
}

type UpdateWebhookOptions CreateWebhookOptions

type Webhook struct {
	ID       string // cloud's webhook ID
	Repo     string // identifier is <repo_owner>/<repo_name>
	Events   []EventType
	Endpoint string // the OTF URL that receives events
}