Log version and git properties at startup

Author: Donnerbart

build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     application
     java
+    alias(libs.plugins.gradle.git.properties)
     alias(libs.plugins.shadow)
 }
 
@@ -34,6 +35,7 @@ dependencies {
 // ********** distribution **********
 
 tasks.shadowJar {
+    dependsOn(tasks.generateGitProperties)
     mergeServiceFiles()
     archiveBaseName = "split-tests-java"
     archiveClassifier = ""
@@ -59,3 +61,16 @@ dependencies {
 tasks.test {
     useJUnitPlatform()
 }
+
+// ********** git properties **********
+
+gitProperties {
+    dotGitDirectory = project.rootProject.layout.projectDirectory.dir(".git")
+    gitPropertiesName = "split-tests-java.properties"
+    keys = listOf("git.branch", "git.commit.id", "git.commit.id.abbrev", "git.commit.time")
+    customProperty("version", version)
+    extProperty = "gitProps"
+}
+tasks.generateGitProperties {
+    outputs.upToDateWhen { false }
+}

gradle/libs.versions.toml

@@ -20,4 +20,5 @@ junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher
 logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "logback" }
 
 [plugins]
+gradle-git-properties = { id = "com.gorylenko.gradle-git-properties", version = "2.5.0" }
 shadow = { id = "com.gradleup.shadow", version = "8.3.6" }

src/main/java/de/donnerbart/split/TestSplitMain.java

@@ -12,7 +12,11 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.text.SimpleDateFormat;
+import java.time.Instant;
+import java.util.Date;
 import java.util.Objects;
+import java.util.Properties;
 import java.util.function.Consumer;
 
 import static de.donnerbart.split.util.FormatUtil.formatTime;
@@ -46,6 +50,12 @@ public static void main(final @Nullable String @NotNull [] args) throws Exceptio
         if (!validateArguments(arguments, workingDirectory)) {
             exitConsumer.accept(1);
         }
+        final var properties = readProperties("split-tests-java.properties");
+        LOG.info("split-tests-java {} (commit: {} on branch: {}) built on {}",
+                properties.getProperty("version", "unknown"),
+                properties.getProperty("git.commit.id.abbrev", "unknown"),
+                properties.getProperty("git.branch", "unknown"),
+                getBuiltTime(properties.getProperty("git.commit.time", "unknown")));
         LOG.info("Split index {} (total: {})", arguments.splitIndex, arguments.splitTotal);
         LOG.info("Working directory: {}", workingDirectory);
         LOG.info("Glob: {}", arguments.glob);
@@ -140,4 +150,24 @@ static int calculateOptimalTotalSplit(final @NotNull Arguments arguments, final
             lastSlowestSplit = slowestSplit;
         }
     }
+
+    @VisibleForTesting
+    static @NotNull Properties readProperties(final @NotNull String resourceFile) throws Exception {
+        final var properties = new Properties();
+        try (final var inputStream = TestSplitMain.class.getClassLoader().getResourceAsStream(resourceFile)) {
+            if (inputStream != null) {
+                properties.load(inputStream);
+            }
+        }
+        return properties;
+    }
+
+    @VisibleForTesting
+    static @NotNull Date getBuiltTime(final @NotNull String dateString) {
+        try {
+            return new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ").parse(dateString);
+        } catch (final Exception e) {
+            return Date.from(Instant.EPOCH);
+        }
+    }
 }

src/test/java/de/donnerbart/split/TestSplitMainTest.java

@@ -9,6 +9,8 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFilePermission;
+import java.time.Instant;
+import java.util.Date;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 
@@ -128,7 +130,18 @@ void calculateOptimalTotalSplit_withMaxCalculations() throws Exception {
         copyResourceToTarget(projectFolder, "tests/NoTimingOneTest.java", "NoTimingOneTest.java", PERMISSIONS);
         copyResourceToTarget(projectFolder, "tests/NoTimingTwoTest.java", "NoTimingTwoTest.java", PERMISSIONS);
 
-        jCommander.parse("-i", "0", "-t", "4", "-g", "**/*Test.java", "-j", "**/junit-reports/*.xml", "-n", "max", "-m", "5");
+        jCommander.parse("-i",
+                "0",
+                "-t",
+                "4",
+                "-g",
+                "**/*Test.java",
+                "-j",
+                "**/junit-reports/*.xml",
+                "-n",
+                "max",
+                "-m",
+                "5");
         assertThat(TestSplitMain.calculateOptimalTotalSplit(arguments, tmp)).isEqualTo(4);
     }
 
@@ -137,7 +150,18 @@ void calculateOptimalTotalSplit_withTooLowMaxCalculations() throws Exception {
         copyResourceToTarget(projectFolder, "tests/NoTimingOneTest.java", "NoTimingOneTest.java", PERMISSIONS);
         copyResourceToTarget(projectFolder, "tests/NoTimingTwoTest.java", "NoTimingTwoTest.java", PERMISSIONS);
 
-        jCommander.parse("-i", "0", "-t", "1", "-g", "**/*Test.java", "-j", "**/junit-reports/*.xml", "-n", "max", "-m", "4");
+        jCommander.parse("-i",
+                "0",
+                "-t",
+                "1",
+                "-g",
+                "**/*Test.java",
+                "-j",
+                "**/junit-reports/*.xml",
+                "-n",
+                "max",
+                "-m",
+                "4");
         assertThat(TestSplitMain.calculateOptimalTotalSplit(arguments, tmp)).isEqualTo(0);
     }
 
@@ -158,4 +182,32 @@ void calculateOptimalTotalSplit_withInvalidSplitIndex() throws Exception {
         jCommander.parse("-i", "1", "-t", "1", "-g", "**/*Test.java", "-j", "**/junit-reports/*.xml");
         assertThat(TestSplitMain.calculateOptimalTotalSplit(arguments, tmp)).isEqualTo(0);
     }
+
+    @Test
+    void readProperties() throws Exception {
+        final var properties = TestSplitMain.readProperties("split-tests-java-test.properties");
+        assertThat(properties).isNotNull();
+        assertThat(properties.getProperty("git.commit.time")).isEqualTo("2023-01-01T00:01:02+0000");
+        assertThat(properties.getProperty("git.commit.id")).isEqualTo("4c204731e327bc2e06d2a1b02f46e4195c210d0e");
+        assertThat(properties.getProperty("git.commit.id.abbrev")).isEqualTo("4c20473");
+        assertThat(properties.getProperty("git.branch")).isEqualTo("master");
+        assertThat(properties.getProperty("version")).isEqualTo("1.2.3-SNAPSHOT");
+    }
+
+    @Test
+    void readProperties_whenFileNotFound() throws Exception {
+        final var properties = TestSplitMain.readProperties("not-found.properties");
+        assertThat(properties).isNotNull();
+        assertThat(properties).isEmpty();
+    }
+
+    @Test
+    void getBuiltTime() {
+        assertThat(TestSplitMain.getBuiltTime("2023-01-01T00:01:02+0000")).isEqualTo("2023-01-01T00:01:02+0000");
+    }
+
+    @Test
+    void getBuiltTime_whenTimeNotParseable() {
+        assertThat(TestSplitMain.getBuiltTime("")).isEqualTo(Date.from(Instant.EPOCH));
+    }
 }

src/test/resources/split-tests-java-test.properties

@@ -0,0 +1,5 @@
+version=1.2.3-SNAPSHOT
+git.branch=master
+git.commit.id=4c204731e327bc2e06d2a1b02f46e4195c210d0e
+git.commit.id.abbrev=4c20473
+git.commit.time=2023-01-01T00\:01\:02+0000