Add --local-result-dir (#523)

Use exit code 3 on fatal error instead of -1

Author: bootstraponline

README.md

@@ -151,6 +151,9 @@ flank:
 
   ## The billing enabled Google Cloud Platform project name to use
   # project: delta-essence-114723
+
+  ## Local folder to store the test result. Folder is DELETED before each run to ensure only artifacts from the new run are saved.
+  # local-result-dir: flank
 ```
 
 ### Android example
@@ -285,6 +288,9 @@ flank:
 
   ## The billing enabled Google Cloud Platform project name to use
   # project: delta-essence-114723
+
+  ## Local folder to store the test result. Folder is DELETED before each run to ensure only artifacts from the new run are saved.
+  # local-result-dir: flank
 ```
 
 ### Android code coverage

release_notes.md

@@ -5,6 +5,7 @@
 - [#514](https://github.com/TestArmada/flank/pull/514) Rename `testShards` to `maxTestShards` ([miguelslemos](https://github.com/miguelslemos))
 - [#518](https://github.com/TestArmada/flank/pull/518) Add deprecation warnings when old key names are used. `flank android doctor --fix` will auto fix the YAML file. ([bootstraponline](https://github.com/bootstraponline))
 - [#519](https://github.com/TestArmada/flank/pull/519)  Rename `maxTestShards` to `max-test-shards`, `shardTime` to `shard-time`, `repeatTests` to `repeat-tests`, `smartFlankGcsPath` to `smart-flank-gcs-path`, `disableSharding` to `disable-sharding`. Moved `project` from `gcloud` to `flank` ([bootstraponline](https://github.com/bootstraponline))
+- [#523](https://github.com/TestArmada/flank/pull/523) Add `--local-result-dir` to make it easy to find the test result at a fixed path. ([bootstraponline](https://github.com/bootstraponline))
 
 ## v4.4.0
 

test_runner/flank.ios.yml

@@ -102,3 +102,6 @@ flank:
 
   ## The billing enabled Google Cloud Platform project name to use
   # project: delta-essence-114723
+
+  ## Local folder to store the test result. Folder is DELETED before each run to ensure only artifacts from the new run are saved.
+  # local-result-dir: flank

test_runner/flank.yml

@@ -121,3 +121,7 @@ flank:
 
   ## The billing enabled Google Cloud Platform project name to use
   # project: delta-essence-114723
+
+  ## Local folder to store the test result. Folder is DELETED before each run to ensure only artifacts from the new run are saved.
+  # local-result-dir: flank
+  

test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt

@@ -19,6 +19,7 @@ import ftl.args.ArgsToString.devicesToString
 import ftl.args.ArgsToString.listToString
 import ftl.args.ArgsToString.mapToString
 import ftl.args.yml.AndroidGcloudYml
+import ftl.args.yml.AndroidGcloudYmlParams
 import ftl.args.yml.FlankYml
 import ftl.args.yml.GcloudYml
 import ftl.args.yml.YamlDeprecated
@@ -72,6 +73,7 @@ class AndroidArgs(
     override val filesToDownload = cli?.filesToDownload ?: flank.filesToDownload
     override val disableSharding = cli?.disableSharding ?: flank.disableSharding
     override val project = cli?.project ?: flank.project
+    override val localResultDir = cli?.localResultDir ?: flank.localResultDir
 
     // computed properties not specified in yaml
     override val testShardChunks: List<List<String>> by lazy {
@@ -173,6 +175,7 @@ ${listToString(filesToDownload)}
 ${listToString(testTargetsAlwaysRun)}
       disable-sharding: $disableSharding
       project: $project
+      local-result-dir: $localResultDir
    """.trimIndent()
     }
 
@@ -199,5 +202,9 @@ ${listToString(testTargetsAlwaysRun)}
                 cli
             )
         }
+
+        fun default(): AndroidArgs {
+            return AndroidArgs(GcloudYml(), AndroidGcloudYml(AndroidGcloudYmlParams(app = ".", test = ".")), FlankYml(), "", AndroidRunCommand())
+        }
     }
 }

test_runner/src/main/kotlin/ftl/args/IArgs.kt

@@ -22,6 +22,7 @@ interface IArgs {
     val testTargetsAlwaysRun: List<String>
     val filesToDownload: List<String>
     val disableSharding: Boolean
+    val localResultDir: String?
 
     // computed property
     val testShardChunks: List<List<String>>

test_runner/src/main/kotlin/ftl/args/IosArgs.kt

@@ -56,6 +56,7 @@ class IosArgs(
     override val filesToDownload = cli?.filesToDownload ?: flank.filesToDownload
     override val disableSharding = cli?.disableSharding ?: flank.disableSharding
     override val project = cli?.project ?: flank.project
+    override val localResultDir = cli?.localResultsDir ?: flank.localResultDir
 
     private val iosFlank = iosFlankYml.flank
     val testTargets = cli?.testTargets ?: iosFlank.testTargets
@@ -132,6 +133,7 @@ ${listToString(filesToDownload)}
 ${listToString(testTargets)}
       disable-sharding: $disableSharding
       project: $project
+      local-result-dir: $localResultDir
     """.trimIndent()
     }
 

test_runner/src/main/kotlin/ftl/args/yml/AndroidGcloudYml.kt

@@ -52,7 +52,7 @@ class AndroidGcloudYmlParams(
 
 @JsonIgnoreProperties(ignoreUnknown = true)
 class AndroidGcloudYml(
-    val gcloud: AndroidGcloudYmlParams
+    val gcloud: AndroidGcloudYmlParams = AndroidGcloudYmlParams()
 
 ) {
     companion object : IYmlMap {

test_runner/src/main/kotlin/ftl/args/yml/FlankYml.kt

@@ -32,13 +32,18 @@ class FlankYmlParams(
     @field:JsonProperty("files-to-download")
     val filesToDownload: List<String> = emptyList(),
 
-    val project: String = ArgsHelper.getDefaultProjectId() ?: ""
+    val project: String = ArgsHelper.getDefaultProjectId() ?: "",
+
+    @field:JsonProperty("local-result-dir")
+    val localResultDir: String = defaultLocalResultDir
 ) {
     companion object : IYmlKeys {
         override val keys = listOf(
             "max-test-shards", "shard-time", "repeat-tests", "smart-flank-gcs-path", "disable-sharding",
-            "test-targets-always-run", "files-to-download", "project"
+            "test-targets-always-run", "files-to-download", "project", "local-result-dir"
         )
+
+        const val defaultLocalResultDir = "results"
     }
 
     init {

test_runner/src/main/kotlin/ftl/cli/firebase/CancelCommand.kt

@@ -1,5 +1,6 @@
 package ftl.cli.firebase
 
+import ftl.args.AndroidArgs
 import ftl.run.TestRunner
 import picocli.CommandLine
 
@@ -18,7 +19,7 @@ Reads in the matrix_ids.json file. Cancels any incomplete matrices.
 )
 class CancelCommand : Runnable {
     override fun run() {
-        TestRunner.cancelLastRun()
+        TestRunner.cancelLastRun(AndroidArgs.default())
     }
 
     @CommandLine.Option(names = ["-h", "--help"], usageHelp = true, description = ["Prints this help message"])