Skip to content

Commit

Permalink
Update flank_corellium.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-goral committed Jun 28, 2021
1 parent cfb2b89 commit 0ece007
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ password: $password
details = Instrument.Status.Details(emptyMap(), "Class", "Test", null)
)
),
Unit event ExecuteTests.Error("1", NullPointerException(), "path/to/log/1", 5..10),
Unit event ExecuteTests.Error("1", Exception(), "path/to/log/1", 5..10),
Unit event RunTestCorelliumAndroid.Created(File("path/to/apk.apk")),
Unit event RunTestCorelliumAndroid.AlreadyExist(File("path/to/apk.apk")),
)
Expand Down
32 changes: 28 additions & 4 deletions docs/flank_corellium.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,34 @@ The successful run should generate the following files:

* JUnitReport.xml
* android_shards.json
* adb_log
* Directory that contains dumped log from `am instrument` commands.
* Each dump name is related instance id.

### Errors

The execution or its part can fail due to exceptions occur.
Typically, most of the errors can be sourced in incorrect initial arguments or network issues.

List of known possible errors:

#### Test result parsing

Flank is using `am instrument` command to execute tests on Corellium devices.
The console output of the device is collected and parsed until all expected tests return their results.
Due to an invalid apk file, the console can print unexpected output that cannot be parsed by Flank.
In this case, Flank will print an error message similar to the following:

```
Error while parsing results from instance { instance id }.
For details check "results/corellium/android/{ report_dir }/adb_log/{ instance id }" lines { from..to }.
java.lang.Exception
at flank.corellium.cli.RunTestCorelliumAndroidCommandTest.outputTest(RunTestCorelliumAndroidCommandTest.kt:242)
{ ... }
```

The visible exception is related directly to the parsing issue.
To see the source of the problem check the log file referenced in the error message. The file should contain a direct dump from `am instrument command`.

# Features

Expand All @@ -179,7 +207,3 @@ The successful run should generate the following files:
* Structural logging.
* iOS support.
* and much more...

# Known bugs

* Missing `<skipped/>` tag for skipped test cases in JUnit report

0 comments on commit 0ece007

Please sign in to comment.