@provartesting/provardx-cli 1.4.1 → 1.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +180 -17
  2. package/lib/commands/provar/automation/config/set.js +1 -1
  3. package/lib/commands/provar/config/set.js +1 -1
  4. package/messages/provar.config.get.md +4 -4
  5. package/messages/provar.config.set.md +12 -4
  6. package/oclif.manifest.json +9 -7
  7. package/package.json +4 -4
package/README.md CHANGED
@@ -27,9 +27,11 @@ $ sf plugins uninstall @provartesting/provardx-cli
27
27
 
28
28
  # Commands
29
29
 
30
+ - [`sf provar config get`](#sf-provar-config-get)
31
+ - [`sf provar config set`](#sf-provar-config-set)
30
32
  - [`sf provar automation config generate`](#sf-provar-automation-config-generate)
31
- - [`sf provar automation config validate`](#sf-provar-automation-config-validate)
32
33
  - [`sf provar automation config load`](#sf-provar-automation-config-load)
34
+ - [`sf provar automation config validate`](#sf-provar-automation-config-validate)
33
35
  - [`sf provar automation config get`](#sf-provar-automation-config-get)
34
36
  - [`sf provar automation config set`](#sf-provar-automation-config-set)
35
37
  - [`sf provar automation setup`](#sf-provar-automation-setup)
@@ -37,50 +39,88 @@ $ sf plugins uninstall @provartesting/provardx-cli
37
39
  - [`sf provar automation metadata download`](#sf-provar-automation-metadata-download)
38
40
  - [`sf provar automation test run`](#sf-provar-automation-test-run)
39
41
  - [`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)
40
44
  - [`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)
41
47
 
42
- ## `sf provar automation config generate`
48
+ ## `sf provar config get`
43
49
 
44
- Generate a boilerplate ProvarDX properties file.
50
+ Retrieve a value from the specified JSON file.
45
51
 
46
52
  ```
47
53
  USAGE
48
- $ sf provar automation config generate [--json] [-p <value>]
54
+ $ sf provar config get -f <value> [--json]
49
55
 
50
56
  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.
53
58
 
54
59
  GLOBAL FLAGS
55
- --json Format output as json.
60
+ --json Format output as json.
56
61
 
57
62
  DESCRIPTION
58
- Generate a boilerplate property file.
63
+ Retrieve a value from the specified JSON file.
59
64
 
60
65
  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:
62
67
 
63
- $ sf provar automation config generate -p provardx-properties.json
68
+ $ sf provar config get environment.testEnvironment -f config.json
64
69
  ```
65
70
 
66
- ## `sf provar automation config validate`
71
+ ## `sf provar config set`
67
72
 
68
- Check if the loaded properties file has all the required properties set.
73
+ Set one or more properties in the specified JSON file.
69
74
 
70
75
  ```
71
76
  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.
73
81
 
74
82
  GLOBAL FLAGS
75
83
  --json Format output as json.
76
84
 
77
85
  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.
79
87
 
80
88
  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
84
124
  ```
85
125
 
86
126
  ## `sf provar automation config load`
@@ -106,6 +146,26 @@ EXAMPLES
106
146
  $ sf provar automation config load -p myproperties.json
107
147
  ```
108
148
 
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
+
109
169
  ## `sf provar automation config get`
110
170
 
111
171
  Retrieve a value from the loaded properties file.
@@ -263,6 +323,46 @@ EXAMPLES
263
323
  $ sf provar manager connect -o ProvarManager
264
324
  ```
265
325
 
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
+
266
366
  ## `sf provar manager testcase retrieve`
267
367
 
268
368
  Retrieve test cases related to the provided user stories (issues) or metadata components, for a given test project.
@@ -304,3 +404,66 @@ EXAMPLES
304
404
  base/main/default/objects/Sprint__c/fields/Sprint_Goal__c.field-meta.xml
305
405
 
306
406
  ```
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
+ ```
package/lib/commands/provar/automation/config/set.js CHANGED
@@ -60,7 +60,7 @@ export default class SfProvarConfigSet extends SfCommand {
60
60
  }
61
61
  }
62
62
  if (this.errorHandler.getErrors().length == 0) {
63
- fileSystem.writeFileSync(propertiesFilePath, JSON.stringify(propertyFileContent, null, 3));
63
+ fileSystem.writeFileSync(propertiesFilePath, JSON.stringify(propertyFileContent, null, 4));
64
64
  }
65
65
  }
66
66
  catch (err) {
package/lib/commands/provar/config/set.js CHANGED
@@ -67,7 +67,7 @@ export default class SfProvarConfigSet extends SfCommand {
67
67
  }
68
68
  }
69
69
  if (this.errorHandler.getErrors().length == 0) {
70
- fileSystem.writeFileSync(propertiesFilePath, JSON.stringify(propertyFileContent, null, 3));
70
+ fileSystem.writeFileSync(propertiesFilePath, JSON.stringify(propertyFileContent, null, 4));
71
71
  }
72
72
  }
73
73
  catch (err) {
package/messages/provar.config.get.md CHANGED
@@ -1,16 +1,16 @@
1
1
  # summary
2
2
 
3
- Retrieves a value from the loaded properties file.
3
+ Retrieve a value from the specified JSON file.
4
4
 
5
5
  # description
6
6
 
7
- Retrieves a value from the loaded properties file.
7
+ Retrieve a value from the specified JSON file.
8
8
 
9
9
  # examples
10
10
 
11
- - Retrieves a value from the loaded properties file
11
+ - Get the testEnvironment value within the environment property from the config.json file:
12
12
 
13
- <%= config.bin %> <%= command.id %> 'key'
13
+ $ sf provar config get environment.testEnvironment -f config.json
14
14
 
15
15
  # error.MultipleFailure
16
16
 
package/messages/provar.config.set.md CHANGED
@@ -1,16 +1,24 @@
1
1
  # summary
2
2
 
3
- Sets a property in the loaded properties file.
3
+ Set one or more properties in the specified JSON file.
4
4
 
5
5
  # description
6
6
 
7
- Sets a property in the loaded properties file.
7
+ Set one or more properties in the specified JSON file.
8
8
 
9
9
  # examples
10
10
 
11
- - Sets a property in the loaded properties file with resp. values
11
+ - Set the environment to “SIT” in the config.json properties file:
12
12
 
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
14
22
 
15
23
  # error.MultipleFailure
16
24
 
package/oclif.manifest.json CHANGED
@@ -3,9 +3,9 @@
3
3
  "provar:config:get": {
4
4
  "aliases": [],
5
5
  "args": {},
6
- "description": "Retrieves a value from the loaded properties file.",
6
+ "description": "Retrieve a value from the specified JSON file.",
7
7
  "examples": [
8
- "Retrieves a value from the loaded properties file\n<%= config.bin %> <%= command.id %> 'key'"
8
+ "Get the testEnvironment value within the environment property from the config.json file:\n$ sf provar config get environment.testEnvironment -f config.json"
9
9
  ],
10
10
  "flags": {
11
11
  "json": {
@@ -32,7 +32,7 @@
32
32
  "pluginName": "@provartesting/provardx-cli",
33
33
  "pluginType": "core",
34
34
  "strict": false,
35
- "summary": "Retrieves a value from the loaded properties file.",
35
+ "summary": "Retrieve a value from the specified JSON file.",
36
36
  "enableJsonFlag": true,
37
37
  "isESM": true,
38
38
  "relativePath": [
@@ -55,9 +55,11 @@
55
55
  "provar:config:set": {
56
56
  "aliases": [],
57
57
  "args": {},
58
- "description": "Sets a property in the loaded properties file.",
58
+ "description": "Set one or more properties in the specified JSON file.",
59
59
  "examples": [
60
- "Sets a property in the loaded properties file with resp. values\n<%= config.bin %> <%= command.id %> 'key'='value'"
60
+ "Set the environment to “SIT” in the config.json properties file:\n$ sf provar config set environment.testEnvironment=\"SIT\" -f config.json",
61
+ "Set the testEnvironment to “SIT” and the webBrowser to “Chrome”, within the environment property.\n$ sf provar config set environment.testEnvironment=\"SIT\" environment.webBrowser=\"Chrome\" -f config.json",
62
+ "Set testCases to a list of test case paths in the config.json properties file.\n$ sf provar config set testCases='[\"tests/myTestCase.testcase\",\"tests/testSuite1/myTestCase1.testCase\"]' -f config.json"
61
63
  ],
62
64
  "flags": {
63
65
  "json": {
@@ -84,7 +86,7 @@
84
86
  "pluginName": "@provartesting/provardx-cli",
85
87
  "pluginType": "core",
86
88
  "strict": false,
87
- "summary": "Sets a property in the loaded properties file.",
89
+ "summary": "Set one or more properties in the specified JSON file.",
88
90
  "enableJsonFlag": true,
89
91
  "isESM": true,
90
92
  "relativePath": [
@@ -440,5 +442,5 @@
440
442
  ]
441
443
  }
442
444
  },
443
- "version": "1.4.1"
445
+ "version": "1.4.5"
444
446
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@provartesting/provardx-cli",
3
3
  "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.5",
5
5
  "license": "BSD-3-Clause",
6
6
  "plugins": [
7
7
  "@provartesting/provardx-plugins-automation",
@@ -18,9 +18,9 @@
18
18
  "fast-xml-parser": "^4.3.6",
19
19
  "jsonschema": "^1.4.1",
20
20
  "node-stream-zip": "^1.15.0",
21
- "@provartesting/provardx-plugins-utils": "1.2.0",
22
- "@provartesting/provardx-plugins-automation": "1.1.0",
23
- "@provartesting/provardx-plugins-manager": "1.2.0",
21
+ "@provartesting/provardx-plugins-utils": "1.3.0",
22
+ "@provartesting/provardx-plugins-automation": "1.2.0",
23
+ "@provartesting/provardx-plugins-manager": "1.3.0",
24
24
  "sync-request": "^6.1.0",
25
25
  "xml-js": "^1.6.11"
26
26
  },