README
¶
V2.0.0
Syntax guide for V2.0.0 ersatz fixtures configuration.
Complete Syntax
version: Must be2.0.0.fixtures: A map (key: endpoint path, value: Resource object), which contains the fixtures you wish to configure.
Resource Object
A map (key: HTTP Method, value: Either Response Object or Request Discriminator Object. Accepted HTTP Methods are get | put | post | delete. You must not specify the same HTTP Method twice, or the second will be overwritten.
Values may either be a single Response object, or many Request Discriminator objects. Request Discriminators are declared in an array, and allow you to specify different responses for different requests (discriminated by request properties other than the Path).
Discriminators are matched in order; if many discriminators match the same request, the first will be used.
Response Object
- Required
status: The http status code to return in response. headers: Headers to return in the response. IfContent-Typeis set, this will dictate the format of the body. Supported content types areapplication/json | text/plain | application/x-yamlbody: Polymorphic property, which supports values either of type string (should be used fortext/plainresponses) or of type Object, which will be serialised by default to JSON.
Request Discriminator Object
- Required
when: Contains eitherheadersorqueryParamswhich are used to identify which response to use for the request.headers: A map (key: string, value: string) of headers to look for the in the request.queryParams: A map (key: string, value: string) of query parameters to look for the in the request.
- Required
response: A Response Object which will be used if the request matches the headers and query parameters specified.
Additionally, values included in the when statement can take the following formats:
${exists}: Specifies that any value is acceptable for the header or query parameter, but it must be present.${missing}: Specifies that the value must not be present in the request.
Documentation
¶
Index ¶
- func Contains(expected string, actual ...string) bool
- func Exists(value string) bool
- func Missing(value string) bool
- func MockPaths(r Router, paths *Fixtures)
- type Discriminator
- type Discriminators
- type Fixtures
- type Headers
- type Path
- type QueryParams
- type RequestDiscriminator
- type Resource
- type Response
- type Router
- type TemplatedFunction
- type TemplatedValues
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Discriminator ¶
type Discriminator struct {
When RequestDiscriminator `json:"when"`
Response Response `json:"response"`
}
type Discriminators ¶
type Discriminators []Discriminator
func (Discriminators) AtLeastOneDiscriminatorIsSatisfied ¶
func (arr Discriminators) AtLeastOneDiscriminatorIsSatisfied(req *http.Request) bool
type Headers ¶
type Headers struct {
textproto.MIMEHeader
TemplatedValues TemplatedValues
}
Headers does what it says on the tin
func (*Headers) UnmarshalJSON ¶
UnmarshalJSON creates a textproto.MIMEHeader compliant struct using provided map values
type QueryParams ¶
type QueryParams struct {
url.Values
TemplatedValues TemplatedValues
}
QueryParams does what it says on the tin
func (*QueryParams) UnmarshalJSON ¶
func (q *QueryParams) UnmarshalJSON(d []byte) error
UnmarshalJSON creates a url.Values compliant struct using the provided map values
type RequestDiscriminator ¶
type RequestDiscriminator struct {
Headers Headers `json:"headers"`
QueryParams QueryParams `json:"queryParams"`
}
func NewRequestDiscriminator ¶
func NewRequestDiscriminator() RequestDiscriminator
func (RequestDiscriminator) SatisfiesDiscriminator ¶
func (r RequestDiscriminator) SatisfiesDiscriminator(req *http.Request) bool
type Resource ¶
type Resource struct {
Discriminators Discriminators
Response Response
}
func (*Resource) UnmarshalJSON ¶
type Response ¶
type Response struct {
Status int `json:"status"`
Headers map[string]string `json:"headers"`
Body interface{} `json:"body"`
}
Response mocks a particular http method for a given path
type Router ¶
type Router interface {
Get(path string, handler http.HandlerFunc, middleware ...vestigo.Middleware)
Put(path string, handler http.HandlerFunc, middleware ...vestigo.Middleware)
Post(path string, handler http.HandlerFunc, middleware ...vestigo.Middleware)
Delete(path string, handler http.HandlerFunc, middleware ...vestigo.Middleware)
}
Router allows us to test that paths are configured properly
type TemplatedFunction ¶
type TemplatedValues ¶
type TemplatedValues map[string]TemplatedFunction
TemplatedValues holds "special" values which can be used for fuzzy discriminators - i.e. ${exists} checks for the existence of the header
func ParseRequestValues ¶
func ParseRequestValues(rawValues map[string]string) (TemplatedValues, map[string]string)
Source Files