Merge pull request #228 from commercetools/227-fix-version-header

227 fix version header

Author: heshamMassoud

.travis.yml

@@ -8,7 +8,7 @@ dist: trusty
 jdk:
 - openjdk8
 install: true # skips travis' default installation step which executes gradle assemble.
-script: ./gradlew clean build
+script: ./gradlew clean setReleaseVersion build
 # The before_cache and the cache steps cache the gradle installation on travis.
 before_cache:
 - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock

build.gradle

@@ -21,4 +21,5 @@ apply from: "$rootDir/gradle-scripts/maven-publish.gradle"
 apply from: "$rootDir/gradle-scripts/bintray-publish.gradle"
 apply from: "$rootDir/gradle-scripts/oss-publish.gradle"
 apply from: "$rootDir/gradle-scripts/javadocs-publish.gradle"
+apply from: "$rootDir/gradle-scripts/set-release-version.gradle"
 apply from: "$rootDir/gradle-scripts/execution-order.gradle"

docs/RELEASE_NOTES.md

@@ -50,6 +50,13 @@
 [Commits](https://github.com/commercetools/commercetools-sync-java/compare/v1.0.0-M8...v1.0.0-M9) |
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M9/) | 
 [Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M9)
+
+
+**Bug Fixes** (1)
+- **Commons** - Fixed library version in User-Agent headers of JVM SDK clients using the library. Now it is not fetched
+ from the JAR manifest but injected by gradle-scripts/set-release-version.gradle. [#227](https://github.com/commercetools/commercetools-sync-java/issues/227)
+
+
 -->
 
 ### v1.0.0-M8 -  Dec 29, 2017

gradle-scripts/execution-order.gradle

@@ -45,3 +45,5 @@ check.dependsOn jacocoTestReport
 // Ensure jacocoTestCoverageVerification and jacocoTestReport run after integrationTest
 jacocoTestCoverageVerification.mustRunAfter integrationTest
 jacocoTestReport.mustRunAfter integrationTest
+// Ensure build runs after setReleaseVersion
+build.mustRunAfter setReleaseVersion

gradle-scripts/set-release-version.gradle

@@ -0,0 +1,32 @@
+task setReleaseVersion {
+    description 'If the env var "TRAVIS_TAG" is set, injects the value in the ' +
+            'src/main/java/com/commercetools/sync/commons/utils/SyncSolutionInfo.java. Otherwise, if the env var is not ' +
+            'set it sets the version to the value "dev-version". Note: Should only be executed before compilation in ' +
+            'the CI tool (e.g. Travis.)'
+    doLast {
+        def versionFile = 'src/main/java/com/commercetools/sync/commons/utils/SyncSolutionInfo.java'
+        def versionFileContents = new File(versionFile).text
+        def versionPlaceholder = '#{LIB_VERSION}'
+        def libVersion = 'dev-version'
+        def tagName = System.getenv('TRAVIS_TAG')
+
+        if (!versionFileContents.contains(versionPlaceholder)) {
+            throw new InvalidUserCodeException("$versionFile does not contain the placeholder: $versionPlaceholder. " +
+                    "Please make sure the file contains the placeholder, in order for the version to be injected " +
+                    "correctly.")
+        }
+
+        // if build was triggered by a git tag, set version to tag name
+        if (tagName) {
+            libVersion = tagName
+        }
+
+        if (libVersion) {
+            println "Injecting the version: '$libVersion' in $versionFile"
+            ant.replace(file: versionFile, token: versionPlaceholder, value: libVersion)
+        } else {
+            throw new InvalidUserDataException("Unable to set library version in $versionFile. Please make sure the" +
+                    " var 'libVersion' is set correctly.")
+        }
+    }
+}

src/main/java/com/commercetools/sync/commons/utils/SyncSolutionInfo.java

@@ -2,34 +2,24 @@
 
 import io.sphere.sdk.client.SolutionInfo;
 
-import javax.annotation.Nullable;
-
-import static org.apache.commons.lang3.StringUtils.isBlank;
-
-public class SyncSolutionInfo extends SolutionInfo {
-    static final String UNSPECIFIED = "unspecified";
+public final class SyncSolutionInfo extends SolutionInfo {
+    private static final String LIB_NAME = "commercetools-sync-java";
+    /**
+     * This value is injected by the script at gradle-scripts/version-setter.gradle.
+     */
+    private static final String LIB_VERSION = "#{LIB_VERSION}";
 
     /**
      * Extends {@link SolutionInfo} class of the JVM SDK to append to the User-Agent header with information of the
      * commercetools-sync-java library
      *
      * <p>A User-Agent header with a solution information looks like this:
      * {@code commercetools-jvm-sdk/1.4.1 (AHC/2.0) Java/1.8.0_92-b14 (Mac OS X; x86_64)
-     * {implementationTitle}/{implementationVersion}}</p>
+     * {@value LIB_NAME}/{@value LIB_VERSION}}</p>
      *
      */
     public SyncSolutionInfo() {
-        final String implementationTitle = getClass().getPackage().getImplementationTitle();
-        final String implementationVersion = getClass().getPackage().getImplementationVersion();
-        final String solutionName = isAttributeUnspecified(implementationTitle)
-            ? "commercetools-sync-java" : implementationTitle;
-        final String solutionVersion = isAttributeUnspecified(implementationVersion)
-            ? "DEBUG-VERSION" : implementationVersion;
-        setName(solutionName);
-        setVersion(solutionVersion);
-    }
-
-    static boolean isAttributeUnspecified(@Nullable final String attributeValue) {
-        return isBlank(attributeValue) || UNSPECIFIED.equals(attributeValue);
+        setName(LIB_NAME);
+        setVersion(LIB_VERSION);
     }
 }