Skip to content

Commit ffe1e4f

Browse files
Palak-Bansal-ProvarPalak-Bansal-Provar
authored
Release v1.4.0 (#96)
README file updated
1 parent 72e8104 commit ffe1e4f

4 files changed

Lines changed: 198 additions & 27 deletions

File tree

‎README.md‎

Lines changed: 180 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,60 +27,100 @@ $ sf plugins uninstall @provartesting/provardx-cli
2727

2828
# Commands
2929

30+
- [`sf provar config get`](#sf-provar-config-get)
31+
- [`sf provar config set`](#sf-provar-config-set)
3032
- [`sf provar automation config generate`](#sf-provar-automation-config-generate)
31-
- [`sf provar automation config validate`](#sf-provar-automation-config-validate)
3233
- [`sf provar automation config load`](#sf-provar-automation-config-load)
34+
- [`sf provar automation config validate`](#sf-provar-automation-config-validate)
3335
- [`sf provar automation config get`](#sf-provar-automation-config-get)
3436
- [`sf provar automation config set`](#sf-provar-automation-config-set)
3537
- [`sf provar automation setup`](#sf-provar-automation-setup)
3638
- [`sf provar automation project compile`](#sf-provar-automation-project-compile)
3739
- [`sf provar automation metadata download`](#sf-provar-automation-metadata-download)
3840
- [`sf provar automation test run`](#sf-provar-automation-test-run)
3941
- [`sf provar manager connect`](#sf-provar-manager-connect)
42+
- [`sf provar manager display`](#sf-provar-manager-display)
43+
- [`sf provar manager open`](#sf-provar-manager-open)
4044
- [`sf provar manager testcase retrieve`](#sf-provar-manager-testcase-retrieve)
45+
- [`sf provar manager test run`](#sf-provar-manager-test-run)
46+
- [`sf provar manager test run report`](#sf-provar-manager-test-run-report)
4147

42-
## `sf provar automation config generate`
48+
## `sf provar config get`
4349

44-
Generate a boilerplate ProvarDX properties file.
50+
Retrieve a value from the specified JSON file.
4551

4652
```
4753
USAGE
48-
$ sf provar automation config generate [--json] [-p <value>]
54+
$ sf provar config get -f <value> [--json]
4955
5056
FLAGS
51-
-p, --properties-file=<value> (required) Path to the properties file that will be generated.
52-
-n, --no-prompt Don't prompt to confirm file should be overwritten.
57+
-f, --file-path=<value> (required) File path of the JSON file to get the property value from.
5358
5459
GLOBAL FLAGS
55-
--json Format output as json.
60+
--json Format output as json.
5661
5762
DESCRIPTION
58-
Generate a boilerplate property file.
63+
Retrieve a value from the specified JSON file.
5964
6065
EXAMPLES
61-
Generate a basic properties file named provardx-properties.json:
66+
Get the testEnvironment value within the environment property from the config.json file:
6267
63-
$ sf provar automation config generate -p provardx-properties.json
68+
$ sf provar config get environment.testEnvironment -f config.json
6469
```
6570

66-
## `sf provar automation config validate`
71+
## `sf provar config set`
6772

68-
Check if the loaded properties file has all the required properties set.
73+
Set one or more properties in the specified JSON file.
6974

7075
```
7176
USAGE
72-
$ sf provar automation config validate [--json]
77+
$ sf provar config set [--json]
78+
79+
FLAGS
80+
-f, --file-path=<value> (required) File path of the JSON file to get the property value from.
7381
7482
GLOBAL FLAGS
7583
--json Format output as json.
7684
7785
DESCRIPTION
78-
Check if the loaded properties file has all the required properties set.
86+
Set one or more properties in the specified JSON file.
7987
8088
EXAMPLES
81-
Check if the loaded properties file has all the required properties set:
82-
83-
$ sf provar automation config validate
89+
Set the environment to “SIT” in the config.json properties file:
90+
91+
$ sf provar config set environment.testEnvironment="SIT" -f config.json
92+
93+
Set the testEnvironment to “SIT” and the webBrowser to “Chrome”, within the environment property.
94+
95+
$ sf provar config set environment.testEnvironment="SIT" environment.webBrowser="Chrome" -f config.json
96+
97+
Set testCases to a list of test case paths in the config.json properties file.
98+
99+
$ sf provar config set testCases='["tests/myTestCase.testcase","tests/testSuite1/myTestCase1.testCase"]' -f config.json
100+
```
101+
102+
## `sf provar automation config generate`
103+
104+
Generate a boilerplate ProvarDX properties file.
105+
106+
```
107+
USAGE
108+
$ sf provar automation config generate [--json] [-p <value>]
109+
110+
FLAGS
111+
-p, --properties-file=<value> (required) Path to the properties file that will be generated.
112+
-n, --no-prompt Don't prompt to confirm file should be overwritten.
113+
114+
GLOBAL FLAGS
115+
--json Format output as json.
116+
117+
DESCRIPTION
118+
Generate a boilerplate property file.
119+
120+
EXAMPLES
121+
Generate a basic properties file named provardx-properties.json:
122+
123+
$ sf provar automation config generate -p provardx-properties.json
84124
```
85125

86126
## `sf provar automation config load`
@@ -106,6 +146,26 @@ EXAMPLES
106146
$ sf provar automation config load -p myproperties.json
107147
```
108148

149+
## `sf provar automation config validate`
150+
151+
Check if the loaded properties file has all the required properties set.
152+
153+
```
154+
USAGE
155+
$ sf provar automation config validate [--json]
156+
157+
GLOBAL FLAGS
158+
--json Format output as json.
159+
160+
DESCRIPTION
161+
Check if the loaded properties file has all the required properties set.
162+
163+
EXAMPLES
164+
Check if the loaded properties file has all the required properties set:
165+
166+
$ sf provar automation config validate
167+
```
168+
109169
## `sf provar automation config get`
110170

111171
Retrieve a value from the loaded properties file.
@@ -263,6 +323,46 @@ EXAMPLES
263323
$ sf provar manager connect -o ProvarManager
264324
```
265325

326+
## `sf provar manager display`
327+
328+
Display information about the connected Provar Manager org.
329+
330+
```
331+
USAGE
332+
$ sf provar manager display [--json]
333+
334+
GLOBAL FLAGS
335+
--json Format output as json.
336+
337+
DESCRIPTION
338+
Display information about the connected Provar Manager org.
339+
340+
EXAMPLES
341+
Display information about the connected Provar Manager org:
342+
343+
$ sf provar manager display
344+
```
345+
346+
## `sf provar manager open`
347+
348+
Open Provar Manager in a browser.
349+
350+
```
351+
USAGE
352+
$ sf provar manager open [--json]
353+
354+
GLOBAL FLAGS
355+
--json Format output as json.
356+
357+
DESCRIPTION
358+
Open Provar Manager in a browser.
359+
360+
EXAMPLES
361+
Open Provar Manager in a browser:
362+
363+
$ sf provar manager open
364+
```
365+
266366
## `sf provar manager testcase retrieve`
267367

268368
Retrieve test cases related to the provided user stories (issues) or metadata components, for a given test project.
@@ -304,3 +404,66 @@ EXAMPLES
304404
base/main/default/objects/Sprint__c/fields/Sprint_Goal__c.field-meta.xml
305405
306406
```
407+
408+
## `sf provar manager test run`
409+
410+
Run tests via Provar Manager.
411+
412+
```
413+
USAGE
414+
$ sf provar manager test run -f <value> [--json] [-y] [-w <value>] [-p <value>] [-o <value>] [-r <value>]
415+
416+
FLAGS
417+
-f, --configuration-file=<value> (required) Path to the configuration file.
418+
-o, --output=<value> Output to a specific file instead of stdout.
419+
-p, --polling-interval=<value> [default: 60] Sets the polling interval in seconds. Default is 60 seconds.
420+
-r, --result-format=<value> [default: human] Format of the test results.
421+
-w, --wait=<value> Sets the polling timeout in minutes.
422+
-y, --synchronous Runs command synchronously; if not specified, the command is run asynchronously.
423+
424+
GLOBAL FLAGS
425+
--json Format output as json.
426+
427+
DESCRIPTION
428+
Run tests via Provar Manager.
429+
430+
EXAMPLES
431+
Run tests as per the config/run-grid-test.json configuration file, wait 10 minutes, poll every 30 seconds, and store the results as JSON in the results.json file:
432+
433+
$ sf provar manager test run -f config/run-grid-tests.json -w 10 -p 30 -r json -o results.json
434+
435+
Run tests as per the config/run-grid-test.json configuration file, wait 20 minutes, and store the results as JUnit in the junit-results.xml file:
436+
437+
$ sf provar manager test run -f config/run-grid-tests.json -w 20 -r junit -o junit-results.xml
438+
439+
```
440+
441+
## `sf provar manager test run report`
442+
443+
Check or poll for the status of a test run operation.
444+
445+
```
446+
USAGE
447+
$ sf provar manager test run report -i <value> [--json] [-r <value>] [-o <value>]
448+
449+
FLAGS
450+
-i, --test-run=<value> (required) Test run ID.
451+
-o, --output=<value> Output to a specific file instead of stdout.
452+
-r, --result-format=<value> [default: human] Format of the test results.
453+
454+
GLOBAL FLAGS
455+
--json Format output as json.
456+
457+
DESCRIPTION
458+
Check or poll for the status of a test run operation.
459+
460+
EXAMPLES
461+
Retrieve results for test run 45f70417-df21-4917-a667-abc2ee46dc63 and store the results as JSON in the results.json file
462+
463+
$ sf provar manager test run report -i 45f70417-df21-4917-a667-abc2ee46dc63 -r json -o results.json
464+
465+
Retrieve results for test run 45f70417-df21-4917-a667-abc2ee46dc63 and store the results as JUnit in the junit-results.xml file:
466+
467+
$ sf provar manager test run report -i 45f70417-df21-4917-a667-abc2ee46dc63 -r junit -o junit-results.xml
468+
469+
```

‎messages/provar.config.get.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# summary
22

3-
Retrieves a value from the loaded properties file.
3+
Retrieve a value from the specified JSON file.
44

55
# description
66

7-
Retrieves a value from the loaded properties file.
7+
Retrieve a value from the specified JSON file.
88

99
# examples
1010

11-
- Retrieves a value from the loaded properties file
11+
- Get the testEnvironment value within the environment property from the config.json file:
1212

13-
<%= config.bin %> <%= command.id %> 'key'
13+
$ sf provar config get environment.testEnvironment -f config.json
1414

1515
# error.MultipleFailure
1616

‎messages/provar.config.set.md‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
11
# summary
22

3-
Sets a property in the loaded properties file.
3+
Set one or more properties in the specified JSON file.
44

55
# description
66

7-
Sets a property in the loaded properties file.
7+
Set one or more properties in the specified JSON file.
88

99
# examples
1010

11-
- Sets a property in the loaded properties file with resp. values
11+
- Set the environment to “SIT” in the config.json properties file:
1212

13-
<%= config.bin %> <%= command.id %> 'key'='value'
13+
$ sf provar config set environment.testEnvironment="SIT" -f config.json
14+
15+
- Set the testEnvironment to “SIT” and the webBrowser to “Chrome”, within the environment property.
16+
17+
$ sf provar config set environment.testEnvironment="SIT" environment.webBrowser="Chrome" -f config.json
18+
19+
- Set testCases to a list of test case paths in the config.json properties file.
20+
21+
$ sf provar config set testCases='["tests/myTestCase.testcase","tests/testSuite1/myTestCase1.testCase"]' -f config.json
1422

1523
# error.MultipleFailure
1624

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@provartesting/provardx-cli",
33
"description": "A plugin for the Salesforce CLI to orchestrate testing activities and report quality metrics to Provar Manager",
4-
"version": "1.4.1",
4+
"version": "1.4.2",
55
"license": "BSD-3-Clause",
66
"plugins": [
77
"@provartesting/provardx-plugins-automation",
@@ -20,7 +20,7 @@
2020
"node-stream-zip": "^1.15.0",
2121
"@provartesting/provardx-plugins-utils": "1.2.0",
2222
"@provartesting/provardx-plugins-automation": "1.1.0",
23-
"@provartesting/provardx-plugins-manager": "1.2.0",
23+
"@provartesting/provardx-plugins-manager": "1.2.1",
2424
"sync-request": "^6.1.0",
2525
"xml-js": "^1.6.11"
2626
},

0 commit comments

Comments
 (0)