Update documentation

Flank · Aug 16, 2021 · 0a6edc1 · 0a6edc1
1 parent 54a2df3
commit 0a6edc1
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/corellium/cli/src/main/kotlin/flank/corellium/cli/TestAndroidCommand.kt b/corellium/cli/src/main/kotlin/flank/corellium/cli/TestAndroidCommand.kt
@@ -161,6 +161,7 @@ class TestAndroidCommand :
                 "A map of name suffixes related to set of result types required to include in custom junit report. " +
                     "As results, this option will generate additional amount of junit reports named `JUnitReport-\$suffix.xml`." +
                     "Available result types to include are: [Skipped, Passed, Failed, Flaky]." +
+                    "For example the default configuration will generate JUnitReport-failures.xml." +
                     "Default value is `--junit-report-config=failures=Failed,Flaky;`"
             ]
         )

diff --git a/docs/flank_corellium.md b/docs/flank_corellium.md
@@ -135,6 +135,17 @@ apks:
 ## This option is hiding sensitive details about tests.
 ## default: false
 # obfuscate: true
+
+### Configure JUnit reports
+## A map of name suffixes related to set of result types required to include in custom junit report.
+## Available result types to include are: [Skipped, Passed, Failed, Flaky] (values are not case-sensitive).
+## As results, this option will generate additional amount of junit reports named `JUnitReport-$suffix.xml`.
+## For example the default configuration will generate JUnitReport-failures.xml.  
+## default: failures: [Failed, Flaky]
+# junit-report-config:
+#   skipped: [Skipped]
+#   passed: [PASSED]
+#   failures: [failed, flaky]
 ```
 
 ### Command-line arguments
@@ -168,7 +179,9 @@ The process during its runtime is printing detailed information about execution
 
 The successful run should generate the following files:
 
-* JUnitReport.xml
+* JUnitReport.xml - raw report with reruns.
+  * JUnitReport_failures.xml - only failed and flaky tests.
+  * or any report files generated according to `junit-report-config` option.
 * android_shards.json
 * adb_log
   * Directory that contains dumped log from `am instrument` commands.
@@ -207,13 +220,13 @@ To see the source of the problem check the log file referenced in the error mess
 * Creating or reusing instances (devices).
 * Installing APKs on remote devices.
 * Running android tests.
+* Flaky test detection.
 * Dumping shards to file.
 * Parsing `adb am instrument` logs.
 * Generating JUnit report.
 
 # Roadmap
 
 * Cleaning devices after test execution.
-* Flaky test detection.
 * iOS support.
 * and much more...