intermediate

Documentation

Overview

Package intermediate serves as the foundation of the configurator.core microservice.

The Configurator is a core microservice that centralizes the dissemination of configuration values to other microservices.

Index

• type Intermediate
  • func NewService(impl ToDo, version int) *Intermediate
• type Mock
  • func NewMock() *Mock
  • func (svc *Mock) MockRefresh(handler func(ctx context.Context) (err error)) *Mock
  • func (svc *Mock) MockSync(...) *Mock
  • func (svc *Mock) MockValues(...) *Mock
  • func (svc *Mock) OnShutdown(ctx context.Context) (err error)
  • func (svc *Mock) OnStartup(ctx context.Context) (err error)
  • func (svc *Mock) PeriodicRefresh(ctx context.Context) (err error)
  • func (svc *Mock) Refresh(ctx context.Context) (err error)
  • func (svc *Mock) Sync(ctx context.Context, timestamp time.Time, values map[string]map[string]string) (err error)
  • func (svc *Mock) Values(ctx context.Context, names []string) (values map[string]string, err error)
• type ToDo

Types

type Intermediate

type Intermediate struct {
	*connector.Connector
	// contains filtered or unexported fields
}

Intermediate extends and customizes the generic base connector. Code generated microservices then extend the intermediate.

func NewService

func NewService(impl ToDo, version int) *Intermediate

NewService creates a new intermediate service.

type Mock

type Mock struct {
	*Intermediate
	// contains filtered or unexported fields
}

Mock is a mockable version of the configurator.core microservice, allowing functions, event sinks and web handlers to be mocked.

func NewMock

func NewMock() *Mock

NewMock creates a new mockable version of the microservice.

func (*Mock) MockRefresh

func (svc *Mock) MockRefresh(handler func(ctx context.Context) (err error)) *Mock

MockRefresh sets up a mock handler for the Refresh endpoint.

func (*Mock) MockSync

func (svc *Mock) MockSync(handler func(ctx context.Context, timestamp time.Time, values map[string]map[string]string) (err error)) *Mock

MockSync sets up a mock handler for the Sync endpoint.

func (*Mock) MockValues

func (svc *Mock) MockValues(handler func(ctx context.Context, names []string) (values map[string]string, err error)) *Mock

MockValues sets up a mock handler for the Values endpoint.

func (*Mock) OnShutdown

func (svc *Mock) OnShutdown(ctx context.Context) (err error)

OnShutdown is a no op.

func (*Mock) OnStartup

func (svc *Mock) OnStartup(ctx context.Context) (err error)

OnStartup makes sure that the mock is not executed in a non-dev environment.

func (*Mock) PeriodicRefresh

func (svc *Mock) PeriodicRefresh(ctx context.Context) (err error)

PeriodicRefresh is a no op.

func (*Mock) Refresh

func (svc *Mock) Refresh(ctx context.Context) (err error)

Refresh runs the mock handler set by MockRefresh.

func (*Mock) Sync

func (svc *Mock) Sync(ctx context.Context, timestamp time.Time, values map[string]map[string]string) (err error)

Sync runs the mock handler set by MockSync.

func (*Mock) Values

func (svc *Mock) Values(ctx context.Context, names []string) (values map[string]string, err error)

Values runs the mock handler set by MockValues.

type ToDo

type ToDo interface {
	OnStartup(ctx context.Context) (err error)
	OnShutdown(ctx context.Context) (err error)
	Values(ctx context.Context, names []string) (values map[string]string, err error)
	Refresh(ctx context.Context) (err error)
	Sync(ctx context.Context, timestamp time.Time, values map[string]map[string]string) (err error)
	PeriodicRefresh(ctx context.Context) (err error)
}

ToDo defines the interface that the microservice must implement. The intermediate delegates handling to this interface.