Added parsing of test runner and test package from apk-s. (#119)

Author: yunikkk

.gitignore

@@ -8,6 +8,7 @@ build/
 /captures
 /gradle/local.properties
 /docs
+/composer-output*
 
 # Share code style.
 !.idea/codeStyleSettings.xml

README.md

@@ -67,13 +67,11 @@ Composer shipped as jar, to run it you need JVM 1.8+: `java -jar composer-latest
   * Path to application apk that needs to be tested.
 * `--test-apk`
   * Path to apk with tests.
-* `--test-package`
-  * Android package name of the test apk (Could be parsed from `--test-apk`, PR welcome).
-* `--test-runner`
-  * Full qualified name of test runner class you're using (Could be parsed from `--test-apk`, PR welcome).
 
 ##### Optional
 
+* `--test-runner`
+  * Fully qualified name of test runner class you're using. Parsed from `--test-apk`, if not specified manually.
 * `--help, -help, help, -h`
   * Print help and exit.
 * `--shard`
@@ -85,7 +83,7 @@ Composer shipped as jar, to run it you need JVM 1.8+: `java -jar composer-latest
 * `--verbose-output`
   * Either `true` or `false` to enable/disable verbose output for Composer. `false` by default.
 * `--keep-output-on-exit`
-  * Keep output on exit. False by default.
+  * Either `true` or `false` to keep/clean output on exit. `false` by default.".
 * `--devices`
   * Connected devices/emulators that will be used to run tests against. If not passed — tests will run on all connected devices/emulators. Specifying both `--devices` and `--device-pattern` will result in an error. Usage example: `--devices emulator-5554 emulator-5556`.
 * `--device-pattern`
@@ -96,11 +94,18 @@ Composer shipped as jar, to run it you need JVM 1.8+: `java -jar composer-latest
 
 ##### Example
 
+Simplest :
+```console
+java -jar composer-latest-version.jar \
+--apk app/build/outputs/apk/example-debug.apk \
+--test-apk app/build/outputs/apk/example-debug-androidTest.apk
+```
+
+With arguments :
 ```console
 java -jar composer-latest-version.jar \
 --apk app/build/outputs/apk/example-debug.apk \
 --test-apk app/build/outputs/apk/example-debug-androidTest.apk \
---test-package com.example.test \
 --test-runner com.example.test.ExampleTestRunner \
 --output-directory artifacts/composer-output \
 --instrumentation-arguments key1 value1 key2 value2 \

ci/docker/Dockerfile

@@ -6,6 +6,29 @@ RUN apt-get update && \
     apt-get --assume-yes install git curl sudo && \
     curl -sL https://deb.nodesource.com/setup_7.x | bash - && apt-get install --assume-yes nodejs
 
+# `aapt` Android SDK build-tool is needed
+# v26.0.1, https://issuetracker.google.com/issues/64292349
+ENV ANDROID_SDK_URL "https://dl.google.com/android/repository/sdk-tools-linux-3859397.zip"
+ENV ANDROID_SDK_FILE_NAME "android-sdk.zip"
+
+ENV ANDROID_HOME /opt/android-sdk-linux
+ENV PATH ${PATH}:${ANDROID_HOME}/tools:${ANDROID_HOME}/tools/bin:${ANDROID_HOME}/platform-tools
+
+RUN \
+  mkdir -p $ANDROID_HOME && \
+  curl $ANDROID_SDK_URL --progress-bar --location --output $ANDROID_SDK_FILE_NAME && \
+  unzip $ANDROID_SDK_FILE_NAME -d $ANDROID_HOME && \
+  rm $ANDROID_SDK_FILE_NAME
+
+# Download required parts of Android SDK (separate from Android SDK layer).
+
+ENV ANDROID_SDK_COMPONENTS_REVISION 2017-10-25-15-22
+ENV ANDROID_SDK_INSTALL_COMPONENT "echo \"y\" | \"$ANDROID_HOME\"/tools/bin/sdkmanager --verbose"
+
+RUN \
+  echo "Android SDK packages revision $ANDROID_SDK_COMPONENTS_REVISION" && \
+  eval $ANDROID_SDK_INSTALL_COMPONENT '"build-tools;27.0.3"'
+
 # Entrypoint script will allow us run as non-root in the container.
 COPY entrypoint.sh /usr/local/bin/entrypoint.sh
 RUN chmod +x /usr/local/bin/entrypoint.sh

composer/src/main/kotlin/com/gojuno/composer/Apk.kt

@@ -0,0 +1,64 @@
+package com.gojuno.composer
+
+import com.gojuno.commander.android.aapt
+import com.gojuno.commander.os.Notification
+import com.gojuno.commander.os.process
+
+sealed class TestPackage {
+    data class Valid(val value: String) : TestPackage()
+    data class ParseError(val error: String) : TestPackage()
+}
+
+sealed class TestRunner {
+    data class Valid(val value: String) : TestRunner()
+    data class ParseError(val error: String) : TestRunner()
+}
+
+fun parseTestPackage(testApkPath: String): TestPackage =
+        process(
+                commandAndArgs = listOf(
+                        aapt, "dump", "badging", testApkPath
+                ),
+                unbufferedOutput = true
+        )
+                .ofType(Notification.Exit::class.java)
+                .map { (output) ->
+                    output
+                            .readText()
+                            .split(System.lineSeparator())
+                            // output format `package: name='$testPackage' versionCode='' versionName='' platformBuildVersionName='xxx'`
+                            .firstOrNull { it.contains("package") }
+                            ?.split(" ")
+                            ?.firstOrNull { it.startsWith("name=") }
+                            ?.split("'")
+                            ?.getOrNull(1)
+                            ?.let(TestPackage::Valid)
+                            ?: TestPackage.ParseError("Cannot parse test package from `aapt dump badging \$APK` output.")
+                }
+                .toSingle()
+                .toBlocking()
+                .value()
+
+fun parseTestRunner(testApkPath: String): TestRunner =
+        process(
+                commandAndArgs = listOf(
+                        aapt, "dump", "xmltree", testApkPath, "AndroidManifest.xml"
+                ),
+                unbufferedOutput = true
+        )
+                .ofType(Notification.Exit::class.java)
+                .map { (output) ->
+                    output
+                            .readText()
+                            .split(System.lineSeparator())
+                            .dropWhile { !it.contains("instrumentation") }
+                            .firstOrNull { it.contains("android:name") }
+                            // output format : `A: android:name(0x01010003)="$testRunner" (Raw: "$testRunner")`
+                            ?.split("\"")
+                            ?.getOrNull(1)
+                            ?.let(TestRunner::Valid)
+                            ?: TestRunner.ParseError("Cannot parse test runner from `aapt dump xmltree \$TEST_APK AndroidManifest.xml` output.")
+                }
+                .toSingle()
+                .toBlocking()
+                .value()

composer/src/main/kotlin/com/gojuno/composer/Args.kt

@@ -9,32 +9,24 @@ data class Args(
         @Parameter(
                 names = arrayOf("--apk"),
                 required = true,
-                description = "Path to application apk that needs to be tested",
+                description = "Path to application apk that needs to be tested.",
                 order = 0
         )
         var appApkPath: String = "",
 
         @Parameter(
                 names = arrayOf("--test-apk"),
                 required = true,
-                description = "Path to apk with tests",
+                description = "Path to apk with tests.",
                 order = 1
         )
         var testApkPath: String = "",
 
-        @Parameter(
-                names = arrayOf("--test-package"),
-                required = true,
-                description = "Android package name of the test apk.",
-                order = 2
-        )
-        var testPackage: String = "",
-
         @Parameter(
                 names = arrayOf("--test-runner"),
-                required = true,
-                description = "Full qualified name of test runner class you're using.",
-                order = 3
+                required = false,
+                description = "Fully qualified name of test runner class you're using. Will be parsed from test APK if not specified excplicitly.",
+                order = 2
         )
         var testRunner: String = "",
 
@@ -43,15 +35,15 @@ data class Args(
                 required = false,
                 arity = 1,
                 description = "Either `true` or `false` to enable/disable test sharding which runs tests in parallel on available devices/emulators. `true` by default.",
-                order = 4
+                order = 3
         )
         var shard: Boolean = true,
 
         @Parameter(
                 names = arrayOf("--output-directory"),
                 required = false,
                 description = "Either relative or absolute path to directory for output: reports, files from devices and so on. `composer-output` by default.",
-                order = 5
+                order = 4
         )
         var outputDirectory: String = "composer-output",
 
@@ -61,7 +53,7 @@ data class Args(
                 variableArity = true,
                 description = "Key-value pairs to pass to Instrumentation Runner. Usage example: `--instrumentation-arguments myKey1 myValue1 myKey2 myValue2`.",
                 listConverter = InstrumentationArgumentsConverter::class,
-                order = 6
+                order = 5
         )
         var instrumentationArguments: List<String> = listOf(),
 
@@ -70,15 +62,15 @@ data class Args(
                 required = false,
                 arity = 1,
                 description = "Either `true` or `false` to enable/disable verbose output for Composer. `false` by default.",
-                order = 7
+                order = 6
         )
         var verboseOutput: Boolean = false,
 
         @Parameter(
                 names = arrayOf("--keep-output-on-exit"),
                 required = false,
-                description = "Keep output on exit. False by default.",
-                order = 8
+                description = "Either `true` or `false` to keep/clean output on exit. `false` by default.",
+                order = 7
         )
         var keepOutputOnExit: Boolean = false,
 
@@ -87,29 +79,29 @@ data class Args(
                 required = false,
                 variableArity = true,
                 description = "Connected devices/emulators that will be used to run tests against. If not passed — tests will run on all connected devices/emulators. Specifying both `--devices` and `--device-pattern` will result in an error. Usage example: `--devices emulator-5554 emulator-5556`.",
-                order = 9
+                order = 8
         )
         var devices: List<String> = emptyList(),
 
         @Parameter(
                 names = arrayOf("--device-pattern"),
                 required = false,
                 description = "Connected devices/emulators that will be used to run tests against. If not passed — tests will run on all connected devices/emulators. Specifying both `--device-pattern` and `--devices` will result in an error. Usage example: `--device-pattern \"somePatterns\"`.",
-                order = 10
+                order = 9
         )
         var devicePattern: String = "",
 
         @Parameter(
                 names = arrayOf("--install-timeout"),
                 required = false,
                 description = "APK installation timeout in seconds. If not passed defaults to 120 seconds (2 minutes). Applicable to both test APK and APK under test.",
-                order = 11
+                order = 10
         )
         var installTimeoutSeconds: Int = TimeUnit.MINUTES.toSeconds(2).toInt()
 )
 
 // No way to share array both for runtime and annotation without reflection.
-val PARAMETER_HELP_NAMES = setOf("--help", "-help", "help", "-h")
+private val PARAMETER_HELP_NAMES = setOf("--help", "-help", "help", "-h")
 
 private fun validateArguments(args: Args) {
     if (!args.devicePattern.isEmpty() && !args.devices.isEmpty()) {
@@ -118,7 +110,7 @@ private fun validateArguments(args: Args) {
 }
 
 fun parseArgs(rawArgs: Array<String>) = Args().also { args ->
-    if (PARAMETER_HELP_NAMES.firstOrNull { rawArgs.contains(it) } != null) {
+    if (PARAMETER_HELP_NAMES.any { rawArgs.contains(it) }) {
         JCommander(args).usage()
         exit(Exit.Ok)
     }

composer/src/main/kotlin/com/gojuno/composer/Instrumentation.kt

@@ -104,7 +104,7 @@ private fun parseInstrumentationEntry(str: String): InstrumentationEntry =
 
 // Reads stream in "tail -f" mode.
 fun readInstrumentationOutput(output: File): Observable<InstrumentationEntry> {
-    data class result(val buffer: String = "", val readyForProcessing: Boolean = false)
+    data class Result(val buffer: String = "", val readyForProcessing: Boolean = false)
 
     return tail(output)
             .map(String::trim)
@@ -113,24 +113,24 @@ fun readInstrumentationOutput(output: File): Observable<InstrumentationEntry> {
                 // `INSTRUMENTATION_CODE: <code>` is the last line printed by instrumentation, even if 0 tests were run.
                 !it.startsWith("INSTRUMENTATION_CODE")
             }
-            .scan(result()) { previousResult, newLine ->
+            .scan(Result()) { previousResult, newLine ->
                 val buffer = when (previousResult.readyForProcessing) {
                     true -> newLine
                     false -> "${previousResult.buffer}${System.lineSeparator()}$newLine"
                 }
 
-                result(buffer = buffer, readyForProcessing = newLine.startsWith("INSTRUMENTATION_STATUS_CODE"))
+                Result(buffer = buffer, readyForProcessing = newLine.startsWith("INSTRUMENTATION_STATUS_CODE"))
             }
             .filter { it.readyForProcessing }
             .map { it.buffer }
             .map(::parseInstrumentationEntry)
 }
 
 fun Observable<InstrumentationEntry>.asTests(): Observable<InstrumentationTest> {
-    data class result(val entries: List<InstrumentationEntry> = emptyList(), val tests: List<InstrumentationTest> = emptyList(), val totalTestsCount: Int = 0)
+    data class Result(val entries: List<InstrumentationEntry> = emptyList(), val tests: List<InstrumentationTest> = emptyList(), val totalTestsCount: Int = 0)
 
     return this
-            .scan(result()) { previousResult, newEntry ->
+            .scan(Result()) { previousResult, newEntry ->
                 val entries = previousResult.entries + newEntry
                 val tests: List<InstrumentationTest> = entries
                         .mapIndexed { index, first ->
@@ -166,7 +166,7 @@ fun Observable<InstrumentationEntry>.asTests(): Observable<InstrumentationTest>
                             )
                         }
 
-                result(
+                Result(
                         entries = entries.filter { entry -> tests.firstOrNull { it.className == entry.clazz && it.testName == entry.test } == null },
                         tests = tests,
                         totalTestsCount = previousResult.totalTestsCount + tests.size