Run entire test suite under Babashka (#58)

We were formerly running a small sanity test for babashka.
By separating out our test http server to a process,
we can now hit our full suite with babashka.

We've kept our bb sanity tests but moved them under our full suite.
(see client-sanity-test ns).

Bb task `test:bb` now runs the full suite.

For consistency, I've re-added `test:jvm` which behaves the same as
`test:bb` but also supports a `--clj-version` option.
CI has been updated to use/exercise the test:jvm task.

Also added a simple test reporter for better feedback when testing
and to make it abundantly clear which platform we are testing on.

See update README for usage.

Some tests initially failed under bb:
- Tests were checking specifically for thrown
`java.net.ssl.SSLException` and `java.net.SocketTimeoutException`.
Neither of these classes are currently available in bb.
I switched to checking the message only.
- Encoding tests were testing against "windows-1252" charset.
Bb does include this charset, but on Windows only.
I switched the test to use "iso-8859-1" which is available on bb on
all platforms.

Other notes:
- noticed that the timeout test sometimes very rarely did not timeout; I increased the server-side timeout to hopefully force the expected failure.
- GitHub Actions on Windows can be very slow. Bumped wait time for our http-server process startup to a very generous 2 mins and added some logging so that we can witness how long this typically takes.

Closes #48

Author: lread

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
       - name: Lint
         run: bb lint
 
-  test:
+  test-jvm:
     runs-on: ${{ matrix.os }}-latest
     strategy:
       fail-fast: false
@@ -78,24 +78,21 @@ jobs:
         uses: DeLaGuardo/setup-clojure@9.4
         with:
           bb: 'latest'
-          cli: 'latest'
 
       - name: Tools versions
         run: |
           echo "bb --version"
           bb --version
-          echo "clojure --version"
-          clojure --version
           echo "java -version"
           java -version
 
       - name: Bring down deps
         run: bb deps
 
       - name: Run tests
-        run: clojure -M:${{ matrix.clojure-version }}:test
+        run: bb test:jvm --clj-version ${{ matrix.clojure-version }}
 
-  bb-test:
+  test-bb:
     runs-on: ${{ matrix.os }}-latest
     strategy:
       fail-fast: false
@@ -143,8 +140,8 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - lint
-      - test
-      - bb-test
+      - test-jvm
+      - test-bb
 
     steps:
       - name: Checkout

README.md

@@ -315,26 +315,39 @@ are sugar over this `clj-http.lite.client/request` function.
 
 ### Clojure JVM Tests
 
-To run tests for the JVM:
-
+Optionally:
 ```shell
 $ bb clean
 $ bb deps
+```
+
+Run all Clojure tests against minimum supported version of Clojure (1.8):
 
-Run all Clojure tests against minimum supported version of Clojure (1.8)
-$ clojure -M:test
+```shell
+$ bb test:jvm
+```
 
-Run Clojure against a specific Clojure version, for example 1.11
-$ clojure -M:1.11:test
+Run tests against a specific Clojure version, for example 1.11
+```shell
+$ bb test:jvm --clj-version 1.11
+```
+
+You can also include cognitect test runner options:
+```shell
+$ bb test:jvm --clj-version 1.9 --namespace-regex '*.sanity.*'
 ```
 
 ### Babashka Tests
 
-To run a small suite of sanity tests for babashka (found under ./bb]):
+To run the entire test suite under Babashka:
 
 ```shell
 $ bb test:bb
 ```
+You can also include cognitect test runner options:
+```shell
+$ bb test:bb --var clj-http.lite.integration-test/roundtrip
+```
 
 ### Linting
 

bb.edn

@@ -1,6 +1,5 @@
 {:paths ["." "bb"]
- :deps {org.clj-commons/clj-http-lite {:local/root "."}
-        lread/status-line {:git/url "https://github.com/lread/status-line.git"
+ :deps {lread/status-line {:git/url "https://github.com/lread/status-line.git"
                            :sha "35ed39645038e81b42cb15ed6753b8462e60a06d"}}
  :tasks
  {:requires ([tasks :as t])
@@ -10,9 +9,18 @@
   clean
   {:doc "Delete any work dirs"
    :task (clojure "-T:build clean")}
+  test:jvm
+  {:doc "Runs tests under JVM Clojure [--clj-version] (recognizes cognitect test-runner args)"
+   :task test-jvm/-main}
   test:bb
-  {:doc "Run babashka tests"
-   :task clj-http.lite.test-runner/-main}
+  {:doc "Runs tests under babashka Clojure (recognizes cognitect test-runner args)"
+   :extra-paths ["src" "test" "test-resources"]
+   :extra-deps {io.github.cognitect-labs/test-runner
+                {:git/tag "v0.5.1" :git/sha "dfb30dd"}
+                org.clojure/tools.namespace {:git/url "https://github.com/babashka/tools.namespace"
+                                             :git/sha "16b8c53174a5c9d89d6e0ce4128aa30b071aabdf"}}
+   :requires ([cognitect.test-runner :as tr])
+   :task (apply tr/-main *command-line-args*)}
   lint
   {:doc "[--rebuild] Lint source code"
    :task lint/-main}

bb/clj_http/lite/test_runner.clj

@@ -0,0 +1,42 @@
+(ns test-jvm
+  (:require [babashka.cli :as cli]
+            [babashka.tasks :as t]
+            [lread.status-line :as status]))
+
+(defn -main [& args]
+  (let [valid-clojure-versions ["1.8" "1.9" "1.10" "1.11"]
+        spec {:clj-version
+              {:ref "<version>"
+               :desc "The Clojure version to test against."
+               :coerce :string
+               :default-desc "1.8"
+               ;; don't specify :default, we want to know if the user passed this option in
+               :validate
+               {:pred (set valid-clojure-versions)
+                :ex-msg (fn [_m]
+                          (str "--clj-version must be one of: " valid-clojure-versions))}}}
+        opts (cli/parse-opts args {:spec spec})
+        clj-version (:clj-version opts)
+        runner-args (if-not clj-version
+                      args
+                      (loop [args args
+                             out-args []]
+                        (if-let [a (first args)]
+                          (if (re-matches #"(--|:)clj-version" a)
+                            (recur (drop 2 args) out-args)
+                            (recur (rest args) (conj out-args a)))
+                          out-args)))
+        clj-version (or clj-version "1.8")]
+
+    (if (:help opts)
+      (do
+        (status/line :head "bb task option help")
+        (println (cli/format-opts {:spec spec}))
+        (status/line :head "test-runner option help")
+        (t/clojure "-M:test --test-help"))
+      (do
+        (println "Testing against Clojure" clj-version)
+        (apply t/clojure (format "-M:%s:test" clj-version) runner-args)))))
+
+(when (= *file* (System/getProperty "babashka.file"))
+  (apply -main *command-line-args*))

bb/test_jvm.clj

@@ -9,16 +9,21 @@
   {:deps {io.github.clojure/tools.build {:git/tag "v0.8.3" :git/sha "0d20256"}
           slipset/deps-deploy {:mvn/version "0.2.0"}}
    :ns-default build}
-  :test
+  :http-server ;; used for to support integration tests
   {:extra-paths ["test" "test-resources"]
-   :extra-deps {io.github.cognitect-labs/test-runner
-                {:git/tag "v0.5.1" :git/sha "dfb30dd"}
+   :override-deps {org.clojure/clojure {:mvn/version "1.11.1"}}
+   :extra-deps {babashka/fs {:mvn/version "0.1.6"}
                 ring/ring-jetty-adapter {:mvn/version "1.9.5"}
                 ch.qos.logback/logback-classic {:mvn/version "1.2.11"
                                                 :exclusions [org.slf4j/slf4j-api]}
                 org.slf4j/jcl-over-slf4j {:mvn/version "1.7.36"}
                 org.slf4j/jul-to-slf4j {:mvn/version "1.7.36"}
                 org.slf4j/log4j-over-slf4j {:mvn/version "1.7.36"}}
+   :exec-fn clj-http.lite.test-util.http-server/run}
+  :test
+  {:extra-paths ["test"]
+   :extra-deps {io.github.cognitect-labs/test-runner
+                {:git/tag "v0.5.1" :git/sha "dfb30dd"}}
    :main-opts ["-m" "cognitect.test-runner"]}
   ;; for consistent linting we use a specific version of clj-kondo through the jvm
   :clj-kondo {:extra-deps {clj-kondo/clj-kondo {:mvn/version "2022.08.03"}}

deps.edn

@@ -1,6 +1,7 @@
-(ns clj-http.lite.client-test
-  (:require [cheshire.core :as json]
-            [clj-http.lite.client :as client]
+(ns clj-http.lite.client-sanity-test
+  "A small subset of tests suitable for sanity testing.
+  Used by babashka libs tests."
+  (:require [clj-http.lite.client :as client]
             [clojure.test :as t :refer [deftest is]]))
 
 (deftest client-test
@@ -11,14 +12,14 @@
   (is (= 200 (:status (client/post "https://postman-echo.com/post" {:throw-exceptions false}))))
 
   (is (= 200 (:status (client/post "https://postman-echo.com/post"
-                                   {:body (json/generate-string {:a 1})
+                                   {:body "{\"a\": 1}"
                                     :headers {"X-Hasura-Role" "admin"}
                                     :content-type :json
                                     :accept :json
                                     :throw-exceptions false}))))
 
   (is (= 200  (:status (client/put "https://postman-echo.com/put"
-                                   {:body (json/generate-string {:a 1})
+                                   {:body "{\"a\": 1}"
                                     :headers {"X-Hasura-Role" "admin"}
                                     :content-type :json
                                     :accept :json

bb/clj_http/lite/client_test.clj renamed to test/clj_http/lite/client_sanity_test.clj

@@ -1,6 +1,7 @@
 (ns clj-http.lite.client-test
   (:require [clj-http.lite.client :as client]
             [clj-http.lite.util :as util]
+            [clj-http.lite.test-util.test-report]
             [clojure.test :refer [deftest is testing]])
   (:import (java.net UnknownHostException)))
 
@@ -132,8 +133,8 @@
     (is (= "fooⓕⓞⓞ" (:body resp)))))
 
 (deftest apply-on-other-output-coercion
-  (let [client (fn [_req] {:body (.getBytes "sõme ßÒññÝ chÀråcters" "windows-1252")
-                          :headers {"content-type" "text/foo;charset=windows-1252"}})
+  (let [client (fn [_req] {:body (.getBytes "sõme ßÒññÝ chÀråcters" "ISO-8859-1")
+                          :headers {"content-type" "text/foo;charset=ISO-8859-1"}})
         o-client (client/wrap-output-coercion client)
         resp (o-client {:uri "/foo" :as :auto})]
     (is (= "sõme ßÒññÝ chÀråcters" (:body resp)))))
@@ -153,7 +154,7 @@
     (doseq [[in-body encoding expected-encoding] [["μτƒ8 нαs мαηλ ςнαяαςτεяs ൠ" nil            "UTF-8"]
                                                   ["μτƒ8 нαs мαηλ ςнαяαςτεяs ൠ" "UTF-8"        "UTF-8"]
                                                   ["plain text"                "ASCII"        "ASCII"]
-                                                  ["sõme ßÒññÝ chÀråcters"     "windows-1252" "windows-1252"]]]
+                                                  ["sõme ßÒññÝ chÀråcters"     "iso-8859-1"   "iso-8859-1"]]]
       (let [resp (i-client {:body in-body :body-encoding encoding})
             decoded-body (slurp (:body resp) :encoding expected-encoding)]
         (is (= expected-encoding (:character-encoding resp)) "character encoding")