donut.endpoint.test.harness — party.donut/endpoint-test 0.0.25

Includes:

• Macros and a fixture for dealing with a system for the duration of a test
• Helpers for composing and dispatching requests
• read-body multimethod for parsing response bodies of different types (transit, json etc)
• assertions that work with response segments

BaseRequest clj

comparison-entities clj

(comparison-entities test-ent-attrs resp-data)

Returns a set that can be used to test if test-ent-attrs is contained in a response

configured-value clj

(configured-value config-key)

Look up a component instance that has path configured by the ::config component group

contains-entity? clj

(contains-entity? resp-data test-ent-attrs)

Request's response data has a map with key/value pairs identical to test-ent-attrs.

content-type-request clj multimethod

Entities clj

Entity clj

handle-request clj

(handle-request & args)

Perform a request with the system's ring handler. Args are the same as those for request.

handler clj

(handler)

Retrieve endpoint handler from ds/system. Relies on :donut/http-handler being set in the system's ::ds/registry

headers clj

(headers req headers)

Add all headers to request

Method clj

prep-comparison clj

(prep-comparison resp-entity test-ent-attrs)

When testing whether a response contains test-ent-attrs, we modify a response entity by:

1. selecting only the keys that are present in test-ent-attrs. This allows us to do an = comparison that won't fail if the response entity contains attributes we don't want to test.

2. Putting the result in a map to handle case where resp-entity is a record.

read-body clj multimethod

Decodes a response body, transforming it from JSON or whatever back into Clojure, which we love

Request clj

request clj

(request {:keys [path route-name route-params query-params content-type]
          :as req-map})

(request method path-or-route-name & [route-params body-params query-params])

Construct a ring.mock.request/request using your ds/system router to build a path. Adds content-type and accept headers.

Single-arity version takes a map with:

  :method HTTP method
    :path string; use if you don't want to use router to build path

:route-name used to build path :route-params map to populate your route's params, e.g. :book/id in /api/books {book/id} :query-params map to add a query string :body-params the data for your request

Response clj

response clj

Handles a request and reads the body. Arugments same as request.

response-entities clj

(response-entities resp-data)

Walk response data and return all entities from entity segments

route-path clj

(route-path route-name)

(route-path route-name route-params)

(route-path route-name route-params query-params)

Construct a path like /api/v1/books/1. Can also build query string.

RouteIdentifier clj

router clj

(router)

Retrieve endpoint router from ds/system. Relies on :donut/endpoint-router being set in the system's ::ds/registry

Segment clj

Segments clj

system clj

(system)

Get ds/system and throw when it's not set. Used by other helpers. Intention is to reduce the boilerplate of system retrieval in your tests.

test-harness-plugin clj