lysclient

README

lysclient

Types and functions to help test a REST API which was created using lys functions.

Documentation

Overview

Package lysclient contains types and functions to help test a REST API which was created using lys functions.

Index

• func DoToValue[T any](ctx context.Context, client http.Client, method string, targetUrl string) (val T, err error)
• func DoToValueTester[T any](ctx context.Context, h http.Handler, method string, targetUrl string) (val T, err error)
• func GetArray[T any](client http.Client, targetUrl string) (arr []T, err error)
• func GetArrayTester[T any](ctx context.Context, h http.Handler, targetUrl string) (arr []T, err error)
• func MustDoToValue[T any](ctx context.Context, t testing.TB, h http.Handler, method string, ...) (val T)
• func MustGetArray[T any](ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (arr []T)
• func MustGetFile(ctx context.Context, t testing.TB, h http.Handler, targetUrl string)
• func MustGetValue[T any](ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (val T)
• func MustPostToValue[inT, outT any](ctx context.Context, t testing.TB, h http.Handler, method string, ...) (val outT)
• func PostArrayToValueTester[inT, outT any](ctx context.Context, h http.Handler, method string, targetUrl string, ...) (val outT, err error)
• func PostToValue[inT, outT any](ctx context.Context, client http.Client, method string, targetUrl string, ...) (val outT, err error)
• func PostToValueTester[inT, outT any](ctx context.Context, h http.Handler, method string, targetUrl string, item inT) (val outT, err error)
• type ArrayResp
• type GetMetadata
• type ItemAResp
  • func GetItemResp(client http.Client, targetUrl string) (itemResp ItemAResp, err error)
  • func GetItemRespTester(ctx context.Context, h http.Handler, targetUrl string) (itemResp ItemAResp, err error)
  • func MustGetItemResp(ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (itemResp ItemAResp)
• type ValueResp

Functions

func DoToValue

func DoToValue[T any](ctx context.Context, client http.Client, method string, targetUrl string) (val T, err error)

DoToValue sends a request without a body to targetUrl. It expects a T in response

func DoToValueTester

func DoToValueTester[T any](ctx context.Context, h http.Handler, method string, targetUrl string) (val T, err error)

DoToValueTester sends a request without a body to targetUrl using a test handler. It expects a T in response

func GetArray

func GetArray[T any](client http.Client, targetUrl string) (arr []T, err error)

GetArray GETs the target Url. It expects an array of T in response

func GetArrayTester

func GetArrayTester[T any](ctx context.Context, h http.Handler, targetUrl string) (arr []T, err error)

GetArrayTester GETs the target Url using a test handler. It expects an array of T in response

func MustDoToValue

func MustDoToValue[T any](ctx context.Context, t testing.TB, h http.Handler, method string, targetUrl string) (val T)

MustDoToValue sends a request without a body to targetUrl using a test handler. It expects a T in response and will fail on any error

func MustGetArray

func MustGetArray[T any](ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (arr []T)

MustGetArray GETs the target Url using a test handler. It expects an array of T in response and will fail on any error

func MustGetFile

func MustGetFile(ctx context.Context, t testing.TB, h http.Handler, targetUrl string)

MustGetFile GETs the target Url using a test handler. It expects a response with file output headers and will fail on any error

func MustGetValue

func MustGetValue[T any](ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (val T)

MustGetValue GETs the target Url using a test handler. It expects a single T in response and will fail on any error

func MustPostToValue

func MustPostToValue[inT, outT any](ctx context.Context, t testing.TB, h http.Handler, method string, targetUrl string, item inT) (val outT)

MustPostToValue sends a POST/PUT/PATCH request to targetUrl using a test handler with an inT as the body. It expects an outT in response and will fail on any error

func PostArrayToValueTester

func PostArrayToValueTester[inT, outT any](ctx context.Context, h http.Handler, method string, targetUrl string, items []inT) (val outT, err error)

PostArrayToValueTester sends a POST/PUT/PATCH request to targetUrl using a test handler with an inT slice as the body. It expects an outT in response

func PostToValue

func PostToValue[inT, outT any](ctx context.Context, client http.Client, method string, targetUrl string, item inT) (val outT, err error)

PostToValue sends a POST/PUT/PATCH request to targetUrl with an inT as the body. It expects an outT in response

func PostToValueTester

func PostToValueTester[inT, outT any](ctx context.Context, h http.Handler, method string, targetUrl string, item inT) (val outT, err error)

PostToValueTester sends a POST/PUT/PATCH request to targetUrl using a test handler with an inT as the body. It expects an outT in response

Types

type ArrayResp

type ArrayResp[T any] struct {
	Status         string `json:"status"`
	Data           []T    `json:"data"`
	ErrDescription string `json:"err_description"`
}

ArrayResp is expected when StdResponse returns an array of T

type GetMetadata

type GetMetadata struct {
	Count                 int   `json:"count"`
	TotalCount            int64 `json:"total_count"`
	TotalCountIsEstimated bool  `json:"total_count_is_estimated"`
}

GetMetadata contains the metadata for a GET request which returns an array of items (db records)

type ItemAResp

type ItemAResp struct {
	Status         string           `json:"status"`
	Data           []map[string]any `json:"data"`
	GetMetadata    *GetMetadata     `json:"metadata,omitempty"` // only used for GET many
	ErrDescription string           `json:"err_description"`
}

ItemAResp is expected when StdResponse returns an array of items (db records)

func GetItemResp

func GetItemResp(client http.Client, targetUrl string) (itemResp ItemAResp, err error)

GetItemResp GETs the target Url. It expects an array of items in response

func GetItemRespTester

func GetItemRespTester(ctx context.Context, h http.Handler, targetUrl string) (itemResp ItemAResp, err error)

GetItemRespTester GETs the target Url using a test handler. It expects an array of items in response

func MustGetItemResp

func MustGetItemResp(ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (itemResp ItemAResp)

MustGetItemResp GETs the target Url using a test handler. It expects an array of items in response and will fail on any error

type ValueResp

type ValueResp[T any] struct {
	Status         string `json:"status"`
	Data           T      `json:"data"`
	ErrDescription string `json:"err_description"`
}

ValueResp is expected when StdResponse returns a T