Add generated BuildConfig class containing version instead of using a resource file (#48)

Vignesh Raja · web-flow · commit e6aed1fd9c9c · 2016-12-29T13:53:18.000-08:00
diff --git a/build.gradle b/build.gradle
@@ -14,7 +14,7 @@ buildscript {
 plugins {
     id 'net.researchgate.release' version '2.2.1'
     id 'nebula.optional-base' version '3.0.3'
-    id "me.champeau.gradle.jmh" version "0.3.1"
+    id 'me.champeau.gradle.jmh' version '0.3.1'
 }
 
 allprojects {
diff --git a/core-api/build.gradle b/core-api/build.gradle
@@ -1,3 +1,16 @@
+buildscript {
+    repositories {
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
+    }
+}
+
+plugins {
+    id 'de.fuerstenau.buildconfig' version '1.1.7'
+}
+
 dependencies {
     compile group: 'org.slf4j', name: 'slf4j-api', version: slf4jVersion
     compile group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: jacksonVersion
@@ -12,24 +25,21 @@ dependencies {
     provided group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: jacksonVersion, optional
 }
 
-task build << {
-    // add the build version information into a file that'll go into the distribution
-    ext.buildVersion = new File(projectDir, "src/main/resources/optimizely-build-version")
-    buildVersion.text = version
+apply plugin: 'com.jfrog.bintray'
+apply plugin: 'de.fuerstenau.buildconfig'
+apply plugin: 'maven-publish'
+
+buildConfig {
+    appName = 'core-api'
+    version = rootProject.version
 }
 
-buildscript {
-    repositories {
-        jcenter()
-    }
-    dependencies {
-        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
+sourceSets {
+    main {
+        java.srcDir "${buildDir}/gen/buildconfig/src/main/"
     }
 }
 
-apply plugin: 'com.jfrog.bintray'
-apply plugin: 'maven-publish'
-
 publishing {
     publications {
         mavenJava(MavenPublication) {
diff --git a/core-api/src/main/java/com/optimizely/ab/Optimizely.java b/core-api/src/main/java/com/optimizely/ab/Optimizely.java
@@ -33,7 +33,6 @@
 import com.optimizely.ab.error.RaiseExceptionErrorHandler;
 import com.optimizely.ab.event.EventHandler;
 import com.optimizely.ab.event.LogEvent;
-import com.optimizely.ab.event.internal.BuildVersionInfo;
 import com.optimizely.ab.event.internal.EventBuilder;
 import com.optimizely.ab.event.internal.EventBuilderV1;
 import com.optimizely.ab.event.internal.EventBuilderV2;
@@ -693,7 +692,7 @@ public Optimizely build() throws ConfigParseException {
             }
 
             if (clientVersion == null) {
-                clientVersion = BuildVersionInfo.VERSION;
+                clientVersion = BuildConfig.VERSION;
             }
 
             if (eventBuilder == null) {
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/BuildVersionInfo.java b/core-api/src/main/java/com/optimizely/ab/event/internal/BuildVersionInfo.java
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV1.java b/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV1.java
@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.event.internal;
 
+import com.optimizely.ab.BuildConfig;
 import com.optimizely.ab.event.LogEvent;
 import com.optimizely.ab.internal.ProjectValidationUtils;
 import com.optimizely.ab.bucketing.Bucketer;
@@ -51,7 +52,7 @@ public class EventBuilderV1 extends EventBuilder {
 
     // offline conversion parameter names and prefixes
     private static final String ACCOUNT_ID_PARAM = "d";
-    private static final String BUILD_VERSION = "java-sdk-" + BuildVersionInfo.VERSION;
+    private static final String BUILD_VERSION = "java-sdk-" + BuildConfig.VERSION;
     private static final String EMPTY_BODY = "";
     private static final String EXPERIMENT_PARAM_PREFIX = "x";
     private static final String GOAL_ID_PARAM = "g";
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV2.java b/core-api/src/main/java/com/optimizely/ab/event/internal/EventBuilderV2.java
@@ -16,6 +16,7 @@
  */
 package com.optimizely.ab.event.internal;
 
+import com.optimizely.ab.BuildConfig;
 import com.optimizely.ab.annotations.VisibleForTesting;
 import com.optimizely.ab.bucketing.Bucketer;
 import com.optimizely.ab.config.Attribute;
@@ -63,7 +64,7 @@ public class EventBuilderV2 extends EventBuilder {
     private Serializer serializer;
 
     public EventBuilderV2() {
-        this(ClientEngine.JAVA_SDK, BuildVersionInfo.VERSION);
+        this(ClientEngine.JAVA_SDK, BuildConfig.VERSION);
     }
 
     public EventBuilderV2(ClientEngine clientEngine, String clientVersion) {
diff --git a/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Event.java b/core-api/src/main/java/com/optimizely/ab/event/internal/payload/Event.java
@@ -18,7 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonValue;
 
-import com.optimizely.ab.event.internal.BuildVersionInfo;
+import com.optimizely.ab.BuildConfig;
 
 public class Event {
 
@@ -39,7 +39,7 @@ public String getClientEngineValue() {
     }
 
     String clientEngine = ClientEngine.JAVA_SDK.getClientEngineValue();
-    String clientVersion = BuildVersionInfo.VERSION;
+    String clientVersion = BuildConfig.VERSION;
 
     public String getClientEngine() {
         return clientEngine;
diff --git a/core-api/src/main/resources/.gitignore b/core-api/src/main/resources/.gitignore
@@ -1 +1 @@
-optimizely-build-version
+
diff --git a/core-api/src/test/java/com/optimizely/ab/OptimizelyBuilderTest.java b/core-api/src/test/java/com/optimizely/ab/OptimizelyBuilderTest.java
@@ -22,7 +22,6 @@
 import com.optimizely.ab.error.ErrorHandler;
 import com.optimizely.ab.error.NoOpErrorHandler;
 import com.optimizely.ab.event.EventHandler;
-import com.optimizely.ab.event.internal.BuildVersionInfo;
 import com.optimizely.ab.event.internal.EventBuilderV2;
 import com.optimizely.ab.event.internal.payload.Event.ClientEngine;
 
@@ -143,7 +142,7 @@ public void withDefaultClientVersion() throws Exception {
         Optimizely optimizelyClient = Optimizely.builder(validConfigJsonV2(), mockEventHandler)
             .build();
 
-        assertThat(((EventBuilderV2)optimizelyClient.eventBuilder).clientVersion, is(BuildVersionInfo.VERSION));
+        assertThat(((EventBuilderV2)optimizelyClient.eventBuilder).clientVersion, is(BuildConfig.VERSION));
     }
 
     @Test
diff --git a/core-api/src/test/java/com/optimizely/ab/event/internal/EventBuilderV2Test.java b/core-api/src/test/java/com/optimizely/ab/event/internal/EventBuilderV2Test.java
@@ -18,6 +18,7 @@
 
 import com.google.gson.Gson;
 
+import com.optimizely.ab.BuildConfig;
 import com.optimizely.ab.bucketing.Bucketer;
 import com.optimizely.ab.event.LogEvent;
 import com.optimizely.ab.config.Attribute;
@@ -97,7 +98,7 @@ public void createImpressionEvent() throws Exception {
         assertThat(impression.getAccountId(), is(projectConfig.getAccountId()));
         assertThat(impression.getUserFeatures(), is(expectedUserFeatures));
         assertThat(impression.getClientEngine(), is(ClientEngine.JAVA_SDK.getClientEngineValue()));
-        assertThat(impression.getClientVersion(), is(BuildVersionInfo.VERSION));
+        assertThat(impression.getClientVersion(), is(BuildConfig.VERSION));
     }
 
     /**
@@ -210,7 +211,7 @@ public void createConversionEvent() throws Exception {
         assertFalse(conversion.getIsGlobalHoldback());
         assertThat(conversion.getAnonymizeIP(), is(projectConfig.getAnonymizeIP()));
         assertThat(conversion.getClientEngine(), is(ClientEngine.JAVA_SDK.getClientEngineValue()));
-        assertThat(conversion.getClientVersion(), is(BuildVersionInfo.VERSION));
+        assertThat(conversion.getClientVersion(), is(BuildConfig.VERSION));
     }
 
     /**
diff --git a/gradle/license.gradle b/gradle/license.gradle
@@ -2,7 +2,8 @@ subprojects {
     apply plugin: 'license'
     license {
         header rootProject.file('gradle/HEADER')
-        excludes(['**/*.properties', '**/*.txt', '**/*.conf', '**/*.xml', '**/*.json', '**/LogbackVerifier.java'])
+        excludes(['**/*.properties', '**/*.txt', '**/*.conf', '**/*.xml', '**/*.json', '**/LogbackVerifier.java',
+                  '**/BuildConfig.java'])
         ext.year = Calendar.getInstance().get(Calendar.YEAR)
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ buildscript {`
`14`	`14`	`plugins {`
`15`	`15`	`id 'net.researchgate.release' version '2.2.1'`
`16`	`16`	`id 'nebula.optional-base' version '3.0.3'`
`17`		`- id "me.champeau.gradle.jmh" version "0.3.1"`
	`17`	`+ id 'me.champeau.gradle.jmh' version '0.3.1'`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`allprojects {`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@`
`33`	`33`	`import com.optimizely.ab.error.RaiseExceptionErrorHandler;`
`34`	`34`	`import com.optimizely.ab.event.EventHandler;`
`35`	`35`	`import com.optimizely.ab.event.LogEvent;`
`36`		`-import com.optimizely.ab.event.internal.BuildVersionInfo;`
`37`	`36`	`import com.optimizely.ab.event.internal.EventBuilder;`
`38`	`37`	`import com.optimizely.ab.event.internal.EventBuilderV1;`
`39`	`38`	`import com.optimizely.ab.event.internal.EventBuilderV2;`
`@@ -693,7 +692,7 @@ public Optimizely build() throws ConfigParseException {`
`693`	`692`	`}`
`694`	`693`
`695`	`694`	`if (clientVersion == null) {`
`696`		`- clientVersion = BuildVersionInfo.VERSION;`
	`695`	`+ clientVersion = BuildConfig.VERSION;`
`697`	`696`	`}`
`698`	`697`
`699`	`698`	`if (eventBuilder == null) {`