fix: restore json result to original for code coverga

@W-12965378@ Fix regression in package version report code coverage result in json
salesforcecli · Apr 4, 2023 · cd4a6fa · cd4a6fa
1 parent 057a17b
commit cd4a6fa
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 11 deletions.
diff --git a/.mocharc.json b/.mocharc.json
@@ -3,5 +3,5 @@
   "watch-extensions": "ts",
   "recursive": true,
   "reporter": "spec",
-  "timeout": 5000
+  "timeout": 10000
 }
diff --git a/schemas/package-version-report.json b/schemas/package-version-report.json
@@ -7,7 +7,14 @@
       "additionalProperties": false,
       "properties": {
         "CodeCoverage": {
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CodeCoverage"
+            },
+            {
+              "type": "string"
+            }
+          ]
         },
         "HasPassedCodeCoverageCheck": {
           "type": ["boolean", "string"]
@@ -170,7 +177,24 @@
           "type": "string"
         }
       },
-      "required": ["CodeCoverage", "HasMetadataRemoved", "Package2", "Version"]
+      "required": ["HasMetadataRemoved", "Package2", "Version"]
+    },
+    "CodeCoverage": {
+      "anyOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "apexCodeCoveragePercentage": {
+              "type": "number"
+            }
+          },
+          "required": ["apexCodeCoveragePercentage"],
+          "additionalProperties": false
+        }
+      ]
     },
     "PackageType": {
       "type": "string",

diff --git a/src/commands/package/version/report.ts b/src/commands/package/version/report.ts
@@ -7,7 +7,7 @@
 
 import { Flags, loglevel, orgApiVersionFlagWithDeprecations, SfCommand } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
-import { PackageVersion, PackageVersionReportResult, PackagingSObjects } from '@salesforce/packaging';
+import { CodeCoverage, PackageVersion, PackageVersionReportResult, PackagingSObjects } from '@salesforce/packaging';
 import * as chalk from 'chalk';
 import { Optional } from '@salesforce/ts-types';
 import { requiredHubFlag } from '../../../utils/hubFlag';
@@ -20,7 +20,7 @@ export type PackageVersionReportResultModified = Omit<
   PackageVersionReportResult,
   'CodeCoverage' | 'HasPassedCodeCoverageCheck' | 'Package2' | 'HasMetadataRemoved' | 'PackageType'
 > & {
-  CodeCoverage: string;
+  CodeCoverage: CodeCoverage | string | undefined;
   HasPassedCodeCoverageCheck: boolean | undefined | string;
   Package2: Partial<Omit<PackagingSObjects.Package2, 'IsOrgDependent'> & { IsOrgDependent: string }>;
   HasMetadataRemoved: boolean | string;
@@ -114,7 +114,12 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
       { key: messages.getMessage('ancestorVersion'), value: record.AncestorVersion },
       {
         key: pvlMessages.getMessage('codeCoverage'),
-        value: record.CodeCoverage,
+        value:
+          typeof record.CodeCoverage === 'string'
+            ? record.CodeCoverage
+            : !record.CodeCoverage
+            ? 'N/A'
+            : `${record.CodeCoverage.apexCodeCoveragePercentage.toFixed(2)}%`,
       },
       {
         key: pvlMessages.getMessage('hasPassedCodeCoverageCheck'),
@@ -208,9 +213,7 @@ export class PackageVersionReportCommand extends SfCommand<PackageVersionReportR
     if (results.Package2.IsOrgDependent === true || results.ValidationSkipped === true) {
       record.CodeCoverage = 'N/A';
     } else {
-      record.CodeCoverage = results.CodeCoverage?.apexCodeCoveragePercentage
-        ? `${results.CodeCoverage?.apexCodeCoveragePercentage}%`
-        : 'N/A';
+      record.CodeCoverage = results.CodeCoverage;
     }
 
     record.HasPassedCodeCoverageCheck =

diff --git a/test/commands/package/versionReport.test.ts b/test/commands/package/versionReport.test.ts
@@ -23,7 +23,7 @@ const pkgVersionReportResultModified: PackageVersionReportResultModified = {
   Branch: '',
   BuildDurationInSeconds: 10,
   BuildNumber: 0,
-  CodeCoverage: 'N/A',
+  CodeCoverage: null,
   CodeCoveragePercentages: {
     codeCovPercentages: [
       {
@@ -187,7 +187,7 @@ describe('package:version:report - tests', () => {
       pvrrm.AncestorId = 'N/A';
       pvrrm.AncestorId = 'N/A';
       pvrrm.Package2.IsOrgDependent = 'N/A';
-      pvrrm.CodeCoverage = '33%';
+      pvrrm.CodeCoverage = { apexCodeCoveragePercentage: 33 };
       pvrrm.HasMetadataRemoved = 'Yes';
       pvrrm.HasPassedCodeCoverageCheck = 'N/A';
       delete pvrrm['PackageType'];