Merge pull request #1396 from salesforcecli/sl/W-18237102

fix: W-18237102 - refresh sandbox with sourceSandboxName

Author: WillieRuemmele

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

@@ -4,7 +4,7 @@ Refresh a sandbox org using the sandbox name.
 
 # description
 
-Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.
+Refreshing a sandbox copies the metadata, and optionally data, from your source org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID. You can also use the --source-id or --source-sandbox-name flags to change the refreshed sandbox org's original source org to a new org; in this case, the refreshed sandbox org's metadata is updated with the new source org's metadata.
 
 You're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the "org delete sandbox" command. And then recreate it with the "org create sandbox" command and give it a new name.
 
@@ -22,6 +22,10 @@ You're not allowed to change the sandbox name when you refresh it with this comm
 
   <%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg
 
+- Refresh the sandbox named "devSbx2" by changing its original source org to be a sandbox called "devSbx3":
+
+  <%= config.bin %> <%= command.id %> --name devSbx2 --source-sandbox-name devSbx3 --target-org prodOrg
+
 # flags.no-auto-activate.summary
 
 Disable auto-activation of the sandbox after a successful refresh.
@@ -106,3 +110,35 @@ 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 that becomes the new source org for the refreshed sandbox.
+
+# flags.source-sandbox-name.description
+
+The value of --source-sandbox-name must be an existing sandbox. The new source sandbox, and the refreshed 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 refreshing an existing sandbox, but not both.
+
+# flags.source-id.summary
+
+ID of the sandbox org that becomes the new source org for the refreshed sandbox.
+
+# flags.source-id.description
+
+The value of --source-id must be an existing sandbox. The new source sandbox, and the refreshed 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-id or --source-sandbox-name when refreshing an existing sandbox, but not both.
+
+# 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 refreshing 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 refreshing 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 refreshing 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,17 @@ 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',
+    }),
     async: Flags.boolean({
       summary: messages.getMessage('flags.async.summary'),
       description: messages.getMessage('flags.async.description'),
@@ -190,6 +201,7 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
 
     let apexId: string | undefined;
     let groupId: string | undefined;
+    let srcId: string | undefined;
 
     if (defFileContent.ApexClassName) {
       apexId = await requestFunctions.getApexClassIdByName(
@@ -206,6 +218,15 @@ export default class RefreshSandbox extends SandboxCommandBase<SandboxCommandRes
       );
       delete defFileContent.ActivationUserGroupName;
     }
+
+    if (defFileContent.SourceSandboxName) {
+      srcId = await requestFunctions.getSrcIdByName(
+        this.flags['target-org'].getConnection(),
+        defFileContent.SourceSandboxName
+      );
+      delete defFileContent.SourceSandboxName;
+    }
+
     // Warn if sandbox name is in `--name` and `--definition-file` flags and they differ.
     if (defFileContent?.SandboxName && sbxName && sbxName !== defFileContent?.SandboxName) {
       this.warn(messages.createWarning('warning.ConflictingSandboxNames', [sbxName, defFileContent?.SandboxName]));
@@ -232,8 +253,19 @@ 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 } : {}),
     });
 
     return sandboxInfo;
@@ -250,6 +282,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 {