Check that a server satisfies the set of properties specified.

Note that, rather than having separate tests for each property you'd like to test, you should generally prefer to combine all properties into a single test. This enables a more parsimonious generation of requests and responses with the same testing depth.

Example usage:

goodAPISpec = describe "my server" $ do

  it "follows best practices" $ do
    withServantServer api server $ \burl ->
      serverSatisfies api burl stdArgs (not500
                                    <%> onlyJsonObjects
                                    <%> notAllowedContainsAllowHeader
                                    <%> mempty)

Since 0.0.0.0

Best Practice

500 Internal Server Error should be avoided - it may represent some issue with the application code, and it moreover gives the client little indication of how to proceed or what went wrong.

This function checks that the response code is not 500.

Since 0.0.0.0

Optional

This function checks that the response from the server does not take longer than the specified number of nanoseconds.

Since 0.0.2.1

Best Practice

Returning anything other than an object when returning JSON is considered bad practice, as:

1. it is hard to modify the returned value while maintaining backwards compatibility
2. many older tools do not support top-level arrays
3. whether top-level numbers, booleans, or strings are valid JSON depends on what RFC you're going by
4. there are security issues with top-level arrays

This function checks that any application/json responses only return JSON objects (and not arrays, strings, numbers, or booleans) at the top level.

References:

• JSON Grammar: RFC 7159 Section 2
• JSON Grammar: RFC 4627 Section 2

Since 0.0.0.0

RFC Compliance

When a request contains an Accept header, the server must either return content in one of the requested representations, or respond with 406 Not Acceptable.

This function checks that every *successful* response has a Content-Type header that matches the Accept header. It does *not* check that the server matches the quality descriptions of the Accept header correctly.

References:

• Accept header: RFC 2616 Section 14.1

Since 0.0.0.0

RFC Compliance

When an HTTP request has a method that is not allowed, a 405 response should be returned. Additionally, it is good practice to return an Allow header with the list of allowed methods.

This function checks that every 405 Method Not Allowed response contains an Allow header with a list of standard HTTP methods.

Note that servant itself does not currently set the Allow headers.

References:

• Allow header: RFC 2616 Section 14.7
• Status 405: RFC 2616 Section 10.4.6
• Servant Allow header issue: Issue #489

Since 0.0.0.0

RFC Compliance

Any 401 Unauthorized response must include a WWW-Authenticate header.

This function checks that, if a response has status code 401, it contains a WWW-Authenticate header.

References:

• WWW-Authenticate header: RFC 7235 Section 4.1

Since 0.0.0.0

Optional

The Last-Modified header represents the time a resource was last modified. It is used to drive caching and conditional requests.

When using this mechanism, the server adds the Last-Modified header to responses. Clients may then make requests with the If-Modified-Since header to conditionally request resources. If the resource has not changed since that date, the server responds with a status code of 304 (Not Modified) without a response body.

The Last-Modified header can also be used in conjunction with the If-Unmodified-Since header to drive optimistic concurrency.

The Last-Modified date must be in RFC 822 format.

References:

• 304 Not Modified: RFC 7232 Section 4.1
• Last-Modified header: RFC 7232 Section 2.2
• If-Modified-Since header: RFC 7232 Section 3.3
• If-Unmodified-Since header: RFC 7232 Section 3.4
• Date format: RFC 2616 Section 3.3

Since 0.0.2.1

Best Practice

Whether or not a representation should be cached, it is good practice to have a Cache-Control header for GET requests. If the representation should not be cached, used Cache-Control: no-cache.

This function checks that GET responses have Cache-Control header. It does NOT currently check that the header is valid.

References:

• Cache-Control header: RFC 7234 Section 5.2

Since 0.0.0.0

Best Practice

Like getsHaveCacheControlHeader, but for HEAD requests.

Since 0.0.0.0

Optional

When creating a new resource, it is good practice to provide a Location header with a link to the created resource.

This function checks that every 201 Created response contains a Location header, and that the link in it responds with a 2XX response code to GET requests.

This is considered optional because other means of linking to the resource (e.g. via the response body) are also acceptable; linking to the resource in some way is considered best practice.

References:

• 201 Created: RFC 7231 Section 6.3.2
• Location header: RFC 7231 Section 7.1.2

Since 0.0.0.0

RFC Compliance

An HTML

document will start with exactly this string: html

This function checks that HTML documents (those with `Content-Type: text/html...`) include a DOCTYPE declaration at the top. We do not enforce capital case for the string DOCTYPE.

References:

• HTML5 Doctype: RFC 7992 Section 6.1 Since 0.3.0.0

Adds a new predicate (either ResponsePredicate or RequestPredicate) to the existing predicates.

not500 <%> onlyJsonObjects <%> empty

Since 0.0.0.0

A set of predicates. Construct one with mempty and <%>.

A predicate that depends only on the response.

Since 0.0.0.0

A predicate that depends on both the request and the response.

Since 0.0.0.0

Check that the two servers running under the provided BaseUrls behave identically by randomly generating arguments (captures, query params, request bodies, headers, etc.) expected by the server. If, given the same request, the response is not the same (according to the definition of == for the return datatype), the Expectation fails, printing the counterexample.

The Int argument specifies maximum number of test cases to generate and run.

Evidently, if the behaviour of the server is expected to be non-deterministic, this function may produce spurious failures

Note that only valid requests are generated and tested. As an example of why this matters, let's say your API specifies that a particular endpoint can only generate JSON. serversEqual will then not generate any requests with an Accept header _other_ than application/json. It may therefore fail to notice that one application, when the request has Accept: text/html, returns a 406 Not Acceptable HTTP response, and another returns a 200 Success, but with application/json as the content-type.

The fact that only valid requests are tested also means that no endpoints not listed in the API type are tested.

Since 0.0.0.0

ByteString Eq instance over the response body.

Since 0.0.0.0

Equality as Value. This means that if two bodies are equal as JSON (e.g., insignificant whitespace difference) they are considered equal.

Since 0.0.3.0

Use Eq instance for Response

Since 0.0.0.0

Start a servant application on an open port, run the provided function, then stop the application.

Since 0.0.0.0

Like withServantServer, but allows passing in a Context to the application.

Since 0.0.0.0

QuickCheck Args with 1000 rather than 100 test cases.

Since 0.0.0.0

Simple data type to represent the target of HTTP requests for servant's automatically-generated clients.

URI scheme to use

Args specifies arguments to the QuickCheck driver

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the 'undefined :: a' idiom.

>>> Proxy :: Proxy (Void, Int -> Int)
Proxy

Proxy can even hold types of higher kinds,

>>> Proxy :: Proxy Either
Proxy

>>> Proxy :: Proxy Functor
Proxy

>>> Proxy :: Proxy complicatedStructure
Proxy