testutils

Documentation

Index

• Constants
• func BoolToPtr(v bool) *bool
• func HandleReqWithBody(t *testing.T, opts *HandleReqOpts)
• func HandleReqWithoutBody(t *testing.T, opts *HandleReqOpts)
• type HandleReqOpts
• type TestEnv
  • func SetupTestEnv() *TestEnv
  • func (testEnv *TestEnv) TearDownTestEnv()

Constants

const (
	UserAgent = "mks-go/user-agent"
	TokenID   = "test-token"
)

Functions

func BoolToPtr

func BoolToPtr(v bool) *bool

BoolToPtr can be used to convert boolean value to boolean pointer.

func HandleReqWithBody

func HandleReqWithBody(t *testing.T, opts *HandleReqOpts)

HandleReqWithBody provides the HTTP endpoint to test requests with body.

func HandleReqWithoutBody

func HandleReqWithoutBody(t *testing.T, opts *HandleReqOpts)

HandleReqWithoutBody provides the HTTP endpoint to test requests without body.

Types

type HandleReqOpts

type HandleReqOpts struct {
	// Mux represents HTTP Mux for a testing handler.
	Mux *http.ServeMux

	// URL represents handler's HTTP URL.
	URL string

	// RawResponse represents raw string HTTP response that needs to be returned
	// by the handler.
	RawResponse string

	// RawRequest represents raw string HTTP request that needs to be compared
	// with the actual request that will be provided by the caller.
	RawRequest string

	// Method contains HTTP method that needs to be compared against real method
	// provided by the caller.
	Method string

	// Status represents HTTP status that will be returned by the handler.
	Status int

	// CallFlag can be used to check if caller sent a request to a handler.
	CallFlag *bool
}

HandleReqOpts represents options for the testing utils package handlers.

type TestEnv

type TestEnv struct {
	Mux    *http.ServeMux
	Server *httptest.Server
}

TestEnv represents a testing environment for all resources.

func SetupTestEnv

func SetupTestEnv() *TestEnv

SetupTestEnv prepares the new testing environment.

func (*TestEnv) TearDownTestEnv

func (testEnv *TestEnv) TearDownTestEnv()

TearDownTestEnv releases the testing environment.