Include git commit ID in manifest

Author: emlun

build.gradle

@@ -74,6 +74,15 @@ task assembleJavadoc(type: Sync) {
   destinationDir = file("${rootProject.buildDir}/javadoc")
 }
 
+String getGitCommit() {
+  def proc = "git rev-parse HEAD".execute(null, projectDir)
+  proc.waitFor()
+  if (proc.exitValue() != 0) {
+    throw new RuntimeException("Failed to get git commit ID");
+  }
+  return proc.text.trim()
+}
+
 subprojects { project ->
 
   sourceCompatibility = 1.8

test-dependent-projects/java-dep-webauthn-server-attestation/src/test/java/com/yubico/webauthn/attestation/ManifestInfoTest.java

@@ -32,4 +32,9 @@ public void standardImplementationPropertiesAreSet() throws IOException {
         assertEquals("Yubico", lookup("Implementation-Vendor"));
     }
 
+    @Test
+    public void customImplementationPropertiesAreSet() throws IOException {
+        assertTrue(lookup("Git-Commit").matches("^[a-f0-9]{40}$"));
+    }
+
 }

test-dependent-projects/java-dep-webauthn-server-core/src/test/java/com/yubico/webauthn/meta/ManifestInfoTest.java

@@ -50,4 +50,9 @@ public void standardImplementationPropertiesAreSet() throws IOException {
         assertEquals("Yubico", lookup("Implementation-Vendor"));
     }
 
+    @Test
+    public void customImplementationPropertiesAreSet() throws IOException {
+        assertTrue(lookup("Git-Commit").matches("^[a-f0-9]{40}$"));
+    }
+
 }

test-dependent-projects/java-dep-webauthn-server-core/src/test/java/com/yubico/webauthn/meta/VersionInfoTest.java

@@ -28,6 +28,7 @@ public void implementationPropertiesAreSet() {
         final Implementation impl = versionInfo.getImplementation();
         assertTrue(impl.getSourceCodeUrl().toExternalForm().startsWith("https://"));
         assertTrue(impl.getVersion().matches("^\\d+\\.\\d+\\.\\d+(-.*)?"));
+        assertTrue(impl.getGitCommit().matches("^[a-f0-9]{40}$"));
     }
 
     @Test

webauthn-server-attestation/build.gradle

@@ -46,6 +46,7 @@ jar {
       'Implementation-Title': project.description,
       'Implementation-Version': project.version,
       'Implementation-Vendor': 'Yubico',
+      'Git-Commit': getGitCommit(),
     ])
   }
 }

webauthn-server-core/build.gradle

@@ -55,6 +55,7 @@ jar {
       'Implementation-Version': project.version,
       'Implementation-Vendor': 'Yubico',
       'Implementation-Source-Url': 'https://github.com/Yubico/java-webauthn-server',
+      'Git-Commit': getGitCommit(),
     ])
   }
 }

webauthn-server-core/src/main/java/com/yubico/webauthn/meta/Implementation.java

@@ -51,4 +51,10 @@ public class Implementation {
     @NonNull
     private final URL sourceCodeUrl;
 
+    /**
+     * The commit ID of the source code the library was built from, if known.
+     */
+    @NonNull
+    private final String gitCommit;
+
 }

webauthn-server-core/src/main/java/com/yubico/webauthn/meta/VersionInfo.java

@@ -74,7 +74,8 @@ public static VersionInfo getInstance() {
      */
     private final Implementation implementation = new Implementation(
         findValueInManifest("Implementation-Version"),
-        new URL(findValueInManifest("Implementation-Source-Url"))
+        new URL(findValueInManifest("Implementation-Source-Url")),
+        findValueInManifest("Git-Commit")
     );
 
     private VersionInfo() throws IOException {