vcs

type Action string

type App interface {
	// ListInstallations retrieves a list of installations.
	ListInstallations(context.Context) ([]Installation, error)
	// GetInstallation retrieves an installation by its ID.
	GetInstallation(context.Context, int64) (Installation, error)
	// InstallationLink is a link to the site where a user can create an
	// installation.
	InstallationLink() templ.SafeURL
}

type AppKind interface {
	GetApp(context.Context) (App, error)
}

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) ([]Repo, error)
	GetDefaultBranch(ctx context.Context, identifier string) (string, 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 Repo, pull int) ([]string, error)
	// GetCommit retrieves commit from the repo with the given git ref
	GetCommit(ctx context.Context, repo Repo, ref string) (Commit, error)
}

type ClientConfig struct {
	Token        *string
	Installation *Installation
	BaseURL      *internal.WebURL
}

type Commit struct {
	SHA    string
	URL    string
	Author CommitAuthor
}

type CommitAuthor struct {
	Username   string
	ProfileURL string
	AvatarURL  string
}

type CreateOptions struct {
	Organization organization.Name `schema:"organization_name,required"`
	Name         string
	KindID       KindID `schema:"kind,required"`
	// Token and InstallID are mutually exclusive.
	Token     *string
	InstallID *int64 `schema:"install_id"`
	// Optional.
	BaseURL *internal.WebURL `schema:"base_url,required"`
	// contains filtered or unexported fields
}

type CreateWebhookOptions struct {
	Repo     Repo   // 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 Repo   // Repository identifier, <owner>/<repo>
	ID   string // vcs' webhook ID
}

type ErrIgnoreEvent struct {
	Reason string
}

type Event struct {
	EventHeader
	EventPayload
}

type EventHeader struct {
	// ID of vcs provider that generated this event.
	// event.
	VCSProviderID resource.TfeID
	// Source of vcs provider kind that generated this event.
	Source source.Source
}

type EventPayload struct {
	Repo          Repo
	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 Repo    // repo identifier, <owner>/<repo>
	Ref  *string // branch/tag/SHA ref, nil means default branch
}

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

type Installation struct {
	ID           int64
	AppID        int64
	Username     *string
	Organization *string
	HTMLURL      string
}

type Kind struct {
	// ID distinguishes this kind from other kinds. NOTE: This must have first
	// been inserted into the vcs_kinds table via a database migration.
	ID KindID
	// DefaultURL is the default base URL for the provider.
	DefaultURL *internal.WebURL
	// Icon renders an icon identifying the VCS host kind.
	Icon templ.Component
	// TokenKind provides info about the token the provider expects. Mutually
	// exclusive with AppKind.
	TokenKind *TokenKind
	// AppKind provides info about installations for this ProviderKind.
	// Mutually exclusive with TokenKind.
	AppKind AppKind
	// NewClient constructs a client implementation.
	NewClient func(context.Context, ClientConfig) (Client, error)
	// EventHandler handles incoming events from the VCS host before relaying
	// them onwards for triggering actions like creating runs etc.
	EventHandler func(r *http.Request, secret string) (*EventPayload, error)
	// SkipRepohook if true skips the creation of a repository-level webhook.
	SkipRepohook bool
	// TFEServiceProviders registers the kind with the TFE API, permitting vcs
	// providers of this kind to be created via the TFE API. The value specified
	// here is the value that should be be provided by API clients via the
	// "service-provider" attribute:
	//
	// https://developer.hashicorp.com/terraform/cloud-docs/api-docs/oauth-clients#request-body
	//
	// Must provide at least one type. A kind can register more than one type,
	// e.g. gitlab-ce and gitlab-ee, in which case if a client specifies either
	// of these types then OTF creates a provider of the gitlab kind. Note that
	// OTF makes no distinction between multiple types but it's merely there to
	// support the TFE API and the various values that clients might provide
	// according to the API documentation (though OTF may in future make a
	// distinction!).
	TFEServiceProviders []TFEServiceProviderType
	// Source sets the source identifier for this kind, to inform users which
	// kind is the source of a run configuration. By default the ID is used as
	// the source identifier but Source takes precedence if it is non-nil.
	Source *source.Source
}

type KindID string

type ListOptions struct {
	resource.PageOptions
	Organization organization.Name `schema:"organization_name"`
}

type ListRepositoriesOptions struct {
	PageSize int
}

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

type NewTokenClientOptions struct {
	Token               string
	BaseURL             *internal.WebURL
	SkipTLSVerification bool
}

type Options struct {
	*internal.HostnameService
	*sql.DB
	*tfeapi.Responder
	logr.Logger

	SourceIconRegistrar SourceIconRegistrar
	SkipTLSVerification bool
	Authorizer          *authz.Authorizer
}

type Provider struct {
	ID           resource.TfeID
	Name         string
	CreatedAt    time.Time
	Organization organization.Name
	Token        *string
	Installation *Installation
	// The kind of provider
	Kind
	// Client is the actual client for interacting with the VCS host.
	Client
	// The base URL of the the provider.
	BaseURL *internal.WebURL
	// contains filtered or unexported fields
}

type Publisher interface {
	Publish(Event)
}

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

type Service struct {
	logr.Logger
	*authz.Authorizer

	*internal.HostnameService
	// contains filtered or unexported fields
}

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

type SourceIconRegistrar interface {
	RegisterSourceIcon(source source.Source, icon templ.Component)
}

type Status string

type Subscriber interface {
	Subscribe(cb Callback)
}

type TFEOAuthClient struct {
	ID                  resource.TfeID         `jsonapi:"primary,oauth-clients"`
	APIURL              string                 `jsonapi:"attribute" json:"api-url"`
	CallbackURL         string                 `jsonapi:"attribute" json:"callback-url"`
	ConnectPath         string                 `jsonapi:"attribute" json:"connect-path"`
	CreatedAt           time.Time              `jsonapi:"attribute" json:"created-at"`
	HTTPURL             string                 `jsonapi:"attribute" json:"http-url"`
	Key                 string                 `jsonapi:"attribute" json:"key"`
	RSAPublicKey        string                 `jsonapi:"attribute" json:"rsa-public-key"`
	Name                *string                `jsonapi:"attribute" json:"name"`
	Secret              string                 `jsonapi:"attribute" json:"secret"`
	ServiceProvider     TFEServiceProviderType `jsonapi:"attribute" json:"service-provider"`
	ServiceProviderName string                 `jsonapi:"attribute" json:"service-provider-display-name"`

	// Relations
	Organization *organization.TFEOrganization `jsonapi:"relationship" json:"organization"`
	OAuthTokens  []*TFEOAuthToken              `jsonapi:"relationship" json:"oauth-tokens"`
}

type TFEOAuthClientCreateOptions struct {
	// Type is a public field utilized by JSON:API to
	// set the resource type via the field tag.
	// It is not a user-defined value and does not need to be set.
	// https://jsonapi.org/format/#crud-creating
	Type string `jsonapi:"primary,oauth-clients"`

	// A display name for the OAuth Client.
	Name *string `jsonapi:"attribute" json:"name"`

	// Required: The base URL of your VCS provider's API.
	APIURL *internal.WebURL `jsonapi:"attribute" json:"api-url"`

	// Required: The homepage of your VCS provider.
	HTTPURL *internal.WebURL `jsonapi:"attribute" json:"http-url"`

	// Optional: The OAuth Client key.
	Key *string `jsonapi:"attribute" json:"key,omitempty"`

	// Optional: The token string you were given by your VCS provider.
	OAuthToken *string `jsonapi:"attribute" json:"oauth-token-string,omitempty"`

	// Optional: Private key associated with this vcs provider - only available for ado_server
	PrivateKey *string `jsonapi:"attribute" json:"private-key,omitempty"`

	// Optional: Secret key associated with this vcs provider - only available for ado_server
	Secret *string `jsonapi:"attribute" json:"secret,omitempty"`

	// Optional: RSAPublicKey the text of the SSH public key associated with your BitBucket
	// Server Application Link.
	RSAPublicKey *string `jsonapi:"attribute" json:"rsa-public-key,omitempty"`

	// Required: The VCS provider being connected with.
	ServiceProvider *TFEServiceProviderType `jsonapi:"attribute" json:"service-provider"`
}

type TFEOAuthToken struct {
	ID                  resource.TfeID `jsonapi:"primary,oauth-tokens"`
	UID                 resource.TfeID `jsonapi:"attribute" json:"uid"`
	CreatedAt           time.Time      `jsonapi:"attribute" json:"created-at"`
	HasSSHKey           bool           `jsonapi:"attribute" json:"has-ssh-key"`
	ServiceProviderUser string         `jsonapi:"attribute" json:"service-provider-user"`

	// Relations
	OAuthClient *TFEOAuthClient `jsonapi:"relationship" json:"oauth-client"`
}

type TFEServiceProviderType string

type Table struct {
	Actions func(vcsProviderID resource.TfeID) templ.Component
}

type TokenKind struct {
	// TokenDescription renders a helpful description of what is expected of the
	// token, e.g. what permissions it should possess.
	Description templ.Component
}

type UpdateOptions struct {
	Name    string
	Token   *string
	BaseURL *internal.WebURL
}

type UpdateWebhookOptions CreateWebhookOptions

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