source

Documentation

Index

• type Domains
  • func NewDomains(cfg *config.GitLab) (*Domains, error)
  • func (d *Domains) GetDomain(ctx context.Context, name string) (*domain.Domain, error)
• type MockSource
  • func NewMockSource() *MockSource
  • func (m *MockSource) GetDomain(ctx context.Context, name string) (*domain.Domain, error)
  • func (m *MockSource) IsReady() bool
• type Source

Types

type Domains

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

Domains struct wraps the GitLab client to fetch a domain configuration TODO: remove/refactor this package https://gitlab.com/gitlab-org/gitlab-pages/-/issues/608

func NewDomains

func NewDomains(cfg *config.GitLab) (*Domains, error)

NewDomains is a factory method for domains initializing a mutex. It should not initialize `dm` as we later check the readiness by comparing it with a nil value.

func (*Domains) GetDomain

func (d *Domains) GetDomain(ctx context.Context, name string) (*domain.Domain, error)

GetDomain retrieves a domain information from a source. We are using two sources here because it allows us to switch behavior and the domain source for some subset of domains, to test / PoC the new GitLab Domains Source that we plan to use to replace the disk source.

type MockSource

type MockSource struct {
	mock.Mock
}

MockSource can be used for testing

func NewMockSource

func NewMockSource() *MockSource

NewMockSource returns a new Source mock for testing

func (*MockSource) GetDomain

func (m *MockSource) GetDomain(ctx context.Context, name string) (*domain.Domain, error)

GetDomain is a mocked function

func (*MockSource) IsReady

func (m *MockSource) IsReady() bool

type Source

type Source interface {
	GetDomain(context.Context, string) (*domain.Domain, error)
}

Source represents an abstract interface of a domains configuration source.