Merge pull request #4 from timothypratley/detect-changes

basic change detection

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
           # Install just one or all simultaneously
           # The value must indicate a particular version of the tool, or use 'latest'
           # to always provision the latest version
-          cli: 1.10.1.693              # Clojure CLI based on tools.deps
+          cli: latest              # Clojure CLI based on tools.deps
 
       # Optional step:
       - name: Cache Clojure dependencies
@@ -38,20 +38,18 @@ jobs:
             ~/.deps.clj
           # List all files containing dependencies:
           key: cljdeps-${{ hashFiles('deps.edn') }}
-          # key: cljdeps-${{ hashFiles('deps.edn', 'bb.edn') }}
-          # key: cljdeps-${{ hashFiles('project.clj') }}
-          # key: cljdeps-${{ hashFiles('build.boot') }}
           restore-keys: cljdeps-
 
       - name: Generate tests
         run: clojure -M:dev:gen --verbose
 
-      - name: Execute tests
-        run: clojure -M:test
+      - name: Execute tests and jar
+        run: clojure -T:build ci
 
-      - name: Deploy
-        if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository == 'org.scicloj/note-to-test'
-        env:
-          CLOJARS_PASSWORD: ${{ secrets.CLOJARSTOKEN }}
-          CLOJARS_USERNAME: myusername
-        run: clojure -T:build deploy
+# TODO: for this to work: change myusername to a valid Clojars username, generate a token, add it as a secret in github project settings
+#      - name: Deploy
+#        if: github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository == 'org.scicloj/note-to-test'
+#        env:
+#          CLOJARS_PASSWORD: ${{ secrets.CLOJARSTOKEN }}
+#          CLOJARS_USERNAME: myusername
+#        run: clojure -T:build deploy

deps.edn

@@ -6,9 +6,11 @@
                    :ns-default build}
            :dev   {:extra-paths ["test" "notebooks"]
                    :extra-deps  {scicloj/tablecloth {:mvn/version "7.000-beta-51"}}}
+           ;; `clojure -T:build test` will run the tests
            :test  {:extra-paths ["test" "notebooks"]
                    :extra-deps  {org.clojure/test.check {:mvn/version "1.1.1"}
                                  io.github.cognitect-labs/test-runner
                                  {:git/tag "v0.5.1" :git/sha "dfb30dd"}
                                  scicloj/tablecloth     {:mvn/version "7.000-beta-51"}}}
+           ;; `clojure -M:dev:gen verbose` will create the tests
            :gen   {:main-opts ["-m" "scicloj.note-to-test.v1.main"]}}}

src/scicloj/note_to_test/v1/api.clj

@@ -13,10 +13,10 @@
   (gentest! \"notebooks/dum/dummy.clj\")
   ```
   "
-  [source-path]
+  [source-path options]
   (-> source-path
       impl/prepare-context
-      impl/write-tests!))
+      (impl/write-tests! options)))
 
 (defn gentests!
   "Generate tests for all source files discovered in [dirs]."
@@ -29,7 +29,7 @@
              ^File file (file-seq (io/file dir))
              :when (impl/clojure-source? file)]
        (when verbose (println "Loading file" (str file)))
-       (cond-> (gentest! file)
+       (cond-> (gentest! file options)
                verbose (println))))
    [:success]))
 

src/scicloj/note_to_test/v1/impl.clj

@@ -156,10 +156,10 @@
 (defn prepare-context [source-path]
   (try
     (load-file (str source-path))
-    (catch Exception e
-      (throw (ex-info "note-to-test: Exception on lode-file"
-                      {:source-path source-path
-                       :exception e}))))
+    (catch Exception ex
+      (throw (ex-info (str "note-to-test: Exception on load-file '" source-path "'")
+                      {:source-path source-path}
+                      ex))))
   (let [forms (read-forms source-path)
         ns-form (->> forms
                      (filter (begins-with? 'ns))
@@ -187,21 +187,31 @@
      :codes-for-tests codes-for-tests}))
 
 
-(defn write-tests! [context]
-  (let [{:keys [ns-symbol
+(defn write-tests! [context options]
+  (let [{:keys [verbose accept]} options
+        {:keys [ns-symbol
                 ns-requires
                 test-ns-symbol
                 test-ns-requires
                 test-path
-                codes-for-tests]} context]
+                codes-for-tests]} context
+        prev-file (io/file test-path)
+        prev-content (when (.exists prev-file)
+                       (slurp prev-file))
+        content (->> codes-for-tests
+                     (map-indexed (fn [i code]
+                                    (->test code i (find-ns ns-symbol))))
+                     (cons (->test-ns test-ns-symbol
+                                      test-ns-requires))
+                     (string/join "\n"))]
+    (when verbose
+      (cond
+        (nil? prev-content) (println "note-to-test: CREATING" test-path)
+        (= content prev-content) (println "note-to-test: NO CHANGES" test-path)
+        ;; TODO: perhaps print a nice diff? or give the line/column?
+        (not= content prev-content) (println "note-to-test: CHANGING" test-path)))
+    (when (not accept)
+      (throw (ex-info "note-to-test: Changes detected with --accept false" {})))
     (io/make-parents test-path)
-    (->> codes-for-tests
-         (map-indexed (fn [i code]
-                        (->test code
-                                i
-                                (find-ns ns-symbol))))
-         (cons (->test-ns test-ns-symbol
-                          test-ns-requires))
-         (string/join "\n")
-         (spit test-path))
+    (spit test-path content)
     [:wrote test-path]))

src/scicloj/note_to_test/v1/main.clj

@@ -1,18 +1,16 @@
 (ns scicloj.note-to-test.v1.main
-  (:require [clojure.edn :as edn]
-            [clojure.tools.cli :as cli]
+  (:require [clojure.tools.cli :as cli]
             [scicloj.note-to-test.v1.api :as ntt]))
 
 (def cli-options
   [["-d" "--dirs" :default ["notebooks"]]
-   ["-a" "--accept"]
+   ["-a" "--accept" :default true]
    ["-v" "--verbose"]
    ["-h" "--help"]])
 
 (defn -main [& args]
   (let [{:keys [options summary]} (cli/parse-opts args cli-options)
-        {:keys [exit-message ok? dirs]} options]
-    (if exit-message
-      (do (println exit-message)
-          (System/exit (if ok? 0 1)))
+        {:keys [dirs help]} options]
+    (if help
+      (println summary)
       (ntt/gentests! dirs options))))