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 GetSlice[T any](client http.Client, targetUrl string) (s []T, err error)
• func GetSliceTester[T any](ctx context.Context, h http.Handler, targetUrl string) (s []T, err error)
• func MustDoToValue[T any](ctx context.Context, t testing.TB, h http.Handler, method string, ...) (val T)
• func MustGetFile(ctx context.Context, t testing.TB, h http.Handler, targetUrl string)
• func MustGetFileWithHeaders(ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (body []byte, headers http.Header)
• func MustGetSlice[T any](ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (s []T)
• 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 PostSliceToValueTester[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 GetMetadata
• type ItemSResp
  • func GetItemResp(client http.Client, targetUrl string) (itemResp ItemSResp, err error)
  • func GetItemRespTester(ctx context.Context, h http.Handler, targetUrl string) (itemResp ItemSResp, err error)
  • func MustGetItemResp(ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (itemResp ItemSResp)
• type SliceResp
• 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 GetSlice

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

GetSlice GETs the target Url. It expects a slice of T in response

func GetSliceTester

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

GetSliceTester GETs the target Url using a test handler. It expects a slice 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 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 MustGetFileWithHeaders

func MustGetFileWithHeaders(ctx context.Context, t testing.TB, h http.Handler, targetUrl string) (body []byte, headers http.Header)

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

func MustGetSlice

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

MustGetSlice GETs the target Url using a test handler. It expects a slice of T in response 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 PostSliceToValueTester

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

PostSliceToValueTester 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 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 a slice of items (db records)

type ItemSResp

type ItemSResp 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"`
}

ItemSResp is expected when StdResponse returns a slice of map[string]any

func GetItemResp

func GetItemResp(client http.Client, targetUrl string) (itemResp ItemSResp, 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 ItemSResp, 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 ItemSResp)

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

type SliceResp

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

SliceResp is expected when StdResponse returns a slice of T

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