service

Documentation

Index

• Variables
• func NewMockHTTPClient(r *http.Response, err error) *dphttp.ClienterMock
• type ExternalServiceList
  • func NewServiceList(initialiser Initialiser) *ExternalServiceList
  • func (e *ExternalServiceList) GetHTTPServer(bindAddr string, router http.Handler) HTTPServer
  • func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
  • func (e *ExternalServiceList) GetHealthClient(name, url string) *health.Client
  • func (e *ExternalServiceList) GetRendererClient(rendererURL string) *renderer.Renderer
• type HTTPServer
• type HealthChecker
• type Init
  • func (e *Init) DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer
  • func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
  • func (e *Init) DoGetHealthClient(name, url string) *health.Client
  • func (e *Init) DoGetRendererClient(rendererURL string) *renderer.Renderer
• type Initialiser
• type Service
  • func New() *Service
  • func (svc *Service) Close(ctx context.Context) error
  • func (svc *Service) Init(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList) (err error)
  • func (svc *Service) Run(ctx context.Context, svcErrors chan error)

Variables

var (
	// BuildTime represents the time in which the service was built
	BuildTime string
	// GitCommit represents the commit (SHA-1) hash of the service that is running
	GitCommit string
	// Version represents the version of the service that is running
	Version string
)

Functions

func NewMockHTTPClient

func NewMockHTTPClient(r *http.Response, err error) *dphttp.ClienterMock

NewMockHTTPClient mocks HTTP Client

Types

type ExternalServiceList

type ExternalServiceList struct {
	HealthCheck bool
	Init        Initialiser
}

ExternalServiceList holds the initialiser and initialisation state of external services.

func NewServiceList

func NewServiceList(initialiser Initialiser) *ExternalServiceList

NewServiceList creates a new service list with the provided initialiser

func (*ExternalServiceList) GetHTTPServer

func (e *ExternalServiceList) GetHTTPServer(bindAddr string, router http.Handler) HTTPServer

GetHTTPServer creates an http server

func (*ExternalServiceList) GetHealthCheck

func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

GetHealthCheck creates a healthcheck with versionInfo and sets the HealthCheck flag to true

func (*ExternalServiceList) GetHealthClient

func (e *ExternalServiceList) GetHealthClient(name, url string) *health.Client

GetHealthClient returns a healthclient for the provided URL

func (*ExternalServiceList) GetRendererClient

func (e *ExternalServiceList) GetRendererClient(rendererURL string) *renderer.Renderer

GetRendererClient creates a renderer Client

type HTTPServer

type HTTPServer interface {
	ListenAndServe() error
	Shutdown(ctx context.Context) error
}

HTTPServer defines the required methods from the HTTP server

type HealthChecker

type HealthChecker interface {
	AddCheck(name string, checker healthcheck.Checker) (err error)
	Handler(w http.ResponseWriter, req *http.Request)
	Start(ctx context.Context)
	Stop()
}

HealthChecker defines the required methods from Healthcheck

type Init

type Init struct{}

Init implements the Initialiser interface to initialise dependencies

func (*Init) DoGetHTTPServer

func (e *Init) DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer

DoGetHTTPServer creates an HTTP Server with the provided bind address and router

func (*Init) DoGetHealthCheck

func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

DoGetHealthCheck creates a healthcheck with versionInfo

func (*Init) DoGetHealthClient

func (e *Init) DoGetHealthClient(name, url string) *health.Client

DoGetHealthClient creates a new Health Client for the provided name and url

func (*Init) DoGetRendererClient

func (e *Init) DoGetRendererClient(rendererURL string) *renderer.Renderer

DoGetRendererClient creates a renderer Client

type Initialiser

type Initialiser interface {
	DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer
	DoGetHealthClient(name, url string) *health.Client
	DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)
	DoGetRendererClient(rendererURL string) *renderer.Renderer
}

Initialiser defines the methods to initialise external services

type Service

type Service struct {
	Config      *config.Config
	HealthCheck HealthChecker
	Server      HTTPServer
	ServiceList *ExternalServiceList
}

Service contains the healthcheck, server and serviceList for the controller

func New

func New() *Service

New creates a new service

func (*Service) Close

func (svc *Service) Close(ctx context.Context) error

Close gracefully shuts the service down in the required order, with timeout

func (*Service) Init

func (svc *Service) Init(ctx context.Context, cfg *config.Config, serviceList *ExternalServiceList) (err error)

Init initialises all the service dependencies, including healthcheck with checkers, api and middleware

func (*Service) Run

func (svc *Service) Run(ctx context.Context, svcErrors chan error)

Run starts an initialised service