This is a Crank Cog for Salesforce, providing steps and assertions for you to validate the state and behavior of your Salesforce instance.
Ensure you have the crank CLI and docker installed and running locally,
then run the following. You'll be prompted to enter your Salesforce
credentials once the Cog is successfully installed.
$ crank cog:install stackmoxie/salesforce
Note: you can always re-authenticate later.
You will be asked for the following authentication details on installation. To avoid prompts in a CI/CD context, you can provide the same details as environment variables.
| Field | Install-Time Environment Variable | Description |
|---|---|---|
| instanceUrl | CRANK_AUTOMATONINC_SALESFORCE__INSTANCEURL |
Login/instance URL (e.g. https://na1.salesforce.com) |
| clientId | CRANK_AUTOMATONINC_SALESFORCE__CLIENTID |
OAuth2 Client ID |
| clientSecret | CRANK_AUTOMATONINC_SALESFORCE__CLIENTSECRET |
OAuth2 Client Secret |
| username | CRANK_AUTOMATONINC_SALESFORCE__USERNAME |
Username |
| password | CRANK_AUTOMATONINC_SALESFORCE__PASSWORD |
Password |
# Re-authenticate by running this
$ crank cog:auth stackmoxie/salesforce
| Name (ID) | Expression | Expected Data |
|---|---|---|
| Create a Salesforce Account ( CreateAccount) |
create a salesforce account |
- account: A map of field names to field values |
| Delete a Salesforce Account ( DeleteAccount) |
delete the salesforce account with (?<field>[a-zA-Z0-9_]+) (?<identifier>.+) |
- field: the name of the field used to identify the account - identifier: the value of the field |
| Check a field on a Salesforce Account ( AccountFieldEquals) |
the (?<field>[a-zA-Z0-9_]+) field on salesforce account with (?<idField>[a-zA-Z0-9_]+) (?<identifier>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- idField: The field used to search/identify the account - identifier: The value of the id field to use when searching - field: The name of the field to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: The expected value of the field |
| Check a field on a Salesforce Campaign Member ( CampaignMemberFieldEquals) |
the salesforce lead (?<email>.+) should have campaign member (?<field>[a-z0-9_]+) (?<operator>set to one of|set to|set|not set to one of|not set to|not set|containing|not containing|less than|greater than) ?(?<expectedValue>.+)? on campaign (?<campaignId>.+) |
- email: Lead's email address - campaignId: Campaign ID - field: Field name to check - operator: Check Logic (set to, not set to, containing, not containing, greater than, less than, set, not set, set to one of, or not set to one of) - expectedValue: Expected field value |
| Check Salesforce Campaign Membership ( CampaignMemberCampaignIdEquals) |
the salesforce lead (?<email>.+) should be a member of campaign (?<campaignId>.+) |
- email: Lead's email address - campaignId: Campaign ID |
| Create a Salesforce Contact ( ContactCreateStep) |
create a salesforce contact |
- contact: A map of field names to field values |
| Delete a Salesforce Contact ( ContactDeleteStep) |
delete the (?<email>.+) salesforce contact |
- email: Contact's Email Address |
| Check a field on a Salesforce Contact ( ContactFieldEqualsStep) |
the (?<field>[a-zA-Z0-9_]+) field on salesforce contact (?<email>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- email: Contact's email address - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: Expected field value |
| Create a Salesforce Lead ( CreateLead) |
create a salesforce lead |
- lead: A map of field names to field values |
| Delete a Salesforce Lead ( DeleteLead) |
delete the (?<email>.+) salesforce lead |
- email: Lead's email address |
| Check a field on a Salesforce Lead ( LeadFieldEquals) |
the (?<field>[a-zA-Z0-9_]+) field on salesforce lead (?<email>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- email: Lead's email address - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: Expected field value |
| Create a Salesforce Object ( CreateObject) |
create a salesforce (?<objName>[a-zA-Z0-9]+) object |
- objName: Salesforce object name - salesforceObject: where keys represent object field names as represented in the SFDC API |
| Delete a Salesforce Object ( DeleteObject) |
delete the salesforce (?<objName>[a-zA-Z0-9]+) object with id (?<id>.+) |
- objName: Salesforce Object name - id: Object ID |
| Check a field on a Salesforce Object ( ObjectFieldEquals) |
the (?<field>[a-zA-Z0-9_]+) field on salesforce (?<objName>[a-zA-Z0-9]+) object with id (?<id>[^s]+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- objName: Salesforce object name - id: Object ID - field: Field name to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: Expected field value |
| Update a Salesforce Object ( UpdateObject) |
update the salesforce (?<objName>[a-zA-Z0-9]+) object identified by id (?<identifier>[^s]+) |
- objName: Salesforce object name - identifier: Salesforce object ID - salesforceObject: where keys represent object field names as represented in the SFDC API |
| Create a Salesforce Opportunity ( CreateOpportunity) |
create a salesforce opportunity |
- opportunity: A map of field names to field values |
| Delete a Salesforce Opportunity ( DeleteOpportunity) |
delete the salesforce opportunity with (?<field>[a-zA-Z0-9_]+) (?<identifier>.+) |
- field: the name of the field used to identify the opportunity - identifier: the value of the field |
| Check a field on a Salesforce Opportunity ( OpportunityFieldEquals) |
the (?<field>[a-zA-Z0-9_]+) field on salesforce opportunity with (?<idField>[a-zA-Z0-9_]+) (?<identifier>.+) should (?<operator>be set|not be set|be less than|be greater than|be one of|be|contain|not be one of|not be|not contain) ?(?<expectedValue>.+)? |
- idField: The field used to search/identify the opportunity - identifier: The value of the id field to use when searching - field: The name of the field to check - operator: Check Logic (be, not be, contain, not contain, be greater than, be less than, be set, not be set, be one of, or not be one of) - expectedValue: The expected value of the field |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to add or update tests as appropriate.
- Install node.js (v12.x+ recommended)
- Clone this repository.
- Intsall dependencies via
npm install - Run
npm startto validate the Cog works locally (ctrl+cto kill it) - Run
crank cog:install --source=local --local-start-command="npm start"to register your local instance of this Cog. You may need to append a--forceflag or runcrank cog:uninstall stackmoxie/salesforceif you've already installed the distributed version of this Cog.
Modify code in src/steps and validate your changes by running
crank cog:step stackmoxie/salesforce and selecting your step.
To add new steps, create new step classes in src/steps. Use existing steps as
a starting point for your new step(s). Note that you will need to run
crank registry:rebuild in order for your new steps to be recognized.
Always add tests for your steps in the test/steps folder. Use existing tests
as a guide.
Modify the ClientWrapper class at src/client/client-wrapper.ts.
- If you need to add or modify authentication details, see the
expectedAuthFieldsstatic property. - If you need to expose additional logic from the wrapped API client, add a new ublic method to the wrapper class, which can then be called in any step.
- It's also possible to swap out the wrapped API client completely. You should only have to modify code within this clase to achieve that.
Note that you will need to run crank registry:rebuild in order for any
changes to authentication fields to be reflected. Afterward, you can
re-authenticate this Cog by running crank cog:auth stackmoxie/salesforce
Tests can be found in the test directory and run like this: npm test.
Ensure your code meets standards by running npm run lint.