#835 update documentation and release notes

release_notes.md

@@ -8,6 +8,8 @@
 - [#862](https://github.com/Flank/flank/pull/862) Added printing outcome details. ([piotradamczyk5](https://github.com/piotradamczyk5), [jan-gogo](https://github.com/jan-gogo))
 - [#876](https://github.com/Flank/flank/pull/876) Added --directories-to-pull validation and avoid making request with empty toolStepResult. ([piotradamczyk5](https://github.com/piotradamczyk5))
 - [#875](https://github.com/Flank/flank/pull/875) Enhance permission denied exception logs. ([adamfilipow92](https://github.com/adamfilipow92), [pawelpasterz](https://github.com/pawelpasterz))
+- [#876](https://github.com/Flank/flank/pull/876) Added option to print available devices and OS version to test against. ([piotradamczyk5](https://github.com/piotradamczyk5))
+-
 -
 
 ## v20.06.2

test_runner/docs/ascii/flank.jar_-android-run.adoc

@@ -13,6 +13,8 @@ flank.jar
 
 *flank.jar
  android run* [*-h*] [*--async*] [*--auto-google-login*]
+                       [*--available-devices*] [*--available-environment*]
+                       [*--available-software-versions*]
                        [*--disable-results-upload*] [*--disable-sharding*] [*--dry*]
                        [*--dump-shards*] [*--full-junit-result*]
                        [*--ignore-failed-tests*] [*--keep-file-path*]
@@ -82,6 +84,15 @@ Configuration is read from flank.yml
 *--obfuscate*::
   Replacing internal test names with unique identifiers when using --dump-shards option to avoid exposing internal details
 
+*--available-devices*::
+  Print current list of devices available to test against
+
+*--available-software-versions*::
+  Print current list of OS versions available to test against
+
+*--available-environment*::
+  Print available devices and OS versions list to test against
+
 *--device*=_<String=String>_[,_<String=String>_...]::
   A list of DIMENSION=VALUE pairs which specify a target device to test against. This flag may be repeated to specify multiple devices. The four device dimensions are: model, version, locale, and orientation. If any dimensions are omitted, they will use a default value. Omitting all of the preceding dimension-related flags will run tests against a single device using defaults for all four device dimensions.
 
@@ -115,12 +126,12 @@ Configuration is read from flank.yml
 *--num-flaky-test-attempts*=_<flakyTestAttempts>_::
   The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.
 
-*--max-test-shards*=_<maxTestShards>_::
-  The amount of matrices to split the tests across.
-
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
+*--max-test-shards*=_<maxTestShards>_::
+  The amount of matrices to split the tests across.
+
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 

test_runner/docs/ascii/flank.jar_-firebase-test-android-run.adoc

@@ -13,6 +13,9 @@ flank.jar
 
 *flank.jar
  firebase test android run* [*-h*] [*--async*] [*--auto-google-login*]
+                                     [*--available-devices*]
+                                     [*--available-environment*]
+                                     [*--available-software-versions*]
                                      [*--disable-results-upload*]
                                      [*--disable-sharding*] [*--dry*]
                                      [*--dump-shards*] [*--full-junit-result*]
@@ -94,6 +97,15 @@ Configuration is read from flank.yml
 *--obfuscate*::
   Replacing internal test names with unique identifiers when using --dump-shards option to avoid exposing internal details
 
+*--available-devices*::
+  Print current list of devices available to test against
+
+*--available-software-versions*::
+  Print current list of OS versions available to test against
+
+*--available-environment*::
+  Print available devices and OS versions list to test against
+
 *--device*=_<String=String>_[,_<String=String>_...]::
   A list of DIMENSION=VALUE pairs which specify a target device to test against. This flag may be repeated to specify multiple devices. The four device dimensions are: model, version, locale, and orientation. If any dimensions are omitted, they will use a default value. Omitting all of the preceding dimension-related flags will run tests against a single device using defaults for all four device dimensions.
 
@@ -127,12 +139,12 @@ Configuration is read from flank.yml
 *--num-flaky-test-attempts*=_<flakyTestAttempts>_::
   The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.
 
-*--max-test-shards*=_<maxTestShards>_::
-  The amount of matrices to split the tests across.
-
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
+*--max-test-shards*=_<maxTestShards>_::
+  The amount of matrices to split the tests across.
+
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 

test_runner/docs/ascii/flank.jar_-firebase-test-ios-run.adoc

@@ -12,7 +12,10 @@ flank.jar
 == Synopsis
 
 *flank.jar
- firebase test ios run* [*-h*] [*--async*] [*--disable-results-upload*]
+ firebase test ios run* [*-h*] [*--async*] [*--available-devices*]
+                                 [*--available-environment*]
+                                 [*--available-software-versions*]
+                                 [*--disable-results-upload*]
                                  [*--disable-sharding*] [*--dry*] [*--dump-shards*]
                                  [*--full-junit-result*] [*--ignore-failed-tests*]
                                  [*--keep-file-path*] [*--no-record-video*]
@@ -73,6 +76,15 @@ Configuration is read from flank.yml
 *--obfuscate*::
   Replacing internal test names with unique identifiers when using --dump-shards option to avoid exposing internal details
 
+*--available-devices*::
+  Print current list of devices available to test against
+
+*--available-software-versions*::
+  Print current list of OS versions available to test against
+
+*--available-environment*::
+  Print available devices and OS versions list to test against
+
 *--device*=_<String=String>_[,_<String=String>_...]::
   A list of DIMENSION=VALUE pairs which specify a target device to test against. This flag may be repeated to specify multiple devices. The four device dimensions are: model, version, locale, and orientation. If any dimensions are omitted, they will use a default value. Omitting all of the preceding dimension-related flags will run tests against a single device using defaults for all four device dimensions.
 
@@ -106,12 +118,12 @@ Configuration is read from flank.yml
 *--num-flaky-test-attempts*=_<flakyTestAttempts>_::
   The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.
 
-*--max-test-shards*=_<maxTestShards>_::
-  The amount of matrices to split the tests across.
-
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
+*--max-test-shards*=_<maxTestShards>_::
+  The amount of matrices to split the tests across.
+
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 

test_runner/docs/ascii/flank.jar_-ios-run.adoc

@@ -12,12 +12,14 @@ flank.jar
 == Synopsis
 
 *flank.jar
- ios run* [*-h*] [*--async*] [*--disable-results-upload*]
-                   [*--disable-sharding*] [*--dry*] [*--dump-shards*]
-                   [*--full-junit-result*] [*--ignore-failed-tests*]
-                   [*--keep-file-path*] [*--no-record-video*] [*--obfuscate*]
-                   [*--record-video*] [*--smart-flank-disable-upload*]
-                   [*-c*=_<configPath>_] [*--local-result-dir*=_<localResultsDir>_]
+ ios run* [*-h*] [*--async*] [*--available-devices*]
+                   [*--available-environment*] [*--available-software-versions*]
+                   [*--disable-results-upload*] [*--disable-sharding*] [*--dry*]
+                   [*--dump-shards*] [*--full-junit-result*]
+                   [*--ignore-failed-tests*] [*--keep-file-path*]
+                   [*--no-record-video*] [*--obfuscate*] [*--record-video*]
+                   [*--smart-flank-disable-upload*] [*-c*=_<configPath>_]
+                   [*--local-result-dir*=_<localResultsDir>_]
                    [*--max-test-shards*=_<maxTestShards>_]
                    [*--network-profile*=_<networkProfile>_]
                    [*--num-flaky-test-attempts*=_<flakyTestAttempts>_]
@@ -65,6 +67,15 @@ Configuration is read from flank.yml
 *--obfuscate*::
   Replacing internal test names with unique identifiers when using --dump-shards option to avoid exposing internal details
 
+*--available-devices*::
+  Print current list of devices available to test against
+
+*--available-software-versions*::
+  Print current list of OS versions available to test against
+
+*--available-environment*::
+  Print available devices and OS versions list to test against
+
 *--device*=_<String=String>_[,_<String=String>_...]::
   A list of DIMENSION=VALUE pairs which specify a target device to test against. This flag may be repeated to specify multiple devices. The four device dimensions are: model, version, locale, and orientation. If any dimensions are omitted, they will use a default value. Omitting all of the preceding dimension-related flags will run tests against a single device using defaults for all four device dimensions.
 
@@ -98,12 +109,12 @@ Configuration is read from flank.yml
 *--num-flaky-test-attempts*=_<flakyTestAttempts>_::
   The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns.
 
-*--max-test-shards*=_<maxTestShards>_::
-  The amount of matrices to split the tests across.
-
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
+*--max-test-shards*=_<maxTestShards>_::
+  The amount of matrices to split the tests across.
+
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 

test_runner/src/main/kotlin/ftl/cli/firebase/test/CommonRunCommand.kt

@@ -54,16 +54,16 @@ abstract class CommonRunCommand {
 
     @CommandLine.Option(
         names = ["--available-devices"],
-        description = ["Print available devices list"])
+        description = ["Print current list of devices available to test against"])
     var printAvailableDevices: Boolean = false
 
     @CommandLine.Option(
         names = ["--available-software-versions"],
-        description = ["Print available software versions list"])
+        description = ["Print current list of OS versions available to test against"])
     var printAvailableSoftwareVersions: Boolean = false
 
     @CommandLine.Option(
         names = ["--available-environment"],
-        description = ["Print available devices and software versions list"])
+        description = ["Print available devices and OS versions list to test against"])
     var printAvailableEnvironment: Boolean = false
 }