Documentation ¶
Index ¶
- Variables
- func WithHelmIndexLoader(l hub.HelmIndexLoader) func(m *Manager)
- type Cloner
- type ClonerMock
- type HTTPGetter
- type HelmIndexLoader
- type HelmIndexLoaderMock
- type Manager
- func (m *Manager) Add(ctx context.Context, orgName string, r *hub.Repository) error
- func (m *Manager) CheckAvailability(ctx context.Context, resourceKind, value string) (bool, error)
- func (m *Manager) ClaimOwnership(ctx context.Context, repoName, orgName string) error
- func (m *Manager) Delete(ctx context.Context, name string) error
- func (m *Manager) GetAll(ctx context.Context) ([]*hub.Repository, error)
- func (m *Manager) GetAllJSON(ctx context.Context) ([]byte, error)
- func (m *Manager) GetByID(ctx context.Context, repositoryID string) (*hub.Repository, error)
- func (m *Manager) GetByKind(ctx context.Context, kind hub.RepositoryKind) ([]*hub.Repository, error)
- func (m *Manager) GetByKindJSON(ctx context.Context, kind hub.RepositoryKind) ([]byte, error)
- func (m *Manager) GetByName(ctx context.Context, name string) (*hub.Repository, error)
- func (m *Manager) GetMetadata(mdFile string) (*hub.RepositoryMetadata, error)
- func (m *Manager) GetOwnedByOrgJSON(ctx context.Context, orgName string) ([]byte, error)
- func (m *Manager) GetOwnedByUserJSON(ctx context.Context) ([]byte, error)
- func (m *Manager) GetPackagesDigest(ctx context.Context, repositoryID string) (map[string]string, error)
- func (m *Manager) SetLastTrackingResults(ctx context.Context, repositoryID, errs string) error
- func (m *Manager) SetVerifiedPublisher(ctx context.Context, repositoryID string, verified bool) error
- func (m *Manager) Transfer(ctx context.Context, repoName, orgName string, ownershipClaim bool) error
- func (m *Manager) Update(ctx context.Context, r *hub.Repository) error
- type ManagerMock
- func (m *ManagerMock) Add(ctx context.Context, orgName string, r *hub.Repository) error
- func (m *ManagerMock) CheckAvailability(ctx context.Context, resourceKind, value string) (bool, error)
- func (m *ManagerMock) ClaimOwnership(ctx context.Context, name, orgName string) error
- func (m *ManagerMock) Delete(ctx context.Context, name string) error
- func (m *ManagerMock) GetAll(ctx context.Context) ([]*hub.Repository, error)
- func (m *ManagerMock) GetAllJSON(ctx context.Context) ([]byte, error)
- func (m *ManagerMock) GetByID(ctx context.Context, repositoryID string) (*hub.Repository, error)
- func (m *ManagerMock) GetByKind(ctx context.Context, kind hub.RepositoryKind) ([]*hub.Repository, error)
- func (m *ManagerMock) GetByKindJSON(ctx context.Context, kind hub.RepositoryKind) ([]byte, error)
- func (m *ManagerMock) GetByName(ctx context.Context, name string) (*hub.Repository, error)
- func (m *ManagerMock) GetMetadata(mdFile string) (*hub.RepositoryMetadata, error)
- func (m *ManagerMock) GetOwnedByOrgJSON(ctx context.Context, orgName string) ([]byte, error)
- func (m *ManagerMock) GetOwnedByUserJSON(ctx context.Context) ([]byte, error)
- func (m *ManagerMock) GetPackagesDigest(ctx context.Context, repositoryID string) (map[string]string, error)
- func (m *ManagerMock) SetLastTrackingResults(ctx context.Context, repositoryID, errs string) error
- func (m *ManagerMock) SetVerifiedPublisher(ctx context.Context, repositoryID string, verified bool) error
- func (m *ManagerMock) Transfer(ctx context.Context, name, orgName string, ownershipClaim bool) error
- func (m *ManagerMock) Update(ctx context.Context, r *hub.Repository) error
Constants ¶
This section is empty.
Variables ¶
var ( // ErrInvalidMetadata indicates that the repository metadata is not valid. ErrInvalidMetadata = errors.New("invalid metadata") // GitRepoURLRE is a regexp used to validate and parse a git based // repository URL. GitRepoURLRE = regexp.MustCompile(`^(https:\/\/(github|gitlab)\.com\/[A-Za-z0-9_.-]+\/[A-Za-z0-9_.-]+)\/?(.*)$`) )
Functions ¶
func WithHelmIndexLoader ¶ added in v0.5.0
func WithHelmIndexLoader(l hub.HelmIndexLoader) func(m *Manager)
WithHelmIndexLoader allows providing a specific HelmIndexLoader implementation for a Manager instance.
Types ¶
type Cloner ¶
type Cloner struct{}
Cloner is a hub.RepositoryCloner implementation.
func (*Cloner) CloneRepository ¶
CloneRepository implements the hub.RepositoryCloner interface.
type ClonerMock ¶
ClonerMock is a mock implementation of the RepositoryCloner interface.
func (*ClonerMock) CloneRepository ¶
func (m *ClonerMock) CloneRepository(ctx context.Context, r *hub.Repository) (string, string, error)
CloneRepository implements the RepositoryCloner interface.
type HTTPGetter ¶ added in v0.6.0
HTTPGetter defines the methods an HTTPGetter implementation must provide.
type HelmIndexLoader ¶
type HelmIndexLoader struct{}
HelmIndexLoader provides a mechanism to load a Helm repository index file, verifying it is valid.
func (*HelmIndexLoader) LoadIndex ¶
func (l *HelmIndexLoader) LoadIndex(r *hub.Repository) (*helmrepo.IndexFile, error)
LoadIndex downloads and parses the index file of the provided repository.
type HelmIndexLoaderMock ¶
HelmIndexLoaderMock is a mock implementation of the HelmIndexLoader interface.
func (*HelmIndexLoaderMock) LoadIndex ¶
func (m *HelmIndexLoaderMock) LoadIndex(r *hub.Repository) (*repo.IndexFile, error)
LoadIndex implements the HelmIndexLoader interface.
type Manager ¶
type Manager struct {
// contains filtered or unexported fields
}
Manager provides an API to manage repositories.
func NewManager ¶
NewManager creates a new Manager instance.
func (*Manager) CheckAvailability ¶
CheckAvailability checks the availability of a given value for the provided resource kind.
func (*Manager) ClaimOwnership ¶ added in v0.6.0
ClaimOwnership allows a user to claim the ownership of a given repository. The repository will be transferred to the destination entity requested if the user is listed as one of the owners in the repository metadata file.
func (*Manager) GetAllJSON ¶ added in v0.6.0
GetAllJSON returns all available repositories as a json array, which is built by the database.
func (*Manager) GetByID ¶ added in v0.5.0
GetByID returns the repository identified by the id provided.
func (*Manager) GetByKind ¶
func (m *Manager) GetByKind(ctx context.Context, kind hub.RepositoryKind) ([]*hub.Repository, error)
GetByKind returns all available repositories of the provided kind.
func (*Manager) GetByKindJSON ¶ added in v0.6.0
GetByKindJSON returns all available repositories of the provided kind as a json array, which is built by the database.
func (*Manager) GetMetadata ¶ added in v0.6.0
func (m *Manager) GetMetadata(mdFile string) (*hub.RepositoryMetadata, error)
GetMetadata reads and parses the repository metadata file provided, which can be a remote URL or a local file path.
func (*Manager) GetOwnedByOrgJSON ¶
GetOwnedByOrgJSON returns all repositories that belong to the organization provided.
func (*Manager) GetOwnedByUserJSON ¶
GetOwnedByUserJSON returns all repositories that belong to the user making the request.
func (*Manager) GetPackagesDigest ¶
func (m *Manager) GetPackagesDigest( ctx context.Context, repositoryID string, ) (map[string]string, error)
GetPackagesDigest returns the digests for all packages in the repository identified by the id provided.
func (*Manager) SetLastTrackingResults ¶
SetLastTrackingResults updates the timestamp and errors of the last tracking of the provided repository in the database.
func (*Manager) SetVerifiedPublisher ¶ added in v0.5.0
func (m *Manager) SetVerifiedPublisher(ctx context.Context, repositoryID string, verified bool) error
SetVerifiedPublisher updates the verified publisher flag of the provided repository in the database.
func (*Manager) Transfer ¶
func (m *Manager) Transfer(ctx context.Context, repoName, orgName string, ownershipClaim bool) error
Transfer transfers the provided repository to a different owner. A user owned repo can be transferred to an organization the requesting user belongs to. An org owned repo can be transfer to the requesting user, provided the user belongs to the owning org, or to a different organization the user belongs to.
type ManagerMock ¶
ManagerMock is a mock implementation of the RepositoryManager interface.
func (*ManagerMock) Add ¶
func (m *ManagerMock) Add(ctx context.Context, orgName string, r *hub.Repository) error
Add implements the RepositoryManager interface.
func (*ManagerMock) CheckAvailability ¶
func (m *ManagerMock) CheckAvailability(ctx context.Context, resourceKind, value string) (bool, error)
CheckAvailability implements the RepositoryManager interface.
func (*ManagerMock) ClaimOwnership ¶ added in v0.6.0
func (m *ManagerMock) ClaimOwnership(ctx context.Context, name, orgName string) error
ClaimOwnership implements the RepositoryManager interface.
func (*ManagerMock) Delete ¶
func (m *ManagerMock) Delete(ctx context.Context, name string) error
Delete implements the RepositoryManager interface.
func (*ManagerMock) GetAll ¶ added in v0.4.0
func (m *ManagerMock) GetAll(ctx context.Context) ([]*hub.Repository, error)
GetAll implements the RepositoryManager interface.
func (*ManagerMock) GetAllJSON ¶ added in v0.6.0
func (m *ManagerMock) GetAllJSON(ctx context.Context) ([]byte, error)
GetAllJSON implements the RepositoryManager interface.
func (*ManagerMock) GetByID ¶ added in v0.5.0
func (m *ManagerMock) GetByID(ctx context.Context, repositoryID string) (*hub.Repository, error)
GetByID implements the RepositoryManager interface.
func (*ManagerMock) GetByKind ¶
func (m *ManagerMock) GetByKind(ctx context.Context, kind hub.RepositoryKind) ([]*hub.Repository, error)
GetByKind implements the RepositoryManager interface.
func (*ManagerMock) GetByKindJSON ¶ added in v0.6.0
func (m *ManagerMock) GetByKindJSON(ctx context.Context, kind hub.RepositoryKind) ([]byte, error)
GetByKindJSON implements the RepositoryManager interface.
func (*ManagerMock) GetByName ¶
func (m *ManagerMock) GetByName(ctx context.Context, name string) (*hub.Repository, error)
GetByName implements the RepositoryManager interface.
func (*ManagerMock) GetMetadata ¶ added in v0.6.0
func (m *ManagerMock) GetMetadata(mdFile string) (*hub.RepositoryMetadata, error)
GetMetadata implements the RepositoryManager interface.
func (*ManagerMock) GetOwnedByOrgJSON ¶
GetOwnedByOrgJSON implements the RepositoryManager interface.
func (*ManagerMock) GetOwnedByUserJSON ¶
func (m *ManagerMock) GetOwnedByUserJSON(ctx context.Context) ([]byte, error)
GetOwnedByUserJSON implements the RepositoryManager interface.
func (*ManagerMock) GetPackagesDigest ¶
func (m *ManagerMock) GetPackagesDigest( ctx context.Context, repositoryID string, ) (map[string]string, error)
GetPackagesDigest implements the RepositoryManager interface.
func (*ManagerMock) SetLastTrackingResults ¶
func (m *ManagerMock) SetLastTrackingResults(ctx context.Context, repositoryID, errs string) error
SetLastTrackingResults implements the RepositoryManager interface.
func (*ManagerMock) SetVerifiedPublisher ¶ added in v0.5.0
func (m *ManagerMock) SetVerifiedPublisher(ctx context.Context, repositoryID string, verified bool) error
SetVerifiedPublisher implements the RepositoryManager interface.
func (*ManagerMock) Transfer ¶
func (m *ManagerMock) Transfer(ctx context.Context, name, orgName string, ownershipClaim bool) error
Transfer implements the RepositoryManager interface.
func (*ManagerMock) Update ¶
func (m *ManagerMock) Update(ctx context.Context, r *hub.Repository) error
Update implements the RepositoryManager interface.