flow Commands

Description for flow get test

Provide a flow test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is displayed after running the "sf flow run test" command.

To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for flow tests in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.

Examples for flow get test

Display flow test results for your default org using a test run ID:

sf flow get test --test-run-id <test run id>

Similar to previous example, but output the result in JUnit format:

sf flow get test --test-run-id <test run id> --result-format junit

Also retrieve code coverage results and output in JSON format:

sf flow get test --test-run-id <test run id> --code-coverage --json

Specify a directory in which to save the test results from the org with the “me@my.org” username (rather than your default org):

sf flow get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org me@my.org'

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-i | --test-run-id TEST-RUN-ID

Required

ID of the test run.

Type: option

-c | --code-coverage

Optional

Retrieve code coverage results.

Type: boolean

--detailed-coverage

Optional

Not available for flow tests.

Type: boolean

-d | --output-dir OUTPUT-DIR

Optional

Directory in which to store test result files.

Type: option

-r | --result-format RESULT-FORMAT

Optional

Format of the test results.

Type: option

Permissible values are: human, tap, junit, json

Default value: human

--concise

Optional

Display only failed test results; works with human-readable output only.

Type: boolean

Description for flow run test

Specify which tests to run by using the --class-names flag followed by the names of the flows you want to test. For example, if you save a flow with the name Flow1, then use: --class-names Flow1.

To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level summary of the test run and the code coverage values for classes in your org. If you specify human-readable result format, use the --detailed-coverage flag to see detailed coverage results for each test method run.

By default, "flow run test" runs asynchronously and immediately returns a test run ID. If you use the -–synchronous flag, you can use the --wait flag to specify the number of minutes to wait; if the tests finish in that timeframe, the command displays the results. If the tests haven't finished by the end of the wait time, the command displays a test run ID. Use the "flow get test --test-run-id" command to get the results.

You must have the "View All Data" org system permission to use this command. The permission is disabled by default and can be enabled only by a system administrator.

Examples for flow run test

Run all local tests in your default org:

sf flow run test --test-level RunLocalTests

Run all the Flow1 and Flow2 flow tests in the org with alias “scratchOrg”:

sf flow run test --target-org scratchOrg --class-names Flow1 --class-names Flow2

Run specific Flow1 and Flow2 flow tests in your default org:

sf flow run test --tests Flow1.Test1 --tests Flow2.Test2 --test-level RunSpecifiedTests

Run all tests synchronously in your default org; the command waits to display the test results until all tests finish:

sf flow run test –synchronous

Run all local tests in the org with the username “me@my.org”; save the output to the specified directory:

sf flow run test --test-level RunLocalTests --output-dir /Users/susan/temp/cliOutput --target-org me@my.org

Flags

--json

Optional

Format output as json.

Type: boolean

--flags-dir FLAGS-DIR

Optional

Import flag values from a directory.

Type: option

-o | --target-org TARGET-ORG

Required

Username or alias of the target org. Not required if the `target-org` configuration variable is already set.

Type: option

--api-version API-VERSION

Optional

Override the api version used for api requests made by this command

Type: option

-r | --result-format RESULT-FORMAT

Optional

Format of the test results.

Type: option

Permissible values are: human, tap, junit, json

Default value: human

--concise

Optional

Display only failed test results; works with human-readable output only.

Type: boolean

-d | --output-dir OUTPUT-DIR

Optional

Directory in which to store test result files.

Type: option

-c | --code-coverage

Optional

Retrieve code coverage results.

Type: boolean

-y | --synchronous

Optional

Run flow tests for one flow synchronously; if not specified, tests are run asynchronously.

Type: boolean

-l | --test-level TEST-LEVEL

Optional

Level of tests to run; default is RunLocalTests.

Here's what the levels mean:

- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages.

- RunAllTestsInOrg — All tests are run. The tests include all tests in your org, including tests of managed packages.

- RunSpecifiedTests - Only the tests that you specify with the --tests flag are run.

Type: option

Permissible values are: RunLocalTests, RunAllTestsInOrg, RunSpecifiedTests

-n | --class-names CLASS-NAMES

Optional

Flow names that contain flow tests to run.

Default is all flow tests. If you select --class-names, you can't specify --tests.

Type: option

-s | --suite-names SUITE-NAMES

Optional

Not available for flow tests.

Not available for flow tests.

Type: option

-t | --tests TESTS

Optional

Flow test names to run.

Default is all flow tests. If you specify --tests, you can't specify --class-names.

Type: option