Skip to content

Commit 80c4c43

Browse files
svc-cli-botsvc-cli-bot
committed
chore(release): 0.0.2 [skip ci]
1 parent 1d30410 commit 80c4c43

3 files changed

Lines changed: 197 additions & 1 deletion

File tree

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 0.0.2 (2025-04-02)
2+
3+
4+

‎README.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,198 @@ Happy debugging!
8686
# Commands
8787

8888
<!-- commands -->
89+
* [`sf flow get log`](#sf-flow-get-log)
90+
* [`sf flow get test`](#sf-flow-get-test)
91+
* [`sf flow run test`](#sf-flow-run-test)
92+
93+
## `sf flow get log`
94+
95+
Display test results for a specific asynchronous test run.
96+
97+
```
98+
USAGE
99+
$ sf flow get log -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value>] [-n <value>]
100+
[-d <value>]
101+
102+
FLAGS
103+
-d, --output-dir=<value> Directory in which to store test result files.
104+
-i, --log-id=<value> ID of the specific log to display.
105+
-n, --number=<value> Number of the most recent logs to display.
106+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
107+
configuration variable is already set.
108+
--api-version=<value> Override the api version used for api requests made by this command
109+
110+
GLOBAL FLAGS
111+
--flags-dir=<value> Import flag values from a directory.
112+
--json Format output as json.
113+
114+
DESCRIPTION
115+
Display test results for a specific asynchronous test run.
116+
117+
Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
118+
displayed after running the "sf apex test run" command.
119+
120+
To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
121+
summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
122+
format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
123+
124+
ALIASES
125+
$ sf force apex log get
126+
127+
EXAMPLES
128+
Display test results for your default org using a test run ID:
129+
130+
$ sf flow get log --test-run-id <test run id>
131+
132+
Similar to previous example, but output the result in JUnit format:
133+
134+
$ sf flow get log --test-run-id <test run id> --result-format junit
135+
136+
Also retrieve code coverage results and output in JSON format:
137+
138+
$ sf flow get log --test-run-id <test run id> --code-coverage --json
139+
140+
Specify a directory in which to save the test results from the org with the specified username (rather than your
141+
default org):
142+
143+
$ sf flow get log --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
144+
me@myorg'
145+
```
146+
147+
## `sf flow get test`
148+
149+
Display test results for a specific asynchronous test run.
150+
151+
```
152+
USAGE
153+
$ sf flow get test -o <value> -i <value> [--json] [--flags-dir <value>] [--api-version <value>]
154+
[--detailed-coverage -c] [-d <value>] [-r human|tap|junit|json] [--concise]
155+
156+
FLAGS
157+
-c, --code-coverage Retrieve code coverage results.
158+
-d, --output-dir=<value> Directory in which to store test result files.
159+
-i, --test-run-id=<value> (required) ID of the test run.
160+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
161+
configuration variable is already set.
162+
-r, --result-format=<option> [default: human] Format of the test results.
163+
<options: human|tap|junit|json>
164+
--api-version=<value> Override the api version used for api requests made by this command
165+
--concise Display only failed test results; works with human-readable output only.
166+
--detailed-coverage Display detailed code coverage per test.
167+
168+
GLOBAL FLAGS
169+
--flags-dir=<value> Import flag values from a directory.
170+
--json Format output as json.
171+
172+
DESCRIPTION
173+
Display test results for a specific asynchronous test run.
174+
175+
Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
176+
displayed after running the "sf apex test run" command.
177+
178+
To see code coverage results, use the --code-coverage flag with --result-format. The output displays a high-level
179+
summary of the test run and the code coverage values for classes in your org. If you specify human-readable result
180+
format, use the --detailed-coverage flag to see detailed coverage results for each test method run.
181+
182+
ALIASES
183+
$ sf force flow test report
184+
185+
EXAMPLES
186+
Display test results for your default org using a test run ID:
187+
188+
$ sf flow get test --test-run-id <test run id>
189+
190+
Similar to previous example, but output the result in JUnit format:
191+
192+
$ sf flow get test --test-run-id <test run id> --result-format junit
193+
194+
Also retrieve code coverage results and output in JSON format:
195+
196+
$ sf flow get test --test-run-id <test run id> --code-coverage --json
197+
198+
Specify a directory in which to save the test results from the org with the specified username (rather than your
199+
default org):
200+
201+
$ sf flow get test --test-run-id <test run id> --code-coverage --output-dir <path to outputdir> --target-org \
202+
me@myorg'
203+
```
204+
205+
## `sf flow run test`
206+
207+
Summary of a command.
208+
209+
```
210+
USAGE
211+
$ sf flow run test -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-r human|tap|junit|json]
212+
[--concise] [-d <value>] [-c] [-y] [-l RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests] [-n <value>... | -s
213+
<value>... | -t <value>...]
214+
215+
FLAGS
216+
-c, --code-coverage Retrieve code coverage results.
217+
-d, --output-dir=<value> Directory in which to store test result files.
218+
-l, --test-level=<option> Level of tests to run; default is RunLocalTests.
219+
<options: RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests>
220+
-n, --class-names=<value>... Flow test class names to run; default is all classes.
221+
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
222+
configuration variable is already set.
223+
-r, --result-format=<option> [default: human] Format of the test results.
224+
<options: human|tap|junit|json>
225+
-s, --suite-names=<value>... Flow test suite names to run.
226+
-t, --tests=<value>... Flow test class names or IDs and, if applicable, test methods to run; default is all
227+
tests.
228+
-y, --synchronous Runs test methods from a single Apex class synchronously; if not specified, tests are
229+
run asynchronously.
230+
--api-version=<value> Override the api version used for api requests made by this command
231+
--concise Display only failed test results; works with human-readable output only.
232+
233+
GLOBAL FLAGS
234+
--flags-dir=<value> Import flag values from a directory.
235+
--json Format output as json.
236+
237+
DESCRIPTION
238+
Summary of a command.
239+
240+
More information about a command. Don't repeat the summary.
241+
242+
ALIASES
243+
$ sf force flow test run
244+
245+
EXAMPLES
246+
$ sf flow run test
247+
248+
FLAG DESCRIPTIONS
249+
-l, --test-level=RunLocalTests|RunAllTestsInOrg|RunSpecifiedTests Level of tests to run; default is RunLocalTests.
250+
251+
Here's what the levels mean:
252+
253+
- RunSpecifiedTests — Only the tests that you specify in the runTests option are run. Code coverage requirements
254+
differ from the default coverage requirements when using this test level. The executed tests must cover each class
255+
and trigger in the deployment package for a minimum of 75% code coverage. This coverage is computed for each class
256+
and triggers individually, and is different than the overall coverage percentage.
257+
- RunLocalTests — All local tests in your org, including tests that originate from no-namespaced unlocked packages,
258+
are run. The tests that originate from installed managed packages and namespaced unlocked packages aren't run. This
259+
test level is the default for production deployments that include Apex classes or triggers.
260+
- RunAllTestsInOrg — All tests are run. The tests include all tests in your org.
261+
262+
-n, --class-names=<value>... Flow test class names to run; default is all classes.
263+
264+
If you select --class-names, you can't specify --suite-names or --tests.
265+
For multiple classes, repeat the flag for each.
266+
--class-names Class1 --class-names Class2
267+
268+
-s, --suite-names=<value>... Flow test suite names to run.
269+
270+
If you select --suite-names, you can't specify --class-names or --tests.
271+
For multiple suites, repeat the flag for each.
272+
--suite-names Suite1 --suite-names Suite2
273+
274+
-t, --tests=<value>... Flow test class names or IDs and, if applicable, test methods to run; default is all tests.
275+
276+
If you specify --tests, you can't specify --class-names or --suite-names
277+
For multiple tests, repeat the flag for each.
278+
--tests Test1 --tests Test2
279+
```
280+
<!-- commandsstop -->
89281

90282
- [`sf flow get log`](#sf-flow-get-log)
91283
- [`sf flow get test`](#sf-flow-get-test)

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-flow",
33
"description": "temp plugin for flow test",
4-
"version": "0.0.1",
4+
"version": "0.0.2",
55
"dependencies": {
66
"@oclif/core": "^4.2.10",
77
"@salesforce/apex-node": "^8.1.20-qa.1",

0 commit comments

Comments
 (0)