A plugin for Salesforce DX CLI that provides ability to generate test data using mockaroo schema
You will need to sign up for the mockaroo API services and generate a schema.
Install plugin using command : sfdx plugins:install seedmockdata
-
Install the SDFX CLI.
-
Clone the repository:
git clone git@github.com:msrivastav13/testdata.git -
Install using yarn:
yarn install -
Link the plugin:
sfdx plugins:link.
-
Requires mockaroo account
-
Get your mockaroo api key from your My Account Settings.
-
Set the MAPIKEY environment variable. On MAC OSX for type
export MAPIKEY=<apikey>. The key is presisted only for current terminal session. For persisitng it for ever add env variable in bash_profile -
Create a Schema mapping in mockaroo. Note that always choose one field with name externalId and map to an Id function in mockaroo
USAGE
sfdx testdata:generate -s <string> [-o <string>] [-d <string>] [-f <string>] [-c <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
Creates test data using mockaroo schema. Requires mockaroo schemaId and key. Set your mockaroo key using environment variable MAPIKEY
USAGE
$ sfdx testdata:generate -s <string> [-o <string>] [-d <string>] [-f <string>] [-c <integer>] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
OPTIONS
-c, --count=count [default: 10] specify the number of
rows of data needed
-d, --outputdir=outputdir [default: ./data] path of the output
directory of file
-f, --format=format file format of the output. Supported
values are json/csv
-o, --sobject=sobject [default: testdata] Name of the
Salesforce object
-s, --schemaid=schemaid (required) Mockaroo Schema Id
--json format output as json
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
this command invocation
EXAMPLES
Generates testdata from mockaroo schemaid and creates a json file account.json with 10 rows of data in ./data
directory
$ sfdx testdata:generate --schemaid=ea4x6ba0 --count=100 --sobject=account --json
Generates testdata from mockaroo schemaid and creates a json file Contact.json in ./data directory
$ sfdx testdata:generate --schemaid=eax36ba0 --sobject=Contact
Generates testdata from mockaroo schemaid and creates a csv file Contact.csv in ./data directory
$ sfdx testdata:generate --schemaid=eax36ba0 --sobject=Contact --outputdir='./data' --format=csv
See code: src/commands/testdata/generate.ts