Extend the test filtering functionality

Now we support multiple include and exclude filter selectors, similar
to what most build tools and the test-runner do.

Author: bbatsov

CHANGELOG.md

@@ -20,7 +20,7 @@
 * Add support for shadow-cljs to `cider-jack-in`.
 * [#2244](https://github.com/clojure-emacs/cider/issues/2244): Display the REPL type in the modeline.
 * [#2238](https://github.com/clojure-emacs/cider/pull/2238): Allow specifying predicates for entries in `cider-jack-in-lein-plugins` and `cider-jack-in-nrepl-middlewares`.
-* Add support for test selectors. If test all or all loaded is called with a prefix ask for a selector in the minibuffer and only run those tests in the project which are marked with the selector. Add variation of test namespace which asks for a selector the same way and only runs a subset of the namespace tests.
+* Add support for test selectors. If test all or all loaded is called with a prefix ask for filter test selectors in the minibuffer and only run those tests in the project which match the filters. Add variation of test namespace which asks for filter selectors the same way and only runs a subset of the namespace tests.
 
 ### Bugs Fixed
 

cider-repl.el

@@ -1427,9 +1427,9 @@ constructs."
 (cider-repl-add-shortcut "test-ns" #'cider-test-run-ns-tests)
 (cider-repl-add-shortcut "test-all" #'cider-test-run-loaded-tests)
 (cider-repl-add-shortcut "test-project" #'cider-test-run-project-tests)
-(cider-repl-add-shortcut "test-ns-with-selector" #'cider-test-run-ns-tests-with-selector)
-(cider-repl-add-shortcut "test-all-with-selector" (lambda () (interactive) (cider-test-run-loaded-tests 'prompt-for-selector)))
-(cider-repl-add-shortcut "test-project-with-selector" (lambda () (interactive) (cider-test-run-project-tests 'prompt-for-selector)))
+(cider-repl-add-shortcut "test-ns-with-filters" #'cider-test-run-ns-tests-with-filters)
+(cider-repl-add-shortcut "test-all-with-filters" (lambda () (interactive) (cider-test-run-loaded-tests 'prompt-for-filters)))
+(cider-repl-add-shortcut "test-project-with-filters" (lambda () (interactive) (cider-test-run-project-tests 'prompt-for-filters)))
 (cider-repl-add-shortcut "test-report" #'cider-test-show-report)
 (cider-repl-add-shortcut "run" #'cider-run)
 (cider-repl-add-shortcut "conn-info" #'cider-display-connection-info)

cider-test.el

@@ -141,7 +141,7 @@ Add to this list to have CIDER recognize additional test defining macros."
     (define-key map (kbd "C-t") #'cider-test-run-test)
     (define-key map (kbd "C-g") #'cider-test-rerun-test)
     (define-key map (kbd "C-n") #'cider-test-run-ns-tests)
-    (define-key map (kbd "C-s") #'cider-test-run-ns-tests-with-selector)
+    (define-key map (kbd "C-s") #'cider-test-run-ns-tests-with-filters)
     (define-key map (kbd "C-l") #'cider-test-run-loaded-tests)
     (define-key map (kbd "C-p") #'cider-test-run-project-tests)
     (define-key map (kbd "C-b") #'cider-test-show-report)
@@ -150,7 +150,7 @@ Add to this list to have CIDER recognize additional test defining macros."
     (define-key map (kbd "t")   #'cider-test-run-test)
     (define-key map (kbd "g")   #'cider-test-rerun-test)
     (define-key map (kbd "n")   #'cider-test-run-ns-tests)
-    (define-key map (kbd "s")   #'cider-test-run-ns-tests-with-selector)
+    (define-key map (kbd "s")   #'cider-test-run-ns-tests-with-filters)
     (define-key map (kbd "l")   #'cider-test-run-loaded-tests)
     (define-key map (kbd "p")   #'cider-test-run-project-tests)
     (define-key map (kbd "b")   #'cider-test-show-report)
@@ -160,11 +160,11 @@ Add to this list to have CIDER recognize additional test defining macros."
   '("Test"
     ["Run test" cider-test-run-test]
     ["Run namespace tests" cider-test-run-ns-tests]
-    ["Run namespace tests with selector" cider-test-run-ns-tests-with-selector]
+    ["Run namespace tests with filters" cider-test-run-ns-tests-with-filters]
     ["Run all loaded tests" cider-test-run-loaded-tests]
-    ["Run all loaded tests with selector" (apply-partially cider-test-run-loaded-tests 'prompt-for-selector)]
+    ["Run all loaded tests with filters" (apply-partially cider-test-run-loaded-tests 'prompt-for-filters)]
     ["Run all project tests" cider-test-run-project-tests]
-    ["Run all project tests with selector" (apply-partially cider-test-run-project-tests 'prompt-for-selector)]
+    ["Run all project tests with filters" (apply-partially cider-test-run-project-tests 'prompt-for-filters)]
     ["Run tests after load-file" cider-auto-test-mode
      :style toggle :selected cider-auto-test-mode]
     "--"
@@ -191,7 +191,7 @@ Add to this list to have CIDER recognize additional test defining macros."
     ;; `f' for "run failed".
     (define-key map "f" #'cider-test-rerun-failed-tests)
     (define-key map "n" #'cider-test-run-ns-tests)
-    (define-key map "s" #'cider-test-run-ns-tests-with-selector)
+    (define-key map "s" #'cider-test-run-ns-tests-with-filters)
     (define-key map "l" #'cider-test-run-loaded-tests)
     (define-key map "p" #'cider-test-run-project-tests)
     ;; `g' generally reloads the buffer.  The closest thing we have to that is
@@ -208,11 +208,11 @@ Add to this list to have CIDER recognize additional test defining macros."
         ["Rerun current test" cider-test-run-test]
         ["Rerun failed/erring tests" cider-test-rerun-failed-tests]
         ["Run all ns tests" cider-test-run-ns-tests]
-        ["Run all ns tests with selector" cider-test-run-ns-tests-with-selector]
+        ["Run all ns tests with filters" cider-test-run-ns-tests-with-filters]
         ["Run all loaded tests" cider-test-run-loaded-tests]
-        ["Run all loaded tests with selector" (apply-partially cider-test-run-loaded-tests 'prompt-for-selector)]
+        ["Run all loaded tests with filters" (apply-partially cider-test-run-loaded-tests 'prompt-for-filters)]
         ["Run all project tests" cider-test-run-project-tests]
-        ["Run all project tests with selector" (apply-partially cider-test-run-project-tests 'prompt-for-selector)]
+        ["Run all project tests with filters" (apply-partially cider-test-run-project-tests 'prompt-for-filters)]
         "--"
         ["Jump to test definition" cider-test-jump]
         ["Display test error" cider-test-stacktrace]
@@ -620,7 +620,7 @@ This uses the Leiningen convention of appending '-test' to the namespace name."
 (declare-function cider-emit-interactive-eval-output "cider-interaction")
 (declare-function cider-emit-interactive-eval-err-output "cider-interaction")
 
-(defun cider-test-execute (ns &optional tests silent prompt-for-selector)
+(defun cider-test-execute (ns &optional tests silent prompt-for-filters)
   "Run tests for NS, which may be a keyword, optionally specifying TESTS.
 
 This tests a single NS, or multiple namespaces when using keywords `:project',
@@ -629,10 +629,18 @@ namespace is specified.  Upon test completion, results are echoed and a test
 report is optionally displayed.  When test failures/errors occur, their sources
 are highlighted.
 If SILENT is non-nil, suppress all messages other then test results.
-If PROMPT-FOR-SELECTOR is non-nil, prompt the user for a test selector.
-The selector will be used to filter the tests before running them."
+If PROMPT-FOR-FILTERS is non-nil, prompt the user for a test selector filters.
+The include/exclude selectors will be used to filter the tests before
+ running them."
   (cider-test-clear-highlights)
-  (let ((selector (when prompt-for-selector (cider-read-from-minibuffer "Test selector (as string): "))))
+  (let ((include-selectors
+         (when prompt-for-filters
+           (split-string
+            (cider-read-from-minibuffer "Test selectors to include (space separated): "))))
+        (exclude-selectors
+         (when prompt-for-filters
+           (split-string
+            (cider-read-from-minibuffer "Test selectors to exclude (space separated): ")))))
     (cider-map-connections
      (lambda (conn)
        (unless silent
@@ -641,16 +649,15 @@ The selector will be used to filter the tests before running them."
              (cider-test-echo-running ns (car tests))
            (cider-test-echo-running ns)))
        (cider-nrepl-send-request
-        `("op"     ,(cond ((stringp ns)         "test")
-                          ((eq :project ns)     "test-all")
-                          ((eq :loaded ns)      "test-all")
-                          ((eq :non-passing ns) "retest"))
-          "selector" ,(when (stringp selector) selector)
-          "ns"     ,(when (stringp ns) ns)
-          "tests"  ,(when (stringp ns) tests)
-          "load?"  ,(when (or (stringp ns)
-                              (eq :project ns))
-                      "true"))
+        `("op"       ,(cond ((stringp ns)         "test")
+                            ((eq :project ns)     "test-all")
+                            ((eq :loaded ns)      "test-all")
+                            ((eq :non-passing ns) "retest"))
+          "includes" ,(when (listp include-selectors) include-selectors)
+          "excludes" ,(when (listp exclude-selectors) exclude-selectors)
+          "ns"       ,(when (stringp ns) ns)
+          "tests"    ,(when (stringp ns) tests)
+          "load?"    ,(when (or (stringp ns) (eq :project ns)) "true"))
         (lambda (response)
           (nrepl-dbind-response response (summary results status out err)
             (cond ((member "namespace-not-found" status)
@@ -692,40 +699,40 @@ The selector will be used to filter the tests before running them."
           (message "No prior failures to retest")))
     (message "No prior results to retest")))
 
-(defun cider-test-run-loaded-tests (prompt-for-selector)
+(defun cider-test-run-loaded-tests (prompt-for-filters)
   "Run all tests defined in currently loaded namespaces.
 
-If PROMPT-FOR-SELECTOR is non-nil, prompt the user for a test selector to filter the tests with."
+If PROMPT-FOR-FILTERS is non-nil, prompt the user for a test selectors to filter the tests with."
   (interactive "P")
-  (cider-test-execute :loaded nil nil prompt-for-selector))
+  (cider-test-execute :loaded nil nil prompt-for-filters))
 
-(defun cider-test-run-project-tests (prompt-for-selector)
+(defun cider-test-run-project-tests (prompt-for-filters)
   "Run all tests defined in all project namespaces, loading these as needed.
 
-If PROMPT-FOR-SELECTOR is non-nil, prompt the user for a test selector to filter the tests with."
+If PROMPT-FOR-FILTERS is non-nil, prompt the user for a test selectors to filter the tests with."
   (interactive "P")
-  (cider-test-execute :project nil nil prompt-for-selector))
+  (cider-test-execute :project nil nil prompt-for-filters))
 
-(defun cider-test-run-ns-tests-with-selector (suppress-inference)
-  "Run tests filtered by a selector for the current Clojure namespace context.
+(defun cider-test-run-ns-tests-with-filters (suppress-inference)
+  "Run tests filtered by selectors for the current Clojure namespace context.
 
 With a prefix arg SUPPRESS-INFERENCE it will try to run the tests in the
 current ns."
   (interactive "P")
   (cider-test-run-ns-tests suppress-inference nil 't))
 
-(defun cider-test-run-ns-tests (suppress-inference &optional silent prompt-for-selector)
+(defun cider-test-run-ns-tests (suppress-inference &optional silent prompt-for-filters)
   "Run all tests for the current Clojure namespace context.
 
 If SILENT is non-nil, suppress all messages other then test results.
 With a prefix arg SUPPRESS-INFERENCE it will try to run the tests in the
-current ns.  If PROMPT-FOR-SELECTOR is non-nil, prompt the user for
-a test selector to filter the tests with."
+current ns.  If PROMPT-FOR-FILTERS is non-nil, prompt the user for
+test selectors to filter the tests with."
   (interactive "P")
   (if-let* ((ns (if suppress-inference
                     (cider-current-ns t)
                   (funcall cider-test-infer-test-ns (cider-current-ns t)))))
-      (cider-test-execute ns nil silent prompt-for-selector)
+      (cider-test-execute ns nil silent prompt-for-filters)
     (if (eq major-mode 'cider-test-report-mode)
         (when (y-or-n-p (concat "Test report does not define a namespace. "
                                 "Rerun failed/erring tests?"))