[test] Make tests pass on Windows

Author: alexander-yakushev

src/orchard/java/resource.clj

@@ -7,37 +7,28 @@
   (:import (java.io File)
            (java.net URL)))
 
-(defn- trim-leading-separator
-  "Trim the java.io.File/separator at the beginning of s."
-  [^String s]
-  (if (.startsWith s java.io.File/separator)
-    (subs s 1)
-    s))
-
 (defn project-resources
   "Get a list of classpath resources, i.e. files that are not clojure/java source
   or class files. Only consider classpath entries that are directories, does not
   consider jars."
   []
-  (mapcat
-   (fn [^File directory]
-     (->> directory
-          (file-seq)
-          (filter (memfn ^File isFile))
-          (map (fn [^File file]
-                 (let [relpath (-> file
-                                   (.getPath)
-                                   (.replaceFirst
-                                    (.getPath directory)
-                                    "")
-                                   (trim-leading-separator))]
-                   {:root directory
-                    :file file
-                    :relpath relpath
-                    :url (io/as-url file)})))
-          (remove #(.startsWith ^String (:relpath %) "META-INF/"))
-          (remove #(re-matches #".*\.(clj[cs]?|java|class)" (:relpath %)))))
-   (filter (memfn ^File isDirectory) (map io/as-file (cp/classpath (cp/context-classloader))))))
+  (->> (cp/classpath (cp/context-classloader))
+       (map io/as-file)
+       (filter (memfn ^File isDirectory))
+       (mapcat
+        (fn [^File directory]
+          (->> (file-seq directory)
+               (filter (memfn ^File isFile))
+               (map (fn [^File file]
+                      (let [relpath (.getPath
+                                     (.relativize (.toURI directory)
+                                                  (.toURI file)))]
+                        {:root directory
+                         :file file
+                         :relpath relpath
+                         :url (io/as-url file)})))
+               (remove #(.startsWith ^String (:relpath %) "META-INF/"))
+               (remove #(re-matches #".*\.(clj[cs]?|java|class)" (:relpath %))))))))
 
 (defn resource-full-path ^URL [relative-path]
   (io/resource relative-path (cp/context-classloader)))

test/orchard/java/classpath_test.clj

@@ -4,13 +4,16 @@
    [clojure.set :as set]
    [clojure.string :as string]
    [clojure.test :refer [deftest is testing]]
+   [matcher-combinators.matchers :as m]
    [orchard.java]
    [orchard.java.classpath :as cp]
    [orchard.misc :as misc])
   (:import
    (java.io File)
    (java.net URL)))
 
+(require 'matcher-combinators.test) ;; for `match?`
+
 ;; Simple normalization for string compare. Classpath URLs have trailing
 ;; slashes; classpath entries specified at JVM launch may or may not.
 (defn- trim-trailing-slash [x]
@@ -33,14 +36,11 @@
       (let [project-root (System/getProperty "user.dir")
             directory-with-jar-extension (some #(when (re-find #"not-a\.jar" (.getPath ^URL %)) %)
                                                (cp/classpath))]
-        (is (some #(= (str (io/file project-root "src")) %)
-                  (map trim-trailing-slash (cp/classpath))))
-        (is (some #(= (str (io/file project-root "test")) %)
-                  (map trim-trailing-slash (cp/classpath))))
-        (is (some #(re-find #".*/clojure-.*\.jar" (.getPath ^URL %))
-                  (cp/classpath)))
-        (is (some #(re-find #".*/clojure-.*-sources\.jar" (.getPath ^URL %))
-                  (cp/classpath)))
+        (is (match? (m/embeds [(trim-trailing-slash (io/as-url (io/file project-root "src")))
+                               (trim-trailing-slash (.getPath (io/as-url (io/file project-root "test"))))
+                               #".*/clojure-.*\.jar"
+                               #".*/clojure-.*-sources\.jar"])
+                    (map trim-trailing-slash (cp/classpath))))
         (testing "Directories with .jar extension"
           (is directory-with-jar-extension "Is present in the classpath")
           (is (-> directory-with-jar-extension io/file .isDirectory)

test/orchard/java/resource_test.clj

@@ -1,15 +1,21 @@
 (ns orchard.java.resource-test
   (:require
+   [clojure.string :as string]
    [clojure.test :refer [deftest is testing]]
+   [matcher-combinators.matchers :as m]
    [orchard.java.resource :as resource]))
 
+(require 'matcher-combinators.test) ;; for `match?`
+
 (deftest resource-path-tuple-test
   (is (nil? (resource/resource-path-tuple "jar:file:fake.jar!/fake/file.clj"))))
 
 (deftest project-resources-test
   (testing "get the correct resources for the orchard project"
-    (let [resources (->> (resource/project-resources)
-                         (filter (fn [{:keys [relpath]}]
-                                   (= relpath "clojuredocs/test_export.edn"))))]
-      (is (= "clojuredocs/test_export.edn" (-> resources first :relpath)))
-      (is (= java.net.URL (-> resources first :url class))))))
+    (let [test-export (some (fn [{:keys [relpath] :as res}]
+                              (when (string/ends-with? relpath "test_export.edn")
+                                res))
+                            (resource/project-resources))]
+      (is (match? {:relpath "clojuredocs/test_export.edn"
+                   :url (m/via class java.net.URL)}
+                  test-export)))))

test/orchard/java/source_files_test.clj

@@ -1,7 +1,8 @@
 (ns orchard.java.source-files-test
   (:require [clojure.test :refer [deftest is testing]]
             [orchard.java.source-files :as src-files]
-            [orchard.test.util :as util]))
+            [orchard.test.util :as util]
+            [orchard.util.os :as os]))
 
 (when util/jdk-sources-present?
   (deftest class->source-file-url-test
@@ -25,30 +26,34 @@
      (#'src-files/find-jar-file-for-class klass))))
 
 ;; TODO: test for Clojure CLI and invoke tool at some point.
-(deftest test-download-sources-jar-using-lein
-  (let [f (sources-jar-file clojure.lang.Ref)]
-    (.delete f)
-    (is (not (.exists f))))
+;; TODO: doesn't currently pass on Windows because it can't find "lein".
+;; Probably a CI setup problem.
+(when-not (= os/os-type ::os/windows)
+  (deftest test-download-sources-jar-using-lein
+    (let [f (sources-jar-file clojure.lang.Ref)]
+      (.delete f)
+      (is (not (.exists f))))
 
-  (is (#'src-files/download-sources-using-lein
-       (src-files/infer-maven-coordinates-for-class clojure.lang.Ref)))
+    (is (#'src-files/download-sources-using-lein
+         (src-files/infer-maven-coordinates-for-class clojure.lang.Ref)))
 
-  (is (.exists (sources-jar-file clojure.lang.Ref)))
+    (is (.exists (sources-jar-file clojure.lang.Ref)))
 
-  (testing "downloaded source jars contain actual source files"
-    (is (> (count (slurp (src-files/class->source-file-url clojure.lang.Ref)))
-           200))))
+    (testing "downloaded source jars contain actual source files"
+      (is (> (count (slurp (src-files/class->source-file-url clojure.lang.Ref)))
+             200)))))
 
-(deftest test-download-sources-jar
-  (let [f (sources-jar-file clojure.lang.Ref)]
-    (.delete f)
-    (is (not (.exists f))))
+(when-not (= os/os-type ::os/windows)
+  (deftest test-download-sources-jar
+    (let [f (sources-jar-file clojure.lang.Ref)]
+      (.delete f)
+      (is (not (.exists f))))
 
-  (is (src-files/download-sources-jar-for-coordinates
-       (src-files/infer-maven-coordinates-for-class clojure.lang.Ref)))
+    (is (src-files/download-sources-jar-for-coordinates
+         (src-files/infer-maven-coordinates-for-class clojure.lang.Ref)))
 
-  (is (.exists (sources-jar-file clojure.lang.Ref)))
+    (is (.exists (sources-jar-file clojure.lang.Ref)))
 
-  (testing "downloaded source jars contain actual source files"
-    (is (> (count (slurp (src-files/class->source-file-url clojure.lang.Ref)))
-           200))))
+    (testing "downloaded source jars contain actual source files"
+      (is (> (count (slurp (src-files/class->source-file-url clojure.lang.Ref)))
+             200)))))

test/orchard/test/util.clj

@@ -1,5 +1,6 @@
 (ns orchard.test.util
-  (:require [orchard.java.source-files :as src-files]))
+  (:require clojure.string
+            [orchard.java.source-files :as src-files]))
 
 (def jdk-sources-present?
   (boolean (src-files/class->source-file-url Thread)))
@@ -8,3 +9,9 @@
   {:post [(seq %)]}
   (->> (ns-imports ns-sym)
        (map #(-> % ^Class val .getName symbol))))
+
+(defmacro with-out-str-rn
+  "Like `with-out-str`, but replaces Windows' CR+LF with LF."
+  [& body]
+  `(let [s# (with-out-str ~@body)]
+     (clojure.string/replace s# "\r\n" "\n")))

test/orchard/trace_test.clj

@@ -2,6 +2,7 @@
   (:require
    [clojure.edn]
    [clojure.test :as t :refer [is are deftest]]
+   [orchard.test.util :refer [with-out-str-rn]]
    [orchard.trace :as sut]
    [orchard.trace-test.sample-ns :as sample-ns]))
 
@@ -53,24 +54,24 @@
 
 (deftest basic-test
   (run! sut/trace-var* vars)
-  (is (= expected-trace-result (with-out-str (sample-ns/qux arg1 arg2))))
+  (is (= expected-trace-result (with-out-str-rn (sample-ns/qux arg1 arg2))))
 
   (run! sut/untrace-var* vars)
-  (is (= "" (with-out-str (sample-ns/qux arg1 arg2))))
+  (is (= "" (with-out-str-rn (sample-ns/qux arg1 arg2))))
 
   (run! sut/trace-var* vars)
   (sut/untrace-var* #'sample-ns/foo)
-  (is (= expected-trace-result-no-foo (with-out-str (sample-ns/qux arg1 arg2))))
+  (is (= expected-trace-result-no-foo (with-out-str-rn (sample-ns/qux arg1 arg2))))
 
   (sut/trace-ns* 'orchard.trace-test.sample-ns)
-  (is (= expected-trace-result (with-out-str (sample-ns/qux arg1 arg2))))
+  (is (= expected-trace-result (with-out-str-rn (sample-ns/qux arg1 arg2))))
 
   (sut/untrace-ns* 'orchard.trace-test.sample-ns)
-  (is (= "" (with-out-str (sample-ns/qux arg1 arg2))))
+  (is (= "" (with-out-str-rn (sample-ns/qux arg1 arg2))))
 
   (sut/trace-ns* 'orchard.trace-test.sample-ns)
   (sut/untrace-all)
-  (is (= "" (with-out-str (sample-ns/qux arg1 arg2)))))
+  (is (= "" (with-out-str-rn (sample-ns/qux arg1 arg2)))))
 
 (deftest fibo-test
   (sut/trace-ns* 'orchard.trace-test.sample-ns)
@@ -136,7 +137,7 @@
 │ 
 └─→ 8
 "
-         (with-out-str (sample-ns/fibo 5))))
+         (with-out-str-rn (sample-ns/fibo 5))))
 
   (is (= "
 (orchard.trace-test.sample-ns/fibo 5)
@@ -199,7 +200,7 @@
 │ 
 └─→ 8
 "
-         (with-out-str (sample-ns/fibo 5))))
+         (with-out-str-rn (sample-ns/fibo 5))))
 
   (is (= "
 (orchard.trace-test.sample-ns/fibo2 0 1 10)
@@ -246,7 +247,7 @@
 │ 
 └─→ 89
 "
-         (with-out-str (sample-ns/fibo2 0 1 10)))))
+         (with-out-str-rn (sample-ns/fibo2 0 1 10)))))
 
 (defn function-that-prints []
   (let [example-data (into {} (map #(vector % :val) (range 1000)))

test/orchard/util/os_test.clj

@@ -4,20 +4,20 @@
    [clojure.test :as test :refer [deftest is testing]]
    [orchard.util.os :as os]))
 
-(deftest cache-dir-test
-  (testing "BSD"
-    (with-redefs [os/os-type ::os/bsd]
-      (is (string/ends-with? (os/cache-dir) "/.cache"))))
+(when-not (= os/os-type ::os/windows)
+  (deftest cache-dir-test
+    (testing "BSD"
+      (with-redefs [os/os-type ::os/bsd]
+        (is (string/ends-with? (os/cache-dir) "/.cache"))))
 
-  (testing "Linux"
-    (with-redefs [os/os-type ::os/linux]
-      (is (string/ends-with? (os/cache-dir) "/.cache"))))
+    (testing "Linux"
+      (with-redefs [os/os-type ::os/linux]
+        (is (string/ends-with? (os/cache-dir) "/.cache"))))
 
-  (testing "Mac"
-    (with-redefs [os/os-type ::os/mac]
-      (is (string/ends-with? (os/cache-dir) "/Library/Caches")))))
+    (testing "Mac"
+      (with-redefs [os/os-type ::os/mac]
+        (is (string/ends-with? (os/cache-dir) "/Library/Caches"))))))
 
-;; NOTE: This test case targets AppVeyor mainly
-(deftest cache-dir-windows-test
-  (when (= ::os/windows os/os-type)
+(when (= os/os-type ::os/windows)
+  (deftest cache-dir-windows-test
     (is (re-seq #"^C:\\Users\\.+\\AppData\\Local" (os/cache-dir)))))