vcsprovider

type CreateOptions struct {
	Organization string
	Name         string
	Kind         *vcs.Kind

	// Specify either token or github app install ID
	Token              *string
	GithubAppInstallID *int64
}

type Options struct {
	internal.HostnameService
	*sql.DB
	*tfeapi.Responder
	html.Renderer
	logr.Logger
	github.GithubAppService
	vcs.Subscriber

	GithubHostname      string
	GitlabHostname      string
	SkipTLSVerification bool
}

type Service interface {
	CreateVCSProvider(ctx context.Context, opts CreateOptions) (*VCSProvider, error)
	UpdateVCSProvider(ctx context.Context, id string, opts UpdateOptions) (*VCSProvider, error)
	GetVCSProvider(ctx context.Context, id string) (*VCSProvider, error)
	ListVCSProviders(ctx context.Context, organization string) ([]*VCSProvider, error)
	ListAllVCSProviders(ctx context.Context) ([]*VCSProvider, error)
	// ListVCSProvidersByGithubAppInstall lists VCS providers using the
	// credentials of a particular github app installation.
	ListVCSProvidersByGithubAppInstall(ctx context.Context, installID int64) ([]*VCSProvider, error)
	DeleteVCSProvider(ctx context.Context, id string) (*VCSProvider, error)

	// GetVCSClient combines retrieving a vcs provider and construct a cloud
	// client from that provider.
	//
	// TODO: rename vcs provider to vcs client; the central purpose of the vcs
	// provider is, after all, to construct a vcs client.
	GetVCSClient(ctx context.Context, providerID string) (vcs.Client, error)

	BeforeDeleteVCSProvider(l hooks.Listener[*VCSProvider])
}

type UpdateOptions struct {
	Token *string
	Name  string
}

type VCSProvider struct {
	ID           string
	Name         string
	CreatedAt    time.Time
	Organization string // name of OTF organization
	Hostname     string // hostname of github/gitlab etc

	Kind  vcs.Kind // github/gitlab etc. Not necessary if GithubApp is non-nil.
	Token *string  // personal access token.

	GithubApp *github.InstallCredentials // mutually exclusive with Token.
	// contains filtered or unexported fields
}

type VCSProviderService Service