intermediate

Documentation

Overview

Package intermediate serves as the foundation of the calculator.example microservice.

The Calculator microservice performs simple mathematical operations.

Index

• type Intermediate
  • func NewService(impl ToDo, version int) *Intermediate
  • func (svc *Intermediate) IncrementOpCount(num int, op string) error
• type Mock
  • func NewMock() *Mock
  • func (svc *Mock) Arithmetic(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)
  • func (svc *Mock) Distance(ctx context.Context, p1 calculatorapi.Point, p2 calculatorapi.Point) (d float64, err error)
  • func (svc *Mock) MockArithmetic(...) *Mock
  • func (svc *Mock) MockDistance(...) *Mock
  • func (svc *Mock) MockSquare(handler func(ctx context.Context, x int) (xEcho int, result int, err error)) *Mock
  • func (svc *Mock) OnShutdown(ctx context.Context) (err error)
  • func (svc *Mock) OnStartup(ctx context.Context) (err error)
  • func (svc *Mock) Square(ctx context.Context, x int) (xEcho int, result int, 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.

func (*Intermediate) IncrementOpCount

func (svc *Intermediate) IncrementOpCount(num int, op string) error

IncrementOpCount increments the value of the "calculator_op_count" metric. OpCount tracks the types of arithmetic calculations.

type Mock

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

Mock is a mockable version of the calculator.example 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) Arithmetic

func (svc *Mock) Arithmetic(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)

Arithmetic runs the mock handler set by MockArithmetic.

func (*Mock) Distance

func (svc *Mock) Distance(ctx context.Context, p1 calculatorapi.Point, p2 calculatorapi.Point) (d float64, err error)

Distance runs the mock handler set by MockDistance.

func (*Mock) MockArithmetic

func (svc *Mock) MockArithmetic(handler func(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)) *Mock

MockArithmetic sets up a mock handler for the Arithmetic endpoint.

func (*Mock) MockDistance

func (svc *Mock) MockDistance(handler func(ctx context.Context, p1 calculatorapi.Point, p2 calculatorapi.Point) (d float64, err error)) *Mock

MockDistance sets up a mock handler for the Distance endpoint.

func (*Mock) MockSquare

func (svc *Mock) MockSquare(handler func(ctx context.Context, x int) (xEcho int, result int, err error)) *Mock

MockSquare sets up a mock handler for the Square 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) Square

func (svc *Mock) Square(ctx context.Context, x int) (xEcho int, result int, err error)

Square runs the mock handler set by MockSquare.

type ToDo

type ToDo interface {
	OnStartup(ctx context.Context) (err error)
	OnShutdown(ctx context.Context) (err error)
	Arithmetic(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)
	Square(ctx context.Context, x int) (xEcho int, result int, err error)
	Distance(ctx context.Context, p1 calculatorapi.Point, p2 calculatorapi.Point) (d float64, err error)
}

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