sf-delta-tests

Calculate dependencies and scope to relevant tests.

This plugin is designed to optimize your Salesforce CI/CD pipeline by calculating only the relevant test classes that need to be run based on the metadata changes in your package. It uses the Salesforce Dependency API to determine these relationships.

Install

sf plugins install sf-delta-tests

Build

To build the plugin locally, make sure to have yarn installed and run the following commands:

# Install the dependencies and compile
yarn && yarn build

To use your plugin, run using the local ./bin/dev.js or ./bin/dev.cmd file.

# Run using local run file.
./bin/dev.js delta test-classes -o <alias name> --package-path=test/fixtures/manifest/package.xml

There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins

Commands

• sf delta test-classes

sf delta test-classes

Run only related tests

USAGE
  $ sf delta test-classes -o <value> [--json] [--flags-dir <value>] [-p <value>] [--always-run-test <value>...]
    [--include-all-flows]

FLAGS
  -o, --target-org=<value>          (required) The org you want to check the dependencies against.
  -p, --package-path=<value>        [default: manifest/package.xml] Path to the package.xml that will be deployed.
      --always-run-test=<value>...  A test class to run when no tests need to be ran.
      --[no-]include-all-flows      When enabled, if any Flow is changed, include all Flows that require test coverage
                                    based on their trigger type or process type. This ensures proper test coverage
                                    validation since Salesforce checks coverage for all such Flows during deployment,
                                    not just the changed ones. Use --no-include-all-flows to disable.

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

DESCRIPTION
  Run only related tests

  Calculates the tests needed to be ran based on the changed metadata given using the Salesforce Dependency API. For
  Flows, also queries FlowTestCoverage to include test classes that have previously covered the Flows.

EXAMPLES
  testCmd=$(sf delta test-classes --target-org [email protected])

    $ sf project deploy validate ${testCmd}

• sf delta test-classes

sf delta test-classes

Calculates the tests needed to be run based on the changed metadata given using the Salesforce Dependency API

Run only related tests

USAGE
  $ sf delta test-classes -o <value> [--json] [--flags-dir <value>] [-p <value>] [--always-run-test <value>...] [--include-all-flows]

FLAGS
  -o, --target-org=<value>          (required) The org you want to check the dependencies against.
  -p, --package-path=<value>        [default: manifest/package.xml] Path to the package.xml that will be deployed.
      --always-run-test=<value>...  A test class to run when no tests need to be ran.
      --[no-]include-all-flows      When enabled, if any Flow is changed, include all Flows that require test coverage based on their trigger type
                                    or process type. This ensures proper test coverage validation since Salesforce checks coverage for all such
                                    Flows during deployment, not just the changed ones. Use --no-include-all-flows to disable.

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

DESCRIPTION
  Run only related tests

  Calculates the tests needed to be ran based on the changed metadata given using the Salesforce Dependency API

EXAMPLES
  testCmd=$(sf delta test-classes --target-org [email protected])

    $ sf project deploy validate ${testCmd}