providers

Documentation

Overview

Package providers contains general utilities for interacting with providers.

Index

• Variables
• func DBToPBAuthFlow(t db.AuthorizationFlow) (minderv1.AuthorizationFlow, bool)
• func DBToPBType(t db.ProviderType) (minderv1.ProviderType, bool)
• func GetCredentialStateForProvider(ctx context.Context, prov db.Provider, s db.Store, cryptoEngine crypto.Engine, ...) string
• func GetProviderClassString(prov db.Provider) string
• func ListProviderClasses() []string
• type ErrProviderNotFoundBy
  • func (e ErrProviderNotFoundBy) Error() string
• type ProviderBuilder
  • func GetProviderBuilder(ctx context.Context, prov db.Provider, store db.Store, crypteng crypto.Engine, ...) (*ProviderBuilder, error)
  • func NewProviderBuilder(p *db.Provider, ownerFilter sql.NullString, isOrg bool, ...) *ProviderBuilder
  • func (pb *ProviderBuilder) GetGit() (provinfv1.Git, error)
  • func (pb *ProviderBuilder) GetGitHub() (provinfv1.GitHub, error)
  • func (pb *ProviderBuilder) GetHTTP() (provinfv1.REST, error)
  • func (pb *ProviderBuilder) GetName() string
  • func (pb *ProviderBuilder) GetRepoLister() (provinfv1.RepoLister, error)
  • func (pb *ProviderBuilder) Implements(impl db.ProviderType) bool
• type ProviderBuilderOption
  • func WithProviderMetrics(metrics telemetry.ProviderMetrics) ProviderBuilderOption
  • func WithRestClientCache(cache ratecache.RestClientCache) ProviderBuilderOption
• type ProviderClassDefinition
  • func GetProviderClassDefinition(class string) (ProviderClassDefinition, error)
• type ProviderStore
  • func NewProviderStore(store db.Store) ProviderStore

Variables

var ErrInvalidCredential = errors.New("invalid credential type")

ErrInvalidCredential is returned when the credential is not of the required type

Functions

func DBToPBAuthFlow

func DBToPBAuthFlow(t db.AuthorizationFlow) (minderv1.AuthorizationFlow, bool)

DBToPBAuthFlow converts a database authorization flow to a protobuf authorization flow.

func DBToPBType

func DBToPBType(t db.ProviderType) (minderv1.ProviderType, bool)

DBToPBType converts a database provider type to a protobuf provider type.

func GetCredentialStateForProvider

func GetCredentialStateForProvider(
	ctx context.Context,
	prov db.Provider,
	s db.Store,
	cryptoEngine crypto.Engine,
	provCfg *serverconfig.ProviderConfig,
) string

GetCredentialStateForProvider returns the credential state for the given provider.

func GetProviderClassString

func GetProviderClassString(prov db.Provider) string

GetProviderClassString returns the string representation of the provider class.

func ListProviderClasses

func ListProviderClasses() []string

ListProviderClasses returns a list of provider classes.

Types

type ErrProviderNotFoundBy

type ErrProviderNotFoundBy struct {
	Name  string
	Trait string
}

ErrProviderNotFoundBy is an error type which is returned when a provider is not found

func (ErrProviderNotFoundBy) Error

func (e ErrProviderNotFoundBy) Error() string

type ProviderBuilder

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

ProviderBuilder is a utility struct which allows for the creation of provider clients.

func GetProviderBuilder

func GetProviderBuilder(
	ctx context.Context,
	prov db.Provider,
	store db.Store,
	crypteng crypto.Engine,
	provCfg *serverconfig.ProviderConfig,
	fallbackTokenClient *gogithub.Client,
	opts ...ProviderBuilderOption,
) (*ProviderBuilder, error)

GetProviderBuilder is a utility function which allows for the creation of a provider factory.

func NewProviderBuilder

func NewProviderBuilder(
	p *db.Provider,
	ownerFilter sql.NullString,
	isOrg bool,
	credential provinfv1.Credential,
	cfg *serverconfig.ProviderConfig,
	fallbackTokenClient *gogithub.Client,
	opts ...ProviderBuilderOption,
) *ProviderBuilder

NewProviderBuilder creates a new provider builder.

func (*ProviderBuilder) GetGit

func (pb *ProviderBuilder) GetGit() (provinfv1.Git, error)

GetGit returns a git client for the provider.

func (*ProviderBuilder) GetGitHub

func (pb *ProviderBuilder) GetGitHub() (provinfv1.GitHub, error)

GetGitHub returns a github client for the provider.

func (*ProviderBuilder) GetHTTP

func (pb *ProviderBuilder) GetHTTP() (provinfv1.REST, error)

GetHTTP returns a github client for the provider.

func (*ProviderBuilder) GetName

func (pb *ProviderBuilder) GetName() string

GetName returns the name of the provider instance as defined in the database.

func (*ProviderBuilder) GetRepoLister

func (pb *ProviderBuilder) GetRepoLister() (provinfv1.RepoLister, error)

GetRepoLister returns a repo lister for the provider.

func (*ProviderBuilder) Implements

func (pb *ProviderBuilder) Implements(impl db.ProviderType) bool

Implements returns true if the provider implements the given type.

type ProviderBuilderOption

type ProviderBuilderOption func(*ProviderBuilder)

ProviderBuilderOption is a function which can be used to set options on the ProviderBuilder.

func WithProviderMetrics

func WithProviderMetrics(metrics telemetry.ProviderMetrics) ProviderBuilderOption

WithProviderMetrics sets the metrics for the ProviderBuilder

func WithRestClientCache

func WithRestClientCache(cache ratecache.RestClientCache) ProviderBuilderOption

WithRestClientCache sets the rest client cache for the ProviderBuilder

type ProviderClassDefinition

type ProviderClassDefinition struct {
	Traits             []db.ProviderType
	AuthorizationFlows []db.AuthorizationFlow
}

ProviderClassDefinition contains the static fields needed when creating a provider

func GetProviderClassDefinition

func GetProviderClassDefinition(class string) (ProviderClassDefinition, error)

GetProviderClassDefinition returns the provider definition for the given provider class

type ProviderStore

type ProviderStore interface {
	// GetByID returns the provider identified by its UUID primary key.
	// It is assumed that the caller carries out some kind of validation to
	// ensure that whoever made the request is authorized to access this
	// provider.
	GetByID(ctx context.Context, providerID uuid.UUID) (*db.Provider, error)
	// GetByName returns the provider instance in the database as
	// identified by its project ID and name. All parent projects of the
	// specified project are included in the search.
	GetByName(ctx context.Context, projectID uuid.UUID, name string) (*db.Provider, error)
	// GetByNameInSpecificProject returns the provider instance in the database as
	// identified by its project ID and name. Unlike `GetByName` it will only
	// search in the specified project, and ignore the project hierarchy.
	GetByNameInSpecificProject(ctx context.Context, projectID uuid.UUID, name string) (*db.Provider, error)
	// GetByNameAndTrait returns the providers in the project which match the
	// specified trait. All parent projects of the specified project are
	// included in the search.
	// Note that if error is nil, there will always be at least one element
	// in the list of providers which is returned.
	GetByNameAndTrait(
		ctx context.Context,
		projectID uuid.UUID,
		name string,
		trait db.ProviderType,
	) ([]db.Provider, error)
}

ProviderStore provides methods for retrieving Providers from the database

func NewProviderStore

func NewProviderStore(store db.Store) ProviderStore

NewProviderStore returns a new instance of ProviderStore.