feat: add test result formatter flags, outputdir flags, junit flag

WillieRuemmele · WillieRuemmele · commit 0018dd60ab92 · 2023-03-10T13:33:20.000-07:00
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -74,13 +74,23 @@
   {
     "command": "project:deploy:report",
     "plugin": "@salesforce/plugin-deploy-retrieve",
-    "flags": ["job-id", "json", "use-most-recent"],
+    "flags": ["coverage-formatters", "job-id", "json", "junit", "results-dir", "use-most-recent"],
     "alias": ["deploy:metadata:report"]
   },
   {
     "command": "project:deploy:resume",
     "plugin": "@salesforce/plugin-deploy-retrieve",
-    "flags": ["concise", "job-id", "json", "use-most-recent", "verbose", "wait"],
+    "flags": [
+      "concise",
+      "coverage-formatters",
+      "job-id",
+      "json",
+      "junit",
+      "results-dir",
+      "use-most-recent",
+      "verbose",
+      "wait"
+    ],
     "alias": ["deploy:metadata:resume"]
   },
   {
@@ -90,14 +100,17 @@
       "api-version",
       "async",
       "concise",
+      "coverage-formatters",
       "dry-run",
       "ignore-conflicts",
       "ignore-errors",
       "ignore-warnings",
       "json",
+      "junit",
       "manifest",
       "metadata",
       "metadata-dir",
+      "results-dir",
       "single-package",
       "source-dir",
       "target-org",
diff --git a/messages/deploy.metadata.md b/messages/deploy.metadata.md
@@ -210,3 +210,19 @@ No local changes to deploy.
 # error.nothingToDeploy.Actions
 
 - To see conflicts and ignored files, run "sf project deploy preview" with any of the manifest, directory, or metadata flags.
+
+# flags.junit
+
+output JUnit test results
+
+# flags.coverage-formatters
+
+format of the code coverage results
+
+# flags.results-dir
+
+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.
diff --git a/messages/deploy.metadata.report.md b/messages/deploy.metadata.report.md
@@ -40,3 +40,15 @@ Use the job ID of the most recent deploy operation.
 # flags.use-most-recent.description
 
 For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.
+
+# flags.junit
+
+output JUnit test results
+
+# flags.coverage-formatters
+
+format of the code coverage results
+
+# flags.results-dir
+
+output directory for code coverage and JUnit results; defaults to the deploy ID
diff --git a/messages/deploy.metadata.resume.md b/messages/deploy.metadata.resume.md
@@ -60,3 +60,15 @@ Show concise output of the deploy operation result.
 # error.DeployNotResumable
 
 Job ID %s is not resumable with status %s.
+
+# flags.junit
+
+output JUnit test results
+
+# flags.coverage-formatters
+
+format of the code coverage results
+
+# flags.results-dir
+
+output directory for code coverage and JUnit results; defaults to the deploy ID
diff --git a/src/commands/project/deploy/report.ts b/src/commands/project/deploy/report.ts
@@ -13,6 +13,7 @@ import { buildComponentSet } from '../../../utils/deploy';
 import { DeployCache } from '../../../utils/deployCache';
 import { DeployReportResultFormatter } from '../../../utils/output';
 import { DeployResultJson } from '../../../utils/types';
+import { reportsFormatters } from './start';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata.report');
@@ -40,6 +41,17 @@ export default class DeployMetadataReport extends SfCommand<DeployResultJson> {
       summary: messages.getMessage('flags.use-most-recent.summary'),
       exactlyOne: ['use-most-recent', 'job-id'],
     }),
+    'coverage-formatters': Flags.string({
+      multiple: true,
+      summary: messages.getMessage('flags.coverage-formatters'),
+      options: reportsFormatters,
+      helpValue: reportsFormatters.join(','),
+    }),
+    junit: Flags.boolean({ summary: messages.getMessage('flags.junit') }),
+    'results-dir': Flags.directory({
+      dependsOn: ['junit', 'coverage-formatters'],
+      summary: messages.getMessage('flags.results-dir'),
+    }),
   };
 
   public async run(): Promise<DeployResultJson> {
@@ -53,7 +65,10 @@ export default class DeployMetadataReport extends SfCommand<DeployResultJson> {
     const componentSet = await buildComponentSet({ ...deployOpts, wait: Duration.minutes(deployOpts.wait) });
     const result = new DeployResult(deployStatus as unknown as MetadataApiDeployStatus, componentSet);
 
-    const formatter = new DeployReportResultFormatter(result, deployOpts);
+    const formatter = new DeployReportResultFormatter(result, {
+      ...deployOpts,
+      ...{ 'target-org': flags['target-org'] as Org },
+    });
 
     if (!this.jsonEnabled()) formatter.display();
 
diff --git a/src/commands/project/deploy/resume.ts b/src/commands/project/deploy/resume.ts
@@ -15,6 +15,7 @@ import { DeployResultJson } from '../../../utils/types';
 import { determineExitCode, executeDeploy, isNotResumable } from '../../../utils/deploy';
 import { DeployCache } from '../../../utils/deployCache';
 import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes';
+import { reportsFormatters } from './start';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata.resume');
@@ -60,6 +61,17 @@ export default class DeployMetadataResume extends SfCommand<DeployResultJson> {
       helpValue: '<minutes>',
       min: 1,
     }),
+    'coverage-formatters': Flags.string({
+      multiple: true,
+      summary: messages.getMessage('flags.coverage-formatters'),
+      options: reportsFormatters,
+      helpValue: reportsFormatters.join(','),
+    }),
+    junit: Flags.boolean({ summary: messages.getMessage('flags.junit') }),
+    'results-dir': Flags.directory({
+      dependsOn: ['junit', 'coverage-formatters'],
+      summary: messages.getMessage('flags.results-dir'),
+    }),
   };
 
   public static envVariablesSection = toHelpSection('ENVIRONMENT VARIABLES', EnvironmentVariable.SF_USE_PROGRESS_BAR);
diff --git a/src/commands/project/deploy/start.ts b/src/commands/project/deploy/start.ts
@@ -8,6 +8,7 @@ import { bold } from 'chalk';
 import { EnvironmentVariable, Messages, OrgConfigProperties, SfError } from '@salesforce/core';
 import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
 import { SourceConflictError } from '@salesforce/source-tracking';
+import { DefaultReportOptions } from '@salesforce/apex-node';
 import { AsyncDeployResultFormatter, DeployResultFormatter, getVersionMessage } from '../../../utils/output';
 import { DeployProgress } from '../../../utils/progressBar';
 import { DeployResultJson, TestLevel } from '../../../utils/types';
@@ -20,6 +21,7 @@ import { writeConflictTable } from '../../../utils/conflicts';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata');
+export const reportsFormatters = Object.keys(DefaultReportOptions);
 
 const exclusiveFlags = ['manifest', 'source-dir', 'metadata', 'metadata-dir'];
 
@@ -129,6 +131,17 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
       min: 1,
       exclusive: ['async'],
     }),
+    'coverage-formatters': Flags.string({
+      multiple: true,
+      summary: messages.getMessage('flags.coverage-formatters'),
+      options: reportsFormatters,
+      helpValue: reportsFormatters.join(','),
+    }),
+    junit: Flags.boolean({ summary: messages.getMessage('flags.junit') }),
+    'results-dir': Flags.directory({
+      dependsOn: ['junit', 'coverage-formatters'],
+      summary: messages.getMessage('flags.results-dir'),
+    }),
   };
 
   public static configurationVariablesSection = toHelpSection(
@@ -167,6 +180,9 @@ export default class DeployMetadata extends SfCommand<DeployResultJson> {
     this.log(`Deploy ID: ${bold(deploy.id)}`);
 
     if (flags.async) {
+      if (flags['coverage-formatters']) {
+        this.warn(messages.getMessage('asyncCoverageJunitWarning'));
+      }
       const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
       if (!this.jsonEnabled()) asyncFormatter.display();
       return asyncFormatter.getJson();
diff --git a/src/utils/deploy.ts b/src/utils/deploy.ts
@@ -63,8 +63,7 @@ export type CachedOptions = Omit<DeployOptions, 'wait' | 'metadata' | 'source-di
 } & Partial<Pick<DeployOptions, 'manifest'>>;
 
 export function validateTests(testLevel: TestLevel, tests: Nullable<string[]>): boolean {
-  if (testLevel === TestLevel.RunSpecifiedTests && (tests ?? []).length === 0) return false;
-  return true;
+  return !(testLevel === TestLevel.RunSpecifiedTests && (tests ?? []).length === 0);
 }
 
 export async function resolveApi(): Promise<API> {
diff --git a/src/utils/metadataDeployer.ts b/src/utils/metadataDeployer.ts
@@ -17,6 +17,7 @@ import {
   NamedPackageDir,
   OrgAuthorization,
   OrgConfigProperties,
+  Org,
 } from '@salesforce/core';
 import { Deployable, Deployer, DeployerResult, generateTableChoices } from '@salesforce/sf-plugins-core';
 
@@ -141,6 +142,7 @@ export class MetadataDeployer extends Deployer {
       'test-level': this.testLevel,
       verbose: false,
       concise: false,
+      'target-org': await Org.create({ aliasOrUsername: this.username }),
     });
     formatter.display();
     const deployerResult: DeployerResult = {
diff --git a/src/utils/output.ts b/src/utils/output.ts
diff --git a/test/commands/delete/source.test.ts b/test/commands/delete/source.test.ts
diff --git a/test/nuts/seeds/deploy.metadata.test-level.seed.ts b/test/nuts/seeds/deploy.metadata.test-level.seed.ts
diff --git a/test/utils/output.test.ts b/test/utils/output.test.ts

Original file line number	Diff line number	Diff line change
`@@ -63,8 +63,7 @@ export type CachedOptions = Omit<DeployOptions, 'wait' \| 'metadata' \| 'source-di`
`63`	`63`	`} & Partial<Pick<DeployOptions, 'manifest'>>;`
`64`	`64`
`65`	`65`	`export function validateTests(testLevel: TestLevel, tests: Nullable<string[]>): boolean {`
`66`		`- if (testLevel === TestLevel.RunSpecifiedTests && (tests ?? []).length === 0) return false;`
`67`		`- return true;`
	`66`	`+ return !(testLevel === TestLevel.RunSpecifiedTests && (tests ?? []).length === 0);`
`68`	`67`	`}`
`69`	`68`
`70`	`69`	`export async function resolveApi(): Promise<API> {`