Add some msg on debug (-X) mode. Add new option: gitCmd

Author: dobladez

README.md

@@ -69,6 +69,11 @@ add these repos to your `settings.xml` or your project `pom.xml`. Example:
     <th>Default</th>
     <th>Description</th>
   </tr>
+  <tr>
+    <td>gitCmd</td>
+    <td>git</td>
+    <td>Name for 'git' executable to use. You may specify an absolute pathname or a command in you "PATH".</td>
+  </tr>
   <tr>
     <td>tstampFormat</td>
     <td>yyyyMMddHHmmss</td>

TODO.org

@@ -7,6 +7,9 @@
 *** DONE write basic assertion (verify.sh) to validate Mojo's output
 ** DONE Clean up Mojo's output on execution.
 ** SOMEDAY Improve error handling? (need more test cases?)
+*** DONE Don't depend on bash
+*** DONE On debug (-X) print forked commands to stdout
+*** DONE On debug (-X) pring lines as they are processed by git-describe-log-lines
 ** TODO Write example pom.xml/project (may be same as integration test?)
 *** add filtering of propeties file
 *** add field on jar MANIFEST
@@ -31,7 +34,7 @@
 * TODO Generalize protocol for potential non-git implementations
 ** see https://github.com/Raynes/bultitude
 * SOMEDAY Learn more about Plexus and how Maven uses it
-* TODO Propose a defmojo macro for clojure-maven project?
+* Propose a defmojo macro for clojure-maven project?
 ** DONE Implement
 (defmojo
   "This is an example Maven Plugin written in Clojure"

src/it/setting-git-cmd/git.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+git "$@"

src/it/setting-git-cmd/pom.xml

@@ -0,0 +1,35 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+                        http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+
+	<groupId>com.code54.mojo</groupId>
+	<artifactId>buildversion-plugin-example</artifactId>
+	<version>9.9.99</version>
+
+	<name>Build version project example</name>
+	<organization>
+		<name>Code54</name>
+		<url>http://code54.com</url>
+	</organization>
+
+    <build>
+        <plugins>
+          <plugin>
+            <groupId>com.code54.mojo</groupId>
+            <artifactId>buildversion-plugin</artifactId>
+            <version>1.0.1-SNAPSHOT</version>
+            <executions>
+              <execution>
+                <goals><goal>set-properties</goal></goals>
+		        <configuration>
+                  <gitCmd>./git.sh</gitCmd>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+
+        </plugins>
+    </build>
+
+</project>

src/it/setting-git-cmd/setup.groovy

@@ -0,0 +1,12 @@
+
+// make git.sh wrapper  executable.
+// Need to do this because maven-invoker-plugin's cloneProjectsTo doesn't seem to preserve
+// permissions
+println "*** Ensure git.sh is executable"
+def p = "chmod +x target/it/setting-git-cmd/git.sh".execute()
+p.waitFor()
+
+return true
+
+
+

src/it/setting-git-cmd/verify.groovy

@@ -0,0 +1,7 @@
+
+// looking for usage of "git.sh", because we specified that as the git command to use
+
+def build_log = new File("target/it/setting-git-cmd/build.log").text
+
+return build_log.contains("git.sh")
+

src/main/clojure/buildversion_plugin/git.clj

@@ -3,14 +3,20 @@
   (:import java.util.Date java.text.SimpleDateFormat)
   (:use    ;; [clojure.tools.trace :only [dotrace deftrace]]
    [clojure.java.io :only [reader]]
-   [clojure.string :only [trim-newline replace-first split]] )
+   [clojure.string :only [trim-newline replace-first split join]] )
   (:require
    [conch.core :as sh] ))
 
+
+(def ^:dynamic *debug-fn* #(println %))
+(def ^:dynamic *git-cmd* "git")
+
+
 (defn run-git
   ([args] (run-git "." args))
-  ([project-dir args] 
-     (apply sh/proc `("git"  ~@args :dir ~project-dir))))
+  ([project-dir args]
+     (*debug-fn* (str "Running cmd: " *git-cmd* " " (join " " args)))
+     (apply sh/proc `(~*git-cmd* ~@args :dir ~project-dir))))
 
 (defn run-git-wait
   ([args] (run-git-wait "." args))
@@ -28,12 +34,13 @@
   "Given a seq of \"git log\" output lines, return map with :git-tag (most recent tag)
    and :git-tag-delta (number of commits to reach it)"
   (loop [i 0, lines log-lines-seq]
-    (let [[_ hash tag] (re-find #"^(\w+) .*tag: (v[^\)\,]+).*" (first lines))]
+    (let [line (first lines)
+          [_ hash tag] (re-find #"^(\w+) .*tag: (v[^\)\,]+).*" line)]
+      (*debug-fn* (str "Processing git-log line: " line))
       (if (and (not tag) (next lines))
         (recur (inc i) (next lines))
         [tag i]))))
 
-
 (defn git-describe-first-parent [dir]
   "Return map with :git-tag (most recent tag on current branch (always following \"first-parent\" on merges))
 and :git-tag-delta (number of commits -couting on first-parent paths only- from :git-tag to HEAD) "
@@ -44,37 +51,40 @@ and :git-tag-delta (number of commits -couting on first-parent paths only- from
     (sh/destroy p)
     {:git-tag tag, :git-tag-delta delta}))
 
-(defn infer-project-version [dir config-map]
+(defn infer-project-version [dir {:keys [tstamp-format git-cmd debug-fn]
+                                  :or {tstamp-format "yyyyMMddHHmmss"
+                                             git-cmd "git"
+                                            debug-fn #(println %)}}]
   "Infer the current project version from tags on the source-control system"
 
-  (let [tstamp-format (:tstamp-format config-map)
-        commit-tstamp (-> (run-git-wait dir ["log" "-n" "1" "--format=%ct"])
-                          trim-newline
-                          (Long/parseLong)
-                          (* 1000)
-                          Date.)
-        format-str (or tstamp-format "yyyyMMddHHmmss")
-        commit-tstamp-str (.format (SimpleDateFormat. format-str)
-                                   commit-tstamp)
+  (binding [*debug-fn* debug-fn, *git-cmd* git-cmd]
+      (let [commit-tstamp (-> (run-git-wait dir ["log" "-n" "1" "--format=%ct"])
+                              trim-newline
+                              (Long/parseLong)
+                              (* 1000)
+                              Date.)
+            format-str (or tstamp-format "yyyyMMddHHmmss")
+            commit-tstamp-str (.format (SimpleDateFormat. format-str)
+                                       commit-tstamp)
 
-        [short-hash long-hash] (split
-                                (run-git-wait dir [ "log" "-n" "1" "--format=%h %H" ])
-                                #" " )
+            [short-hash long-hash] (split
+                                    (run-git-wait dir [ "log" "-n" "1" "--format=%h %H" ])
+                                    #" " )
 
-        versioning-properties {:build-tag "N/A"
-                               :build-version "N/A"
-                               :build-tag-delta "0"
-                               :build-tstamp commit-tstamp-str
-                               :build-commit long-hash
-                               :build-commit-abbrev short-hash }
-                                                                                                                                                                     
-        {:keys [git-tag git-tag-delta] } (git-describe-first-parent dir)]
+            versioning-properties {:build-tag "N/A"
+                                   :build-version "N/A"
+                                   :build-tag-delta "0"
+                                   :build-tstamp commit-tstamp-str
+                                   :build-commit long-hash
+                                   :build-commit-abbrev short-hash }
+            
+            {:keys [git-tag git-tag-delta] } (git-describe-first-parent dir)]
 
-    (if (nil? git-tag)
-      versioning-properties
-      
-      (let [maven-artifact-version ((re-find #"v(.*)" git-tag) 1)]
-        (merge versioning-properties
-               {:build-tag maven-artifact-version
-                :build-version (str (replace-first git-tag #"^v" "") "-" git-tag-delta "-" short-hash)
-                :build-tag-delta (str git-tag-delta) })))))
+        (if (nil? git-tag)
+          versioning-properties
+          
+          (let [maven-artifact-version ((re-find #"v(.*)" git-tag) 1)]
+            (merge versioning-properties
+                   {:build-tag maven-artifact-version
+                    :build-version (str (replace-first git-tag #"^v" "") "-" git-tag-delta "-" short-hash)
+                    :build-tag-delta (str git-tag-delta) }))))))

src/main/clojure/buildversion_plugin/mojo.clj

@@ -19,31 +19,36 @@
   {:goal "set-properties" :phase "initialize" }
 
   ;; Mojo parameters
-  
-  [project  {:expression "${project}" :required true :readonly true}
-
-   tstamp-format {:alias "tstampFormat" :default "yyyyMMddHHmmss"
+  [project       {:expression "${project}"
+                  :required true
+                  :readonly true}
+   tstamp-format {:alias    "tstampFormat"
+                  :default  "yyyyMMddHHmmss"
                   :typename "java.lang.String"}
-
-   custom-script {:alias "customProperties" :typename "java.lang.String"} ]
-
+   custom-script {:alias    "customProperties"
+                  :typename "java.lang.String"}
+   git-cmd       {:alias    "gitCmd"
+                  :default  "git"
+                  :typename "java.lang.String"}   ]
 
   ;; Goal execution
-  (let [git-versions (git/infer-project-version "." {:tstamp-format tstamp-format} )
+  (let [log-debug #(.debug log/*plexus-log* (str "[buildversion-plugin] " %))
+        git-versions (git/infer-project-version "."
+                                                {:tstamp-format tstamp-format
+                                                 :git-cmd (or git-cmd "git")
+                                                 :debug-fn log-debug } )
         custom-versions (if custom-script
                           (eval-custom-script git-versions custom-script)
                           {})
         versions-map (merge git-versions custom-versions)
         props (.getProperties project)
         ]
 
-    (log/debug (str "buildversion-plugin - Setting properties: "))
+    (log-debug "Setting properties: ")
     (doseq [[prop value] versions-map]
-      (log/debug (str (name prop) ": " value))
+      (log-debug (str (name prop) ": " value))
       (.put props (name prop) value))))
 
 
-
-
     ;; injecting project version does not working well :-(
     ;; (.setVersion project (:maven-artifact-version versions-map))

src/test/clojure/buildversion_plugin/test/git.clj

@@ -74,6 +74,15 @@
   (is (re-seq #"git version [\d\.]+"
               (git/run-git-wait sample-project-dir ["--version"]))))
 
+(deftest test-run-git-invalid-path
+  (binding [git/*git-cmd* "/invalid/path/to/git"]
+    (is (thrown-with-msg? Exception #"/invalid/path/to/git"
+          (git/run-git-wait sample-project-dir ["--version"])))))
+
+(deftest test-run-git-invalid-arguments
+  (is (thrown-with-msg? RuntimeException #"Git command failed"
+        (git/run-git-wait sample-project-dir ["--invalid-argument-here"]))))
+
 (deftest test-infer-project-versions
 
   (assert-for-commit "First tagged commit"
@@ -149,6 +158,12 @@
         "bbccdde Dummy commit2"
         "ccddeef Dymmy commit3"] nil 2))
 
+(deftest test-git-describe-first-parent--unexpected-output
+
+  (let [lines ["unexpected" "output" "from" "git"]]
+    (git/git-describe-log-lines lines)))
+
+
 
 (deftest test-tstamp-format-option
   (let [actual-versions (git/infer-project-version sample-project-dir