[ftr/flags] improve help text (#86971)

Co-authored-by: spalger <spalger@users.noreply.github.com>
elastic · Dec 28, 2020 · db2f7e6 · db2f7e6
1 parent 3ddc527
commit db2f7e6
Showing 1 changed file with 21 additions and 16 deletions.
diff --git a/packages/kbn-test/src/functional_test_runner/cli.ts b/packages/kbn-test/src/functional_test_runner/cli.ts
@@ -141,22 +141,27 @@ export function runFtrCli() {
           config: 'test/functional/config.js',
         },
         help: `
-        --config=path      path to a config file
-        --bail             stop tests after the first failure
-        --grep <pattern>   pattern used to select which tests to run
-        --invert           invert grep to exclude tests
-        --include=file     a test file to be included, pass multiple times for multiple files
-        --exclude=file     a test file to be excluded, pass multiple times for multiple files
-        --include-tag=tag  a tag to be included, pass multiple times for multiple tags
-        --exclude-tag=tag  a tag to be excluded, pass multiple times for multiple tags
-        --test-stats       print the number of tests (included and excluded) to STDERR
-        --updateBaselines  replace baseline screenshots with whatever is generated from the test
-        --updateSnapshots  replace inline and file snapshots with whatever is generated from the test
-        -u                 replace both baseline screenshots and snapshots
-        --kibana-install-dir  directory where the Kibana install being tested resides
-        --throttle         enable network throttling in Chrome browser
-        --headless         run browser in headless mode
-      `,
+          --config=path      path to a config file
+          --bail             stop tests after the first failure
+          --grep <pattern>   pattern used to select which tests to run
+          --invert           invert grep to exclude tests
+          --include=file     a test file to be included, pass multiple times for multiple files
+          --exclude=file     a test file to be excluded, pass multiple times for multiple files
+          --include-tag=tag  a tag to be included, pass multiple times for multiple tags. Only
+                               suites which have one of the passed include-tag tags will be executed.
+                               When combined with the --exclude-tag flag both conditions must be met
+                               for a suite to run.
+          --exclude-tag=tag  a tag to be excluded, pass multiple times for multiple tags. Any suite
+                               which has any of the exclude-tags will be excluded. When combined with
+                               the --include-tag flag both conditions must be met for a suite to run.
+          --test-stats       print the number of tests (included and excluded) to STDERR
+          --updateBaselines  replace baseline screenshots with whatever is generated from the test
+          --updateSnapshots  replace inline and file snapshots with whatever is generated from the test
+          -u                 replace both baseline screenshots and snapshots
+          --kibana-install-dir  directory where the Kibana install being tested resides
+          --throttle         enable network throttling in Chrome browser
+          --headless         run browser in headless mode
+        `,
       },
     }
   );