fix(cli): change help for parse --include-flaky-tests + optimize exec…

…ution
MarathonLabs · Jan 23, 2024 · 26470f7 · 26470f7
1 parent 1d62f7b
commit 26470f7
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 7 deletions.
diff --git a/cli/src/main/kotlin/com/malinskiy/marathon/cli/args/CliCommands.kt b/cli/src/main/kotlin/com/malinskiy/marathon/cli/args/CliCommands.kt
@@ -59,7 +59,7 @@ class Parse(
         .file()
         .default(File("Marathonfile"))
     private val parseOutputFileName by option("--output", "-o", help="Output file name in yaml format")
-    private val includeFlakyTests by option("--include-flaky-tests", "-f", help="Include/Exclude flaky tests that will be run too in the output")
+    private val includeFlakyTests by option("--include-flaky-tests", "-f", help="Include/exclude flaky tests that will have preventive retries according to the current flakinessStrategy")
         .convert { it.toBoolean() }
         .default(false)
     override fun run() {

diff --git a/core/src/main/kotlin/com/malinskiy/marathon/Marathon.kt b/core/src/main/kotlin/com/malinskiy/marathon/Marathon.kt
@@ -137,10 +137,12 @@ class Marathon(
 
         if (parsedAllTests.isEmpty()) throw NoTestCasesFoundException("No tests cases were found")
         val parsedFilteredTests = applyTestFilters(parsedAllTests)
-        val shard = prepareTestShard(parsedFilteredTests, analytics)
 
         if (executionCommand is ParseCommand) {
-            val flakyTests = if (executionCommand.includeFlakyTests) shard.flakyTests.toList() else emptyList()
+            // Delay potentially querying remote TSDB unless user requested to get flaky tests
+            val flakyTests = if (executionCommand.includeFlakyTests) {
+                prepareTestShard(parsedFilteredTests, analytics).flakyTests.toList()
+            } else emptyList()
             marathonTestParseCommand.execute(
                 tests = parsedFilteredTests,
                 flakyTests = flakyTests,
@@ -150,6 +152,8 @@ class Marathon(
             return true
         }
 
+        val shard = prepareTestShard(parsedFilteredTests, analytics)
+
         usageTracker.trackEvent(Event.TestsTotal(parsedAllTests.size))
         usageTracker.trackEvent(Event.TestsRun(parsedFilteredTests.size))
 

diff --git a/docs/runner/intro/execute.md b/docs/runner/intro/execute.md
@@ -37,14 +37,18 @@ Options:
 ## Parse command
 ```shell-session
 foo@bar $ marathon parse -h
-Usage: marathon parse [OPTIONS]
+Usage: marathon parse [<options>]
 
   Print the list of tests without executing them
 
 Options:
-  -m, --marathonfile PATH  Marathonfile file path
-  -o, --output TEXT        Output file name in yaml format
-  -h, --help               Show this message and exit
+  -m, --marathonfile=<path>  Marathonfile file path
+  -o, --output=<text>        Output file name in yaml format
+  -f, --include-flaky-tests=<value>
+                             Include/exclude flaky tests that will have
+                             preventive retries according to the current
+                             flakinessStrategy
+  -h, --help                 Show this message and exit
 ```
 
 ## Version command