Merge pull request #525 from SpectraLogic/3_5_git_commit_hash

Fix for https://jira.spectralogic.com/browse/JSDK-268.

Author: rpmoore

build.gradle

@@ -29,6 +29,10 @@ buildscript {
 }
 
 
+plugins {
+    id "com.palantir.git-version" version "0.10.0"
+}
+
 allprojects {
     group = 'com.spectralogic.ds3'
     version = '3.5.3'

ds3-sdk/build.gradle

@@ -58,10 +58,13 @@ task genConfigProperties {
             Files.createDirectories(configPath)
         }
 
+        def gitInfo = versionDetails()
+
         configFile.withWriter{out ->
             out.writeLine("productionBuild=" + productionBuild.toString())
             out.writeLine("version=" + version.toString())
             out.writeLine("build.date=" + new Date().toString())
+            out.writeLine("git.commitHash=" + gitInfo.gitHashFull)
         }
     }
 }

ds3-sdk/src/main/java/com/spectralogic/ds3client/utils/PropertyUtils.java

@@ -26,9 +26,11 @@ public final class PropertyUtils {
     private static final Logger LOG = LoggerFactory.getLogger(PropertyUtils.class);
 
     private static final String SDK_VERSION_PROPERTY_NAME = "version";
+    private static final String GIT_COMMIT_HASH_PROPERTY_NAME = "git.commitHash";
     private static final String PROPERTIES_FILE_NAME = "ds3_sdk.properties";
 
     private static final AtomicReference<String> versionProperty = new AtomicReference<>("");
+    private static final AtomicReference<String> gitCommitHashProperty = new AtomicReference<>("");
 
     private PropertyUtils() {}
 
@@ -37,29 +39,47 @@ private PropertyUtils() {}
      * @return The sdk version, if we can find one, an empty string otherwise.
      */
     public static String getSdkVersion() {
-        if ( ! Guard.isStringNullOrEmpty(versionProperty.get())) {
-            return versionProperty.get();
+        return getPropertyFromPropertiesFile(SDK_VERSION_PROPERTY_NAME, versionProperty);
+    }
+
+    private static String getPropertyFromPropertiesFile(final String propertyName, final AtomicReference<String> propertyValue) {
+        if ( ! Guard.isStringNullOrEmpty(propertyValue.get())) {
+            return propertyValue.get();
+        }
+
+        final String propertyFromPropertiesFile = getPropertyFromPropertiesFile(propertyName);
+
+        if ( ! Guard.isStringNullOrEmpty(propertyFromPropertiesFile)) {
+            propertyValue.set(propertyFromPropertiesFile);
         }
 
+        return propertyValue.get();
+    }
+
+    private static String getPropertyFromPropertiesFile(final String propertyName) {
         final Properties properties = new Properties();
 
         try (final InputStream propertiesStream = PropertyUtils.class.getClassLoader().getResourceAsStream(PROPERTIES_FILE_NAME)) {
             if (propertiesStream != null) {
                 properties.load(propertiesStream);
-                final Object versionPropertyObject = properties.get(SDK_VERSION_PROPERTY_NAME);
-
-                if (versionPropertyObject != null) {
-                    final String versionFromPropFile = properties.get(SDK_VERSION_PROPERTY_NAME).toString();
+                final Object propertyObject = properties.get(propertyName);
 
-                    if ( ! Guard.isStringNullOrEmpty(versionFromPropFile)) {
-                        versionProperty.set(versionFromPropFile);
-                    }
+                if (propertyObject != null) {
+                    return properties.get(propertyName).toString();
                 }
             }
         } catch (final Throwable t) {
             LOG.warn("Could not read properties file.", t);
         }
 
-        return versionProperty.get();
+        return "";
+    }
+
+    /**
+     * Get the git commit hash from a properties file.
+     * @return The git commit hash, if we can find it, an empty string otherwise.
+     */
+    public static String getGitCommitHash() {
+        return getPropertyFromPropertiesFile(GIT_COMMIT_HASH_PROPERTY_NAME, gitCommitHashProperty);
     }
 }

ds3-sdk/src/test/java/com/spectralogic/ds3client/Ds3Client_Test.java

@@ -30,6 +30,7 @@
 import com.spectralogic.ds3client.networking.FailedRequestUsingMgmtPortException;
 import com.spectralogic.ds3client.networking.HttpVerb;
 import com.spectralogic.ds3client.utils.ByteArraySeekableByteChannel;
+import com.spectralogic.ds3client.utils.PropertyUtils;
 import com.spectralogic.ds3client.utils.ResourceUtils;
 import org.junit.Before;
 import org.junit.Test;
@@ -50,6 +51,7 @@
 import static org.hamcrest.CoreMatchers.*;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.greaterThanOrEqualTo;
+import static org.junit.Assert.assertEquals;
 
 public class Ds3Client_Test {
     private static final UUID MASTER_OBJECT_LIST_JOB_ID = UUID.fromString("1a85e743-ec8f-4789-afec-97e587a26936");
@@ -923,6 +925,13 @@ public void testGettingDefaultUserAgent() {
         assertThat(matcher.find(), is(true));
     }
 
+    @Test
+    public void testGettingGitCommitHash() {
+        final String gitCommitHash = PropertyUtils.getGitCommitHash();
+
+        assertEquals(40, gitCommitHash.length());
+    }
+
     @Test
     public void VerifySystemHealthSpectraS3() throws IOException {
         final String responsePayload = "<Data><MsRequiredToVerifyDataPlannerHealth>0</MsRequiredToVerifyDataPlannerHealth></Data>";