Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexferrari88/sfdx-runtimes-exporter
SFDX plugin to keep track of tests running times during deployments
https://github.com/alexferrari88/sfdx-runtimes-exporter
salesforce sfdx sfdx-plugin
Last synced: 8 days ago
JSON representation
SFDX plugin to keep track of tests running times during deployments
- Host: GitHub
- URL: https://github.com/alexferrari88/sfdx-runtimes-exporter
- Owner: alexferrari88
- Created: 2022-03-24T05:44:30.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-04T12:05:23.000Z (over 2 years ago)
- Last Synced: 2024-12-16T01:06:08.189Z (13 days ago)
- Topics: salesforce, sfdx, sfdx-plugin
- Language: TypeScript
- Homepage:
- Size: 480 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
sfdx-test-performance
=====================
Keep track of tests running times during your deployments.
[](https://npmjs.org/package/sfdx-test-performance)
[](https://circleci.com/gh/alexferrari88/sfdx-test-performance/tree/master)
[](https://ci.appveyor.com/project/heroku/sfdx-test-performance/branch/master)
[](https://greenkeeper.io/)
[](https://snyk.io/test/github/alexferrari88/sfdx-test-performance)
[](https://npmjs.org/package/sfdx-test-performance)
[](https://github.com/alexferrari88/sfdx-test-performance/blob/master/package.json)
* [Debugging your plugin](#debugging-your-plugin)
* [Debugging your plugin](#debugging-your-plugin)
```sh-session
$ npm install -g sfdx-runtimes-exporter
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-runtimes-exporter/0.0.1 win32-x64 node-v17.7.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
```
```sh-session
$ npm install -g sfdx-runtimes-exporter
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-runtimes-exporter/0.0.1 win32-x64 node-v17.7.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
```
* [`sfdx list [-b ] [-a ] [-l] [-m ] [-o csv|json|S3|dynamoDB] [-d ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-list--b-datetime--a-datetime--l--m-integer--o-csvjsons3dynamodb--d-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
* [`sfdx runtimes -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-runtimes--i-id--o-csvjsons3dynamodb--d-string--t-integer--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
## `sfdx list [-b ] [-a ] [-l] [-m ] [-o csv|json|S3|dynamoDB] [-d ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Retrieve IDs of successful deployments with tests within a given time range
```
USAGE
$ sfdx list [-b ] [-a ] [-l] [-m ] [-o csv|json|S3|dynamoDB] [-d ] [-u ]
[--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-a, --after=after date time after which the
deployments should be retrieved
-b, --before=before date time before which the
deployments should be retrieved
-d, --target=target target location to save the results
(do not include the file name)
-l, --latest retrieve only the latest deployments
(provide the "max" flag to retrieve
more than one)
-m, --max=max [default: 10] maximum number of
deployments to be retrieved
-o, --output=(csv|json|S3|dynamoDB) [default: json] where do you want to
output the results
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLES
sfdx list --targetusername [email protected] --before "01/02/2000 01:02:34" --max=5 --output=csv --target=myFolder
sfdx list --targetusername [email protected] --after "01/02/2000 01:02:34" --output=csv --target=myFolder
sfdx list --targetusername [email protected] --latest --max=5 --output=csv --target=myFolder
```
_See code: [src/commands/list.ts](https://github.com/alexferrari88/sfdx-runtimes-exporter/blob/v0.0.1/src/commands/list.ts)_
## `sfdx runtimes -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Retrieve tests execution time for a given deployment
```
USAGE
$ sfdx runtimes -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion ]
[--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --target=target target location to save the results
(do not include the file name)
-i, --deployment=deployment (required) id of the deployment to
get tests execution time for
-o, --output=(csv|json|S3|dynamoDB) [default: json] where do you want to
output the results
-t, --threshold=threshold return the tests execution time to
only those above the threshold (in
milliseconds)
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLES
sfdx runtimes --targetusername [email protected] --deployment deploymentId --output=s3 --target=s3://myBucket/myFolder
sfdx runtimes --targetusername [email protected] --deployment deploymentId --output=csv --target=myFolder
sfdx runtimes --targetusername [email protected] --deployment deploymentId --output=dynamoDB --target=myTable
sfdx runtimes --targetusername [email protected] --deployment deploymentId --output=json --target=myFolder
--threshold=10000
```
_See code: [src/commands/runtimes.ts](https://github.com/alexferrari88/sfdx-runtimes-exporter/blob/v0.0.1/src/commands/runtimes.ts)_
* [`sfdx runtimes:tests -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-runtimestests--i-id--o-csvjsons3dynamodb--d-string--t-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
## `sfdx runtimes:tests -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
Retrieve tests execution time for a given deployment
```
USAGE
$ sfdx runtimes:tests -i [-o csv|json|S3|dynamoDB] [-d ] [-t ] [-u ] [--apiversion
] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-d, --target=target target location to save the results
(do not include the file name)
-i, --deployment=deployment (required) id of the deployment to
get tests execution time for
-o, --output=(csv|json|S3|dynamoDB) [default: json] where do you want to
output the results
-t, --threshold=threshold return the tests execution time to
only those above the threshold (in
milliseconds)
-u, --targetusername=targetusername username or alias for the target
org; overrides default target org
--apiversion=apiversion override the api version used for
api requests made by this command
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLES
sfdx per:tst --deployment deploymentId --targetusername [email protected] --output=s3 --target=s3://myBucket/myFolder
sfdx per:tst --deployment deploymentId --targetusername [email protected] --output=csv --target=myFile.csv
sfdx per:tst --deployment deploymentId --targetusername [email protected] --output=dynamoDB --target=myTable
sfdx per:tst --deployment deploymentId --targetusername [email protected] --output=json --target=myFile.json
--threshold=10000
```
_See code: [src/commands/runtimes/tests.ts](https://github.com/alexferrari88/sfdx-runtimes-exporter/blob/v0.0.1/src/commands/runtimes/tests.ts)_
# Debugging your plugin
We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
To debug the `hello:org` command:
1. Start the inspector
If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
```sh-session
$ sfdx hello:org -u [email protected] --dev-suspend
```
Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
```sh-session
$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u [email protected]
```
2. Set some breakpoints in your command code
3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
Congrats, you are debugging!