Skip to content

Commit 1fe7330

Browse files
mitch-kylemitch-kyle
authored
Add fixture functions to basilisp.test #980 (#1067)
I've separated out the test fixture functions from #1044 for #980
1 parent 30842eb commit 1fe7330

File tree

4 files changed

+153
-22
lines changed

4 files changed

+153
-22
lines changed

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
### Added
10+
* Added functions to `basilisp.test` for using and combining test fixtures (#980)
11+
912
### Fixed
1013
* Fix a bug where the reader was double counting the CRLF newline seq in metadata (#1063)
1114
* Conform to the `cider-nrepl` `info` ops spec by ensuring result's `:file` is URI, also added missing :column number (#1066)

‎src/basilisp/test.lpy‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
Tests may take advantage of Basilisp fixtures via :lpy:fn:`use-fixtures` to perform
2020
setup and teardown functions for each test or namespace. Fixtures are not the same
2121
(nor are they compatible with) PyTest fixtures."
22+
(:import types)
2223
(:require
2324
[basilisp.template :as template]))
2425

@@ -59,6 +60,11 @@
5960
via ``use-fixture`` and then removing them after the test is defined."
6061
(fn [fixture-type & _] fixture-type))
6162

63+
(defn generator?
64+
"Return true if ``x`` is a generator type, else false."
65+
[x]
66+
(instance? types/GeneratorType x))
67+
6268
(defmethod use-fixtures :each
6369
[_ & fixtures]
6470
(alter-meta! *ns* assoc ::each-fixtures fixtures))
@@ -67,6 +73,42 @@
6773
[_ & fixtures]
6874
(alter-meta! *ns* assoc ::once-fixtures fixtures))
6975

76+
(defmacro with-fixtures
77+
"Wrap the ``body`` in the ``fixtures`` in the given order. Handle
78+
setup and teardown for each of the ``fixtures``."
79+
[fixtures & body]
80+
(assert (vector? fixtures) "Expected a literal vector of fixtures")
81+
(let [result (gensym "result")]
82+
(reduce (fn [form fixture]
83+
`(let [~result (~fixture)]
84+
(if (generator? ~result)
85+
(try
86+
(python/next ~result)
87+
~form
88+
(finally
89+
(try
90+
(python/next ~result)
91+
(catch python/StopIteration ~'_ nil))))
92+
~form)))
93+
`(do ~@body)
94+
(reverse fixtures))))
95+
96+
(defmacro compose-fixtures
97+
"Compose any number of ``fixtures``, in order, creating a new fixture
98+
that combines their behavior. Always returns a valid fixture
99+
function, even if no fixtures are given."
100+
[& fixtures]
101+
`(fn [] (with-fixtures [~@fixtures] (yield))))
102+
103+
(defn join-fixtures
104+
"Composes a collection of ``fixtures``, in order. Always returns a valid
105+
fixture function, even if the collection is empty.
106+
Prefer :lpy:fn:`compose-fixtures` if fixtures are known at compile time."
107+
[fixtures]
108+
(if (seq fixtures)
109+
(reduce #(compose-fixtures %1 %2) fixtures)
110+
(constantly nil)))
111+
70112
(defmulti
71113
^{:arglists '([expr msg line-num])}
72114
gen-assert

‎tests/basilisp/contrib/nrepl_server_test.lpy‎

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -273,29 +273,36 @@
273273
{:id @id* :ns "user" :value "1"}
274274
{:id @id* :ns "user" :status ["done"]})
275275
(client-send! client {:id (id-inc!) :op "complete" :prefix "clojure.test/"})
276-
(is (= {:id @id* :status ["done"]
277-
:completions [{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-failures*"}
278-
{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-name*"}
279-
{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-section*"}
280-
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/are"}
281-
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/deftest"}
282-
{:type "var" :ns "basilisp.test" :candidate "clojure.test/gen-assert"}
283-
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/is"}
284-
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/testing"}
285-
{:type "var" :ns "basilisp.test" :candidate "clojure.test/use-fixtures"}]}
286-
(client-recv! client)))
276+
(let [result (client-recv! client)
277+
has-completion? (set (:completions result))]
278+
(is (= @id* (:id result)))
279+
(is (= ["done"] (:status result)))
280+
(are [completion] (has-completion? completion)
281+
{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-failures*"}
282+
{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-name*"}
283+
{:type "var" :ns "basilisp.test" :candidate "clojure.test/*test-section*"}
284+
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/are"}
285+
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/deftest"}
286+
{:type "var" :ns "basilisp.test" :candidate "clojure.test/gen-assert"}
287+
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/is"}
288+
{:type "macro" :ns "basilisp.test" :candidate "clojure.test/testing"}
289+
{:type "var" :ns "basilisp.test" :candidate "clojure.test/use-fixtures"}))
290+
287291
(client-send! client {:id (id-inc!) :op "complete" :prefix "test/"})
288-
(is (= {:id @id* :status ["done"]
289-
:completions [{:type "var" :ns "basilisp.test" :candidate "test/*test-failures*"}
290-
{:type "var" :ns "basilisp.test" :candidate "test/*test-name*"}
291-
{:type "var" :ns "basilisp.test" :candidate "test/*test-section*"}
292-
{:type "macro" :ns "basilisp.test" :candidate "test/are"}
293-
{:type "macro" :ns "basilisp.test" :candidate "test/deftest"}
294-
{:type "var" :ns "basilisp.test" :candidate "test/gen-assert"}
295-
{:type "macro" :ns "basilisp.test" :candidate "test/is"}
296-
{:type "macro" :ns "basilisp.test" :candidate "test/testing"}
297-
{:type "var" :ns "basilisp.test" :candidate "test/use-fixtures"}]}
298-
(client-recv! client))))))))
292+
(let [result (client-recv! client)
293+
has-completion? (set (:completions result))]
294+
(is (= @id* (:id result)))
295+
(is (= ["done"] (:status result)))
296+
(are [completion] (has-completion? completion)
297+
{:type "var" :ns "basilisp.test" :candidate "test/*test-failures*"}
298+
{:type "var" :ns "basilisp.test" :candidate "test/*test-name*"}
299+
{:type "var" :ns "basilisp.test" :candidate "test/*test-section*"}
300+
{:type "macro" :ns "basilisp.test" :candidate "test/are"}
301+
{:type "macro" :ns "basilisp.test" :candidate "test/deftest"}
302+
{:type "var" :ns "basilisp.test" :candidate "test/gen-assert"}
303+
{:type "macro" :ns "basilisp.test" :candidate "test/is"}
304+
{:type "macro" :ns "basilisp.test" :candidate "test/testing"}
305+
{:type "var" :ns "basilisp.test" :candidate "test/use-fixtures"})))))))
299306

300307
(deftest nrepl-server-eval
301308
(testing "basic"

‎tests/basilisp/test_test.lpy‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
(ns tests.basilisp.test-test
2+
(:require [basilisp.test :refer :all]))
3+
4+
(defn- before-after-fixture
5+
[events]
6+
(fn []
7+
(swap! events conj :before)
8+
(yield)
9+
(swap! events conj :after)))
10+
11+
(defn- index-fixture
12+
[events idx]
13+
(fn []
14+
(swap! events conj idx)
15+
(yield)
16+
(swap! events conj idx)))
17+
18+
(def ^:dynamic *state* nil)
19+
20+
(deftest with-fixtures-test
21+
(testing "setup and teardown"
22+
(let [events (atom [])]
23+
(with-fixtures [(before-after-fixture events)]
24+
(swap! events conj :during))
25+
(is (= [:before :during :after] @events))))
26+
27+
(testing "teardown on exception"
28+
(let [events (atom [])]
29+
(try
30+
(with-fixtures [(before-after-fixture events)]
31+
(swap! events conj :during)
32+
(throw (ex-info "Boom!" {})))
33+
(catch Exception _ nil))
34+
(is (= [:before :during :after] @events))))
35+
36+
(testing "teardown on fixture setup exception"
37+
(let [events (atom [])]
38+
(try
39+
(with-fixtures [(before-after-fixture events)
40+
#(throw (ex-info "Boom!" {}))]
41+
(swap! events conj :during))
42+
(catch Exception _ nil))
43+
(is (= [:before :after] @events))))
44+
45+
(testing "teardown on fixture teardown exception"
46+
(let [events (atom [])]
47+
(try
48+
(with-fixtures [(before-after-fixture events)
49+
(fn []
50+
(yield)
51+
(throw (ex-info "Boom!" {})))]
52+
(swap! events conj :during))
53+
(catch Exception _ nil))
54+
(is (= [:before :during :after] @events))))
55+
56+
(testing "applied in order"
57+
(let [events (atom nil)]
58+
(with-fixtures [(index-fixture events 1)
59+
(index-fixture events 2)
60+
(index-fixture events 3)]
61+
(swap! events conj 4))
62+
(is (= '(1 2 3 4 3 2 1) @events))))
63+
64+
(testing "nesting fixtures"
65+
(with-fixtures [(fn []
66+
(with-fixtures [(fn []
67+
(binding [*state* 1]
68+
(yield)))]
69+
(yield)))]
70+
(is (= 1 *state*)))))
71+
72+
(deftest join-fixtures-test
73+
(testing "applied in order"
74+
(let [events (atom nil)]
75+
(with-fixtures [(join-fixtures [(index-fixture events 1)
76+
(index-fixture events 2)
77+
(index-fixture events 3)])]
78+
(swap! events conj 4))
79+
(is (= '(1 2 3 4 3 2 1) @events)))))

0 commit comments

Comments
 (0)