test

type APICall struct {
	// http.Handler to run the call against
	Handler http.Handler

	// HTTP method, e.g. http.MethodPatch
	Method string

	// Request Path
	Path string

	// Request body. If nil, an empty body is sent
	RequestBody RequestBody

	// Request header. If nil, default header is sent
	Header http.Header

	// Request context. If nil, default context is used
	Context context.Context

	// Status that's expected to be received. If set to 0, the status is not checked
	ExpectedStatus int

	// Validator for the response body. If set to nil, the body is not validated
	ExpectedBody BodyValidator
}

type APICallResult struct {
	// Full body as read from the server
	Body []byte

	// Status code returned from the server
	StatusCode int
}

type BodyValidator interface {
	// Validate returns nil if the body is valid. If the body isn't valid, a descriptive error is returned.
	Validate(body []byte) error
}

type JSONRequestBody string

type JSONValidator struct {
	// Content is the expected json content of the body
	//
	// Note that the key order of maps is arbitrary
	Content string

	// IgnoreFields is a list of JSON keys that should be removed from both expected body and actual body
	IgnoreFields []string
}

type RequestBody interface {
	// Body returns the intended request body as a slice of bytes
	Body() []byte

	// ContentType returns value for Content-Type request header
	ContentType() string
}