README
¶
V1.0.0
Syntax guide for V1.0.0 ersatz fixtures configuration.
Complete Syntax
version: Must be1.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: Response Object). Accepted HTTP Methods are get | put | post | delete. You must not specify the same HTTP Method twice, or the second will be overwritten.
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.expectations: Polymorphic property which supports passing either a single expectation, or multiple expectations in an array. Expectations check the request for providedheaderorqueryParamvalues. If multiple expectations are provided, at least one set of expectations must pass for ersatz to proceed.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Expectation ¶
type Expectation struct {
Headers ExpectedHeaders `json:"headers"`
QueryParams ExpectedQueryParams `json:"queryParams"`
}
Expectation contains expectations for the endpoint
func NewExpectation ¶
func NewExpectation() Expectation
NewExpectation returns a setup Expectation used for test cases.
type Expectations ¶
type Expectations []Expectation
func (Expectations) AtLeastOneExpectationPasses ¶
func (e Expectations) AtLeastOneExpectationPasses(r *http.Request) bool
AtLeastOneExpectationPasses verifies that for multiple expectations at least one passes successfully, allowing the simulation to proceed
func (*Expectations) UnmarshalJSON ¶
func (e *Expectations) UnmarshalJSON(d []byte) error
UnmarshalJSON allows expectations to be declared either as an array or as a singular expectation
type ExpectedHeaders ¶
type ExpectedHeaders struct {
textproto.MIMEHeader
}
ExpectedHeaders does what it says on the tin
func (*ExpectedHeaders) UnmarshalJSON ¶
func (e *ExpectedHeaders) UnmarshalJSON(d []byte) error
UnmarshalJSON supports non-array declaration of headers
type ExpectedQueryParams ¶
ExpectedQueryParams does what it says on the tin
func (*ExpectedQueryParams) UnmarshalJSON ¶
func (e *ExpectedQueryParams) UnmarshalJSON(d []byte) error
UnmarshalJSON supports non-array declaration of headers
type Resource ¶
type Resource struct {
Status int `json:"status"`
Headers map[string]string `json:"headers"`
Body interface{} `json:"body"`
Expectations Expectations `json:"expectations"`
}
Resource 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
Source Files