Get CI/CD Working #33

aarsilv · 2023-10-23T17:42:24Z

Fixes: FF-1121 - Get Android SDK CI/CD Working

This gets automated tests for this SDK working by three main changes:

Creating a GitHub action, test.yml, that spins up an emulator with internet access to run the tests
Leveraging a cloud function to serve as a mock RAC server.
Addressing a caching race condition with our client in our unit tests; adjusting instantiation and waiting to be sure caches are deleted and hydrated when we expect

To support the development of the above--and future development--some additional log statements were added and a common log tag prefix was established that we can use to upload filtered logs as an artifact of the run.

aarsilv · 2023-10-26T21:47:56Z

.github/workflows/test.yaml

+          MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}


It's ok these aren't populated in this repo, they just need to be defined (even if empty string)

aarsilv · 2023-10-26T21:48:36Z

.github/workflows/test.yaml

+          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


8.8.8.8 is Google's DNS server.

A bug in Android resulted in newer images not having valid DNS, and thus no internet, so we need to specify this.

aarsilv · 2023-10-26T21:49:06Z

.github/workflows/test.yaml

+            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


We use grep so we get all the logs from our SDK, regardless of the specific class logging.

aarsilv · 2023-10-26T21:50:23Z

eppo/build.gradle

@@ -63,17 +63,16 @@ ext.versions = [
    "androidx_runner": "1.5.2",
    "gson": "2.9.1",
    "okhttp": "4.10.0",
-    "wiremock": "2.34.0"
+    "commonsio": "2.14.0"


We were using some classes, in apache commons, that came with Wiremock outside of our mock server.

aarsilv · 2023-10-26T21:50:29Z

eppo/build.gradle

@@ -63,17 +63,16 @@ ext.versions = [
    "androidx_runner": "1.5.2",
    "gson": "2.9.1",
    "okhttp": "4.10.0",
-    "wiremock": "2.34.0"


aarsilv · 2023-10-26T21:51:03Z

eppo/src/androidTest/AndroidManifest.xml

@@ -4,5 +4,6 @@
    <application android:usesCleartextTraffic="true" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />


Pretty sure this is not needed but figure I'd keep it for paranoia, especially in case we start testing old versions of the SDK or something.

aarsilv · 2023-10-26T21:52:01Z

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

-    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";


Ideally this is some nice DNS thing but not needed

aarsilv · 2023-10-26T21:52:36Z

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

@@ -154,34 +149,18 @@ public void onError(String errorMessage) {
        lock.await(2000, TimeUnit.MILLISECONDS);
    }

-    @Before


Setting one up once before all tests just caused issues.

leoromanovsky · 2023-10-26T21:52:16Z

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

-            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


leoromanovsky · 2023-10-26T22:04:22Z

.github/workflows/test.yaml

+    env:
+      ANDROID_API_LEVEL: 33


I learned that this env is not necessary

Ok will axe! 🪓

aarsilv force-pushed the aaron/android-sdk-ci-cd branch from 344140d to 5851441 Compare October 23, 2023 20:49

use external mock RAC server

23c7971

aarsilv force-pushed the aaron/android-sdk-ci-cd branch from bc1fd8f to 23c7971 Compare October 25, 2023 22:01

aarsilv added 27 commits October 25, 2023 16:04

pass dns as emulator option

79fd4c1

upload report

c74ac22

allow writing to storage in manifest

606008e

upload emulator logs too

f811529

save logs

53e0025

fix dumb copy paste mistake

6c1f6f3

try a different way to pipe logs:

cd8ec0d

another log attempt

1163a2d

give test step an id

3ecce64

make the directory

5d72c0c

always upload artifacts

aeec925

gradle cache

d9ecd81

correct path

f2d0007

try to copy logging from other PR

3b9df94

specify API level

7c864c4

correct log file name

5baef28

log all the logs

f4f53d5

use same log tag everywhere

48df560

change sleep and add additional logs

b6173db

some more logs

e95b857

include DNS in cache

89ba261

skip caching for now

b27b2e2

remove another gradle caching thing

9e92243

adjust log tag

1660271

try grep to still filter logs

570d3bf

safe truncating of log tag

0b37214

rename task names

432611b

aarsilv commented Oct 26, 2023

View reviewed changes

leoromanovsky approved these changes Oct 26, 2023

View reviewed changes

leoromanovsky reviewed Oct 26, 2023

View reviewed changes

aarsilv added 2 commits October 26, 2023 16:04

minSdk version back to 21

0c2c12e

git rid of extraneous env variable

9fc5dd2

aarsilv marked this pull request as ready for review October 26, 2023 22:08

aarsilv requested review from petzel and agamkrbit October 26, 2023 22:09

aarsilv assigned aarsilv and petzel Oct 26, 2023

remove deprecated android manfest write permission

44f33b0

leoromanovsky closed this Oct 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get CI/CD Working #33

Get CI/CD Working #33

aarsilv commented Oct 23, 2023 •

edited

Loading

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

aarsilv Oct 26, 2023

leoromanovsky Oct 26, 2023

leoromanovsky Oct 26, 2023

aarsilv Oct 26, 2023

		MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
		MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}

Get CI/CD Working #33

Get CI/CD Working #33

Conversation

aarsilv commented Oct 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aarsilv commented Oct 23, 2023 •

edited

Loading