feat: add 'source-id' and 'source-sandbox-name' flags

Author: soridalac

command-snapshot.json

@@ -159,6 +159,8 @@
       "no-auto-activate",
       "no-prompt",
       "poll-interval",
+      "source-id",
+      "source-sandbox-name",
       "target-org",
       "wait"
     ],

messages/refresh.sandbox.md

@@ -106,3 +106,33 @@ The poll interval (%d seconds) can't be larger than the wait period (%d in secon
 # sandboxInfoRefreshFailed
 
 The sandbox org refresh failed with a result of %s.
+
+# flags.source-sandbox-name.summary
+
+Name of the sandbox org to clone.
+
+# flags.source-sandbox-name.description
+
+The value of --source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
+
+You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
+
+# flags.source-id.summary
+
+ID of the sandbox org to clone.
+
+# flags.source-id.description
+
+The value of --source-id must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
+
+# error.bothIdFlagAndDefFilePropertyAreProvided
+
+You can't specify both the --source-id and --definition-file flags, and also include the "SourceId" option in the definition file. Pick one method of cloning a sandbox and try again.
+
+# error.bothNameFlagAndDefFilePropertyAreProvided
+
+You can't specify both the --source-sandbox-name and --definition-file flags, and also include the "SourceSandboxName" option in the definition file. Pick one method of cloning a sandbox and try again.
+
+# error.bothIdFlagAndNameDefFileAreNotAllowed
+
+You can't specify both the --source-sandbox-name and --definition-file flags, and also include the "SourceId" option in the definition file. Same with the --source-id flag and "SourceSandboxName" option. Pick one method of cloning a sandbox and try again.

src/commands/org/refresh/sandbox.ts

@@ -9,7 +9,7 @@ import { Duration, omit } from '@salesforce/kit';
 import { Flags } from '@salesforce/sf-plugins-core';
 import { Lifecycle, Messages, SandboxEvents, SandboxInfo, SfError } from '@salesforce/core';
 import { Interfaces } from '@oclif/core';
-import requestFunctions from '../../../shared/sandboxRequest.js';
+import requestFunctions, { readSandboxDefFile } from '../../../shared/sandboxRequest.js';
 import { SandboxCommandBase, SandboxCommandResponse } from '../../../shared/sandboxCommandBase.js';
 
 type SandboxInfoRecord = SandboxInfo & {
@@ -69,6 +69,18 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
       helpValue: '<seconds>',
       exclusive: ['async'],
     }),
+    'source-sandbox-name': Flags.string({
+      summary: messages.getMessage('flags.source-sandbox-name.summary'),
+      description: messages.getMessage('flags.source-sandbox-name.description'),
+      exclusive: ['source-id'],
+    }),
+    'source-id': Flags.salesforceId({
+      summary: messages.getMessage('flags.source-id.summary'),
+      description: messages.getMessage('flags.source-id.description'),
+      exclusive: ['source-sandbox-name'],
+      length: 'both',
+      char: undefined,
+    }),
     async: Flags.boolean({
       summary: messages.getMessage('flags.async.summary'),
       description: messages.getMessage('flags.async.description'),
@@ -242,6 +254,16 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
     sandboxInfo = Object.assign(sandboxInfo, defFileContent, {
       SandboxName: sbxName,
       AutoActivate: !this.flags['no-auto-activate'],
+      ...(this.flags['source-sandbox-name']
+        ? {
+            SourceId: await requestFunctions.getSrcIdByName(
+              this.flags['target-org'].getConnection(),
+              this.flags['source-sandbox-name']
+            ),
+          }
+        : this.flags['source-id']
+        ? { SourceId: this.flags['source-id'] }
+        : {}),
       ...(apexId ? { ApexClassId: apexId } : {}),
       ...(groupId ? { ActivationUserGroupId: groupId } : {}),
       ...(srcId ? { SourceId: srcId } : {}),
@@ -261,6 +283,22 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
         this.flags.wait.seconds,
       ]);
     }
+    if (!this.flags['definition-file']) {
+      return undefined;
+    }
+    const parsedDef = readSandboxDefFile(this.flags['definition-file']);
+    if (this.flags['source-id'] && parsedDef.SourceId) {
+      throw messages.createError('error.bothIdFlagAndDefFilePropertyAreProvided');
+    }
+    if (this.flags['source-sandbox-name'] && parsedDef.SourceSandboxName) {
+      throw messages.createError('error.bothNameFlagAndDefFilePropertyAreProvided');
+    }
+    if (this.flags['source-id'] && parsedDef.SourceSandboxName) {
+      throw messages.createError('error.bothIdFlagAndNameDefFileAreNotAllowed');
+    }
+    if (this.flags['source-sandbox-name'] && parsedDef.SourceId) {
+      throw messages.createError('error.bothIdFlagAndNameDefFileAreNotAllowed');
+    }
   }
 
   private initSandboxProcessData(sandboxInfo: SandboxInfo): void {