Merge pull request #681 from salesforcecli/sm/email-and-source-org

Sm/email-and-source-org

Author: WillieRuemmele

command-snapshot.json

@@ -73,6 +73,7 @@
     "command": "org:create:scratch",
     "plugin": "@salesforce/plugin-org",
     "flags": [
+      "admin-email",
       "alias",
       "api-version",
       "async",
@@ -87,6 +88,7 @@
       "no-namespace",
       "release",
       "set-default",
+      "source-org",
       "target-dev-hub",
       "track-source",
       "username",

messages/create_scratch.md

@@ -13,6 +13,8 @@ For either method, you can also use these flags; if you use them with --definiti
     * --username
     * --release
     * --edition
+    * --admin-email (equivalent to the "adminEmail" option)
+    * --source-org (equivalent to the "sourceOrg" option)
 
 If you want to set options other than the preceding ones, such as org features or settings, you must use a definition file.
 
@@ -84,6 +86,14 @@ The scratch org definition file is a blueprint for the scratch org. It mimics th
 
 Consumer key of the Dev Hub connected app.
 
+# flags.adminEmail.summary
+
+Email address that will be applied to the org's admin user. Overrides the value of the "adminEmail" option in the definition file, if set.
+
+# flags.sourceOrg.summary
+
+15-character ID of the org whose shape the new scratch org will be based on. Overrides the value of the "sourceOrg" option in the definition file, if set.
+
 # flags.wait.summary
 
 Number of minutes to wait for the scratch org to be ready.

src/commands/org/create/scratch.ts

@@ -5,11 +5,8 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import * as fs from 'fs';
-import { Duration } from '@salesforce/kit';
 import {
   Messages,
-  ScratchOrgCreateOptions,
   Lifecycle,
   ScratchOrgLifecycleEvent,
   scratchOrgLifecycleEventName,
@@ -18,6 +15,8 @@ import {
   SfError,
 } from '@salesforce/core';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Duration } from '@salesforce/kit';
+import { buildScratchOrgRequest } from '../../../shared/scratchOrgRequest';
 import { buildStatus } from '../../../shared/scratchOrgOutput';
 import { ScratchCreateResponse } from '../../../shared/orgTypes';
 Messages.importMessagesDirectory(__dirname);
@@ -85,7 +84,7 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
     }),
     'duration-days': Flags.duration({
       unit: 'days',
-      defaultValue: 7,
+      default: Duration.days(7),
       min: 1,
       max: 30,
       char: 'y',
@@ -94,7 +93,7 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
     }),
     wait: Flags.duration({
       unit: 'minutes',
-      defaultValue: 5,
+      default: Duration.minutes(5),
       min: 2,
       char: 'w',
       helpValue: '<minutes>',
@@ -128,40 +127,28 @@ export default class EnvCreateScratch extends SfCommand<ScratchCreateResponse> {
       description: messages.getMessage('flags.release.description'),
       options: ['preview', 'previous'],
     }),
+    'admin-email': Flags.string({
+      summary: messages.getMessage('flags.adminEmail.summary'),
+    }),
+    'source-org': Flags.salesforceId({
+      summary: messages.getMessage('flags.sourceOrg.summary'),
+      startsWith: '00D',
+      length: 15,
+    }),
   };
+
   public async run(): Promise<ScratchCreateResponse> {
     const lifecycle = Lifecycle.getInstance();
     const { flags } = await this.parse(EnvCreateScratch);
     const baseUrl = flags['target-dev-hub'].getField(Org.Fields.INSTANCE_URL)?.toString();
     if (!baseUrl) {
       throw new SfError('No instance URL found for the dev hub');
     }
-    const orgConfig = {
-      ...(flags['definition-file']
-        ? (JSON.parse(await fs.promises.readFile(flags['definition-file'], 'utf-8')) as Record<string, unknown>)
-        : {}),
-      ...(flags.edition ? { edition: flags.edition } : {}),
-      ...(flags.username ? { username: flags.username } : {}),
-      ...(flags.description ? { description: flags.description } : {}),
-      ...(flags.name ? { orgName: flags.name } : {}),
-      ...(flags.release ? { release: flags.release } : {}),
-    };
-
-    const createCommandOptions: ScratchOrgCreateOptions = {
-      hubOrg: flags['target-dev-hub'],
-      clientSecret: flags['client-id'] ? await this.clientSecretPrompt() : undefined,
-      connectedAppConsumerKey: flags['client-id'],
-      durationDays: (flags['duration-days'] as Duration).days,
-      nonamespace: flags['no-namespace'],
-      noancestors: flags['no-ancestors'],
-      wait: flags.async ? Duration.minutes(0) : flags.wait,
-      apiversion: flags['api-version'],
-      orgConfig,
-      alias: flags.alias,
-      setDefault: flags['set-default'],
-      tracksSource: flags['track-source'],
-    };
 
+    const createCommandOptions = await buildScratchOrgRequest(
+      flags,
+      flags['client-id'] ? await this.clientSecretPrompt() : undefined
+    );
     let lastStatus: string | undefined;
 
     if (!flags.async) {

src/shared/scratchOrgRequest.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import * as fs from 'fs';
+import { Interfaces } from '@oclif/core';
+import { ScratchOrgCreateOptions } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+import EnvCreateScratch from '../commands/org/create/scratch';
+/**
+ * Provide the parsed flags
+ * Returns the objet necessary to create a scratch org
+ */
+export const buildScratchOrgRequest = async (
+  flags: Interfaces.InferredFlags<typeof EnvCreateScratch.flags>,
+  clientSecret?: string
+): Promise<ScratchOrgCreateOptions> => {
+  const orgConfig = {
+    ...(flags['definition-file']
+      ? (JSON.parse(await fs.promises.readFile(flags['definition-file'], 'utf-8')) as Record<string, unknown>)
+      : {}),
+    ...(flags.edition ? { edition: flags.edition } : {}),
+    ...(flags.username ? { username: flags.username } : {}),
+    ...(flags.description ? { description: flags.description } : {}),
+    ...(flags.name ? { orgName: flags.name } : {}),
+    ...(flags.release ? { release: flags.release } : {}),
+    ...(flags['source-org'] ? { sourceOrg: flags['source-org'] } : {}),
+    ...(flags['admin-email'] ? { adminEmail: flags['admin-email'] } : {}),
+  };
+
+  const createCommandOptions: ScratchOrgCreateOptions = {
+    hubOrg: flags['target-dev-hub'],
+    clientSecret,
+    connectedAppConsumerKey: flags['client-id'],
+    durationDays: flags['duration-days'].days,
+    nonamespace: flags['no-namespace'],
+    noancestors: flags['no-ancestors'],
+    wait: flags.async ? Duration.minutes(0) : flags.wait,
+    apiversion: flags['api-version'],
+    orgConfig,
+    alias: flags.alias,
+    setDefault: flags['set-default'],
+    tracksSource: flags['track-source'],
+  };
+
+  return createCommandOptions;
+};

test/nut/scratchCreate.nut.ts

@@ -84,16 +84,17 @@ describe('env create scratch NUTs', () => {
       expect(resp).to.have.all.keys(keys);
       expect(resp?.orgId).to.match(/^00D.{15}/);
     });
-    it('creates an org from config file with "override" flags ', () => {
+    it('creates an org from config file with "override" flags and custom admin email', () => {
       const expectedUsername = genUniqueString('%[email protected]');
       const resp = execCmd<ScratchCreateResponse>(
-        `env:create:scratch -f config/project-scratch-def.json --json --username ${expectedUsername} --description "new one" --name TheOrg --wait 60`,
+        `env:create:scratch -f config/project-scratch-def.json --json --username ${expectedUsername} --description "new one" --name TheOrg --wait 60 --admin-email [email protected]`,
         {
           ensureExitCode: 0,
         }
       ).jsonOutput?.result;
       expect(resp).to.have.all.keys(keys);
       expect(resp?.username).to.equal(expectedUsername);
+      expect(resp?.scratchOrgInfo?.AdminEmail).to.equal('[email protected]');
     });
     it('creates an org with tracking disabled ', async () => {
       const resp = execCmd<ScratchCreateResponse>(

test/shared/scratch-def.json

@@ -0,0 +1,3 @@
+{
+  "adminEmail": "[email protected]"
+}

test/shared/scratchOrgRequest.test.ts

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { Config, Interfaces } from '@oclif/core';
+import { expect } from 'chai';
+import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
+import { buildScratchOrgRequest } from '../../src/shared/scratchOrgRequest';
+import EnvCreateScratch from '../../src/commands/org/create/scratch';
+
+class Wrapper extends EnvCreateScratch {
+  // simple method to return the parsed flags so they can be used in the tests
+  public async getFlags(): Promise<Interfaces.InferredFlags<typeof Wrapper.flags>> {
+    return (await this.parse(Wrapper)).flags;
+  }
+}
+
+/** pass in the params in array form, get back the parsed flags */
+const paramsToFlags = async (params: string[]): Promise<Interfaces.InferredFlags<typeof EnvCreateScratch.flags>> =>
+  new Wrapper(params, {} as Config).getFlags();
+
+describe('buildScratchOrgRequest function', () => {
+  const $$ = new TestContext();
+  beforeEach(async () => {
+    const hub = new MockTestOrgData();
+    hub.isDevHub = true;
+    await $$.stubAuths(hub);
+    await $$.stubConfig({ 'target-dev-hub': hub.username });
+  });
+
+  after(() => {
+    $$.SANDBOX.restore();
+  });
+
+  it('edition as only flag', async () => {
+    const flags = await paramsToFlags(['--edition', 'developer']);
+    const result = await buildScratchOrgRequest(flags);
+    expect(result.durationDays).to.equal(7);
+    expect(result.orgConfig).to.deep.equal({ edition: 'developer' });
+  });
+
+  describe('source-org', () => {
+    it('valid source-org as only flag', async () => {
+      const flags = await paramsToFlags(['--source-org', '00D123456789012']);
+      const result = await buildScratchOrgRequest(flags);
+      expect(result.durationDays).to.equal(7);
+      expect(result.orgConfig).to.deep.equal({ sourceOrg: '00D123456789012' });
+    });
+  });
+
+  describe('definition file', () => {
+    it('prop from definitionFile', async () => {
+      const flags = await paramsToFlags(['--definition-file', 'test/shared/scratch-def.json']);
+      const result = await buildScratchOrgRequest(flags);
+      expect(result.durationDays).to.equal(7);
+      expect(result.orgConfig?.adminEmail).to.deep.equal('[email protected]');
+    });
+    it('prop from definitionFile overridden by flag', async () => {
+      const overriddenEmail = '[email protected]';
+      const flags = await paramsToFlags([
+        '--definition-file',
+        'test/shared/scratch-def.json',
+        '--admin-email',
+        overriddenEmail,
+      ]);
+      const result = await buildScratchOrgRequest(flags);
+      expect(result.durationDays).to.equal(7);
+      expect(result.orgConfig?.adminEmail).to.deep.equal(overriddenEmail);
+    });
+  });
+
+  it('applies secret if given', async () => {
+    const secret = 'ImASecret';
+    const flags = await paramsToFlags(['--edition', 'developer']);
+    const result = await buildScratchOrgRequest(flags, secret);
+    expect(result.clientSecret).to.equal(secret);
+  });
+
+  it('async becomes 0 min', async () => {
+    const flags = await paramsToFlags(['--edition', 'developer', '--async']);
+    const result = await buildScratchOrgRequest(flags);
+    expect(result.wait?.minutes).to.equal(0);
+  });
+});