test

Documentation

Index

• type Handler
• type MockHandler
  • func (m *MockHandler) Handle(method, path string, header *http.Header, body []byte) Response
• type Response
• type Server
  • func NewServer(handler Handler) *Server
  • func NewUnstartedServer(handler Handler) *Server
  • func (s *Server) Close()
  • func (s *Server) Start()
  • func (s *Server) URL() string

Types

type Handler

type Handler interface {
	Handle(method, path string, header *http.Header, body []byte) Response
}

Handler is the interface used by httpmock instead of http.Handler so that it can be mocked very easily.

type MockHandler

type MockHandler struct {
	mock.Mock
}

MockHandler is a test.Handler that uses github.com/stretchr/testify/mock.

func (*MockHandler) Handle

func (m *MockHandler) Handle(method, path string, header *http.Header, body []byte) Response

Handle makes this implement the Handler interface.

type Response

type Response struct {
	// The HTTP status code to write (default: 200)
	Status int
	// Headers to add to the response
	Header http.Header
	// The response body to write (default: no body)
	Body []byte
}

Response holds the response a handler wants to return to the client.

type Server

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

Server listens for requests and interprets them into calls to your Handler.

func NewServer

func NewServer(handler Handler) *Server

NewServer constructs a new server and starts it (compare to httptest.NewServer). It needs to be Closed()ed.

func NewUnstartedServer

func NewUnstartedServer(handler Handler) *Server

NewUnstartedServer constructs a new server but doesn't start it (compare to httptest.NewUnstartedServer).

func (*Server) Close

func (s *Server) Close()

Close shuts down a started server.

func (*Server) Start

func (s *Server) Start()

Start starts an unstarted server.

func (*Server) URL

func (s *Server) URL() string

URL is the URL for the local test server, i.e. the value of httptest.Server.URL