fix: Merge pull request #656 from salesforcecli/wr/failToValidateDeployError

fix: warn when code coverage doesn't meet requirement

Author: shetzel

messages/deploy.metadata.validate.md

@@ -126,4 +126,5 @@ Run "%s project deploy quick --job-id %s" to execute this deploy
 
 # error.FailedValidation
 
-Failed to validate the deployment (%s).
+Failed to validate the deployment (%s). Due To:
+%s

src/commands/project/deploy/validate.ts

@@ -4,10 +4,12 @@
  * 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 os from 'os';
 import { bold } from 'chalk';
 import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError } from '@salesforce/core';
-import { DeployVersionData, RequestStatus } from '@salesforce/source-deploy-retrieve';
+import { CodeCoverageWarnings, DeployVersionData, RequestStatus } from '@salesforce/source-deploy-retrieve';
 import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
+import { ensureArray } from '@salesforce/kit';
 import { AsyncDeployResultFormatter } from '../../../formatters/asyncDeployResultFormatter';
 import { DeployResultFormatter } from '../../../formatters/deployResultFormatter';
 import { DeployProgress } from '../../../utils/progressBar';
@@ -173,7 +175,20 @@ export default class DeployMetadataValidate extends SfCommand<DeployResultJson>
       this.logSuccess(messages.getMessage('info.SuccessfulValidation', [deploy.id]));
       this.log(messages.getMessage('info.suggestedQuickDeploy', [this.config.bin, deploy.id]));
     } else {
-      throw messages.createError('error.FailedValidation', [deploy.id]);
+      throw messages.createError('error.FailedValidation', [
+        deploy.id,
+        [
+          // I think the type might be wrong in SDR
+          ...ensureArray(result.response.details.runTestResult?.codeCoverageWarnings).map(
+            (warning: CodeCoverageWarnings & { name?: string }) =>
+              `${warning.name ? `${warning.name} - ` : ''}${warning.message}`
+          ),
+          result.response.errorMessage,
+          result.response.numberComponentErrors ? `${result.response.numberComponentErrors} component error(s)` : '',
+        ]
+          .join(os.EOL)
+          .trim(),
+      ]);
     }
 
     return formatter.getJson();

src/formatters/deployResultFormatter.ts

@@ -10,6 +10,7 @@ import * as fs from 'fs';
 import { ux } from '@oclif/core';
 import { dim, underline, bold } from 'chalk';
 import {
+  CodeCoverageWarnings,
   DeployResult,
   Failures,
   FileResponse,
@@ -309,14 +310,16 @@ export class DeployResultFormatter implements Formatter<DeployResultJson> {
 
     ux.log();
     ux.log(tableHeader('Test Results Summary'));
-    const passing = this.result.response.numberTestsCompleted ?? 0;
-    const failing = this.result.response.numberTestErrors ?? 0;
-    const total = this.result.response.numberTestsTotal ?? 0;
+    ux.log(`Passing: ${this.result.response.numberTestsCompleted ?? 0}`);
+    ux.log(`Failing: ${this.result.response.numberTestErrors ?? 0}`);
+    ux.log(`Total: ${this.result.response.numberTestsTotal ?? 0}`);
     const time = this.result.response.details.runTestResult?.totalTime ?? 0;
-    ux.log(`Passing: ${passing}`);
-    ux.log(`Failing: ${failing}`);
-    ux.log(`Total: ${total}`);
     if (time) ux.log(`Time: ${time}`);
+    // I think the type might be wrong in SDR
+    ensureArray(this.result.response.details.runTestResult?.codeCoverageWarnings).map(
+      (warning: CodeCoverageWarnings & { name?: string }) =>
+        ux.warn(`${warning.name ? `${warning.name} - ` : ''}${warning.message}`)
+    );
   }
 
   private displayVerboseTestSuccesses(): void {

test/utils/deployResponses.ts

@@ -78,6 +78,7 @@ export type DeployResponseType =
   | 'failedTest'
   | 'passedTest'
   | 'passedAndFailedTest'
+  | 'codeCoverageWarning'
   | 'partialSuccessSync';
 
 export const getDeployResponse = (
@@ -199,6 +200,52 @@ export const getDeployResponse = (
     response.runTestsEnabled = true;
     response.numberTestErrors = 0;
   }
+  if (type === 'codeCoverageWarning') {
+    response.status = RequestStatus.Failed;
+    response.success = false;
+    response.details.componentFailures = cloneJson(baseDeployResponse.details.componentSuccesses[1]) as DeployMessage;
+    response.details.componentSuccesses = cloneJson(baseDeployResponse.details.componentSuccesses[0]) as DeployMessage;
+    response.details.componentFailures.success = 'false';
+    delete response.details.componentFailures.id;
+    if (response.details.runTestResult) {
+      response.details.runTestResult.successes = [
+        {
+          name: 'ChangePasswordController',
+          methodName: 'testMethod',
+          id: 'testId',
+          time: 'testTime',
+        },
+      ];
+      response.details.runTestResult.failures = [];
+      response.details.runTestResult.codeCoverageWarnings = [
+        {
+          id: response.id,
+          namespace: '',
+          message:
+            'Average test coverage across all Apex Classes and Triggers is 25%, at least 75% test coverage is required.',
+        },
+      ];
+      response.details.runTestResult.codeCoverage = [
+        {
+          id: 'ChangePasswordController',
+          type: 'ApexClass',
+          name: 'ChangePasswordController',
+          numLocations: '1',
+          locationsNotCovered: {
+            column: '54',
+            line: '2',
+            numExecutions: '1',
+            time: '2',
+          },
+          numLocationsNotCovered: '5',
+        },
+      ];
+      response.details.runTestResult.numFailures = '0';
+      response.numberTestsTotal = 1;
+    }
+    response.runTestsEnabled = true;
+    response.numberTestErrors = 0;
+  }
   if (type === 'passedAndFailedTest') {
     response.status = RequestStatus.Failed;
     response.success = false;

test/utils/output.test.ts

@@ -58,6 +58,17 @@ describe('deployResultFormatter', () => {
         });
       });
 
+      it('will warn when code coverage warning present from server', () => {
+        const deployResult = getDeployResult('codeCoverageWarning');
+        const formatter = new DeployResultFormatter(deployResult, {});
+        const warnStub = sandbox.stub(ux, 'warn');
+        formatter.display();
+        expect(warnStub.callCount).to.equal(1);
+        expect(warnStub.firstCall.args[0]).to.equal(
+          'Average test coverage across all Apex Classes and Triggers is 25%, at least 75% test coverage is required.'
+        );
+      });
+
       it('will write test output when in json mode', async () => {
         const deployResult = getDeployResult('passedTest');
         const formatter = new DeployResultFormatter(deployResult, {