fix: emit warning when PPDS=true

Author: WillieRuemmele

messages/deploy.metadata.md

@@ -238,3 +238,7 @@ output directory for code coverage and JUnit results; defaults to the deploy ID
 # asyncCoverageJunitWarning
 
 You requested an async deploy with code coverage or JUnit results. The reports will be available when the deploy completes.
+
+# pushPackageDirsWarning
+
+The `pushPackageDirectoriesSequentially` property is no longer respected by this command. Please specify directories by using the `--source-dir | -d` flag in their deployment order.

src/commands/project/deploy/start.ts

@@ -173,6 +173,17 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
 
   public async run(): Promise<DeployResultJson> {
     const { flags } = await this.parse(DeployMetadata);
+    if (
+      this.project.getSfProjectJson().getContents()['pushPackageDirectoriesSequentially'] &&
+      // flag exclusivity is handled correctly above - but to avoid short-circuiting the check, we need to check all of them
+      !flags.manifest &&
+      !flags.metadata &&
+      !flags['source-dir']
+    ) {
+      // if pushPackageDirectoriesSequentially = true, and they're not using any of the flags that would modify their deploy
+      // e.g. they're recreating a `source:push` command, which is the only one that respects this config value, warn them about it not working like it used to
+      this.warn(messages.getMessage('pushPackageDirsWarning'));
+    }
     if (!validateTests(flags['test-level'], flags.tests)) {
       throw messages.createError('error.NoTestsSpecified');
     }

test/commands/deploy/start.test.ts

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2020, 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 { expect } from 'chai';
+import { MockTestOrgData, TestContext } from '@salesforce/core/lib/testSetup';
+import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
+import DeployMetadata from '../../../src/commands/project/deploy/start';
+
+describe('project deploy start', () => {
+  const $$ = new TestContext();
+  const testOrg = new MockTestOrgData();
+  testOrg.isScratchOrg = true;
+  let warnStub: sinon.SinonStub;
+
+  beforeEach(async () => {
+    await $$.stubAuths(testOrg);
+    await $$.stubConfig({ 'target-org': testOrg.username });
+    warnStub = stubSfCommandUx($$.SANDBOX).warn;
+  });
+
+  afterEach(() => {
+    $$.restore();
+  });
+
+  it('should emit warning when PPDS=true', async () => {
+    $$.setConfigStubContents('SfProjectJson', {
+      contents: {
+        packageDirectories: [{ path: 'force-app', default: true }],
+        pushPackageDirectoriesSequentially: true,
+      },
+    });
+    try {
+      await DeployMetadata.run([]);
+    } catch (e) {
+      expect(warnStub.firstCall.args[0]).to.contain('pushPackageDirectoriesSequentially');
+      expect(warnStub.called).to.be.true;
+      // do nothing, only need to assert that it warns correctly, avoid too much UT setup
+    }
+  });
+
+  it('should not emit warning when PPDS=true and flags', async () => {
+    $$.setConfigStubContents('SfProjectJson', {
+      contents: {
+        packageDirectories: [{ path: 'force-app', default: true }],
+        pushPackageDirectoriesSequentially: true,
+      },
+    });
+    try {
+      await DeployMetadata.run(['--source-dir', 'test']);
+    } catch (e) {
+      expect(warnStub.called).to.be.false;
+      // do nothing, only need to assert that it warns correctly, avoid too much UT setup
+    }
+  });
+
+  it('should not emit warning when PPDS=false and a flag', async () => {
+    $$.setConfigStubContents('SfProjectJson', {
+      contents: {
+        packageDirectories: [{ path: 'force-app', default: true }],
+        pushPackageDirectoriesSequentially: false,
+      },
+    });
+    try {
+      await DeployMetadata.run(['--source-dir', 'test']);
+    } catch (e) {
+      expect(warnStub.called).to.be.false;
+      // do nothing, only need to assert that it warns correctly, avoid too much UT setup
+    }
+  });
+});