test-results

Get test result reports from Salesforce

• Debugging your plugin

$ npm install -g sfdx-test-run-report
$ sfdx-test-run-report COMMAND
running command...
$ sfdx-test-run-report (-v|--version|version)
sfdx-test-run-report/0.1.2 darwin-x64 node-v8.12.0
$ sfdx-test-run-report --help [COMMAND]
USAGE
  $ sfdx-test-run-report COMMAND
...

• sfdx-test-run-report testrunreport:convert
• sfdx-test-run-report testrunreport:retrieve [-d <string>] [-c] [-a] [-l] [-r] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]
• sfdx-test-run-report testrunreport:view

sfdx-test-run-report testrunreport:convert

Convert test results to report type

USAGE
  $ sfdx-test-run-report testrunreport:convert

OPTIONS
  -d, --outputdir=outputdir    [default: ./test-results] the directory to scan for reports
  -i, --inputdir=inputdir      (required) the directory to scan for reports
  -r, --reporttype=reporttype  [default: sonarqube] type of report to convert to [sonarqube*]
  -s, --sourcedir=sourcedir    [default: ./src] the directory to scan for reports

See code: src/commands/testrunreport/convert.ts

sfdx-test-run-report testrunreport:retrieve [-d <string>] [-c] [-a] [-l] [-r] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

Retrieve reports for a test run

USAGE
  $ sfdx-test-run-report testrunreport:retrieve [-d <string>] [-c] [-a] [-l] [-r] [-v <string>] [-u <string>] 
  [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

OPTIONS
  -a, --alltestsonly                               only retrieve results for full test runs
  -c, --codecoverage                               directory root to place test results
  -d, --outputdirectory=outputdirectory            [default: test-results] directory root to place test results
  -l, --uselatest                                  use latest test run

  -r, --resultformat                               test result format emitted to stdout; --json flag overrides this
                                                   parameter (human*,tap,junit,json)

  -u, --targetusername=targetusername              username or alias for the target org; overrides default target org

  -v, --targetdevhubusername=targetdevhubusername  username or alias for the dev hub org; overrides default dev hub 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)   [default: warn] logging level for this command invocation

EXAMPLE
  $ sfdx testrunreport:retrieve --targetusername [email protected] --outputDirectory results
     Test results written to results/[email protected]/2019-03-06T09:45:21.000+0000

See code: src/commands/testrunreport/retrieve.ts

sfdx-test-run-report testrunreport:view

View test run results

USAGE
  $ sfdx-test-run-report testrunreport:view

OPTIONS
  -i, --inputdir=inputdir  (required) the directory to scan for reports
  -p, --port=port          [default: 3000] port to run server on

See code: src/commands/testrunreport/view.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:

$ 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:

$ 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!