Plugin: Hooks

The hooks plugin allows hooking into Kaocha's process with arbitrary functions. This is very similar to using writing a plugin, but requires less boilerplate.

See the documentation for extending Kaocha for a description of the different hooks. The supported hooks are: config, pre-load, post-load, pre-run, post-run, wrap-run, pre-test, post-test, pre-report, post-summary.

The hooks plugin also provides hooks at the test suite level, which in order are :kaocha.hooks/pre-load-test, :kaocha.hooks/post-load-test, :kaocha.hooks/pre-test, :kaocha.hooks/post-test.

Hooks can be specified as a fully qualified symbol referencing a function, or a collection thereof. The referenced namespaces will be loaded during the config phase. It's also possible to have functions directly inline, but due to limitations of the EDN reader this is of limited use, and you are generally better off sticking your hooks into a proper namespace.

Implementing a hook

• Given a file named "tests.edn" with:

#kaocha/v1
{:plugins [:kaocha.plugin/hooks]
 :kaocha.hooks/pre-test [my.kaocha.hooks/sample-hook]}

• And a file named "src/my/kaocha/hooks.clj" with:

(ns my.kaocha.hooks)

(println "ok")

(defn sample-hook [test test-plan]
  (if (re-find #"fail" (str (:kaocha.testable/id test)))
    (assoc test :kaocha.testable/pending true)
    test))

• And a file named "test/sample_test.clj" with:

(ns sample-test
  (:require [clojure.test :refer :all]))

(deftest stdout-pass-test
  (println "You peng zi yuan fang lai")
  (is (= :same :same)))

(deftest stdout-fail-test
  (println "Bu yi le hu?")
  (is (= :same :not-same)))

• When I run bin/kaocha

• Then the output should contain:

PENDING sample-test/stdout-fail-test (sample_test.clj:8)

Implementing a test-suite specific hook

• Given a file named "tests.edn" with:

#kaocha/v1
{:plugins [:kaocha.plugin/hooks]
 :tests [{:id :unit
          :kaocha.hooks/before [my.kaocha.hooks/sample-before-hook]
          :kaocha.hooks/after  [my.kaocha.hooks/sample-after-hook]}]}

• And a file named "src/my/kaocha/hooks.clj" with:

(ns my.kaocha.hooks)

(defn sample-before-hook [suite test-plan]
  (println "before suite:" (:kaocha.testable/id suite))
  suite)

(defn sample-after-hook [suite test-plan]
  (println "after suite:" (:kaocha.testable/id suite))
  suite)

• And a file named "test/sample_test.clj" with:

(ns sample-test
  (:require [clojure.test :refer :all]))

(deftest stdout-pass-test
  (println "You peng zi yuan fang lai")
  (is (= :same :same)))

• When I run bin/kaocha

• Then the output should contain:

before suite: :unit
[(.)]after suite: :unit