source

Documentation

Index

• type Config
• type Domains
  • func NewDomains(config Config) (*Domains, error)
  • func (d *Domains) GetDomain(name string) (*domain.Domain, error)
  • func (d *Domains) IsReady() bool
  • func (d *Domains) Read(rootDomain string)
• type MockSource
  • func NewMockSource() *MockSource
  • func (m *MockSource) GetDomain(name string) (*domain.Domain, error)
• type Source

Types

type Config

type Config client.Config

Config represents an interface that is configuration provider for client capable of comunicating with GitLab

type Domains

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

Domains struct represents a map of all domains supported by pages. It is currently using two sources during the transition to the new GitLab domains source.

func NewDomains

func NewDomains(config Config) (*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(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.

func (*Domains) IsReady

func (d *Domains) IsReady() bool

IsReady checks if the disk domain source managed to traverse entire pages filesystem and is ready for use. It is DEPRECATED, because we want to remove it entirely when disk source gets removed.

func (*Domains) Read

func (d *Domains) Read(rootDomain string)

Read starts the disk domain source. It is DEPRECATED, because we want to remove it entirely when disk source gets removed.

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(name string) (*domain.Domain, error)

GetDomain is a mocked function

type Source

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

Source represents an abstract interface of a domains configuration source.