Get CI/CD Working

.github/workflows/test.yaml

@@ -0,0 +1,72 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - '**/*'
+
+jobs:
+  test-android-sdk:
+    runs-on: macos-latest
+    steps:
+      - name: Check out Java SDK
+        uses: actions/checkout@v3
+        with:
+          repository: 'Eppo-exp/android-sdk'
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+
+      - name: 'Set up GCP SDK'
+        uses: 'google-github-actions/setup-gcloud@v0'
+
+      - name: Restore gradle.properties
+        env:
+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+        shell: bash
+        run: |
+          mkdir -p ~/.gradle/
+          echo "GRADLE_USER_HOME=${HOME}/.gradle" >> $GITHUB_ENV
+          echo "MAVEN_USERNAME=${MAVEN_USERNAME}" > ~/.gradle/gradle.properties
+          echo "MAVEN_PASSWORD=${MAVEN_PASSWORD}" >> ~/.gradle/gradle.properties
+
+      - name: Set up test data
+        run: make test-data
+
+      - name: Spin up emulator and run tests
+        id: testing
+        uses: ReactiveCircus/android-emulator-runner@v2
+        with:
+          api-level: 33
+          target: google_apis
+          arch: x86_64
+          emulator-options: -no-window -gpu swiftshader_indirect -no-snapshot -noaudio -no-boot-anim -dns-server 8.8.8.8
+          script: |
+            echo "Emulator started" 
+            adb logcat -c                                     # clear logs
+            mkdir -p app/                                     # create directory
+            touch app/emulator.log                            # create log file
+            chmod 777 app/emulator.log                        # allow writing to log file
+            adb logcat | grep EppoSDK >> app/emulator.log &   # pipe all logcat messages into log file as a background process
+            ./gradlew connectedCheck                          # run tests
+
+      - name: Upload Emulator Logs
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: emulator logs
+          path: app/emulator.log
+
+      - name: Upload Test Report
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: report
+          path: /Users/runner/work/android-sdk/android-sdk/eppo/build/reports/androidTests/connected/index.html

eppo/build.gradle

@@ -11,14 +11,7 @@ android {
 
     defaultConfig {
         namespace "cloud.eppo.android"
-
-        gradle.startParameter.taskNames.each {
-            if (it.contains("AndroidTest") || it.contains('connectedCheck')) {
-                minSdk 33 // required to use wiremock in tests
-            } else {
-                minSdk 21
-            }
-        }
+        minSdk 21
         targetSdk 33
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -63,17 +56,16 @@ ext.versions = [
     "androidx_runner": "1.5.2",
     "gson": "2.9.1",
     "okhttp": "4.10.0",
-    "wiremock": "2.34.0"
+    "commonsio": "2.14.0"
 ]
 
 
 dependencies {
     testImplementation "junit:junit:${versions.junit}"
-    androidTestImplementation "com.github.tomakehurst:wiremock-jre8:${versions.wiremock}"
     androidTestImplementation "androidx.test.ext:junit:${versions.androidx_junit}"
     androidTestImplementation "androidx.test:core:${versions.androidx_core}"
     androidTestImplementation "androidx.test:runner:${versions.androidx_runner}"
-
+    androidTestImplementation "commons-io:commons-io:${versions.commonsio}"
     implementation("com.google.code.gson:gson:${versions.gson}")
     implementation("com.squareup.okhttp3:okhttp:${versions.okhttp}")
 }

eppo/src/androidTest/java/cloud/eppo/android/EppoClientTest.java

@@ -9,19 +9,17 @@
 import android.content.res.AssetManager;
 import androidx.test.core.app.ApplicationProvider;
 
-import com.github.tomakehurst.wiremock.WireMockServer;
-import com.github.tomakehurst.wiremock.client.WireMock;
+import org.apache.commons.io.Charsets;
+import org.apache.commons.io.IOUtils;
+
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 import com.google.gson.JsonDeserializationContext;
 import com.google.gson.JsonDeserializer;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParseException;
 
-import org.apache.commons.io.Charsets;
-import org.apache.commons.io.IOUtils;
 import org.junit.After;
-import org.junit.Before;
 import org.junit.Test;
 
 import java.io.File;
@@ -38,11 +36,8 @@
 import cloud.eppo.android.dto.adapters.EppoValueAdapter;
 
 public class EppoClientTest {
-    private static final String TAG = EppoClientTest.class.getSimpleName();
-    private static final int TEST_PORT = 4001;
-    private static final String HOST = "http://localhost:" + TEST_PORT;
-    private static final String INVALID_HOST = "http://localhost:" + (TEST_PORT + 1);
-    private WireMockServer mockServer;
+    private static final String TEST_HOST = "http://us-central1-eppo-prod-312905.cloudfunctions.net/serveGithubRacTestFile";
+    private static final String INVALID_HOST = "http://thisisabaddomainforthistest.com";
     private Gson gson = new GsonBuilder()
             .registerTypeAdapter(EppoValue.class, new EppoValueAdapter())
             .registerTypeAdapter(AssignmentValueType.class, new AssignmentValueTypeAdapter(AssignmentValueType.STRING))
@@ -154,34 +149,18 @@ public void onError(String errorMessage) {
         lock.await(2000, TimeUnit.MILLISECONDS);
     }
 
-    @Before
-    public void init() {
-        setupMockRacServer();
-
-        try {
-            initClient(HOST, true, true);
-        } catch (InterruptedException e) {
-            e.printStackTrace();
-            fail();
-        }
-    }
-
     @After
     public void teardown() {
-        this.mockServer.stop();
         deleteCacheFiles();
     }
 
-    private void setupMockRacServer() {
-        this.mockServer = new WireMockServer(TEST_PORT);
-        this.mockServer.start();
-        String racResponseJson = getMockRandomizedAssignmentResponse();
-        this.mockServer.stubFor(WireMock.get(WireMock.urlMatching(".*randomized_assignment.*"))
-                .willReturn(WireMock.okJson(racResponseJson)));
-    }
-
     @Test
     public void testAssignments() {
+        try {
+            initClient(TEST_HOST, true, true);
+        } catch (InterruptedException e) {
+            throw new RuntimeException(e);
+        }
         runTestCases();
     }
 
@@ -202,12 +181,13 @@ private void runTestCases() {
     @Test
     public void testCachedAssignments() {
         try {
-            initClient(HOST, false, true); // ensure cache is populated
-            initClient(INVALID_HOST, false, false); // invalid port to force to use cache
+            initClient(TEST_HOST, false, true); // ensure cache is populated
 
             // wait for a bit since file is loaded asynchronously
             System.out.println("Sleeping for a bit to wait for cache population to complete");
             Thread.sleep(1000);
+
+            initClient(INVALID_HOST, false, false); // invalid port to force to use cache
         } catch (Exception e) {
             fail();
         }

eppo/src/main/java/cloud/eppo/android/ConfigCacheFile.java

@@ -10,7 +10,6 @@
 import java.io.OutputStreamWriter;
 
 public class ConfigCacheFile {
-    private static final String TAG = ConfigCacheFile.class.getSimpleName();
     static final String CACHE_FILE_NAME = "eppo-sdk-config-v2.json";
     private final File filesDir;
     private final File cacheFile;

eppo/src/main/java/cloud/eppo/android/ConfigurationRequestor.java

@@ -1,5 +1,7 @@
 package cloud.eppo.android;
 
+import static cloud.eppo.android.util.Utils.logTag;
+
 import android.util.Log;
 
 import com.google.gson.JsonIOException;
@@ -10,7 +12,7 @@
 import cloud.eppo.android.dto.FlagConfig;
 
 public class ConfigurationRequestor {
-    private static final String TAG = ConfigurationRequestor.class.getCanonicalName();
+    private static final String TAG = logTag(ConfigurationRequestor.class);
 
     private EppoHttpClient client;
     private ConfigurationStore configurationStore;

eppo/src/main/java/cloud/eppo/android/ConfigurationStore.java

@@ -1,5 +1,7 @@
 package cloud.eppo.android;
 
+import static cloud.eppo.android.util.Utils.logTag;
+
 import android.app.Application;
 import android.content.SharedPreferences;
 import android.os.AsyncTask;
@@ -23,7 +25,7 @@
 
 public class ConfigurationStore {
 
-    private static final String TAG = ConfigurationStore.class.getSimpleName();
+    private static final String TAG = logTag(ConfigurationStore.class);
 
     private final Gson gson = new GsonBuilder()
             .registerTypeAdapter(EppoValue.class, new EppoValueAdapter())
@@ -42,17 +44,20 @@ public ConfigurationStore(Application application) {
 
     public boolean loadFromCache(InitializationCallback callback) {
         if (flags != null || !cacheFile.exists()) {
+            Log.d(TAG, "Not loading from cache ("+(flags == null ? "null flags" : "non-null flags")+")");
             return false;
         }
 
         AsyncTask.execute(() -> {
+            Log.d(TAG, "Loading from cache");
             try {
                 synchronized (cacheFile) {
                     InputStreamReader reader = cacheFile.getInputReader();
                     RandomizationConfigResponse configResponse = gson.fromJson(reader, RandomizationConfigResponse.class);
                     reader.close();
                     flags = configResponse.getFlags();
                 }
+                Log.d(TAG, "Cache loaded successfully");
             } catch (Exception e) {
                 Log.e(TAG, "Error loading from local cache", e);
                 cacheFile.delete();

eppo/src/main/java/cloud/eppo/android/EppoClient.java

@@ -1,5 +1,6 @@
 package cloud.eppo.android;
 
+import static cloud.eppo.android.util.Utils.logTag;
 import static cloud.eppo.android.util.Utils.validateNotEmptyOrNull;
 
 import android.app.ActivityManager;
@@ -26,7 +27,7 @@
 import cloud.eppo.android.util.Utils;
 
 public class EppoClient {
-    private static final String TAG = EppoClient.class.getCanonicalName();
+    private static final String TAG = logTag(EppoClient.class);
     private static final String DEFAULT_HOST = "https://fscdn.eppo.cloud";
 
     private final ConfigurationRequestor requestor;

eppo/src/main/java/cloud/eppo/android/EppoHttpClient.java

@@ -1,5 +1,7 @@
 package cloud.eppo.android;
 
+import static cloud.eppo.android.util.Utils.logTag;
+
 import android.util.Log;
 
 import java.io.IOException;
@@ -15,6 +17,8 @@
 import okhttp3.Response;
 
 public class EppoHttpClient {
+    private static final String TAG = logTag(EppoHttpClient.class);
+
     private final OkHttpClient client = new OkHttpClient().newBuilder()
             .connectTimeout(10, TimeUnit.SECONDS)
             .readTimeout(10, TimeUnit.SECONDS)
@@ -41,6 +45,7 @@ public void get(String path, RequestCallback callback) {
             @Override
             public void onResponse(Call call, Response response) {
                 if (response.isSuccessful()) {
+                    Log.d(TAG, "Fetch successfull");
                     callback.onSuccess(response.body().charStream());
                 } else {
                     switch (response.code()) {
@@ -49,9 +54,9 @@ public void onResponse(Call call, Response response) {
                             break;
                         default:
                             if (BuildConfig.DEBUG) {
-                                Log.e(EppoHttpClient.class.getCanonicalName(), "Fetch failed with status code: " + response.code());
+                                Log.e(TAG, "Fetch failed with status code: " + response.code());
                             }
-                            callback.onFailure("Unable to fetch from URL");
+                            callback.onFailure("Bad response from URL "+httpUrl);
                     }
                 }
                 response.close();
@@ -62,7 +67,7 @@ public void onFailure(Call call, IOException e) {
                 if (BuildConfig.DEBUG) {
                     e.printStackTrace();
                 }
-                callback.onFailure("Unable to fetch from URL");
+                callback.onFailure("Unable to fetch from URL "+httpUrl);
             }
         });
     }

eppo/src/main/java/cloud/eppo/android/dto/adapters/EppoValueAdapter.java

@@ -1,5 +1,7 @@
 package cloud.eppo.android.dto.adapters;
 
+import static cloud.eppo.android.util.Utils.logTag;
+
 import android.util.Log;
 
 import com.google.gson.JsonArray;
@@ -13,12 +15,13 @@
 
 import java.lang.reflect.Type;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 
 import cloud.eppo.android.dto.EppoValue;
 
 public class EppoValueAdapter implements JsonDeserializer<EppoValue>, JsonSerializer<EppoValue> {
+    public static final String TAG = logTag(EppoValueAdapter.class);
+
     @Override
     public EppoValue deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
             throws JsonParseException {
@@ -28,7 +31,7 @@ public EppoValue deserialize(JsonElement json, Type typeOfT, JsonDeserialization
                 try {
                     array.add(element.getAsString());
                 } catch (Exception e) {
-                    Log.e(EppoValueAdapter.class.getCanonicalName(), "only Strings are supported");
+                    Log.e(TAG, "only Strings are supported");
                 }
             }
             return EppoValue.valueOf(array);

eppo/src/main/java/cloud/eppo/android/util/Utils.java

@@ -2,14 +2,12 @@
 
 import android.content.Context;
 import android.content.SharedPreferences;
-import android.os.Build;
 
 import java.math.BigInteger;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
-import java.util.Base64;
 import java.util.Date;
 import java.util.TimeZone;
 
@@ -65,4 +63,16 @@ public static SharedPreferences getSharedPrefs(Context context) {
     public static String generateExperimentKey(String featureFlagKey, String allocationKey) {
         return featureFlagKey + '-' + allocationKey;
     }
+
+    public static String logTag(Class loggingClass) {
+        // Common prefix can make filtering logs easier
+        String logTag = ("EppoSDK:"+loggingClass.getSimpleName());
+
+        // Android prefers keeping log tags 23 characters or less
+        if (logTag.length() > 23) {
+            logTag = logTag.substring(0, 23);
+        }
+
+        return logTag;
+    }
 }