feat: add coverage test to verify coverage works

Author: k13gomez

.github/workflows/clojure.yml

@@ -25,6 +25,8 @@ jobs:
         cli: 1.11.1.1429
     - name: Run tests
       run: make test
+    - name: Run coverage tests
+      run: make test-coverage
     - name: Run generative tests
       run: make test-generative
     - name: Run clj-kondo linter

Makefile

@@ -14,6 +14,10 @@ repl: compile-test-java
 test: compile-test-java
 	clojure -M:dev:test:runner --focus :unit --reporter kaocha.report/documentation --no-capture-output
 
+test-coverage: compile-test-java
+	clojure -M:dev:test:runner --focus :coverage --reporter kaocha.report/documentation --no-capture-output
+	jq '.coverage["clara/coverage_ruleset.clj"]|join("_")' target/coverage/codecov.json | grep "_1___1____1_0_1__1__" || echo "Unexpected coverage output for clara.coverage-ruleset." exit 1
+
 test-generative: compile-test-java
 	clojure -M:dev:test:runner --focus :generative --reporter kaocha.report/documentation --no-capture-output
 

deps.edn

@@ -24,7 +24,9 @@
               :main-opts ["-m" "clj-kondo.main"]}
 
   :test {:extra-paths ["src/test/clojure" "target/test/classes"]
-         :extra-deps {lambdaisland/kaocha         {:mvn/version "1.80.1274"}
+         :extra-deps {lambdaisland/kaocha {:mvn/version "1.80.1274"}
+                      lambdaisland/kaocha-junit-xml {:mvn/version "1.17.101"}
+                      lambdaisland/kaocha-cloverage {:mvn/version "1.1.89"}
                       org.clojure/test.check {:mvn/version "1.1.1"}
                       pjstadig/humane-test-output {:mvn/version "0.10.0"}}}
 

src/test/clojure/clara/coverage_ruleset.clj

@@ -0,0 +1,14 @@
+(ns clara.coverage-ruleset
+  (:require [clara.rules :refer [defrule defquery insert!]]))
+
+(defrule simple-rule-with-rhs
+  [:weather [{:keys [temperature]}]
+   (= temperature ?temperature)]
+  =>
+  (if (< ?temperature 50)
+    (insert! {:type :climate :label "Cold"})
+    (insert! {:type :climate :label "Warm"})))
+
+(defquery climate-query
+  []
+  [?result <- :climate])

src/test/clojure/clara/test_coverage.clj

@@ -0,0 +1,14 @@
+(ns ^:coverage clara.test-coverage
+  (:require [clojure.test :refer [deftest testing is]]
+            [clara.rules :refer [mk-session insert fire-rules query]]
+            [clara.coverage-ruleset]))
+
+(deftest test-coverage
+  (testing "run the rules"
+    (let [result (-> (mk-session 'clara.coverage-ruleset :fact-type-fn :type)
+                     (insert {:type :weather
+                              :temperature 75})
+                     (fire-rules)
+                     (query clara.coverage-ruleset/climate-query))]
+      (is (= result [{:?result {:type :climate
+                                :label "Warm"}}])))))

tests.edn

@@ -3,15 +3,40 @@
             :plugins                         [:kaocha.plugin/profiling
                                               :kaocha.plugin/gc-profiling
                                               :kaocha.plugin/print-invocations
+                                              :kaocha.plugin/junit-xml
+                                              :kaocha.plugin/cloverage
                                               :kaocha.plugin/hooks
                                               :preloads]
+            :kaocha.plugin.junit-xml/target-file "target/junit.xml"
+            :kaocha.plugin.junit-xml/add-location-metadata? true
+            :cloverage/opts {:ns-exclude-regex []
+                             :text? false
+                             :lcov? false
+                             :high-watermark 80
+                             :fail-threshold 0
+                             :output "target/coverage"
+                             :low-watermark 50
+                             :src-ns-path ["src/main/clojure"
+                                           "src/test/clojure"]
+                             :ns-regex ["clara.coverage-ruleset"]
+                             :summary? true
+                             :coveralls? false
+                             :emma-xml? false
+                             :html? true
+                             :nop? false
+                             :codecov? true}
             :kaocha.hooks/pre-report         [clara.test-setup/defuse-zero-assertions]
             :kaocha.plugin.preloads/ns-names [clara.test-setup]
             :tests                           [{:id        :unit
                                                :kaocha/source-paths             ["src/main/clojure"]
                                                :kaocha/test-paths               ["src/test/clojure"]
                                                :ns-patterns                     [".*"]
-                                               :skip-meta                       [:generative]}
+                                               :skip-meta                       [:generative :coverage]}
+                                              {:id         :coverage
+                                               :kaocha/source-paths             ["src/main/clojure"]
+                                               :kaocha/test-paths               ["src/test/clojure"]
+                                               :ns-patterns                     [".*"]
+                                               :focus-meta                      [:coverage]}
                                               {:id         :generative
                                                :kaocha/source-paths             ["src/main/clojure"]
                                                :kaocha/test-paths               ["src/test/clojure"]