Smock-it is a powerful CLI plugin, a tool for generating mock data for Salesforce testing. It simplifies the creation of compliant, relationship-aware test data, allowing developers, QA teams, and admins to quickly generate and use unique datasets directly within their Salesforce orgs.
Want to get started with Smock-it? Quick Start Guide.
Smock-it v3 brings smarter, faster test data generation for Salesforce, with:
Smock-it has eliminated its dependency on mockaroo and now comes with its own data library. This allows it to generate 100% unique data up to 300K records for Salesforce standard duplicate rules.
When generating location-based data, Smock-it intelligently associates countries with their respective states and cities, ensuring the data is both logical and realistic.
Using advanced, context-aware algorithms, it generates realistic names, industries, emails, currencies, and other text-based data. This ensures that your test data closely mirrors real-world scenarios, enhancing its authenticity and reliability.
The new data upload feature allows users to upload generated datasets to different orgs using the username or alias. This makes it seamless for teams to test across environments with the exact same dataset.
Smock-it removes the biggest roadblocks Salesforce professionals face when managing and generating test data.
Smock-It lets you easily upload and reuse generated data across different orgs, making it seamless for teams to test with the same dataset. This ensures consistency and accuracy across environments.
QAs need test data that looks realistic, and Smock-It delivers just that. The data it generates isn’t just random numbers or text; it’s context-aware, logically correct, and closely resembles real-world scenarios. This ensures that the data is not only realistic but also meaningful.
With no API dependencies, data generation time has drastically reduced, from approximately 15 minutes for 200,000 records to just 2 minutes. It also removes previous limitations, allowing unlimited data generation per day.
Before installing Smock-it, ensure you have the following:
- Salesforce CLI
- Node.js (v18.0.0 or later)
Run the following command in your terminal to install Smock-it as a Salesforce CLI plugin:
sf plugins install smock-it
To confirm that Smock-it was installed successfully, run the below command. This will list all installed plugins, including Smock-it.
sf plugins
Keep Smock-it up to date with the latest enhancements by running:
sf plugins update
When running template init command, the following directories are automatically created in your current working directory (if they don’t already exist). These directories help to organize your output test data and template configurations, making it easier to manage and reuse:
PROJECT_BASE/
├── data_gen/
│ ├── templates/ #refer to template structure
│ │ ├ createAccount.json
│ ├── output/ #refer to Output
│ │ ├ CreateAccount_DI_Ouput.json
│ │ ├ CreateAccount_CSV_Ouput.csv
│ │ ├ CreateAccount_JSON_Ouput.jsonWhile creating the template (template init), you will be prompted with questions to fully customize your template based on your test data needs. For a complete guide, please refer to Template Init Questionnaire..
Below is an example template:
{
"namespaceToExclude": ["testGen"],
"outputFormat": [
"di",
"csv",
"json"
],
"count": 200,
"sObjects": [
{
"account": {
"count": 50,
"fieldsToExclude": ["fax"],
"fieldsToConsider": {
"name": [],
"email": [],
"dp-country__c": ["USA"],
"dp-state__c": ["California"]
},
"pickLeftFields": true
}
}
]
}
For more on Template Use Cases, Please refer Common Template Use Cases.
Smock-it generates output based on the format provided in the template configuration file. Currently it supports csv, json and DI format where DI means Direct Insert into your Salesforce org.
Create fresh template for data generation. Read more
⚠️ Warning: The template create command 'sf template init [--default]' will be deprecated soon. Use
sf smockit template init [--default]
Check data generation template for correctness. Read more
⚠️ Warning: The template validate command 'sf template validate' will be deprecated soon. Use
sf smockit template validate -t <templateFileName> -a <aliasorUsername>
Generate and/or insert data based on the objects and settings defined within the template. Read more
⚠️ Warning: The template generate command 'sf template generate' will be deprecated soon. Use
sf smockit data generate -t <templateFileName> -a <aliasorUsername>
Note: The alias name or username of the Salesforce Org is required.
Upload generated data (CSV, JSON) to multiple orgs. Read more
⚠️ Warning: The template upload command 'sf data upload' will be deprecated soon. Use
sf smockit data upload -u <filename.json|filename.csv> -a <alias_or_username> -s <sObject>
Note: Make sure to append the filename with .json or .csv to upload the data.
Review the template configuration before using it to generate data in read-only. Read more
⚠️ Warning: The template print command 'sf template print' will be deprecated soon. Use
sf smockit template print -t <templateFileName>
Modify or add configuration to an existing template. Read more
⚠️ Warning: The template upsert command 'sf template upsert' will be deprecated soon. Use
sf smockit template upsert -t <templateFileName> [-s <sObject>] [-c <recordCount>] [-x <namespaceToExclude>] [-f <outputFormat>] [-e <fieldsToExclude>] [-i <fieldsToConsider>] [-p <pickLeftFields>]
Remove specific configurations from an existing data generation template. Read more
⚠️ Warning: The template remove command 'sf template remove' will be deprecated soon. Use
sf smockit template remove -t <templateFileName> [-s <sObject>] [-c <recordCount>] [-x <namespaceToExclude>] [-f <outputFormat>] [-e <fieldsToExclude>] [-i <fieldsToConsider>] [-p <pickLeftFields>]
| Flag | Short Hand | Flag Name | Description |
|---|---|---|---|
--default |
Default Template | Creates a default template. | |
--templateName |
-t |
Template Name | Specify the name of the data template to be utilized. The template must exist in the data_gen/templates directory. |
--count |
-c |
Count | Set the number of records to generate. If --sObject or -s is provided, this will only update or remove the count for that object. |
--namespaceToExclude |
-x |
Namespace to Exclude | Exclude specific namespaces from generating record data for namespace fields. Multiple namespaces can be separated by commas. |
--outputFormat |
-f |
Output Format | Define the output format(s) for generated data (e.g., CSV, JSON, DI). Multiple formats can be specified, separated by commas. |
--sObject |
-s |
Specific Object | Target a specific object and override its existing settings. If not found in the template, an "add object" prompt will appear. |
--upload |
-u |
Upload | The -u command is used to upload the generated JSON or CSV data into the target Salesforce org. |
--fieldsToExclude |
-e |
Fields to Exclude | Exclude specific fields from test data generation for a given object. Applies only at the object level. |
--fieldsToConsider |
-i |
Fields to Consider | Include specific fields from test data generation for a given object. This applies only at the object level, with the specified values. |
--pickLeftFields |
-p |
Pick Left Fields | If true, generates data for all fields except those listed in FieldsToExclude. If false, generates data only for the fields specified in FieldsToConsider. |
--aliasOrUserName |
-a |
Alias Or UserName | This flag is required when using the validate and data generate commands. It accepts a username or alias name and only supports orgs listed in the Salesforce Org List. |
Integrate Smock-it within the DevOps pipeline. Read more
To access command help:
sf <template/data> <command> --help