Change name and description of flag

elihart · elihart · commit aa5b3682daaf · 2019-04-05T09:05:01.000-05:00
diff --git a/README.md b/README.md
@@ -131,10 +131,9 @@ flank:
   ## Google cloud storage path to store the JUnit XML results from the last run.
   # smart-flank-gcs-path: gs://tmp_flank/flank/test_app_ios.xml
 
-  ## Whether the JUnit XML results should be uploaded for Smart Flank.
-  ## This can be disabled to prevent new results from overriding previous results.
-  ## Default: true
-  # smart-flank-upload-enabled: true
+  ## Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated.
+  ## Default: false
+  # smart-flank-disable-upload: false
 
   ## Disables sharding. Useful for parameterized tests.
   # disable-sharding: false
@@ -279,10 +278,9 @@ flank:
   ## Google cloud storage path to store the JUnit XML results from the last run.
   # smart-flank-gcs-path: gs://tmp_flank/flank/test_app_android.xml
 
-  ## Whether the JUnit XML results should be uploaded for Smart Flank.
-  ## This can be disabled to prevent new results from overriding previous results.
-  ## Default: true
-  # smart-flank-upload-enabled: true
+  ## Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated.
+  ## Default: false
+  # smart-flank-disable-upload: false
 
   ## Disables sharding. Useful for parameterized tests.
   # disable-sharding: false
diff --git a/release_notes.md b/release_notes.md
@@ -1,6 +1,6 @@
 ## next (unreleased)
 
-- [#537](https://github.com/TestArmada/flank/pull/537) Add `smart-flank-upload-enabled` yml option to prevent new results from overriding previous results. ([elihart](https://github.com/elihart))
+- [#537](https://github.com/TestArmada/flank/pull/537) Add `smart-flank-disable-upload` yml option to prevent new results from overriding previous results. ([elihart](https://github.com/elihart))
 
 ## v5.0.1
 
diff --git a/test_runner/flank.ios.yml b/test_runner/flank.ios.yml
@@ -82,10 +82,9 @@ flank:
   ## Google cloud storage path to store the JUnit XML results from the last run.
   # smart-flank-gcs-path: gs://tmp_flank/flank/test_app_ios.xml
 
-  ## Whether the JUnit XML results should be uploaded for Smart Flank.
-  ## This can be disabled to prevent new results from overriding previous results.
-  ## Default: true
-  # smart-flank-upload-enabled: true
+  ## Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated.
+  ## Default: false
+  # smart-flank-disable-upload: false
 
   ## Disables sharding. Useful for parameterized tests.
   # disable-sharding: false
diff --git a/test_runner/flank.yml b/test_runner/flank.yml
@@ -107,10 +107,9 @@ flank:
   ## Google cloud storage path to store the JUnit XML results from the last run.
   # smart-flank-gcs-path: gs://tmp_flank/flank/test_app_android.xml
 
-  ## Whether the JUnit XML results should be uploaded for Smart Flank.
-  ## This can be disabled to prevent new results from overriding previous results.
-  ## Default: true
-  # smart-flank-upload-enabled: true
+  ## Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated.
+  ## Default: false
+  # smart-flank-disable-upload: false
 
   ## Disables sharding. Useful for parameterized tests.
   # disable-sharding: false
diff --git a/test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt b/test_runner/src/main/kotlin/ftl/args/AndroidArgs.kt
@@ -69,7 +69,7 @@ class AndroidArgs(
     override val shardTime = cli?.shardTime ?: flank.shardTime
     override val repeatTests = cli?.repeatTests ?: flank.repeatTests
     override val smartFlankGcsPath = flank.smartFlankGcsPath
-    override val smartFlankUploadEnabled = cli?.smartFlankUploadEnabled ?: flank.smartFlankUploadEnabled
+    override val smartFlankDisableUpload = cli?.smartFlankDisableUpload ?: flank.smartFlankDisableUpload
     override val testTargetsAlwaysRun = cli?.testTargetsAlwaysRun ?: flank.testTargetsAlwaysRun
     override val filesToDownload = cli?.filesToDownload ?: flank.filesToDownload
     override val disableSharding = cli?.disableSharding ?: flank.disableSharding
@@ -170,7 +170,7 @@ ${devicesToString(devices)}
       shard-time: $shardTime
       repeat-tests: $repeatTests
       smart-flank-gcs-path: $smartFlankGcsPath
-      smart-flank-upload-enabled: $smartFlankUploadEnabled
+      smart-flank-disable-upload: $smartFlankDisableUpload
       files-to-download:
 ${listToString(filesToDownload)}
       test-targets-always-run:
diff --git a/test_runner/src/main/kotlin/ftl/args/IArgs.kt b/test_runner/src/main/kotlin/ftl/args/IArgs.kt
@@ -21,7 +21,7 @@ interface IArgs {
     val shardTime: Int
     val repeatTests: Int
     val smartFlankGcsPath: String
-    val smartFlankUploadEnabled: Boolean
+    val smartFlankDisableUpload: Boolean
     val testTargetsAlwaysRun: List<String>
     val filesToDownload: List<String>
     val disableSharding: Boolean
diff --git a/test_runner/src/main/kotlin/ftl/args/IosArgs.kt b/test_runner/src/main/kotlin/ftl/args/IosArgs.kt
@@ -52,7 +52,7 @@ class IosArgs(
     override val shardTime = cli?.shardTime ?: flank.shardTime
     override val repeatTests = cli?.repeatTests ?: flank.repeatTests
     override val smartFlankGcsPath = flank.smartFlankGcsPath
-    override val smartFlankUploadEnabled = cli?.smartFlankUploadEnabled ?: flank.smartFlankUploadEnabled
+    override val smartFlankDisableUpload = cli?.smartFlankDisableUpload ?: flank.smartFlankDisableUpload
     override val testTargetsAlwaysRun = cli?.testTargetsAlwaysRun ?: flank.testTargetsAlwaysRun
     override val filesToDownload = cli?.filesToDownload ?: flank.filesToDownload
     override val disableSharding = cli?.disableSharding ?: flank.disableSharding
@@ -125,7 +125,7 @@ ${devicesToString(devices)}
       shard-time: $shardTime
       repeat-tests: $repeatTests
       smart-flank-gcs-path: $smartFlankGcsPath
-      smart-flank-upload-enabled: $smartFlankUploadEnabled
+      smart-flank-disable-upload: $smartFlankDisableUpload
       test-targets-always-run:
 ${listToString(testTargetsAlwaysRun)}
       files-to-download:
diff --git a/test_runner/src/main/kotlin/ftl/args/yml/FlankYml.kt b/test_runner/src/main/kotlin/ftl/args/yml/FlankYml.kt
@@ -23,8 +23,8 @@ class FlankYmlParams(
     @field:JsonProperty("smart-flank-gcs-path")
     val smartFlankGcsPath: String = "",
 
-    @field:JsonProperty("smart-flank-upload-enabled")
-    val smartFlankUploadEnabled: Boolean = true,
+    @field:JsonProperty("smart-flank-disable-upload")
+    val smartFlankDisableUpload: Boolean = false,
 
     @field:JsonProperty("disable-sharding")
     val disableSharding: Boolean = false,
@@ -42,7 +42,7 @@ class FlankYmlParams(
 ) {
     companion object : IYmlKeys {
         override val keys = listOf(
-            "max-test-shards", "shard-time", "repeat-tests", "smart-flank-gcs-path", "smart-flank-upload-enabled",
+            "max-test-shards", "shard-time", "repeat-tests", "smart-flank-gcs-path", "smart-flank-disable-upload",
             "disable-sharding", "test-targets-always-run", "files-to-download", "project", "local-result-dir"
         )
 
diff --git a/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt b/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt
@@ -281,8 +281,8 @@ class AndroidRunCommand : Runnable {
     var localResultDir: String? = null
 
     @Option(
-        names = ["--smart-flank-upload-enabled"],
-        description = ["Whether the JUnit XML results should be uploaded to the Smart Flank cloud storage."]
+        names = ["--smart-flank-disable-upload"],
+        description = ["Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated."]
     )
-    var smartFlankUploadEnabled: Boolean? = null
+    var smartFlankDisableUpload: Boolean? = null
 }
diff --git a/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt b/test_runner/src/main/kotlin/ftl/cli/firebase/test/ios/IosRunCommand.kt
@@ -222,8 +222,8 @@ class IosRunCommand : Runnable {
     var localResultsDir: String? = null
 
     @Option(
-        names = ["--smart-flank-upload-enabled"],
-        description = ["Whether the JUnit XML results should be uploaded to the Smart Flank cloud storage."]
+        names = ["--smart-flank-disable-upload"],
+        description = ["Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated."]
     )
-    var smartFlankUploadEnabled: Boolean? = null
+    var smartFlankDisableUpload: Boolean? = null
 }
diff --git a/test_runner/src/main/kotlin/ftl/gc/GcStorage.kt b/test_runner/src/main/kotlin/ftl/gc/GcStorage.kt
@@ -54,7 +54,7 @@ object GcStorage {
         )
 
     fun uploadJunitXml(testResult: JUnitTestResult, args: IArgs) {
-        if (args.smartFlankGcsPath.isEmpty() || !args.smartFlankUploadEnabled) return
+        if (args.smartFlankGcsPath.isEmpty() || !args.smartFlankDisableUpload) return
 
         // bucket/path/to/object
         val rawPath = args.smartFlankGcsPath.drop(GCS_PREFIX.length)
diff --git a/test_runner/src/test/kotlin/ftl/args/AndroidArgsTest.kt b/test_runner/src/test/kotlin/ftl/args/AndroidArgsTest.kt
@@ -218,7 +218,7 @@ AndroidArgs
       shard-time: 60
       repeat-tests: 8
       smart-flank-gcs-path:${' '}
-      smart-flank-upload-enabled: true
+      smart-flank-disable-upload: false
       files-to-download:
         - /sdcard/screenshots
         - /sdcard/screenshots2
@@ -816,20 +816,20 @@ AndroidArgs
     }
 
     @Test
-    fun `cli smart-flank-upload-enabled`() {
+    fun `cli smart-flank-disable-upload`() {
         val cli = AndroidRunCommand()
-        CommandLine(cli).parse("--smart-flank-upload-enabled=false")
+        CommandLine(cli).parse("--smart-flank-disable-upload=true")
 
         val yaml = """
         gcloud:
           app: $appApk
           test: $testApk
         flank:
-          smart-flank-upload-enabled: true
+          smart-flank-disable-upload: false
       """
-        assertThat(AndroidArgs.load(yaml).smartFlankUploadEnabled).isEqualTo(true)
+        assertThat(AndroidArgs.load(yaml).smartFlankDisableUpload).isEqualTo(false)
 
         val androidArgs = AndroidArgs.load(yaml, cli)
-        assertThat(androidArgs.smartFlankUploadEnabled).isEqualTo(false)
+        assertThat(androidArgs.smartFlankDisableUpload).isEqualTo(true)
     }
 }
diff --git a/test_runner/src/test/kotlin/ftl/args/IosArgsTest.kt b/test_runner/src/test/kotlin/ftl/args/IosArgsTest.kt
@@ -167,7 +167,7 @@ IosArgs
       shard-time: 60
       repeat-tests: 8
       smart-flank-gcs-path:${' '}
-      smart-flank-upload-enabled: true
+      smart-flank-disable-upload: false
       test-targets-always-run:
         - a/testGrantPermissions
         - a/testGrantPermissions2
@@ -636,19 +636,19 @@ IosArgs
     }
 
     @Test
-    fun `cli smart-flank-upload-enabled`() {
+    fun `cli smart-flank-disable-upload`() {
         val cli = IosRunCommand()
-        CommandLine(cli).parse("--smart-flank-upload-enabled=false")
+        CommandLine(cli).parse("--smart-flank-disable-upload=true")
 
         val yaml = """
         gcloud:
           test: $testPath
           xctestrun-file: $testPath
       """
-        assertThat(IosArgs.load(yaml).smartFlankUploadEnabled).isEqualTo(true)
+        assertThat(IosArgs.load(yaml).smartFlankDisableUpload).isEqualTo(false)
 
         val androidArgs = IosArgs.load(yaml, cli)
-        assertThat(androidArgs.smartFlankUploadEnabled).isEqualTo(false)
+        assertThat(androidArgs.smartFlankDisableUpload).isEqualTo(true)
     }
 
     private fun getValidTestsSample() = listOf(
diff --git a/test_runner/src/test/kotlin/ftl/cli/firebase/test/android/AndroidRunCommandTest.kt b/test_runner/src/test/kotlin/ftl/cli/firebase/test/android/AndroidRunCommandTest.kt
@@ -88,7 +88,7 @@ class AndroidRunCommandTest {
         assertThat(cmd.flakyTestAttempts).isNull()
         assertThat(cmd.disableSharding).isNull()
         assertThat(cmd.localResultDir).isNull()
-        assertThat(cmd.smartFlankUploadEnabled).isNull()
+        assertThat(cmd.smartFlankDisableUpload).isNull()
     }
 
     @Test
@@ -323,10 +323,10 @@ class AndroidRunCommandTest {
     }
 
     @Test
-    fun `smartFlankUploadEnabled parse`() {
+    fun `smartFlankDisableUpload parse`() {
         val cmd = AndroidRunCommand()
-        CommandLine(cmd).parse("--smart-flank-upload-enabled=false")
+        CommandLine(cmd).parse("--smart-flank-disable-upload=true")
 
-        assertThat(cmd.smartFlankUploadEnabled).isEqualTo(false)
+        assertThat(cmd.smartFlankDisableUpload).isEqualTo(true)
     }
 }
diff --git a/test_runner/src/test/kotlin/ftl/cli/firebase/test/ios/IosRunCommandTest.kt b/test_runner/src/test/kotlin/ftl/cli/firebase/test/ios/IosRunCommandTest.kt
@@ -82,7 +82,7 @@ class IosRunCommandTest {
         assertThat(cmd.resultsDir).isNull()
         assertThat(cmd.flakyTestAttempts).isNull()
         assertThat(cmd.localResultsDir).isNull()
-        assertThat(cmd.smartFlankUploadEnabled).isNull()
+        assertThat(cmd.smartFlankDisableUpload).isNull()
     }
 
     @Test
@@ -258,10 +258,10 @@ class IosRunCommandTest {
     }
 
     @Test
-    fun `smart-flank-upload-enabled parse`() {
+    fun `smart-flank-disable-upload parse`() {
         val cmd = IosRunCommand()
-        CommandLine(cmd).parse("--smart-flank-upload-enabled=false")
+        CommandLine(cmd).parse("--smart-flank-disable-upload=true")
 
-        assertThat(cmd.smartFlankUploadEnabled).isEqualTo(false)
+        assertThat(cmd.smartFlankDisableUpload).isEqualTo(true)
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -281,8 +281,8 @@ class AndroidRunCommand : Runnable {`
`281`	`281`	`var localResultDir: String? = null`
`282`	`282`
`283`	`283`	`@Option(`
`284`		`- names = ["--smart-flank-upload-enabled"],`
`285`		`- description = ["Whether the JUnit XML results should be uploaded to the Smart Flank cloud storage."]`
	`284`	`+ names = ["--smart-flank-disable-upload"],`
	`285`	`+ description = ["Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated."]`
`286`	`286`	`)`
`287`		`- var smartFlankUploadEnabled: Boolean? = null`
	`287`	`+ var smartFlankDisableUpload: Boolean? = null`
`288`	`288`	`}`
Original file line number	Diff line number	Diff line change
`@@ -222,8 +222,8 @@ class IosRunCommand : Runnable {`
`222`	`222`	`var localResultsDir: String? = null`
`223`	`223`
`224`	`224`	`@Option(`
`225`		`- names = ["--smart-flank-upload-enabled"],`
`226`		`- description = ["Whether the JUnit XML results should be uploaded to the Smart Flank cloud storage."]`
	`225`	`+ names = ["--smart-flank-disable-upload"],`
	`226`	`+ description = ["Disables smart flank JUnit XML uploading. Useful for preventing timing data from being updated."]`
`227`	`227`	`)`
`228`		`- var smartFlankUploadEnabled: Boolean? = null`
	`228`	`+ var smartFlankDisableUpload: Boolean? = null`
`229`	`229`	`}`