Run tests on Android

This is currently completely manual. In a follow-up it would be nice to get this running in CI. On a Pixel 3A emulator running Android 30 I observed test crashes in the following tests: selectSpanningMultipleSegments readLargeNioBufferOnlyReadsOneSegment gzipSink gzipSource I needed to rename BufferedSourceTest to BufferedSourceJavaTest, and similarly for BufferedSinkJavaTest and ByteStringJavaTest. We were seeing simple name collisions in these tests which I believe were previously preventing these tests from being executed.
sneha1702 · Dec 27, 2020 · f14edb7 · f14edb7
1 parent 137d44f
commit f14edb7
Show file tree

Hide file tree

Showing 18 changed files with 165 additions and 19 deletions.
diff --git a/android-test/README.md b/android-test/README.md
@@ -0,0 +1,44 @@
+Android Test
+============
+
+This module runs Okio's test suite on a connected Android emulator or device. It requires the same
+set-up as [OkHttp's android-test module][okhttp_android_test].
+
+In brief, configure the Android SDK and PATH:
+
+```
+export ANDROID_SDK_ROOT=/Users/$USER/Library/Android/sdk
+export PATH=$PATH:$ANDROID_SDK_ROOT/tools/bin:$ANDROID_SDK_ROOT/platform-tools
+```
+
+Use `logcat` to stream test logs:
+
+```
+adb logcat '*:E' TestRunner:D TaskRunner:D GnssHAL_GnssInterface:F DeviceStateChecker:F memtrack:F
+```
+
+Then run the tests:
+
+```
+./gradlew :android-test:connectedCheck
+```
+
+
+### Watch Out For Crashing Failures
+
+Some of Okio's tests can cause the test process to crash. The test will be reported as a failure
+with a message like this:
+
+> Test failed to run to completion. Reason: 'Instrumentation run failed due to 'Process crashed.''.
+> Check device logcat for details
+
+When this happens, it's possible that tests are missing from the test run! One workaround is to
+exclude the crashing test and re-run the rest. You can confirm that the test run completed normally
+if a `run finished` line is printed in the logcat logs:
+
+```
+01-01 00:00:00.000 12345 23456 I TestRunner: run finished: 2976 tests, 0 failed, 3 ignored
+```
+
+
+[okhttp_android_test]: https://github.com/square/okhttp/tree/master/android-test
diff --git a/android-test/build.gradle b/android-test/build.gradle
@@ -0,0 +1,66 @@
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
+buildscript {
+  repositories {
+    mavenCentral()
+    gradlePluginPortal()
+    google()
+  }
+}
+
+def isIDE = properties.containsKey('android.injected.invoked.from.ide') ||
+  (System.getenv("XPC_SERVICE_NAME") ?: "").contains("intellij") ||
+  System.getenv("IDEA_INITIAL_DIRECTORY") != null
+
+android {
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_7
+    targetCompatibility JavaVersion.VERSION_1_7
+  }
+
+  kotlinOptions {
+    freeCompilerArgs += "-Xmulti-platform"
+  }
+
+  compileSdkVersion 30
+
+  defaultConfig {
+    minSdkVersion 15
+    targetSdkVersion 30
+    versionCode 1
+    versionName "1.0"
+    testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+  }
+
+  if (!isIDE) {
+    sourceSets {
+      named("androidTest") {
+        it.java.srcDirs += [
+          project.file("../okio-testing/src/commonMain/kotlin"),
+          project.file("../okio/src/commonMain/kotlin"),
+          project.file("../okio/src/commonTest/java"),
+          project.file("../okio/src/commonTest/kotlin"),
+          project.file("../okio/src/hashFunctions/kotlin"),
+          project.file("../okio/src/jvmMain/kotlin"),
+          project.file("../okio/src/jvmTest/java"),
+          project.file("../okio/src/jvmTest/kotlin"),
+        ]
+      }
+    }
+  }
+}
+
+
+dependencies {
+  androidTestImplementation deps.androidx.testExtJunit
+  androidTestImplementation deps.androidx.testRunner
+  androidTestImplementation deps.animalSniffer.annotations
+  androidTestImplementation deps.kotlin.stdLib.common
+  androidTestImplementation deps.kotlin.test.annotations
+  androidTestImplementation deps.kotlin.test.common
+  androidTestImplementation deps.kotlin.test.jdk
+  androidTestImplementation deps.kotlin.time
+  androidTestImplementation deps.test.assertj
+  androidTestImplementation deps.test.junit
+}
diff --git a/android-test/src/main/AndroidManifest.xml b/android-test/src/main/AndroidManifest.xml
@@ -0,0 +1,6 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="okio.android.test">
+  <application
+      android:usesCleartextTraffic="true" />
+  <uses-permission android:name="android.permission.INTERNET" />
+</manifest>
diff --git a/android-test/src/main/res/values/strings.xml b/android-test/src/main/res/values/strings.xml
@@ -0,0 +1,3 @@
+<resources>
+  <string name="app_name">android-test</string>
+</resources>
diff --git a/android-test/src/main/res/xml/network_security_config.xml b/android-test/src/main/res/xml/network_security_config.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<network-security-config>
+  <base-config cleartextTrafficPermitted="false">
+  </base-config>
+</network-security-config>
diff --git a/build.gradle b/build.gradle
@@ -21,6 +21,13 @@ buildscript {
   ]
 
   ext.deps = [
+      'android': [
+        "gradlePlugin": "com.android.tools.build:gradle:4.0.2",
+      ],
+      'androidx': [
+        'testExtJunit': "androidx.test.ext:junit:1.1.2",
+        'testRunner': "androidx.test:runner:1.3.0",
+      ],
       'kotlin': [
           'gradlePlugin': "org.jetbrains.kotlin:kotlin-gradle-plugin:${versions.kotlin}",
           'stdLib': [
@@ -59,6 +66,7 @@ buildscript {
   ]
 
   dependencies {
+    classpath deps.android.gradlePlugin
     classpath deps.kotlin.gradlePlugin
     classpath deps.animalSniffer.gradlePlugin
     classpath deps.japicmp
@@ -74,6 +82,8 @@ buildscript {
   repositories {
     mavenCentral()
     gradlePluginPortal()
+    jcenter()
+    google()
     maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
     maven { url 'https://kotlin.bintray.com/kotlinx/' }
   }
@@ -91,6 +101,7 @@ subprojects {
   repositories {
     mavenCentral()
     jcenter()
+    google()
     maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
     maven { url 'https://kotlin.bintray.com/kotlinx/' }
   }

diff --git a/gradle.properties b/gradle.properties
@@ -1,4 +1,6 @@
 org.gradle.jvmargs='-Dfile.encoding=UTF-8'
+android.enableJetifier=true
+android.useAndroidX=true
 
 # Publishing SHA 256 and 512 hashses of maven-metadata is not supported by Sonatype and Nexus.
 # See https://github.com/gradle/gradle/issues/11308 and

diff --git a/...ommonTest/kotlin/okio/BufferedSinkTest.kt → ...t/kotlin/okio/AbstractBufferedSinkTest.kt b/...ommonTest/kotlin/okio/BufferedSinkTest.kt → ...t/kotlin/okio/AbstractBufferedSinkTest.kt
diff --git a/...monTest/kotlin/okio/BufferedSourceTest.kt → ...kotlin/okio/AbstractBufferedSourceTest.kt b/...monTest/kotlin/okio/BufferedSourceTest.kt → ...kotlin/okio/AbstractBufferedSourceTest.kt
@@ -1013,6 +1013,7 @@ abstract class AbstractBufferedSourceTest internal constructor(
     assertTrue(source.exhausted())
   }
 
+  /** Note that this test crashes the VM on Android. */
   @Test fun selectSpanningMultipleSegments() {
     val commonPrefix = randomBytes(Segment.SIZE + 10)
     val a = Buffer().write(commonPrefix).writeUtf8("a").readByteString()

diff --git a/okio/src/commonTest/kotlin/okio/AbstractFilesystemTest.kt b/okio/src/commonTest/kotlin/okio/AbstractFilesystemTest.kt
@@ -50,10 +50,12 @@ abstract class AbstractFilesystemTest(
   fun canonicalizeDotReturnsCurrentWorkingDirectory() {
     if (filesystem is FakeFilesystem || filesystem is ForwardingFilesystem) return
     val cwd = filesystem.canonicalize(".".toPath())
-    assertTrue(cwd.toString()) {
-      cwd.toString().endsWith("okio${Path.directorySeparator}okio") ||
-        cwd.toString().endsWith("${Path.directorySeparator}okio-okio-test") ||
-        cwd.toString().contains("/CoreSimulator/Devices/")
+    val cwdString = cwd.toString()
+    assertTrue(cwdString) {
+      cwdString.endsWith("okio${Path.directorySeparator}okio") ||
+        cwdString.endsWith("${Path.directorySeparator}okio-parent-okio-test") || // JS
+        cwdString.contains("/CoreSimulator/Devices/") || // iOS simulator.
+        cwdString == "/" // Android emulator.
     }
   }
 

diff --git a/...mTest/java/okio/RealBufferedSinkTest.java → ...mTest/java/okio/BufferedSinkJavaTest.java b/...mTest/java/okio/RealBufferedSinkTest.java → ...mTest/java/okio/BufferedSinkJavaTest.java
@@ -28,7 +28,7 @@
  * Tests solely for the behavior of RealBufferedSink's implementation. For generic
  * BufferedSink behavior use BufferedSinkTest.
  */
-public final class RealBufferedSinkTest {
+public final class BufferedSinkJavaTest {
   @Test public void inputStreamCloses() throws Exception {
     BufferedSink sink = Okio.buffer((Sink) new Buffer());
     OutputStream out = sink.outputStream();

diff --git a/...est/java/okio/RealBufferedSourceTest.java → ...est/java/okio/BufferedSourceJavaTest.java b/...est/java/okio/RealBufferedSourceTest.java → ...est/java/okio/BufferedSourceJavaTest.java
@@ -30,7 +30,7 @@
  * Tests solely for the behavior of RealBufferedSource's implementation. For generic
  * BufferedSource behavior use BufferedSourceTest.
  */
-public final class RealBufferedSourceTest {
+public final class BufferedSourceJavaTest {
   @Test public void inputStreamTracksSegments() throws Exception {
     Buffer source = new Buffer();
     source.writeUtf8("a");

diff --git a/okio/src/jvmTest/java/okio/BufferedSourceTest.java b/okio/src/jvmTest/java/okio/BufferedSourceTest.java
@@ -1192,6 +1192,7 @@ private void assertLongDecimalString(String s, long expected) throws IOException
     assertTrue(source.exhausted());
   }
 
+  /** Note that this test crashes the VM on Android. */
   @Test public void selectSpanningMultipleSegments() throws IOException {
     ByteString commonPrefix = TestUtil.randomBytes(SEGMENT_SIZE + 10);
     ByteString a = new Buffer().write(commonPrefix).writeUtf8("a").readByteString();
@@ -1458,6 +1459,7 @@ private void assertLongDecimalString(String s, long expected) throws IOException
     assertEquals(expected, new String(data));
   }
 
+  /** Note that this test crashes the VM on Android. */
   @Test public void readLargeNioBufferOnlyReadsOneSegment() throws Exception {
     String expected = factory.isOneByteAtATime()
         ? "a"

diff --git a/...src/jvmTest/java/okio/ByteStringTest.java → ...jvmTest/java/okio/ByteStringJavaTest.java b/...src/jvmTest/java/okio/ByteStringTest.java → ...jvmTest/java/okio/ByteStringJavaTest.java
@@ -42,7 +42,7 @@
 import static org.junit.Assert.fail;
 
 @RunWith(Parameterized.class)
-public final class ByteStringTest {
+public final class ByteStringJavaTest {
   interface Factory {
     Factory BYTE_STRING = new Factory() {
       @Override public ByteString decodeHex(String hex) {
@@ -286,23 +286,23 @@ public static List<Object[]> parameters() {
     try {
       ByteString.encodeString("hello", null);
       fail();
-    } catch (IllegalArgumentException expected) {
+    } catch (NullPointerException expected) {
     }
   }
 
   @Test public void encodeNullString() throws Exception {
     try {
       ByteString.encodeString(null, Charset.forName("UTF-8"));
       fail();
-    } catch (IllegalArgumentException expected) {
+    } catch (NullPointerException expected) {
     }
   }
 
   @Test public void decodeNullCharset() throws Exception {
     try {
       ByteString.of().string(null);
       fail();
-    } catch (IllegalArgumentException expected) {
+    } catch (NullPointerException expected) {
     }
   }
 

diff --git a/okio/src/jvmTest/java/okio/LargeStreamsTest.java b/okio/src/jvmTest/java/okio/LargeStreamsTest.java
@@ -51,6 +51,7 @@ public final class LargeStreamsTest {
     assertEquals(SHA256_RANDOM_FOUR_GIB_PLUS_1, hashingSink.hash());
   }
 
+  /** Note that this test hangs on Android. */
   @Test public void gzipSource() throws Exception {
     Pipe pipe = new Pipe(1024 * 1024);
 
@@ -71,6 +72,7 @@ public final class LargeStreamsTest {
     assertEquals(SHA256_RANDOM_FOUR_GIB_PLUS_1, hashingSink.hash());
   }
 
+  /** Note that this test hangs on Android. */
   @Test public void gzipSink() throws Exception {
     Pipe pipe = new Pipe(1024 * 1024);
 

diff --git a/okio/src/jvmTest/java/okio/OkioTest.java b/okio/src/jvmTest/java/okio/OkioTest.java
@@ -146,9 +146,6 @@ public final class OkioTest {
       Okio.buffer((Sink) null);
       fail();
     } catch (NullPointerException expected) {
-      assertEquals("Parameter specified as non-null is null: "
-              + "method okio.Okio__OkioKt.buffer, parameter $this$buffer",
-          expected.getMessage());
     }
   }
 
@@ -157,9 +154,6 @@ public final class OkioTest {
       Okio.buffer((Source) null);
       fail();
     } catch (NullPointerException expected) {
-      assertEquals("Parameter specified as non-null is null: "
-              + "method okio.Okio__OkioKt.buffer, parameter $this$buffer",
-          expected.getMessage());
     }
   }
 

diff --git a/okio/src/jvmTest/kotlin/okio/JvmTest.kt b/okio/src/jvmTest/kotlin/okio/JvmTest.kt
@@ -24,21 +24,21 @@ import kotlin.test.Test
 @ExperimentalFilesystem
 class JvmTest {
   @Test
-  fun `base directory consistent with java io File`() {
+  fun baseDirectoryConsistentWithJavaIoFile() {
     assertThat(Filesystem.SYSTEM.canonicalize(".".toPath()).toString())
       .isEqualTo(File("").canonicalFile.toString())
   }
 
   @Test
-  fun `java io File to okio Path`() {
+  fun javaIoFileToOkioPath() {
     val javaIoFile = File("/foo/bar/baz")
     val okioPath = "/foo/bar/baz".toPath(Path.directorySeparator)
     assertThat(javaIoFile.toOkioPath()).isEqualTo(okioPath)
     assertThat(okioPath.toFile()).isEqualTo(javaIoFile)
   }
 
   @Test
-  fun `nio Path to okio Path`() {
+  fun nioPathToOkioPath() {
     val nioPath = Paths.get("/foo/bar/baz")
     val okioPath = "/foo/bar/baz".toPath(Path.directorySeparator)
     assertThat(nioPath.toOkioPath()).isEqualTo(okioPath)

diff --git a/settings.gradle b/settings.gradle
@@ -1,7 +1,15 @@
+rootProject.name = 'okio-parent'
+
 include ':okio'
 include ':okio-testing'
 include ':okio:jvm:japicmp'
 include ':okio:jvm:jmh'
 include ':samples'
 
 enableFeaturePreview("GRADLE_METADATA")
+
+// The Android test module doesn't work in IntelliJ. Use Android Studio or the command line.
+if (properties.containsKey('android.injected.invoked.from.ide') ||
+  System.getenv('ANDROID_SDK_ROOT') != null) {
+  include ':android-test'
+}