server

Documentation

Index

• type Controller
• type MockController
  • func NewMockController(ctrl *gomock.Controller) *MockController
  • func (_m *MockController) EXPECT() *_MockControllerRecorder
  • func (_m *MockController) NilCheck(ctx context.Context, i *models.NilCheckInput) error
• type Server
  • func New(c Controller, addr string) *Server
  • func NewWithMiddleware(c Controller, addr string, m []func(http.Handler) http.Handler) *Server
  • func (s *Server) Serve() error

Types

type Controller

type Controller interface {

	// NilCheck makes a POST request to /check/{id}
	// Nil check tests
	// 200: nil
	// 400: *models.BadRequest
	// 500: *models.InternalError
	// default: client side HTTP errors, for example: context.DeadlineExceeded.
	NilCheck(ctx context.Context, i *models.NilCheckInput) error
}

Controller defines the interface for the nil-test service.

type MockController

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

Mock of Controller interface

func NewMockController

func NewMockController(ctrl *gomock.Controller) *MockController

func (*MockController) EXPECT

func (_m *MockController) EXPECT() *_MockControllerRecorder

func (*MockController) NilCheck

func (_m *MockController) NilCheck(ctx context.Context, i *models.NilCheckInput) error

type Server

type Server struct {
	// Handler should generally not be changed. It exposed to make testing easier.
	Handler http.Handler
	// contains filtered or unexported fields
}

Server defines a HTTP server that implements the Controller interface.

func New

func New(c Controller, addr string) *Server

New returns a Server that implements the Controller interface. It will start when "Serve" is called.

func NewWithMiddleware

func NewWithMiddleware(c Controller, addr string, m []func(http.Handler) http.Handler) *Server

NewWithMiddleware returns a Server that implemenets the Controller interface. It runs the middleware after the built-in middleware (e.g. logging), but before the controller methods. The middleware is executed in the order specified. The server will start when "Serve" is called.

func (*Server) Serve

func (s *Server) Serve() error

Serve starts the server. It will return if an error occurs.