The @salesforce/core library provides client-side management of Salesforce DX projects, org authentication, connections to Salesforce APIs, and other utilities. Much of the core functionality that powers the Salesforcedx plug-ins comes from this library. You can use this functionality in your plug-ins too.
See the API documentation.
If you are interested in contributing, please take a look at the CONTRIBUTING guide.
Related Docs and Repositories
- @salesforce/command - Contains base Salesforce CLI command,
- @salesforce/plugin-generator - The generator plug-in for building plug-ins for Salesforce CLI.
The Salesforce DX Core Library provides a unit testing utility to help with mocking and sand-boxing core components. This feature allows unit tests to execute without needing to make API calls to salesforce.com.
Here you can mock authorization for a Salesforce scratch org.
;;;;describe'Mocking Auth data',;
After having a valid AuthInfo object you can then create fake connections to a Salesforce.com scratch org. This allows for writing tests that can validate result responses for SOQL queries and REST endpoints.
;;;;;;;describe'Mocking a force server call',;
Using the Built-in Sinon Sandboxes
sfdx-core uses Sinon as its underlying mocking system. If you're unfamiliar with Sinon and it's sandboxing concept you can find more information here:
spys must be cleaned up after test invocations. To ease the use of Sinon with sfdx core we've exposed our sandbox in TestSetup. After adding your own
spys they will automatically be cleaned up after each test using mocha's afterEach method.
;;;;describe'Using the built in Sinon sandbox.',;
Testing Expected Failures
It's important to have negative tests that ensure proper error handling. With
shouldThrow it's easy to test for expected async rejections.
;;;describe'Testing for expected errors',;
Testing Log Lines
It's also useful to check expected values and content from log lines. TestSetup configures the sfdx-core logger to use an in memory LogLine storage structure. These can be easily accessed from tests.
;;;;;describe'Testing log lines',;