vcsprovider

Documentation

Overview

Package vcsprovider is responsible for VCS providers

Index

• Constants
• type CreateOptions
• type Options
• type Service
  • func NewService(opts Options) *Service
  • func (a *Service) AddHandlers(r *mux.Router)
  • func (a *Service) BeforeDeleteVCSProvider(hook func(context.Context, *VCSProvider) error)
  • func (a *Service) Create(ctx context.Context, opts CreateOptions) (*VCSProvider, error)
  • func (a *Service) Delete(ctx context.Context, id resource.ID) (*VCSProvider, error)
  • func (a *Service) Get(ctx context.Context, id resource.ID) (*VCSProvider, error)
  • func (a *Service) GetVCSClient(ctx context.Context, providerID resource.ID) (vcs.Client, error)
  • func (a *Service) List(ctx context.Context, organization string) ([]*VCSProvider, error)
  • func (a *Service) ListAllVCSProviders(ctx context.Context) ([]*VCSProvider, error)
  • func (a *Service) ListVCSProvidersByGithubAppInstall(ctx context.Context, installID int64) ([]*VCSProvider, error)
  • func (a *Service) Update(ctx context.Context, id resource.ID, opts UpdateOptions) (*VCSProvider, error)
• type UpdateOptions
• type VCSProvider
  • func (t *VCSProvider) LogValue() slog.Value
  • func (t *VCSProvider) NewClient() (vcs.Client, error)
  • func (t *VCSProvider) String() string
  • func (t *VCSProvider) Update(opts UpdateOptions) error

Constants

const (
	GithubAPIURL  = "https://api.github.com"
	GithubHTTPURL = "https://github.com"
)

Types

type CreateOptions

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

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

type Options

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

	GithubAppService    *github.Service
	GithubHostname      string
	GitlabHostname      string
	SkipTLSVerification bool
	Authorizer          *authz.Authorizer
}

type Service

type Service struct {
	logr.Logger
	*authz.Authorizer

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

func NewService

func NewService(opts Options) *Service

func (*Service) AddHandlers

func (a *Service) AddHandlers(r *mux.Router)

func (*Service) BeforeDeleteVCSProvider

func (a *Service) BeforeDeleteVCSProvider(hook func(context.Context, *VCSProvider) error)

func (*Service) Create

func (a *Service) Create(ctx context.Context, opts CreateOptions) (*VCSProvider, error)

func (*Service) Delete

func (a *Service) Delete(ctx context.Context, id resource.ID) (*VCSProvider, error)

func (*Service) Get

func (a *Service) Get(ctx context.Context, id resource.ID) (*VCSProvider, error)

func (*Service) GetVCSClient

func (a *Service) GetVCSClient(ctx context.Context, providerID resource.ID) (vcs.Client, error)

func (*Service) List

func (a *Service) List(ctx context.Context, organization string) ([]*VCSProvider, error)

func (*Service) ListAllVCSProviders

func (a *Service) ListAllVCSProviders(ctx context.Context) ([]*VCSProvider, error)

func (*Service) ListVCSProvidersByGithubAppInstall

func (a *Service) ListVCSProvidersByGithubAppInstall(ctx context.Context, installID int64) ([]*VCSProvider, error)

ListVCSProvidersByGithubAppInstall is unauthenticated: only for internal use.

func (*Service) Update

func (a *Service) Update(ctx context.Context, id resource.ID, opts UpdateOptions) (*VCSProvider, error)

type UpdateOptions

type UpdateOptions struct {
	Token *string
	Name  string
}

type VCSProvider

type VCSProvider struct {
	ID           resource.ID
	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
}

VCSProvider provides authenticated access to a VCS.

func (*VCSProvider) LogValue

func (t *VCSProvider) LogValue() slog.Value

LogValue implements slog.LogValuer.

func (*VCSProvider) NewClient

func (t *VCSProvider) NewClient() (vcs.Client, error)

func (*VCSProvider) String

func (t *VCSProvider) String() string

String provides a human meaningful description of the vcs provider, using the name if set; otherwise a name is constructed using both the underlying cloud kind and the auth kind.

func (*VCSProvider) Update

func (t *VCSProvider) Update(opts UpdateOptions) error