testkit

package

v1.0.0 Latest Latest Go to latest Published: Sep 3, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Execute[Body any](t testing.TB, tc *TestCase) *netkit.Response[netkit.InternalBody[Body]]

Execute performs HTTP request to the target server The request URL must contain remote server address Parse the response to internal structure

func TestGin[Body any](t testing.TB, tc *TestCase, engine *gin.Engine) *netkit.Response[netkit.InternalBody[Body]]

TestGin executes test case with gin engine Parse the response to internal structure

type Assertion struct {
	StatusCode int
	Verdict    string
}

type ResponseRecorder struct {
	*httptest.ResponseRecorder
	// contains filtered or unexported fields
}

ResponseRecorder wraps recorder to support CloseNotify

func NewResponseRecorder() *ResponseRecorder

NewResponseRecorder returns a new instance

func (r *ResponseRecorder) CloseNotify() <-chan bool

CloseNotify waits for closed message This is required method for go-gin framework

type TestCase struct {
	Name      string
	Request   *http.Request
	Assertion *Assertion
}

TestCase is a test case for HTTP request

func NewTestCase(name string, method string, path string, expectedStatus int, expectedVerdict string) *TestCase

NewTestCase returns a new HTTP test case. Panic if error

func NewUploadTestCase(name string, path string, reader io.Reader, fields map[string]string, expectedStatus int, expectedVerdict string) *TestCase

NewUploadTestCase creates new upload test case

func (tc *TestCase) Execute(t testing.TB) *http.Response

Execute performs HTTP request to the target server The request URL must contain remote server address

func (tc *TestCase) WithBody(body interface{}) *TestCase

WithBody converts input to JSON and sets to request body

func (tc *TestCase) WithHeader(k, v string) *TestCase

WithHeader adds header

func (tc *TestCase) WithQuery(queries interface{}) *TestCase

WithQuery adds queries parameter. Support map and struct

func (tc *TestCase) WithToken(token string) *TestCase

WithToken sets bearer token