okapitest

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2026 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const UpdateGoldenEnv = "OKAPI_UPDATE_GOLDEN"

UpdateGoldenEnv is the environment variable that, set to 1, makes AssertOpenAPIGolden write the golden file instead of comparing with it.

Variables

This section is empty.

Functions

func AssertOpenAPIGolden added in v1.2.0

func AssertOpenAPIGolden(t *testing.T, app OpenAPIProvider, path string)

AssertOpenAPIGolden compares the OpenAPI 3.1 document of app with the golden file at path, and fails the test with the first difference. It keeps the documented API from drifting unnoticed: a change to it shows up in the golden file's diff.

Run the tests with OKAPI_UPDATE_GOLDEN=1 to write the golden file:

func TestOpenAPI(t *testing.T) {
    okapitest.AssertOpenAPIGolden(t, newApp(), "testdata/openapi.json")
}

func GracefulExitAfter added in v0.3.0

func GracefulExitAfter(duration time.Duration)

GracefulExitAfter sends the current process SIGTERM after duration, so a server that shuts down gracefully on signals, such as okapicli.RunServer, stops as if it had been terminated.

Types

type OpenAPIProvider added in v1.2.0

type OpenAPIProvider interface {
	OpenAPISpec() *openapi3.T
}

OpenAPIProvider builds an OpenAPI document. It is implemented by *okapi.Okapi.

type RequestBuilder

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

func DELETE

func DELETE(t *testing.T, url string) *RequestBuilder

func FromRecorder added in v0.1.3

func FromRecorder(t *testing.T, recorder interface{ Result() *http.Response }) *RequestBuilder

FromRecorder creates a RequestBuilder from a httptest.ResponseRecorder This is useful for testing handlers directly without making HTTP requests

func GET

func GET(t *testing.T, url string) *RequestBuilder
func HEAD(t *testing.T, url string) *RequestBuilder

func OPTIONS

func OPTIONS(t *testing.T, url string) *RequestBuilder

func PATCH

func PATCH(t *testing.T, url string) *RequestBuilder

func POST

func POST(t *testing.T, url string) *RequestBuilder

func PUT

func PUT(t *testing.T, url string) *RequestBuilder

func Request

func Request(t *testing.T) *RequestBuilder

func (*RequestBuilder) Body

func (rb *RequestBuilder) Body(body io.Reader) *RequestBuilder

func (*RequestBuilder) Execute

func (rb *RequestBuilder) Execute() (*http.Response, []byte)

Execute and return response for manual inspection

func (*RequestBuilder) ExpectBody

func (rb *RequestBuilder) ExpectBody(expected string) *RequestBuilder

func (*RequestBuilder) ExpectBodyContains

func (rb *RequestBuilder) ExpectBodyContains(substr string) *RequestBuilder

func (*RequestBuilder) ExpectBodyNotContains

func (rb *RequestBuilder) ExpectBodyNotContains(substr string) *RequestBuilder

func (*RequestBuilder) ExpectContains

func (rb *RequestBuilder) ExpectContains(substr string) *RequestBuilder

func (*RequestBuilder) ExpectContentType

func (rb *RequestBuilder) ExpectContentType(contentType string) *RequestBuilder

func (*RequestBuilder) ExpectCookie added in v0.4.0

func (rb *RequestBuilder) ExpectCookie(key, expectedValue string) *RequestBuilder

func (*RequestBuilder) ExpectCookieExist added in v0.4.0

func (rb *RequestBuilder) ExpectCookieExist(key string) *RequestBuilder

func (*RequestBuilder) ExpectEmptyBody

func (rb *RequestBuilder) ExpectEmptyBody() *RequestBuilder

func (*RequestBuilder) ExpectHeader

func (rb *RequestBuilder) ExpectHeader(key, value string) *RequestBuilder

func (*RequestBuilder) ExpectHeaderContains

func (rb *RequestBuilder) ExpectHeaderContains(key, substr string) *RequestBuilder

func (*RequestBuilder) ExpectHeaderExists

func (rb *RequestBuilder) ExpectHeaderExists(key string) *RequestBuilder

func (*RequestBuilder) ExpectJSON

func (rb *RequestBuilder) ExpectJSON(expected any) *RequestBuilder

func (*RequestBuilder) ExpectJSONPath

func (rb *RequestBuilder) ExpectJSONPath(path string, expected any) *RequestBuilder

func (*RequestBuilder) ExpectStatus

func (rb *RequestBuilder) ExpectStatus(code int) *RequestBuilder

func (*RequestBuilder) ExpectStatusAccepted

func (rb *RequestBuilder) ExpectStatusAccepted() *RequestBuilder

func (*RequestBuilder) ExpectStatusBadRequest

func (rb *RequestBuilder) ExpectStatusBadRequest() *RequestBuilder

func (*RequestBuilder) ExpectStatusConflict

func (rb *RequestBuilder) ExpectStatusConflict() *RequestBuilder

func (*RequestBuilder) ExpectStatusCreated

func (rb *RequestBuilder) ExpectStatusCreated() *RequestBuilder

func (*RequestBuilder) ExpectStatusForbidden

func (rb *RequestBuilder) ExpectStatusForbidden() *RequestBuilder

func (*RequestBuilder) ExpectStatusInternalServerError

func (rb *RequestBuilder) ExpectStatusInternalServerError() *RequestBuilder

func (*RequestBuilder) ExpectStatusNoContent

func (rb *RequestBuilder) ExpectStatusNoContent() *RequestBuilder

func (*RequestBuilder) ExpectStatusNotFound

func (rb *RequestBuilder) ExpectStatusNotFound() *RequestBuilder

func (*RequestBuilder) ExpectStatusOK

func (rb *RequestBuilder) ExpectStatusOK() *RequestBuilder

func (*RequestBuilder) ExpectStatusUnauthorized

func (rb *RequestBuilder) ExpectStatusUnauthorized() *RequestBuilder

func (*RequestBuilder) FormBody

func (rb *RequestBuilder) FormBody(values map[string]string) *RequestBuilder

func (*RequestBuilder) Header

func (rb *RequestBuilder) Header(k, v string) *RequestBuilder

func (*RequestBuilder) Headers

func (rb *RequestBuilder) Headers(headers map[string]string) *RequestBuilder

func (*RequestBuilder) JSONBody

func (rb *RequestBuilder) JSONBody(v any) *RequestBuilder

func (*RequestBuilder) Method

func (rb *RequestBuilder) Method(method string) *RequestBuilder

func (*RequestBuilder) ParseJSON

func (rb *RequestBuilder) ParseJSON(target any) *RequestBuilder

func (*RequestBuilder) Path

func (rb *RequestBuilder) Path(path string) *RequestBuilder

Path appends a path segment to the existing URL

func (*RequestBuilder) QueryParam added in v0.3.2

func (rb *RequestBuilder) QueryParam(key, value string) *RequestBuilder

func (*RequestBuilder) QueryParams added in v0.3.2

func (rb *RequestBuilder) QueryParams(params map[string]string) *RequestBuilder

func (*RequestBuilder) SetBasicAuth

func (rb *RequestBuilder) SetBasicAuth(username, password string) *RequestBuilder

func (*RequestBuilder) SetBearerAuth

func (rb *RequestBuilder) SetBearerAuth(token string) *RequestBuilder

func (*RequestBuilder) Timeout

func (rb *RequestBuilder) Timeout(timeout time.Duration) *RequestBuilder

func (*RequestBuilder) URL added in v0.1.3

func (rb *RequestBuilder) URL(url string) *RequestBuilder

URL sets the request URL

type TestClient added in v0.1.3

type TestClient struct {
	// BaseURL is the base URL for the test client.
	BaseURL string
	// Headers are the default headers to include in each request.
	Headers map[string]string
	// contains filtered or unexported fields
}

func NewClient added in v0.1.3

func NewClient(t *testing.T, baseURL string) *TestClient

NewClient creates a new TestClient with the specified base URL.

func (*TestClient) DELETE added in v0.1.3

func (tc *TestClient) DELETE(path string) *RequestBuilder

func (*TestClient) GET added in v0.1.3

func (tc *TestClient) GET(path string) *RequestBuilder

func (*TestClient) HEAD added in v0.1.3

func (tc *TestClient) HEAD(path string) *RequestBuilder

func (*TestClient) OPTIONS added in v0.1.3

func (tc *TestClient) OPTIONS(path string) *RequestBuilder

func (*TestClient) PATCH added in v0.1.3

func (tc *TestClient) PATCH(path string) *RequestBuilder

func (*TestClient) POST added in v0.1.3

func (tc *TestClient) POST(path string) *RequestBuilder

func (*TestClient) PUT added in v0.1.3

func (tc *TestClient) PUT(path string) *RequestBuilder

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL