-
Notifications
You must be signed in to change notification settings - Fork 119
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add docs for Corellium modules (#1969)
Fixes #1951 Added or updated README.md files: * [:corellium](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium) * [:corellium:adapter](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/adapter) * [:corellium:api](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/api) * [:corellium:apk](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/apk) * [:corellium:cli](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/cli) * [:corellium:client](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/client) * [:corellium:domain](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/domain) * [:corellium:instrument](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/instrument) * [:corellium:instrument:command](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/instrument/command) * [:corellium:instrument:log](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/instrument/log) * [:corellium:junit](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/junit) * [:corellium:sandbox](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/sandbox) * [:corellium:shard](https://github.com/Flank/flank/tree/1951_Improve_Flank-Corellium_documentation/corellium/shard) Additionally, this PR is fixing instrument log parsing to match the specification.
- Loading branch information
Showing
37 changed files
with
815 additions
and
344 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Flank - Corellium | ||
|
||
The Flank test runner driven on Corellium backend. | ||
|
||
### Modules | ||
|
||
![flank-corellium-modules](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1951_Improve_Flank-Corellium_documentation/docs/corellium/modules.puml) | ||
|
||
### Android test run | ||
|
||
![corellium-run-test-android](http://www.plantuml.com/plantuml/proxy?cache=no&fmt=svg&src=https://raw.githubusercontent.com/Flank/flank/1951_Improve_Flank-Corellium_documentation/docs/corellium/run-test-android.puml) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Flank - Corellium - Adapters | ||
|
||
This module is implementing adapters that connect [API](../api) interfaces with Corellium [client](../client). | ||
|
||
### References | ||
|
||
* Module type - [adapter](../../docs/architecture.md#adapter) | ||
* Dependency type - [static](../../docs/architecture.md#static_dependencies) | ||
* Public API - [Api.kt](./src/main/kotlin/flank/corellium/Api.kt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Flank - Corellium - API | ||
|
||
This module specifies the API required by the business logic to operate on corellium features. | ||
|
||
The API is designed to exactly meet domain requirements rather than reflect the remote protocol or third-party client. | ||
|
||
### References | ||
|
||
* Module type - [API](../../docs/architecture.md#api) | ||
* Dependency type - [dynamic](../../docs/architecture.md#dynamic_dependencies) | ||
* Public API - [CorelliumApi.kt](./src/main/kotlin/flank/corellium/api/CorelliumApi.kt) | ||
|
||
## Features | ||
|
||
* Authorizing corellium session - [Authorization.kt](./src/main/kotlin/flank/corellium/api/Authorization.kt) | ||
* Invoking android virtual instances - [AndroidInstance.kt](./src/main/kotlin/flank/corellium/api/AndroidInstance.kt) | ||
* Installing android apps and tests - [AndroidApps.kt](./src/main/kotlin/flank/corellium/api/AndroidApps.kt) | ||
* Executing tests & getting logs - [AndroidTestPlan.kt](./src/main/kotlin/flank/corellium/api/AndroidApps.kt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Android apk parser | ||
|
||
Module responsible for retrieving data like: | ||
|
||
* test cases names | ||
* test runner name | ||
* package name | ||
|
||
from the provided apk files. | ||
|
||
### References | ||
|
||
* Module type - [tool](../../docs/architecture.md#tool) | ||
* Dependency type - [dynamic](../../docs/architecture.md#dynamic_dependencies) | ||
* Public API - [Apk.kt](./src/main/kotlin/flank/apk/Apk.kt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Flank - Corellium - CLI | ||
|
||
This module is specifying and implementing a command-line user interface for Flank-Corellium features. | ||
|
||
### References | ||
|
||
* Module type - [presentation](../../docs/architecture.md#presentation) | ||
* Dependency type - [static](../../docs/architecture.md#dynamic_dependencies) | ||
* Public API - package [flank.corellium.cli](./src/main/kotlin/flank/corellium/cli) |
Oops, something went wrong.