Merge pull request #1069 from salesforcecli/wr/purgeOnDelete

fix: allow purge-on-delete with mdapi dirs
salesforcecli · Jun 27, 2024 · 98b8557 · 98b8557
2 parents 4e2b8bb + f4d1c63
commit 98b8557
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md
@@ -64,6 +64,14 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
 
       <%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests
 
+- Deploy all metadata formatted files in the "MDAPI" directory:
+
+      <%= config.bin %> <%= command.id %> --metadata-dir MDAPI
+
+- Deploy all metadata formatted files in the "MDAPI" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:
+
+      <%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete
+
 # flags.pre-destructive-changes.summary
 
 File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.

diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -134,8 +134,9 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     }),
     'purge-on-delete': Flags.boolean({
       summary: messages.getMessage('flags.purge-on-delete.summary'),
-      dependsOn: ['manifest'],
-      relationships: [{ type: 'some', flags: ['pre-destructive-changes', 'post-destructive-changes'] }],
+      relationships: [
+        { type: 'some', flags: ['pre-destructive-changes', 'manifest', 'metadata-dir', 'post-destructive-changes'] },
+      ],
       helpGroup: destructiveFlags,
     }),
     'pre-destructive-changes': Flags.file({

diff --git a/test/nuts/destructive/destructiveChanges.nut.ts b/test/nuts/destructive/destructiveChanges.nut.ts
@@ -6,8 +6,9 @@
  */
 
 import * as path from 'node:path';
-import { writeFileSync } from 'node:fs';
+import { copyFileSync, writeFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
 import { assert, expect } from 'chai';
 import { execCmd } from '@salesforce/cli-plugins-testkit';
 import { SourceTestkit } from '@salesforce/source-testkit';
@@ -230,6 +231,38 @@ describe('project deploy start --destructive NUTs', () => {
       expect(preDeleted).to.be.true;
       expect(postDeleted).to.be.true;
     });
+
+    it('should delete a class in metadata api format with --purge-on-delete', async () => {
+      const pre = createApexClass('pre').apexName;
+      const post = createApexClass('post').apexName;
+      let preDeleted = await isNameObsolete(testkit.username, 'ApexClass', pre);
+      let postDeleted = await isNameObsolete(testkit.username, 'ApexClass', post);
+
+      expect(preDeleted).to.be.false;
+      expect(postDeleted).to.be.false;
+      // convert file to deploy to MDAPI format
+      execCmd('project:convert:source --output-dir mdapi --metadata ApexClass:GeocodingService');
+
+      createManifest(`ApexClass:${post}`, 'post');
+      createManifest(`ApexClass:${pre}`, 'pre');
+      // move the destructive changes files into the mdapi dirt
+      copyFileSync(
+        join(testkit.projectDir, 'destructiveChangesPre.xml'),
+        join(testkit.projectDir, 'mdapi', 'destructiveChangesPre.xml')
+      );
+      copyFileSync(
+        join(testkit.projectDir, 'destructiveChangesPost.xml'),
+        join(testkit.projectDir, 'mdapi', 'destructiveChangesPost.xml')
+      );
+      execCmd('project:deploy:start --json --metadata-dir mdapi --purge-on-delete', {
+        ensureExitCode: 0,
+      });
+
+      preDeleted = await isNameObsolete(testkit.username, 'ApexClass', pre);
+      postDeleted = await isNameObsolete(testkit.username, 'ApexClass', post);
+      expect(preDeleted).to.be.true;
+      expect(postDeleted).to.be.true;
+    });
   });
 
   describe('errors', () => {