Salesforce Apex Plugin

Introduction

This is an oclif plugin that supports the Salesforce Apex commands.

Building the Plugin

Clone the project and cd into it:

$ git clone git@github.com:salesforcecli/plugin-apex.git
$ cd plugin-apex

Ensure you have Yarn installed, then run:

$ yarn install
$ yarn build

Linking the Plugin

Link the plugin from the plugin-apex package directory and then run your command:

$ sfdx plugins:link .
$ sfdx force:apex:log:list -u myOrg@example.com

Alternatively, you can also run the command from the plugin-apex package directory without linking the plugin:

$ NODE_OPTIONS=--inspect-brk bin/dev force:apex:log:list -u myOrg@example.com

Running the Test Suite

Test the test suite locally by building the project first and then running the tests.

$ yarn build
$ yarn test

Debugging the 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 a command:

1. If you linked your plugin to the Salesforce CLI using yarn plugin:link, call your command with the dev-suspend switch:

$ sfdx force:apex:log:list -u myOrg@example.com --dev-suspend

Alternatively, replace sfdx with NODE_OPTIONS=--inspect-brk bin/dev and run your command:

$ NODE_OPTIONS=--inspect-brk bin/dev force:apex:log:list -u myOrg@example.com

2. Set some breakpoints in your code.
3. Click on the Debug icon in the Activity Bar to open up the Debugger view.
4. In the upper left hand corner, set the launch configuration to Attach to Remote.
5. Click the green play button on the left of the debugger view. The debugger should now be suspended on the first line of the program.
6. Click the green play button in the mini toolbar to continue running the program.
   
   

Commands

• sf apex get log
• sf apex get test
• sf apex list log
• sf apex run
• sf apex run test
• sf apex tail log

sf apex get log

Fetch the specified log or given number of most recent logs from the org.

USAGE
  $ sf apex get log -o  [--json] [--flags-dir ] [--api-version ] [-i ] [-n ]
    [-d ]

FLAGS
  -d, --output-dir=   Directory for saving the log files.
  -i, --log-id=       ID of the specific log to display.
  -n, --number=       Number of the most recent logs to display.
  -o, --target-org=   (required) Username or alias of the target org. Not required if the `target-org`
                             configuration variable is already set.
      --api-version=  Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Fetch the specified log or given number of most recent logs from the org.

  To get the IDs for your debug logs, run "sf apex log list". Executing this command without flags returns the most
  recent log.

ALIASES
  $ sf force apex log get

EXAMPLES
  Fetch the log in your default org using an ID:

    $ sf apex get log --log-id 

  Fetch the log in the org with the specified username using an ID:

    $ sf apex get log --log-id  --target-org me@my.org

  Fetch the two most recent logs in your default org:

    $ sf apex get log --number 2

  Similar to previous example, but save the two log files in the specified directory:

    $ sf apex get log --output-dir /Users/sfdxUser/logs --number 2

FLAG DESCRIPTIONS
  -d, --output-dir=  Directory for saving the log files.

    The location can be an absolute path or relative to the current working directory. The default is the current
    directory.

See code: src/commands/apex/get/log.ts

sf apex get test

Display test results for a specific asynchronous test run.

USAGE
  $ sf apex get test -o  -i  [--json] [--flags-dir ] [--api-version ] [-c] [-d ]
    [-r human|tap|junit|json]

FLAGS
  -c, --code-coverage           Retrieve code coverage results.
  -d, --output-dir=      Directory in which to store test result files.
  -i, --test-run-id=     (required) ID of the test run.
  -o, --target-org=      (required) Username or alias of the target org. Not required if the `target-org`
                                configuration variable is already set.
  -r, --result-format=<option>  [default: human] Format of the results.
                                
      --api-version=     Override the api version used for api requests made by this command

GLOBAL FLAGS
  --flags-dir=  Import flag values from a directory.
  --json               Format output as json.

DESCRIPTION
  Display test results for a specific asynchronous test run.

  Provide a test run ID to display test results for an enqueued or completed asynchronous test run. The test run ID is
  displayed after running the "sf apex test run" command.

ALIASES
  $ sf force apex test report

EXAMPLES
  Display test results for your default org using a test run ID:

    $ sf apex get test --test-run-id 

  Similar to previous example, but output the result in JUnit format:

    $ sf apex get test --test-run-id  --result-format junit

  Also retrieve code coverage results and output in JSON format:

    $ sf apex get test --test-run-id  --code-coverage --json

  Specify a directory in which to save the test results from the org with the specified username (rather than your
  default org):

    $ sf apex get test --test-run-id  --code-coverage --output-dir </option>