httptest

Documentation

Index

• type Header
  • func (h *Header) View() http.Header
• type ResponseRecorder
  • func NewRecorder() *ResponseRecorder
  • func (rw *ResponseRecorder) Header() pkgHTTP.Header
  • func (rw *ResponseRecorder) ID() uint32
  • func (rw *ResponseRecorder) ReadBody() ([]byte, error)
  • func (rw *ResponseRecorder) StatusCode() int
  • func (rw *ResponseRecorder) Var(key string) ([]byte, error)
  • func (rw *ResponseRecorder) Write(buf []byte) (int, error)
  • func (rw *ResponseRecorder) WriteHeader(code int)

Types

type Header

type Header struct {
	http.Header
}

func (*Header) View

func (h *Header) View() http.Header

type ResponseRecorder

type ResponseRecorder struct {
	// Code is the HTTP response code set at initialization.
	Code int

	// HeaderMap contains the headers explicitly set by the Handler.
	// It is an internal detail.
	HeaderMap pkgHTTP.Header

	// Body is the buffer to which the Handler's Write calls are sent.
	// If nil, the Writes are silently discarded.
	Body *bytes.Buffer

	// OriginBody is the response body received by APISIX from upstream.
	OriginBody []byte

	Vars map[string][]byte
	// contains filtered or unexported fields
}

ResponseRecorder is an implementation of pkgHTTP.Response that records its mutations for later inspection in tests.

func NewRecorder

func NewRecorder() *ResponseRecorder

NewRecorder returns an initialized ResponseRecorder.

func (*ResponseRecorder) Header

func (rw *ResponseRecorder) Header() pkgHTTP.Header

Header implements pkgHTTP.Response. It returns the response headers to mutate within a handler.

func (*ResponseRecorder) ID

func (rw *ResponseRecorder) ID() uint32

ID is APISIX rpc's id.

func (*ResponseRecorder) ReadBody

func (rw *ResponseRecorder) ReadBody() ([]byte, error)

ReadBody implements pkgHTTP.Response.

func (*ResponseRecorder) StatusCode

func (rw *ResponseRecorder) StatusCode() int

StatusCode returns the response code.

Note that if a Handler never calls WriteHeader, this will be initial status code, rather than the implicit http.StatusOK.

func (*ResponseRecorder) Var

func (rw *ResponseRecorder) Var(key string) ([]byte, error)

Var implements pkgHTTP.Response.

func (*ResponseRecorder) Write

func (rw *ResponseRecorder) Write(buf []byte) (int, error)

Write implements pkgHTTP.Response. The data in buf is written to rw.Body, if not nil.

func (*ResponseRecorder) WriteHeader

func (rw *ResponseRecorder) WriteHeader(code int)

WriteHeader implements pkgHTTP.Response. The statusCode is only allowed to be written once.