fixpoint.core
Fixture Functions and Protocols
as
(as data document-id)Declare the given fixture’s reference ID, which can be used from within other fixtures.
4 |(defn person
5 | [reference name]
6 | (-> {:db/table :people
7 | :name name}
8 | (as reference)
9 | (on-datasource :db)))
10 |
11 | (defn post
12 | [reference author-reference text]
13 | (-> {:db/table :posts
14 | :author-id author-reference
15 | :text text}
16 | (as reference)
17 | (on-datasource :db)))
18 | A simple set of fixtures could be:
20 |[(person :person/me "me")
21 | (post :post/happy :person/me "yay!")]
22 | You can also reference specific fields of other documents using a vector notation, e.g. to declare a post with the same author as :post/happy:
(post :post/again [:post/happy :author-id] "still yay!")
25 | Note that every reference ID can be used exactly once.
by-namespace
(by-namespace nspace & path)Retrieve a property for each entity whose reference (attached using as) has the given namespace.
27 |(with-datasource [ds (pg/make-datasource :db ...)]
28 | (with-data [(person :person/me "me")
29 | (person :person/you "you")
30 | (post :post/happy :person/me "yay!")]
31 | (by-namespace :person :id)))
32 | ;; => {:person/me 1, :person/you 2}
33 | Returns a map associating the reference (see as) with the queried property.
Datasource
protocol
Protocol for fixture-capable test datasources.
members
as-raw-datasource
(as-raw-datasource this)Retrieve the underlying raw datasource, e.g. a clojure.java.jdbc database spec, or some raw connection object.
This should fail on non-started datasources.
datasource-id
(datasource-id this)Return an ID for this datasource.
insert-document!
(insert-document! this document)Insert the given data into the current datasource. Return a map of :id (the reference ID), :data (the actual data inserted) and optionally :tags (a seq of tags for entity filtering).
Reference IDs must be namespaced keywords.
run-with-rollback
(run-with-rollback this f)Run (f datasource), where datasource is a transacted version of the current datasource. Ensure that changes made via datasource are rolled back afterwards.
start-datasource
(start-datasource this)Start the datasource.
stop-datasource
(stop-datasource this)Stop the datasource.
datasource
(datasource id)Get the Datasource registered under the given ID within the current scope. Throws an AssertionError if there is none.
Fixture
protocol
Protocol for datasource fixtures.
members
fixture-documents
(fixture-documents this)Generate a seq of fixture document maps, each one belonging to a single datasource identified by the :fixpoint/datasource key.
match
(match tags & transformations)Look up a fixture document’s property for every entity that matches all of the given tags.
maybe-datasource
(maybe-datasource id)Get the Datasource registered with the given ID within the current scope, or nil if there is none.
on-datasource
(on-datasource data datasource-id)Declare the given fixture’s target datasource, corresponding to one to-be-instantiated within with-datasource or with-rollback-datasource.
37 |(defn person
38 | [reference name]
39 | (-> {:db/table :people
40 | :name name}
41 | (as reference)
42 | (on-datasource :db)))
43 |
44 | (with-datasource [ds (pg/make-datasource :db ...)]
45 | (with-data [(person :person/me "me") ...]
46 | ...))
47 | The result can be passed to with-data to be run against the actual datasource.
properties
(properties document-ids & transformations)See property. Performs a lookup in multiple fixture documents, returning values in an order corresponding to document-ids.
property
(property document-id & transformations)Look up a single fixture document’s property using a reference attached to a fixture using as.
49 |(defn person
50 | [reference name]
51 | (-> {:db/table :people
52 | :name name}
53 | (as reference)
54 | (on-datasource :db)))
55 |
56 | (with-datasource [ds (pg/make-datasource :db ...)]
57 | (with-data [(person :person/me "me")
58 | (person :person/you "you")]
59 | (println (property :person/me))
60 | (println (property :person/you :id))))
61 | transformations can be given to apply a sequence of functions, in order, to the fixture map. Has to be used within a with-data block.
raw-datasource
(raw-datasource id)Get the raw datasource value for the Datasource registered under the given ID within the current scope.
63 |See datasource and as-raw-datasource.
use-data
(use-data & fixtures)A clojure.test fixture that will insert the given fixtures into their respective datasources.
64 |Needs to be applied after use-datasources.
use-datasources
(use-datasources & datasources)A clojure.test fixture that will wrap test runs with startup/shutdown of the given datasources. After the tests have run, a rollback will be initiated to cleanup the database.
with-data
macro
(with-data fixtures & body)Given a Fixture (or a seq of them), run them against their respective datasources, then execute body.
(defn person
66 | [name]
67 | (-> {:db/table :people
68 | :name name}
69 | (on-datasource :db)))
70 |
71 | (with-datasource [ds (pg/make-datasource :db ...)]
72 | (with-data [(person "me") (person "you")]
73 | ...))
74 | This has to be wrapped by with-datasource or with-rollback-datasource since otherwise there is nothing to insert into.
with-datasource
macro
(with-datasource [sym datasource] & body)Start datasource and bind it to sym, then run body in its scope.
(with-datasource [ds (pg/make-datasource ...)]
77 | ...)
78 | with-rollback
macro
(with-rollback [sym datasource] & body)Run the given body within a ‘transacted’ version of the given datasource, rolling back after the run has finished.
79 |(with-datasource [ds (pg/make-datasource ...)]
80 | (with-rollback [tx ds]
81 | (let [db (as-jdbc-datasource tx)]
82 | (jdbc/execute! db ["INSERT INTO ..." ...]))))
83 | with-rollback-datasource
macro
(with-rollback-datasource [sym datasource] & body)Start a ‘transacted’ version of datasource, rolling back any changed made after the run has finished.
(with-rollback-datasource [ds (pg/make-datasource ...)]
85 | (let [db (as-jdbc-datasource ds)]
86 | (jdbc/execute! db ["INSERT INTO ..." ...])))
87 | This is a convenience function combining with-datasource and with-rollback.