Merge pull request #7 from salesforcecli/ew/generate

Generate, migrage, and report commands

Author: iowillhoit

.gitignore

@@ -47,3 +47,7 @@ node_modules
 # os specific files
 .DS_Store
 .idea
+
+
+# Temp
+ignore/

README.md

@@ -87,11 +87,11 @@ git clone git@github.com:salesforcecli/plugin-data-seeding
 yarn && yarn build
 ```
 
-To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file.
 
 ```bash
 # Run using local run file.
-./bin/dev hello world
+./bin/dev.js data-seeding generate
 ```
 
 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.
@@ -107,43 +107,188 @@ sf plugins
 
 <!-- commands -->
 
-- [`sf hello world`](#sf-hello-world)
+- [`sf data-seeding generate`](#sf-data-seeding-generate)
+- [`sf data-seeding generate report`](#sf-data-seeding-generate-report)
+- [`sf data-seeding migrate`](#sf-data-seeding-migrate)
+- [`sf data-seeding migrate report`](#sf-data-seeding-migrate-report)
 
-## `sf hello world`
+## `sf data-seeding generate`
 
-Say hello.
+Generate synthetic org data that mimics existing data in a source org, and then load it into a separate target org.
 
 ```
 USAGE
-  $ sf hello world [--json] [--flags-dir <value>] [-n <value>]
+  $ sf data-seeding generate -o <value> -s <value> -f <value> [--json] [--flags-dir <value>] [-w <value> | --async]
 
 FLAGS
-  -n, --name=<value>  [default: World] The name of the person you'd like to say hello to.
+  -f, --config-file=<value>  (required) Path to the data seeding JSON configuration file.
+  -o, --target-org=<value>   (required) Username or alias of the target org into which the generated data will be
+                             loaded.
+  -s, --source-org=<value>   (required) Username or alias of the source org that contains the data that AI will mimic.
+  -w, --wait=<value>         [default: 33 minutes] Number of minutes to wait for the command to complete; when reached,
+                             the command completes asynchronously if necessary.
+      --async                Run the command asynchronously and immediately return control of the terminal.
 
 GLOBAL FLAGS
   --flags-dir=<value>  Import flag values from a directory.
   --json               Format output as json.
 
 DESCRIPTION
-  Say hello.
+  Generate synthetic org data that mimics existing data in a source org, and then load it into a separate target org.
 
-  Say hello either to the world or someone you know.
+  This command uses AI to generate synthetic (or "fake") data that has a similar format to selected data in a source
+  org. The command uses a JSON configuration file to define the characteristics of the synthetic data. For example, the
+  configuration file might specify the number of records to generate for one or more Salesforce objects, along with the
+  subset of fields to include. Once generated, the data is automatically loaded into the specified target org. You must
+  be authenticated to both the source and target orgs before running this command.
+
+  By default, this command runs synchronously and outputs the job ID, along with a running status of each execution
+  phase, such as querying the source org or generating the data. If you prefer, you can run the command asynchronously
+  by specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID
+  to run the "data-seeding generate report" command to view the status.
+
+EXAMPLES
+  Generate synthetic data similar to existing data in the org with alias "mySourceOrg" then load it into the org with
+  alias "myTargetOrg"; use the specified config file to determine the format of the generated data:
+
+    $ sf data-seeding generate --source-org mySourceOrg --target-org myTargetOrg --config-file \
+      ./config/seed-config.json
+
+  Generate synthetic data using org usernames and run the command asynchronously:
+
+    $ sf data-seeding generate --source-org source@org.com" --target-org target@org.com" --config-file \
+      ./config/seed-config.json --async
+
+  Generate synthetic data using org aliases; if after 5 minutes the command hasn't finished, it completes
+  asynchronously:
+
+    $ sf data-seeding generate --source-org source@org.com" --target-org target@org.com" --config-file \
+      ./config/seed-config.json --wait 5
+```
+
+_See code: [src/commands/data-seeding/generate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/generate/index.ts)_
+
+## `sf data-seeding generate report`
+
+Display the status of a data-seeding generate job.
+
+```
+USAGE
+  $ sf data-seeding generate report [--json] [--flags-dir <value>] [-i <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>   ID of a specific execution of the "data-seeding generate" command.
+  -r, --use-most-recent  View the status of the most recently run "data-seeding generate" command.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Display the status of a data-seeding generate job.
+
+  This command displays the status of a previously initiated or completed execution of the "data-seeding generate"
+  command. Run this command by either passing it the job ID returned by "data-seeding generate", or use the
+  --use-most-recent flag to view the status of the most recently run "data-seeding generate" command.
 
 EXAMPLES
-  Say hello to the world:
+  Display the status of a specific execution of the "data-seeding generate" command:
 
-    $ sf hello world
+    $ sf data-seeding generate report --job-id 1234-5678-AAAA-BBBB
 
-  Say hello to someone you know:
+  Display the status of the most recently run "data-seeding generate" command:
+
+    $ sf data-seeding generate report --use-most-recent
+```
+
+_See code: [src/commands/data-seeding/generate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/generate/report.ts)_
+
+## `sf data-seeding migrate`
+
+Migrate data from one org to another.
+
+```
+USAGE
+  $ sf data-seeding migrate -o <value> -s <value> -f <value> [--json] [--flags-dir <value>] [-w <value> | --async]
+
+FLAGS
+  -f, --config-file=<value>  (required) Path to the data migration JSON configuration file.
+  -o, --target-org=<value>   (required) Username or alias of the target org into which the migrated data is loaded.
+  -s, --source-org=<value>   (required) Username or alias of the source org that contains the data to be migrated.
+  -w, --wait=<value>         [default: 33 minutes] Number of minutes to wait for the command to complete; when reached,
+                             the command completes asynchronously if necessary.
+      --async                Run the command asynchronously and immediately return control of the terminal.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Migrate data from one org to another.
+
+  This command migrates selected data from a source org and loads it into a target org. The command uses a JSON
+  configuration file that defines the characteristics of the data. For example, the configuration file might specify a
+  number of records from one or more Salesforce objects to migrate, along with the subset of fields to include. You must
+  be authenticated to both the source and target orgs before running this command.
+
+  By default, this command runs synchronously and outputs a job ID along with a running status of each execution phase,
+  such as querying the source org or loading into the target. If you prefer, you can run the command asynchronously by
+  specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID to
+  run the "data-seeding migrate report" command to view the status.
+
+EXAMPLES
+  Migrate data from the org with alias "mySourceOrg" to the org with alias "myTargetOrg"; use the specified
+  configuration file to determine the data to migrate:
+
+    $ sf data-seeding migrate --source-org mySourceOrg --target-org myTargetOrg --config-file \
+      ./config/data-seed.json
+
+  Migrate data by specifying usernames for the source and target orgs, and run the command asynchronously:
+
+    $ sf data-seeding migrate --source-org source@org.com --target-org target@org.com \
+      --config-file=./config/data-seed.json --async
+
+  Migrate data using org aliases; if after 5 minutes the command hasn't finished, it completes asynchronously:
+
+    $ sf data-seeding migrate --source-org mySourceOrg --target-org myTargetOrg --config-file \
+      ./config/data-seed.json --wait 5
+```
+
+_See code: [src/commands/data-seeding/migrate/index.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/migrate/index.ts)_
+
+## `sf data-seeding migrate report`
+
+Display the status of a data-seeding migrate job.
+
+```
+USAGE
+  $ sf data-seeding migrate report [--json] [--flags-dir <value>] [-i <value>] [-r]
+
+FLAGS
+  -i, --job-id=<value>   ID of a specific execution of the "data-seeding migrate" command.
+  -r, --use-most-recent  View the status of the most recently run "data-seeding migrate" command.
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Display the status of a data-seeding migrate job.
+
+  This command displays the status of a previously initiated or completed execution of the "data-seeding migrate"
+  command. Run this command by either passing it the job ID returned by "data-seeding migrate", or use the
+  --use-most-recent flag to view the status of the most recently run "data-seeding migrate" command.
+
+EXAMPLES
+  Display the status of a specific execution of the "data-seeding migrate" command:
 
-    $ sf hello world --name Astro
+    $ sf data-seeding migrate report --job-id 1234-5678-AAAA-BBBB
 
-FLAG DESCRIPTIONS
-  -n, --name=<value>  The name of the person you'd like to say hello to.
+  Display the status of the most recently run "data-seeding migrate" command:
 
-    This person can be anyone in the world!
+    $ sf data-seeding migrate report --use-most-recent
 ```
 
-_See code: [src/commands/hello/world.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/1.0.10/src/commands/hello/world.ts)_
+_See code: [src/commands/data-seeding/migrate/report.ts](https://github.com/salesforcecli/plugin-data-seeding/blob/v1.0.10/src/commands/data-seeding/migrate/report.ts)_
 
 <!-- commandsstop -->

command-snapshot.json

@@ -1,10 +1,34 @@
 [
   {
     "alias": [],
-    "command": "hello:world",
+    "command": "data-seeding:generate",
     "flagAliases": [],
-    "flagChars": ["n"],
-    "flags": ["flags-dir", "json", "name"],
+    "flagChars": ["f", "o", "s", "w"],
+    "flags": ["async", "config-file", "flags-dir", "json", "source-org", "target-org", "wait"],
+    "plugin": "@salesforce/plugin-data-seeding"
+  },
+  {
+    "alias": [],
+    "command": "data-seeding:generate:report",
+    "flagAliases": [],
+    "flagChars": ["i", "r"],
+    "flags": ["flags-dir", "job-id", "json", "use-most-recent"],
+    "plugin": "@salesforce/plugin-data-seeding"
+  },
+  {
+    "alias": [],
+    "command": "data-seeding:migrate",
+    "flagAliases": [],
+    "flagChars": ["f", "o", "s", "w"],
+    "flags": ["async", "config-file", "flags-dir", "json", "source-org", "target-org", "wait"],
+    "plugin": "@salesforce/plugin-data-seeding"
+  },
+  {
+    "alias": [],
+    "command": "data-seeding:migrate:report",
+    "flagAliases": [],
+    "flagChars": ["i", "r"],
+    "flags": ["flags-dir", "job-id", "json", "use-most-recent"],
     "plugin": "@salesforce/plugin-data-seeding"
   }
 ]