Exercise enrich-classpath and all Orchard Parser variants in CI

Author: vemv

.circleci/config.yml

@@ -148,6 +148,9 @@ jobs:
       clojure_version:
         description: Version of Clojure to test against
         type: string
+      parser_target:
+        description: The Orchard Java parser to be exercised
+        type: string
     executor: << parameters.jdk_version >>
     environment:
       VERSION: << parameters.clojure_version >>
@@ -159,10 +162,10 @@ jobs:
           steps:
             - run:
                 name: Running tests # Redundant relative to `make test`, however it makes the CI jobs fail faster, given how much time mranderson takes.
-                command: make quick-test
+                command: PARSER_TARGET=<< parameters.parser_target >> make --debug quick-test
             - run:
                 name: Running tests with inlined deps
-                command: make test smoketest
+                command: PARSER_TARGET=<< parameters.parser_target >> make --debug test smoketest
             - run:
                 name: Install the Clojure CLI
                 command: |
@@ -199,6 +202,7 @@ workflows:
             parameters:
               clojure_version: ["1.8", "1.9", "1.10", "1.11", "master"]
               jdk_version: [openjdk8, openjdk11, openjdk16, openjdk17]
+              parser_target: ["parser-next", "parser", "legacy-parser"]
           filters:
             branches:
               only: /.*/

.gitignore

@@ -20,3 +20,5 @@ out
 .source-deps
 .clj-kondo/.cache
 /.no-mranderson
+/test-runner
+/.test-classpath

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test quick-test fast-test eastwood cljfmt install fast-install smoketest deploy clean detect_timeout lein-repl repl lint light-kondo docs
+.PHONY: test quick-test fast-test eastwood cljfmt install fast-install smoketest deploy clean detect_timeout lein-repl repl lint light-kondo docs test_impl
 .DEFAULT_GOAL := quick-test
 
 CLOJURE_VERSION ?= 1.11
@@ -9,9 +9,26 @@ CLOJURE_VERSION ?= 1.11
 # Don't use spaces here.
 LEIN_PROFILES ?= "+dev,+test"
 
+TEST_PROFILES ?= "-user,-dev,+test"
+
 # The enrich-classpath version to be injected.
 # Feel free to upgrade this.
-ENRICH_CLASSPATH_VERSION="1.17.1"
+ENRICH_CLASSPATH_VERSION="1.18.0"
+
+# Set bash instead of sh for the @if [[ conditions,
+# and use the usual safety flags:
+SHELL = /bin/bash -Eeu
+
+ifeq ($(OS),Darwin) # macOS
+	SED_INPLACE = -i ''
+else
+	SED_INPLACE = -i
+endif
+
+TEST_RUNNER_SOURCE_DIR = test-runner
+
+$(TEST_RUNNER_SOURCE_DIR):
+	@if [ ! -d "$(TEST_RUNNER_SOURCE_DIR)" ]; then git clone https://github.com/cognitect-labs/test-runner.git $(TEST_RUNNER_SOURCE_DIR) --depth=1; fi
 
 test/resources/cider/nrepl/clojuredocs/export.edn:
 	curl -o $@ https://github.com/clojure-emacs/clojuredocs-export-edn/raw/master/exports/export.compact.edn
@@ -24,12 +41,35 @@ dump-version:
 	lein with-profile -user,-dev inline-deps
 	touch $@
 
-test: clean .inline-deps test/resources/cider/nrepl/clojuredocs/export.edn
+test_impl: $(TEST_RUNNER_SOURCE_DIR) test/resources/cider/nrepl/clojuredocs/export.edn
 	rm -f .no-mranderson
-	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+test,+plugin.mranderson/config test
+	@if [[ "$$PARSER_TARGET" == "parser-next" ]] ; then \
+		export SKIP_INLINING_TEST_DEPS=true; \
+		bash 'lein' 'update-in' ':plugins' 'conj' "[mx.cider/lein-enrich-classpath \"$(ENRICH_CLASSPATH_VERSION)\"]" '--' 'with-profile' $(TEST_PROFILES),+cognitest,+$(CLOJURE_VERSION) 'update-in' ':middleware' 'conj' 'cider.enrich-classpath.plugin-v2/middleware' '--' 'repl' | grep " -cp " > .test-classpath; \
+		cat .test-classpath; \
+		eval "$$(cat .test-classpath)"; \
+		rm .test-classpath; \
+	elif [[ "$$PARSER_TARGET" == "parser" ]] ; then \
+		export SKIP_INLINING_TEST_DEPS=true; \
+		bash 'lein' 'update-in' ':plugins' 'conj' "[mx.cider/lein-enrich-classpath \"$(ENRICH_CLASSPATH_VERSION)\"]" '--' 'with-profile' $(TEST_PROFILES),+cognitest,+$(CLOJURE_VERSION) 'update-in' ':middleware' 'conj' 'cider.enrich-classpath.plugin-v2/middleware' '--' 'repl' | grep " -cp " > .test-classpath; \
+		cat .test-classpath; \
+		sed $(SED_INPLACE) 's/--add-opens=jdk.compiler\/com.sun.tools.javac.code=ALL-UNNAMED//g' .test-classpath; \
+		sed $(SED_INPLACE) 's/--add-opens=jdk.compiler\/com.sun.tools.javac.tree=ALL-UNNAMED//g' .test-classpath; \
+		cat .test-classpath; \
+		eval "$$(cat .test-classpath)"; \
+		rm .test-classpath; \
+	elif [[ "$$PARSER_TARGET" == "legacy-parser" ]] ; then \
+		export SKIP_INLINING_TEST_DEPS=true; \
+		lein with-profile +$(CLOJURE_VERSION),$(TEST_PROFILES) test; \
+	else \
+		echo "PARSER_TARGET unset!"; \
+		exit 1; \
+	fi
+
+test: clean .inline-deps
+	@make test_impl TEST_PROFILES="$(TEST_PROFILES),+plugin.mranderson/config"
 
-quick-test: clean
-	lein with-profile -user,-dev,+$(CLOJURE_VERSION),+test test
+quick-test: clean test_impl
 
 fast-test: quick-test
 
@@ -81,7 +121,9 @@ fast-install: dump-version check-install-env
 	make clean
 	git checkout resources/cider/nrepl/version.edn
 
-smoketest: install
+smoketest:
+	export SKIP_INLINING_TEST_DEPS=true
+	make install
 	cd test/smoketest && \
         lein with-profile -user,-dev,+$(CLOJURE_VERSION) uberjar && \
         java -jar target/smoketest-0.1.0-SNAPSHOT-standalone.jar
@@ -127,6 +169,7 @@ clean:
 # Launches a repl, falling back to vanilla lein repl if something went wrong during classpath calculation.
 lein-repl: .enrich-classpath-lein-repl
 	@if grep --silent " -cp " .enrich-classpath-lein-repl; then \
+		export YOURKIT_SESSION_NAME="$(basename $(PWD))";
 		eval "$$(cat .enrich-classpath-lein-repl) --interactive"; \
 	else \
 		echo "Falling back to lein repl... (you can avoid further falling back by removing .enrich-classpath-lein-repl)"; \

README.md

@@ -73,10 +73,10 @@ These are its main tasks for local development:
 make repl
 
 # Run tests, using mranderson (slower but more realistic)
-make test
+PARSER_TARGET=parser-next make test
 
 # Run tests, without using mranderson (considerably faster)
-make fast-test
+PARSER_TARGET=parser-next make fast-test
 
 # Install the project in your local ~/.m2 directory, using mranderson (recommended)
 # The JVM flag is a temporary workaround.

project.clj

@@ -8,15 +8,19 @@
             :url "http://www.eclipse.org/legal/epl-v10.html"}
   :scm {:name "git" :url "https://github.com/clojure-emacs/cider-nrepl"}
   :dependencies [[nrepl "1.0.0"]
-                 ^:inline-dep [cider/orchard "0.15.1" :exclusions [com.google.code.findbugs/jsr305 com.google.errorprone/error_prone_annotations]]
+                 ~(with-meta '[cider/orchard "0.15.1" :exclusions [com.google.code.findbugs/jsr305 com.google.errorprone/error_prone_annotations]]
+                    ;; orchard is used in a test, so we cannot inline it while running tests.
+                    {:inline-dep (not= "true" (System/getenv "SKIP_INLINING_TEST_DEPS"))})
                  ^:inline-dep [mx.cider/haystack "0.3.1"]
                  ^:inline-dep [thunknyc/profile "0.5.2"]
                  ^:inline-dep [mvxcvi/puget "1.3.4"]
                  ^:inline-dep [fipp ~fipp-version] ; can be removed in unresolved-tree mode
                  ^:inline-dep [compliment "0.4.4-20230929.205009-1"]
                  ^:inline-dep [org.rksm/suitable "0.5.0" :exclusions [org.clojure/clojurescript]]
                  ^:inline-dep [cljfmt "0.9.2" :exclusions [org.clojure/clojurescript]]
-                 ^:inline-dep [org.clojure/tools.namespace "1.3.0"]
+                 ~(with-meta '[org.clojure/tools.namespace "1.3.0"]
+                    ;; :cognitest uses tools.namespace, so we cannot inline it while running tests.
+                    {:inline-dep (not= "true" (System/getenv "SKIP_INLINING_TEST_DEPS"))})
                  ^:inline-dep [org.clojure/tools.trace "0.7.11"]
                  ^:inline-dep [org.clojure/tools.reader "1.3.6"]
                  [mx.cider/logjam "0.1.1"]]
@@ -104,7 +108,7 @@
                                      [org.clojure/clojurescript "1.11.60" :scope "provided"]]}
 
              :maint {:source-paths ["src" "maint"]
-                     :dependencies [[org.clojure/tools.cli "1.0.206"]]}
+                     :dependencies [[org.clojure/tools.cli "1.0.214"]]}
 
              :test {:global-vars {*assert* true}
                     :source-paths ["test/src"]
@@ -123,6 +127,26 @@
                                                                          com.google.code.findbugs/jsr305]]
                                    [cider/piggieback "0.5.3"]]}
 
+             ;; Running the tests with enrich-classpath doing its thing isn't compatible with `lein test`
+             ;; (because there's no such thing as "run `lein test` using this specific classpath"),
+             ;; So we use cognitect.test-runner instead.
+             :cognitest {:dependencies [[org.clojure/tools.namespace "1.4.4"]
+                                        [org.clojure/tools.cli "1.0.214"]]
+                         :source-paths ["test-runner/src"]
+                         ;; This piece of middleware dynamically adds the test paths to a cognitect.test-runner main invocation.
+                         :middleware [~(do
+                                         (defn add-cognitest [{:keys [test-paths] :as project}]
+                                           (assert (seq test-paths))
+                                           (let [cmd (reduce into [["cognitect.test-runner"]
+                                                                   (vec
+                                                                    (interleave (take (count test-paths)
+                                                                                      (repeat "--dir"))
+                                                                                test-paths))
+                                                                   ["--namespace-regex" (pr-str ".*")]
+                                                                   ["--exclude" "cognitest-exclude"]])]
+                                             (assoc-in project [:enrich-classpath :main] (clojure.string/join " " cmd))))
+                                         `add-cognitest)]}
+
              ;; Need ^:repl because of: https://github.com/technomancy/leiningen/issues/2132
              :repl ^:repl [:test
                            {:repl-options {:nrepl-middleware [cider.nrepl/wrap-apropos

test/clj/cider/nrepl/middleware/info_test.clj

@@ -6,7 +6,8 @@
    [clojure.data]
    [clojure.java.io :as io]
    [clojure.string :as str]
-   [clojure.test :refer :all])
+   [clojure.test :refer :all]
+   [orchard.misc :as misc])
   (:import
    (cider.nrepl.test AnotherTestClass TestClass YetAnotherTest)
    (org.apache.commons.lang3 SystemUtils)))
@@ -20,6 +21,23 @@
   (boolean (or (io/resource "java/lang/Thread.java")
                (io/resource "java.base/java/lang/Thread.java"))))
 
+;; TODO: use `orchard.java/parser-next-available?` after Orchar's next release
+(def parser-next-available?
+  (delay ;; avoid the side-effects at compile-time
+    (atom ;; make the result mutable - this is helpful in case the detection below wasn't sufficient
+     (and (>= misc/java-api-version 9)
+          (try
+            ;; indicates that the classes are available
+            ;; however it does not indicate if necessary `add-opens=...` JVM flag is in place:
+            (and
+             (Class/forName "com.sun.tools.javac.tree.DCTree$DCBlockTag")
+             (Class/forName "com.sun.tools.javac.code.Type$ArrayType")
+             (seq (do
+                    (require 'orchard.java.parser-next)
+                    ((resolve 'orchard.java.parser-next/source-info) `String))))
+            (catch Throwable e
+              false))))))
+
 (deftest format-response-test
   (is (re-find #"^(https?|file|jar|zip):" ; resolved either locally or online
                (-> (info/info {:class "java.lang.Object" :member "toString"})
@@ -146,7 +164,7 @@
         (is (= (:doc response) "a macro for testing"))
         (is (nil? (:spec response)))))
 
-    (when enriched-classpath?
+    (when @@parser-next-available?
       (testing "'fragments' attributes are returned"
         (let [{:keys [doc-fragments doc-first-sentence-fragments doc-block-tags-fragments]
                :as response}
@@ -197,7 +215,9 @@
             (pr-str response))
         (is (= (:class response) "cider.nrepl.test.TestClass"))
         (is (= (:member response) "doSomething"))
-        (is (= "[int int java.lang.String]" (:arglists-str response)))
+        (is (#{"[int int java.lang.String]" ;; without enrich-classpath in
+               "[a b c]"} ;; with enrich-classpath in
+             (:arglists-str response)))
         (is (= (:argtypes response) ["int" "int" "java.lang.String"]))
         (is (= (:returns response) "void"))
         (is (= (:modifiers response) "#{:private :static}"))
@@ -382,7 +402,7 @@
             (is (not (contains? response :ns)))
             (is (= "function" (:type response)))))))
 
-    (when enriched-classpath?
+    (when @@parser-next-available?
       (testing "Fragments for java interop method with single class"
         (let [{:keys [doc-fragments doc-first-sentence-fragments doc-block-tags-fragments]
                :as response}
@@ -403,10 +423,16 @@
 
     (testing "java method eldoc lookup, internal testing methods"
       (let [response (session/message {:op "eldoc" :sym "fnWithSameName" :ns "cider.nrepl.middleware.info-test"})]
-        (is (= #{["this"] ;;TestClass
+        (is (#{;; without enrich-classpath in:
+               #{["this"] ;;TestClass
                  ["int" "java.lang.String" "boolean"] ;;AnotherTestClass
                  ["this" "byte[]" "java.lang.Object[]" "java.util.List"]} ;;YetAnotherTest
-               (set (:eldoc response)))
+
+               ;; with enrich-classpath in:
+               #{["this"]
+                 ["a" "b" "c"]
+                 ["this" "prim" "things" "generic"]}}
+             (set (:eldoc response)))
             (pr-str response))
         (is (= "function" (:type response)))))))
 

test/clj/cider/nrepl/plugin_test.clj

@@ -10,7 +10,7 @@
                   ['cider/cider-nrepl version-string]]
    :repl-options {:nrepl-middleware mw/cider-middleware}})
 
-(deftest version-checks
+(deftest ^:cognitest-exclude version-checks
   (testing "undefined versions work"
     (is (= expected-output
            (middleware {:dependencies [['org.clojure/clojure]]}))))