Orchestra is a Clojure library made as a drop-in replacement for
clojure.spec.test.alpha, which provides custom
instrumentation that validates all aspects of function specs. By default,
clojure.spec will only instrument :args. This leaves out :ret and :fn
from automatic validation; Orchestra checks all of them for you.
Leiningen dependency:
;; Depending on your Clojure version, choose one of the following. All of them
;; provide the same API but follow different internal spec changes.
;; Requires org.clojure/clojure >= 1.9.0-alpha16
;; Requires org.clojure/spec.alpha >= 0.1.108
[orchestra "0.3.0"]
;; Requires 1.9.0 >= Clojure < 1.9.0-alpha16
[orchestra "0.2.0"]Just replace your ns and require forms to reference orchestra.spec.test
instead of clojure.spec.test.alpha. No further code changes required!
;; Before
(ns kitty-ninja
(:require [clojure.spec.test.alpha :as st]))
;; After
(ns kitty-ninja
(:require [orchestra.spec.test :as st]))Just as with vanilla Clojure, begin your instrumentation by calling:
; Call after defining all of your specs
(st/instrument)If you're not familiar with Clojure's instrumentation, it's worth reading the
official spec
guide. In short,
after calling orchestra.spec.test/instrument, every call to a function which
you've spec'd will have its arguments, return value, and :fn spec validated,
based on the specs you've provided.
This magic is possible by rebinding the var, to which your spec'd functions are
bound, with a different function which first checks all arguments, then calls
the original function, then checks the :ret and :fn specs, if they're
present.
I highly recommend having this always on during development and testing. You may have systems tests, rather than unit tests, and this can help verify that your data stays in the exact shape you intended.
Feel free to shoot Bitcoins my way: 123NMGCvRZLfQJwk2AhsLMLSpCCJhCRoz6
For more information regarding how I use donations, see here.
Distributed under the Eclipse Public License version 1.0, just like Clojure.