meissa/data-test
7
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

added reference

Browse source
This commit is contained in:
jem 2019-05-31 13:56:29 +02:00
parent feb56750ea
commit 512600a86f
1 changed files with 50 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -6,22 +6,22 @@
## About ## About
data-test separates test data from test code and allows a more data driven approach for testing. In case of having huge amounts of test-input & -expectations your test code will remain readable and concise. data-test is founded on and compatible with `clojure.test`. Integration in your test environments will work. For explicit, intentful and obvious data, data-test uses (https://github.com/juxt/aero)[aero]. data-test separates test data from test code and allows a more data driven approach for testing. In case of having huge amounts of test-input & -expectations your test code will remain readable and concise. data-test is founded on and compatible with `clojure.test`. Integration in your test environments will work without any changes. For explicit, intentful and obvious data, data-test uses [aero](https://github.com/juxt/aero).
## Usage ## Usage
Define your data test similar to `deftest` and express your test e.g. with `is` macro. The given binding `[input expected]` can be used in your testcode. Define your data test similar to `deftest` and express your test e.g. with `is` macro. The given binding `[input expected]` will let symbols which can be used in your test code.
```clojure ```clojure
(ns my.cool.project-test (ns my.cool.project-test
(:require [clojure.test :refer :all] (:require [clojure.test :refer :all]
[data-test :refer :all]) [data-test :refer :all]))
(defdatatest should-test-multiple-specs [input expected] (defdatatest should-test-multiple-specs [input expected]
(is (= input expected))) (is (= input expected)))
``` ```
Your test data has to be located in classpath. The path is determined by your tests namespace and your tests definition name. In given case it is `my/cool/project_test/should_test_multiple_spec.edn`: Your test data are loaded as resource and therefore data has to be located in classpath. The path is determined by your tests namespace and your tests definition name. In given case it is `my/cool/project_test/should_test_multiple_spec.edn`:
```clojure ```clojure
{:input 1 {:input 1
@ -43,15 +43,60 @@ FAIL in: project_test.clj: 35: should-test-multiple-specs: project_test/should_t
4 tests finished, problems found. 😭 errors: 0, failures: 1, ns: 1, vars: 3 4 tests finished, problems found. 😭 errors: 0, failures: 1, ns: 1, vars: 3
``` ```
The test data file used will determine the testing context. The test data resource used will determine the testing context.
## Reference ## Reference
### Loading Resources ### Loading Resources
data-test tries to locate data files on classpath as resource - should work similar in jar-files and in filesystem classpaths. The resource locations are determined by test namespace (e.g. `my/cool/project_test`) and defined test name (e.g. `should_test_multiple_spec.edn`). Resource-naming is following clojures usual filesystem mapping conventions.
```console
my/cool/project_test/should_test_multiple_spec.edn
my/cool/project_test/should_test_multiple_spec.1.edn
...
my/cool/project_test/should_test_multiple_spec.9.edn
```
A test is executed for every file defined.
### Bindings ### Bindings
`defdatatest name [binding-for-input binding-for-expected]` is translated in sth. like:
```clojure
(deftest should-test-with-data-explicit-version
(let [testdata (loader/read-test-data-spec (io/resource "data_test_test/should_test_with_data_explicit_version.edn"))
{:keys [input expected]} testdata]
(is (= expected
input))))
```
As you can see, input and expected can be used in your test code. You have to declare the used symbols in the binding section.
### Resources with AERO ### Resources with AERO
You can use [aero](https://github.com/juxt/aero) in your test data declaration, e.g.
```clojure
{:to-be-refernced "ref-test"
:key1 #ref [:to-be-refernced]
:key2 #ref [:to-be-refernced]}
```
### Generated Output ### Generated Output
Each data-test execution will report it's results to "target/datatest/". The key `:test-event` reflect [clojure.test reporting events](https://github.com/clojure/clojure/blob/8c402a8c9695a4eddc07cbbe0d95d44e1372f0bf/src/clj/clojure/test.clj#L214), the key `:test-data-spec` reflects the used data-test data specification.
```clojure
(def TestDataReport
{:test-event s/Any
:test-data-spec {:input s/Any
:expected s/Any
:data-spec-file s/Str}})
```
## License ## License
Copyright © 2019 meissa GmbH Copyright © 2019 meissa GmbH