Run tests by tasks

[reify-raman-adlakha]

Not an issue but a suggestion.

Exercism Clojure track tests have metadata :task attached with values from 1 to n, each representing a task in the exercise. While working through tasks sequentially, I prefer running tests specific to the current task. Running these tests using :only (like lein test :only ns/test_function) is tedious since I must execute each test individually. I wanted a way to run all tests associated with a task at once.

After studying how test selectors work, I added a test-selector in project.clj. Now I can run all tests for a specific task—for example, task 2 —using lein test :task 2

Add the :task test-selector in any project that has tests defined with ^{:task 1} type markers.

I hope you find it useful.

(defproject annalyns-infiltration "0.1.0-SNAPSHOT"
    :description "annalyns-infiltration exercise."
    :url "https://github.com/exercism/clojure/tree/main/exercises/concept/annalyns-infiltration"
    :dependencies [[org.clojure/clojure "1.11.1"]]
    :test-selectors {;; Selects all tests with the :task metadata key matching the given value.                          
                     ;; usage
                     ;; lein test :task n ;; where n is the task number
                     :task (fn [m task]
                             (when-let [task-value (get m :task)]
                               (= task task-value)))})

[github-actions]

Hello. Thanks for opening an issue on Exercism 🙂

At Exercism we use our Community Forum, not GitHub issues, as the primary place for discussion. That allows maintainers and contributors from across Exercism's ecosystem to discuss your problems/ideas/suggestions without them having to subscribe to hundreds of repositories.

This issue will be automatically closed. Please use this link to copy your GitHub Issue into a new topic on the forum, where we look forward to chatting with you!

If you're interested in learning more about this auto-responder, please read this blog post.

[ErikSchierboom]

I like the idea. @tasxatzial what about you?

[tasxatzial]

Yes, they posted this on discord and I redirected them here.

[tasxatzial]

We can also do something similar for practice exercises. Run by function, for instance.

[ErikSchierboom]

Great idea.

[tasxatzial]

@ErikSchierboom I have an idea. Concept exercises already have {:task 1} as metadata in the deftests. As far as i know, the cognitect test runner can't pick which functions to run by task. It can select by the :task keyword, but it can't filter by the task number (i think). With this in mind, here's a simple modification that works:

For concept exercises the metadata for the deftests is expanded to avoid breaking existing setup. For example {:task 1 :task-1 true} instead of the current {:task 1}. Project.clj becomes

(defproject annalyns-infiltration "0.1.0-SNAPSHOT"
  :description "annalyns-infiltration exercise."
  :url "https://github.com/exercism/clojure/tree/main/exercises/concept/annalyns-infiltration"
  :dependencies [[org.clojure/clojure "1.12.0"]]
  :test-selectors {:task-1 :task-1 :task-2 :task-2 etc.})

Then we can select with lein as lein test :task-1 to run the tests for the first task.
With the cognitect test runner we can run: clj -X:test :includes '[:task-1]' without modifying deps.edn

As for the practice exercises, they don't have any metadata. So we can simply add a boolean flag. For example:

(deftest ^:allergic-to? allergic-to?_test_1
  (testing "check for eggs allergy ▶ not allergic to anything"
    (is (false? (allergies/allergic-to? 0 :eggs)))))

and we can add the ^:allergic-to? metadata to all deftests that test the allergic-to? function. Running is done as before.

[ErikSchierboom]

Sounds like something worth trying out!

[tasxatzial]

Alright, i'll wait a few days in case anything new comes up, and then i'll start updating the concept exercises first.