ghttp

Documentation

Index

• func CombineHandlers(handlers ...http.HandlerFunc) http.HandlerFunc
• func RespondWith(statusCode int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc
• func RespondWithJSONEncoded(statusCode int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc
• func RespondWithJSONEncodedPtr(statusCode *int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc
• func RespondWithProto(statusCode int, message proto.Message, optionalHeader ...http.Header) http.HandlerFunc
• func RespondWithPtr(statusCode *int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc
• func VerifyBasicAuth(username string, password string) http.HandlerFunc
• func VerifyBody(expectedBody []byte) http.HandlerFunc
• func VerifyContentType(contentType string) http.HandlerFunc
• func VerifyForm(values url.Values) http.HandlerFunc
• func VerifyFormKV(key string, values ...string) http.HandlerFunc
• func VerifyHeader(header http.Header) http.HandlerFunc
• func VerifyHeaderKV(key string, values ...string) http.HandlerFunc
• func VerifyJSON(expectedJSON string) http.HandlerFunc
• func VerifyJSONRepresenting(object interface{}) http.HandlerFunc
• func VerifyMimeType(mimeType string) http.HandlerFunc
• func VerifyProtoRepresenting(expected proto.Message) http.HandlerFunc
• func VerifyRequest(method string, path interface{}, rawQuery ...string) http.HandlerFunc
• type GHTTPWithGomega
  • func NewGHTTPWithGomega(gomega Gomega) *GHTTPWithGomega
  • func (g GHTTPWithGomega) RespondWith(statusCode int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) RespondWithJSONEncoded(statusCode int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) RespondWithJSONEncodedPtr(statusCode *int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) RespondWithProto(statusCode int, message proto.Message, optionalHeader ...http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) RespondWithPtr(statusCode *int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyBasicAuth(username string, password string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyBody(expectedBody []byte) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyContentType(contentType string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyForm(values url.Values) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyFormKV(key string, values ...string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyHeader(header http.Header) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyHeaderKV(key string, values ...string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyJSON(expectedJSON string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyJSONRepresenting(object interface{}) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyMimeType(mimeType string) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyProtoRepresenting(expected proto.Message) http.HandlerFunc
  • func (g GHTTPWithGomega) VerifyRequest(method string, path interface{}, rawQuery ...string) http.HandlerFunc
• type Server
  • func NewServer() *Server
  • func NewTLSServer() *Server
  • func NewUnstartedServer() *Server
  • func (s *Server) Addr() string
  • func (s *Server) AppendHandlers(handlers ...http.HandlerFunc)
  • func (s *Server) Close()
  • func (s *Server) CloseClientConnections()
  • func (s *Server) GetAllowUnhandledRequests() bool
  • func (s *Server) GetHandler(index int) http.HandlerFunc
  • func (s *Server) GetUnhandledRequestStatusCode() int
  • func (s *Server) ReceivedRequests() []*http.Request
  • func (s *Server) Reset()
  • func (s *Server) RouteToHandler(method string, path interface{}, handler http.HandlerFunc)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (s *Server) SetAllowUnhandledRequests(allowUnhandledRequests bool)
  • func (s *Server) SetHandler(index int, handler http.HandlerFunc)
  • func (s *Server) SetUnhandledRequestStatusCode(statusCode int)
  • func (s *Server) Start()
  • func (s *Server) URL() string
  • func (s *Server) WrapHandler(index int, handler http.HandlerFunc)

Functions

func CombineHandlers

func CombineHandlers(handlers ...http.HandlerFunc) http.HandlerFunc

CombineHandler takes variadic list of handlers and produces one handler that calls each handler in order.

func RespondWith

func RespondWith(statusCode int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc

func RespondWithJSONEncoded

func RespondWithJSONEncoded(statusCode int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc

func RespondWithJSONEncodedPtr

func RespondWithJSONEncodedPtr(statusCode *int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc

func RespondWithProto

func RespondWithProto(statusCode int, message proto.Message, optionalHeader ...http.Header) http.HandlerFunc

func RespondWithPtr

func RespondWithPtr(statusCode *int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc

func VerifyBasicAuth

func VerifyBasicAuth(username string, password string) http.HandlerFunc

func VerifyBody

func VerifyBody(expectedBody []byte) http.HandlerFunc

func VerifyContentType

func VerifyContentType(contentType string) http.HandlerFunc

func VerifyForm

func VerifyForm(values url.Values) http.HandlerFunc

func VerifyFormKV

func VerifyFormKV(key string, values ...string) http.HandlerFunc

func VerifyHeader

func VerifyHeader(header http.Header) http.HandlerFunc

func VerifyHeaderKV

func VerifyHeaderKV(key string, values ...string) http.HandlerFunc

func VerifyJSON

func VerifyJSON(expectedJSON string) http.HandlerFunc

func VerifyJSONRepresenting

func VerifyJSONRepresenting(object interface{}) http.HandlerFunc

func VerifyMimeType

func VerifyMimeType(mimeType string) http.HandlerFunc

func VerifyProtoRepresenting

func VerifyProtoRepresenting(expected proto.Message) http.HandlerFunc

func VerifyRequest

func VerifyRequest(method string, path interface{}, rawQuery ...string) http.HandlerFunc

Types

type GHTTPWithGomega

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

func NewGHTTPWithGomega

func NewGHTTPWithGomega(gomega Gomega) *GHTTPWithGomega

func (GHTTPWithGomega) RespondWith

func (g GHTTPWithGomega) RespondWith(statusCode int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc

RespondWith returns a handler that responds to a request with the specified status code and body

Body may be a string or []byte

Also, RespondWith can be given an optional http.Header. The headers defined therein will be added to the response headers.

func (GHTTPWithGomega) RespondWithJSONEncoded

func (g GHTTPWithGomega) RespondWithJSONEncoded(statusCode int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc

RespondWithJSONEncoded returns a handler that responds to a request with the specified status code and a body containing the JSON-encoding of the passed in object

Also, RespondWithJSONEncoded can be given an optional http.Header. The headers defined therein will be added to the response headers.

func (GHTTPWithGomega) RespondWithJSONEncodedPtr

func (g GHTTPWithGomega) RespondWithJSONEncodedPtr(statusCode *int, object interface{}, optionalHeader ...http.Header) http.HandlerFunc

RespondWithJSONEncodedPtr behaves like RespondWithJSONEncoded but takes a pointer to a status code and object.

This allows different tests to share the same setup but specify different status codes and JSON-encoded objects.

Also, RespondWithJSONEncodedPtr can be given an optional http.Header. The headers defined therein will be added to the response headers. Since the http.Header can be mutated after the fact you don't need to pass in a pointer.

func (GHTTPWithGomega) RespondWithProto

func (g GHTTPWithGomega) RespondWithProto(statusCode int, message proto.Message, optionalHeader ...http.Header) http.HandlerFunc

RespondWithProto returns a handler that responds to a request with the specified status code and a body containing the protobuf serialization of the provided message.

Also, RespondWithProto can be given an optional http.Header. The headers defined therein will be added to the response headers.

func (GHTTPWithGomega) RespondWithPtr

func (g GHTTPWithGomega) RespondWithPtr(statusCode *int, body interface{}, optionalHeader ...http.Header) http.HandlerFunc

RespondWithPtr returns a handler that responds to a request with the specified status code and body

Unlike RespondWith, you pass RepondWithPtr a pointer to the status code and body allowing different tests to share the same setup but specify different status codes and bodies.

Also, RespondWithPtr can be given an optional http.Header. The headers defined therein will be added to the response headers. Since the http.Header can be mutated after the fact you don't need to pass in a pointer.

func (GHTTPWithGomega) VerifyBasicAuth

func (g GHTTPWithGomega) VerifyBasicAuth(username string, password string) http.HandlerFunc

VerifyBasicAuth returns a handler that verifies the request contains a BasicAuth Authorization header matching the passed in username and password

func (GHTTPWithGomega) VerifyBody

func (g GHTTPWithGomega) VerifyBody(expectedBody []byte) http.HandlerFunc

VerifyBody returns a handler that verifies that the body of the request matches the passed in byte array. It does this using Equal().

func (GHTTPWithGomega) VerifyContentType

func (g GHTTPWithGomega) VerifyContentType(contentType string) http.HandlerFunc

VerifyContentType returns a handler that verifies that a request has a Content-Type header set to the specified value

func (GHTTPWithGomega) VerifyForm

func (g GHTTPWithGomega) VerifyForm(values url.Values) http.HandlerFunc

VerifyForm returns a handler that verifies a request contains the specified form values.

The request must contain *all* of the specified values, but it is allowed to have additional form values beyond the passed in set.

func (GHTTPWithGomega) VerifyFormKV

func (g GHTTPWithGomega) VerifyFormKV(key string, values ...string) http.HandlerFunc

VerifyFormKV returns a handler that verifies a request contains a form key with the specified values.

It is a convenience wrapper around `VerifyForm` that lets you avoid having to create a `url.Values` object.

func (GHTTPWithGomega) VerifyHeader

func (g GHTTPWithGomega) VerifyHeader(header http.Header) http.HandlerFunc

VerifyHeader returns a handler that verifies the request contains the passed in headers. The passed in header keys are first canonicalized via http.CanonicalHeaderKey.

The request must contain *all* the passed in headers, but it is allowed to have additional headers beyond the passed in set.

func (GHTTPWithGomega) VerifyHeaderKV

func (g GHTTPWithGomega) VerifyHeaderKV(key string, values ...string) http.HandlerFunc

VerifyHeaderKV returns a handler that verifies the request contains a header matching the passed in key and values (recall that a `http.Header` is a mapping from string (key) to []string (values)) It is a convenience wrapper around `VerifyHeader` that allows you to avoid having to create an `http.Header` object.

func (GHTTPWithGomega) VerifyJSON

func (g GHTTPWithGomega) VerifyJSON(expectedJSON string) http.HandlerFunc

VerifyJSON returns a handler that verifies that the body of the request is a valid JSON representation matching the passed in JSON string. It does this using Gomega's MatchJSON method

VerifyJSON also verifies that the request's content type is application/json

func (GHTTPWithGomega) VerifyJSONRepresenting

func (g GHTTPWithGomega) VerifyJSONRepresenting(object interface{}) http.HandlerFunc

VerifyJSONRepresenting is similar to VerifyJSON. Instead of taking a JSON string, however, it takes an arbitrary JSON-encodable object and verifies that the requests's body is a JSON representation that matches the object

func (GHTTPWithGomega) VerifyMimeType

func (g GHTTPWithGomega) VerifyMimeType(mimeType string) http.HandlerFunc

VerifyMimeType returns a handler that verifies that a request has a specified mime type set in Content-Type header

func (GHTTPWithGomega) VerifyProtoRepresenting

func (g GHTTPWithGomega) VerifyProtoRepresenting(expected proto.Message) http.HandlerFunc

VerifyProtoRepresenting returns a handler that verifies that the body of the request is a valid protobuf representation of the passed message.

VerifyProtoRepresenting also verifies that the request's content type is application/x-protobuf

func (GHTTPWithGomega) VerifyRequest

func (g GHTTPWithGomega) VerifyRequest(method string, path interface{}, rawQuery ...string) http.HandlerFunc

VerifyRequest returns a handler that verifies that a request uses the specified method to connect to the specified path You may also pass in an optional rawQuery string which is tested against the request's `req.URL.RawQuery`

For path, you may pass in a string, in which case strict equality will be applied Alternatively you can pass in a matcher (ContainSubstring("/foo") and MatchRegexp("/foo/[a-f0-9]+") for example)

type Server

type Server struct {
	//The underlying httptest server
	HTTPTestServer *httptest.Server

	//Defaults to false.  If set to true, the Server will allow more requests than there are registered handlers.
	//Direct use of this property is deprecated and is likely to be removed, use GetAllowUnhandledRequests and SetAllowUnhandledRequests instead.
	AllowUnhandledRequests bool

	//The status code returned when receiving an unhandled request.
	//Defaults to http.StatusInternalServerError.
	//Only applies if AllowUnhandledRequests is true
	//Direct use of this property is deprecated and is likely to be removed, use GetUnhandledRequestStatusCode and SetUnhandledRequestStatusCode instead.
	UnhandledRequestStatusCode int

	//If provided, ghttp will log about each request received to the provided io.Writer
	//Defaults to nil
	//If you're using Ginkgo, set this to GinkgoWriter to get improved output during failures
	Writer io.Writer
	// contains filtered or unexported fields
}

func NewServer

func NewServer() *Server

NewServer returns a new `*ghttp.Server` that wraps an `httptest` server. The server is started automatically.

func NewTLSServer

func NewTLSServer() *Server

NewTLSServer returns a new `*ghttp.Server` that wraps an `httptest` TLS server. The server is started automatically.

func NewUnstartedServer

func NewUnstartedServer() *Server

NewUnstartedServer return a new, unstarted, `*ghttp.Server`. Useful for specifying a custom listener on `server.HTTPTestServer`.

func (*Server) Addr

func (s *Server) Addr() string

Addr() returns the address on which the server is listening.

func (*Server) AppendHandlers

func (s *Server) AppendHandlers(handlers ...http.HandlerFunc)

AppendHandlers will appends http.HandlerFuncs to the server's list of registered handlers. The first incoming request is handled by the first handler, the second by the second, etc...

func (*Server) Close

func (s *Server) Close()

Close() should be called at the end of each test. It spins down and cleans up the test server.

func (*Server) CloseClientConnections

func (s *Server) CloseClientConnections()

func (*Server) GetAllowUnhandledRequests

func (s *Server) GetAllowUnhandledRequests() bool

GetAllowUnhandledRequests returns true if the server accepts unhandled requests.

func (*Server) GetHandler

func (s *Server) GetHandler(index int) http.HandlerFunc

GetHandler returns the handler registered at the passed in index.

func (*Server) GetUnhandledRequestStatusCode

func (s *Server) GetUnhandledRequestStatusCode() int

GetUnhandledRequestStatusCode returns the current status code being returned for unhandled requests

func (*Server) ReceivedRequests

func (s *Server) ReceivedRequests() []*http.Request

ReceivedRequests is an array containing all requests received by the server (both handled and unhandled requests)

func (*Server) Reset

func (s *Server) Reset()

func (*Server) RouteToHandler

func (s *Server) RouteToHandler(method string, path interface{}, handler http.HandlerFunc)

RouteToHandler can be used to register handlers that will always handle requests that match the passed in method and path.

The path may be either a string object or a *regexp.Regexp.

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, req *http.Request)

ServeHTTP() makes Server an http.Handler When the server receives a request it handles the request in the following order:

1. If the request matches a handler registered with RouteToHandler, that handler is called.
2. Otherwise, if there are handlers registered via AppendHandlers, those handlers are called in order.
3. If all registered handlers have been called then: a) If AllowUnhandledRequests is set to true, the request will be handled with response code of UnhandledRequestStatusCode b) If AllowUnhandledRequests is false, the request will not be handled and the current test will be marked as failed.

func (*Server) SetAllowUnhandledRequests

func (s *Server) SetAllowUnhandledRequests(allowUnhandledRequests bool)

SetAllowUnhandledRequests enables the server to accept unhandled requests.

func (*Server) SetHandler

func (s *Server) SetHandler(index int, handler http.HandlerFunc)

SetHandler overrides the registered handler at the passed in index with the passed in handler This is useful, for example, when a server has been set up in a shared context, but must be tweaked for a particular test.

func (*Server) SetUnhandledRequestStatusCode

func (s *Server) SetUnhandledRequestStatusCode(statusCode int)

SetUnhandledRequestStatusCode status code to be returned when the server receives unhandled requests

func (*Server) Start

func (s *Server) Start()

Start() starts an unstarted ghttp server. It is a catastrophic error to call Start more than once (thanks, httptest).

func (*Server) URL

func (s *Server) URL() string

URL() returns a url that will hit the server

func (*Server) WrapHandler

func (s *Server) WrapHandler(index int, handler http.HandlerFunc)

WrapHandler combines the passed in handler with the handler registered at the passed in index. This is useful, for example, when a server has been set up in a shared context but must be tweaked for a particular test.

If the currently registered handler is A, and the new passed in handler is B then WrapHandler will generate a new handler that first calls A, then calls B, and assign it to index