Use version text file (#234)

Author: MaitreyaBuddha

AndroidSDK/res/values/strings.xml

@@ -2,6 +2,5 @@
 <resources>
 
     <string name="app_name">Android SDK</string>
-    <string name="sdk_version">4.1.1</string>
 
-</resources>
+</resources>

AndroidSDKCore/build.gradle

@@ -13,16 +13,20 @@ android {
 
     defaultConfig {
         consumerProguardFiles CONSUMER_PROGUARD_FILES
+
+        def packageIdentifier =  System.getenv('LEANPLUM_PACKAGE_IDENTIFIER') ?: 's'
+        buildConfigField 'String', 'LEANPLUM_PACKAGE_IDENTIFIER', '\"' + packageIdentifier + '\"'
+
+        def sdkVersion = file('sdk-version.txt').text
+        buildConfigField 'String', 'SDK_VERSION', '\"' + sdkVersion + '\"'
+
+        def buildNumber = System.getenv('BUILD_NUMBER') ?: '0'
+        buildConfigField 'String', 'BUILD_NUMBER', '\"' + buildNumber + '\"'
     }
     buildTypes {
         release {
             proguardFiles PROGUARD_FILES
         }
-        buildTypes.each {
-            def packageIdentifier = '\"' + (System.getenv("LEANPLUM_PACKAGE_IDENTIFIER") ?: "s") +
-                    '\"'
-            it.buildConfigField 'String', 'LEANPLUM_PACKAGE_IDENTIFIER', packageIdentifier
-        }
     }
 }
 

AndroidSDKCore/sdk-version.txt

@@ -0,0 +1 @@
+4.1.1

AndroidSDKCore/src/main/java/com/leanplum/internal/Constants.java

@@ -36,7 +36,7 @@ public class Constants {
   public static int SOCKET_PORT = 80;
   public static int NETWORK_TIMEOUT_SECONDS = 10;
   public static int NETWORK_TIMEOUT_SECONDS_FOR_DOWNLOADS = 10;
-  public static String LEANPLUM_VERSION = "4.1.1";
+  public static String LEANPLUM_VERSION = BuildConfig.SDK_VERSION + '.' + BuildConfig.BUILD_NUMBER;
   public static String CLIENT = "android";
 
   static final String LEANPLUM_PACKAGE_IDENTIFIER = BuildConfig.LEANPLUM_PACKAGE_IDENTIFIER;

AndroidSDKTests/src/test/java/com/leanplum/internal/BuildConfigTest.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2018, Leanplum, Inc. All rights reserved.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.leanplum.internal;
+
+import com.leanplum.__setup.AbstractTest;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Tests settings that are built from gradle.
+ */
+public class BuildConfigTest extends AbstractTest {
+  /**
+   * Test that a valid version is checked in.
+   */
+  @Test
+  public void testVersion() {
+    String[] parts = Constants.LEANPLUM_VERSION.split("\\.");
+
+    assertEquals(4, parts.length);
+    // Ensure we can parse and do not go down in major version.
+    int major = Integer.parseInt(parts[0]);
+    assert(major >= 4);
+
+    // Ensure minor and patch versions are parseable.
+    int minor = Integer.parseInt(parts[1]);
+    assert(minor >= 0);
+    int patch = Integer.parseInt(parts[2]);
+    assert(patch >= 0);
+
+    // Ensure build number propagates.
+    int build = Integer.parseInt(parts[3]);
+    assert(build >= 0);
+  }
+}

Tools/create-release.py

@@ -1,23 +1,18 @@
 #!/usr/bin/env python2.7
 
 import semver
-import xml.etree.ElementTree as ET
 import sys 
 
-ANDROID_STRINGS_XML = "AndroidSDK/res/values/strings.xml"
+SDK_VERSION_FILE = "AndroidSDKCore/sdk-version.txt"
 
-def get_current_version(root):
-  for element in root.iter("string"):
-    if element.attrib.get("name") == "sdk_version":
-      return element.text
+def get_current_version():
+    with open(SDK_VERSION_FILE, 'r') as f:
+        return f.read()
 
-def update_version(root, xml, version):
-  for element in root.iter("string"):
-    if element.attrib.get("name") == "sdk_version":
-      element.text = str(version)
-      xml.write(ANDROID_STRINGS_XML, encoding='utf-8', xml_declaration=True)
+def update_version(version):
+    with open(SDK_VERSION_FILE, 'w') as f:
+        f.write(version)
 
-"""Type: Major/Minor/Patch"""
 
 """
 1. Read in values.xml
@@ -26,10 +21,8 @@ def update_version(root, xml, version):
 """
 def main():
   release_type = sys.argv[1]
-  xml = ET.parse(ANDROID_STRINGS_XML)
-  root = xml.getroot()
 
-  current_version = get_current_version(root)
+  current_version = get_current_version()
 
   if release_type == "patch":
     release_version = semver.bump_patch(current_version)
@@ -40,7 +33,7 @@ def main():
   else:
     raise Exception("Please pick one patch/minor/major")
 
-  update_version(root, xml, release_version)
+  update_version(release_version)
   sys.stdout.write(release_version)
 
 if __name__ == "__main__":