https://github.com/oliyh/fixa

Better test fixtures for clojure
https://github.com/oliyh/fixa

clojure fixtures testing

Last synced: 16 days ago
JSON representation

Better test fixtures for clojure

• Host: GitHub
• URL: https://github.com/oliyh/fixa
• Owner: oliyh
• License: mit
• Created: 2021-05-07T09:46:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-11T16:33:22.000Z (about 2 years ago)
• Last Synced: 2024-10-04T12:49:18.376Z (about 1 month ago)
• Topics: clojure, fixtures, testing
• Language: Clojure
• Homepage:
• Size: 17.6 KB
• Stars: 27
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# fixa

Better fixtures for Clojure

Why does `clojure.test` limit us to a single set of `:each` and `:once` fixtures for all tests in a namespace?

Shouldn't we have the granularity of being able to apply particular fixtures to an individual test?

fixa lets you define fixtures at the individual test level using a simple metadata notation.

[![Clojars Project](https://img.shields.io/clojars/v/com.github.oliyh/fixa.svg)](https://clojars.org/com.github.oliyh/fixa)

## Usage

Firstly you need to add the fixa metadata to your test vars, then choose the appropriate instructions for your test runner (kaocha or clojure.test).

Note that the fixa fixtures will run _after_ any fixtures defined by `use-fixtures`.

### Annotate your tests

Add `:fixa/fixture` (singular) or `:fixa/fixtures` (a list) as metadata to your `deftest`:

```clj

(deftest ^{:fixa/fixture fixture-a} single-fixture-test

  (is (= 1 1)))

(deftest ^{:fixa/fixtures [fixture-a fixture-b]} multiple-fixtures-test

  (is (= 1 1)))

```

### Kaocha

All that's needed is the `fixa.kaocha/wrap-run` plugin. Add it to your `tests.edn` like this:

```clj

#kaocha/v1 {:plugins [:hooks]

            :kaocha.hooks/wrap-run [fixa.kaocha/wrap-run]}

```

### clojure.test

Unfortunately due to the way clojure.test is written, an alternative `deftest` is required to smuggle the fixtures through.

```clj

(require '[fixa.clj-test :refer [deftest]])

(deftest ^{:fixa/fixture fixture-a} single-fixture-test

  (is (= 1 1)))

```

## Built-in fixtures

Now that fixa has added the ability to have per-test fixtures, we can do more.

The following are built-in fixtures provided by the library.

### fail-after

You can add a `:fixa/fail-after` to your tests which will make the test start to fail when the date is surpassed:

```clj

(deftest ^{:fixa/fail-after "2023-01-05"} christmas-decorations-test

  (is (christmas-decorations)))

```

### run-after

You can add a `:fixa/run-after` to your tests which will make the test skip evaluation until the date is surpassed:

```clj

(deftest ^{:fixa/run-after "2022-12-01"} future-v2-integration-test

  (is (some-feature-only-available-in-v2)))

```

## Development

[![CircleCI](https://circleci.com/gh/oliyh/fixa/tree/main.svg?style=svg)](https://circleci.com/gh/oliyh/fixa/tree/main)