feat: More details when call gis --version

fix: #90

Author: minh

.dockerignore

@@ -1,4 +1,3 @@
-.git
 .gitignore
 .vscode
 target

Containerfile

@@ -13,7 +13,7 @@ USER root
 WORKDIR /app/gis
 COPY --from=build /app/gis/target/gis-*.jar target/
 COPY --from=build /app/gis/target/lib target/lib
-RUN native-image -march=compatibility -cp target/gis-*.jar "org.nqm.Gis" --no-fallback
+RUN native-image -march=compatibility -cp target/gis-*.jar "org.nqm.Gis" --no-fallback -H:IncludeResources=".properties"
 RUN mv org.nqm.gis gis
 RUN chmod +x gis
 RUN ./gis --version

integration_test.sh

@@ -5,12 +5,12 @@
   <groupId>org.nqm</groupId>
   <artifactId>gis</artifactId>
   <version>2.0.0-dev</version>
-  <packaging>${packaging}</packaging>
+  <packaging>jar</packaging>
 
   <properties>
+    <commit.hash>${git.commit.id.abbrev}</commit.hash>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-    <packaging>jar</packaging>
     <maven.compiler.target>21</maven.compiler.target>
     <maven.compiler.source>21</maven.compiler.source>
     <picocli.version>4.7.6</picocli.version>
@@ -22,6 +22,8 @@
     <maven-surefire.version>3.3.0</maven-surefire.version>
     <compiler.plugin.version>3.12.1</compiler.plugin.version>
     <jar.plugin.version>3.3.0</jar.plugin.version>
+    <jacoco.version>0.8.12</jacoco.version>
+    <commit.id.version>9.0.1</commit.id.version>
   </properties>
 
   <dependencies>
@@ -78,6 +80,12 @@
 
   <build>
     <defaultGoal>package</defaultGoal>
+    <resources>
+      <resource>
+        <directory>src/main/resources</directory>
+        <filtering>true</filtering>
+      </resource>
+    </resources>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -153,10 +161,10 @@
       <plugin>
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
-        <version>0.8.12</version>
+        <version>${jacoco.version}</version>
         <executions>
           <execution>
-            <id>prepare-agent</id>
+            <phase>test-compile</phase>
             <goals>
               <goal>prepare-agent</goal>
             </goals>
@@ -174,6 +182,25 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>io.github.git-commit-id</groupId>
+        <artifactId>git-commit-id-maven-plugin</artifactId>
+        <version>${commit.id.version}</version>
+        <executions>
+          <execution>
+            <id>get-the-git-infos</id>
+            <goals>
+              <goal>revision</goal>
+            </goals>
+            <phase>process-sources</phase>
+          </execution>
+        </executions>
+        <configuration>
+          <includeOnlyProperties>
+            <includeOnlyProperty>^git.commit.id.abbrev$</includeOnlyProperty>
+          </includeOnlyProperties>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
 </project>

pom.xml

@@ -1,5 +1,6 @@
 package org.nqm;
 
+import org.nqm.command.GisVersion;
 import org.nqm.command.GitCommand;
 import org.nqm.config.GisLog;
 import org.nqm.exception.GisException;
@@ -14,7 +15,7 @@
     name = "gis",
     description = "Git extension wrapper which supports submodules",
     mixinStandardHelpOptions = true,
-    version = "2.0.0-dev")
+    versionProvider = GisVersion.class)
 public class Gis extends GitCommand {
 
   private static final IExecutionExceptionHandler GLOBAL_EXCEPTION_HANLER = new IExecutionExceptionHandler() {

src/main/java/org/nqm/Gis.java

@@ -0,0 +1,20 @@
+package org.nqm.command;
+
+import java.util.Properties;
+import picocli.CommandLine.IVersionProvider;
+
+public class GisVersion implements IVersionProvider {
+
+    @Override
+    public String[] getVersion() throws Exception {
+        var p = new Properties();
+        var gisVersion = "";
+        var commitHash = "";
+        try (var gisConfigs = this.getClass().getClassLoader().getResourceAsStream(".properties")) {
+            p.load(gisConfigs);
+            gisVersion = p.getProperty("gis.version");
+            commitHash = p.getProperty("git.commit.hash");
+        }
+        return new String[] {"gis " + gisVersion, "commit " + commitHash};
+    }
+}

src/main/java/org/nqm/command/GisVersion.java

@@ -0,0 +1,2 @@
+gis.version=${project.version}
+git.commit.hash=${commit.hash}

src/main/resources/.properties

@@ -0,0 +1,19 @@
+package org.nqm.command;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import org.junit.jupiter.api.Test;
+
+class GisVersionTest {
+
+  @Test
+  void getVersion_OK() throws Exception {
+    // given:
+    var gisVersion = new GisVersion();
+
+    // when:
+    var version = gisVersion.getVersion();
+
+    // then:
+    assertThat(version).containsExactly("gis 1.2.3-dev", "commit 44e3d50");
+  }
+}

src/test/java/org/nqm/command/GisVersionTest.java

@@ -0,0 +1,2 @@
+gis.version=1.2.3-dev
+git.commit.hash=44e3d50