client

Documentation

Index

• Constants
• type Client
  • func NewClient(baseURL string, secretKey []byte, ...) (*Client, error)
  • func NewFromConfig(config Config) (*Client, error)
  • func (gc *Client) GetLookup(ctx context.Context, host string) api.Lookup
  • func (gc *Client) Resolve(ctx context.Context, host string) *api.Lookup
  • func (gc *Client) Status() error
• type Config
• type StubClient
  • func (c StubClient) GetLookup(ctx context.Context, host string) api.Lookup
  • func (c StubClient) Resolve(ctx context.Context, host string) *api.Lookup
  • func (c StubClient) Status() error

Constants

const ConnectionErrorMsg = "failed to connect to internal Pages API"

ConnectionErrorMsg to be returned with `gc.Status` if Pages fails to connect to the internal GitLab API, times out or a 401 given that the credentials used are wrong

Types

type Client

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

Client is a HTTP client to access Pages internal API

func NewClient

func NewClient(baseURL string, secretKey []byte, connectionTimeout, jwtTokenExpiry time.Duration) (*Client, error)

NewClient initializes and returns new Client baseUrl is appConfig.InternalGitLabServer secretKey is appConfig.GitLabAPISecretKey

func NewFromConfig

func NewFromConfig(config Config) (*Client, error)

NewFromConfig creates a new client from Config struct

func (*Client) GetLookup

func (gc *Client) GetLookup(ctx context.Context, host string) api.Lookup

GetLookup returns a VirtualDomain configuration wrapped into a Lookup for a given host

func (*Client) Resolve

func (gc *Client) Resolve(ctx context.Context, host string) *api.Lookup

Resolve returns a VirtualDomain configuration wrapped into a Lookup for a given host. It implements api.Resolve type.

func (*Client) Status

func (gc *Client) Status() error

Status checks that Pages can reach the rails internal Pages API for source domain configuration. Timeout is the same as -gitlab-client-http-timeout

type Config

type Config interface {
	InternalGitLabServerURL() string
	GitlabAPISecret() []byte
	GitlabClientConnectionTimeout() time.Duration
	GitlabJWTTokenExpiry() time.Duration
	DomainConfigSource() string
}

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

type StubClient

type StubClient struct {
	File      string
	StatusErr func() error
}

StubClient is a stubbed client used for testing

func (StubClient) GetLookup

func (c StubClient) GetLookup(ctx context.Context, host string) api.Lookup

GetLookup reads a test fixture and unmarshalls it

func (StubClient) Resolve

func (c StubClient) Resolve(ctx context.Context, host string) *api.Lookup

Resolve implements api.Resolver

func (StubClient) Status

func (c StubClient) Status() error