feat: add support for cobertura format

mcarvin8 · Dec 16, 2024 · 094d0ee · 094d0ee
1 parent 3f747af
commit 094d0ee
Show file tree

Hide file tree

Showing 9 changed files with 348 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@
 - [License](#license)
 </details>
 
-A Salesforce CLI plugin to transform the Apex code coverage JSON files created during deployments and test runs into the generic test coverage format (XML) accepted by SonarQube.
+A Salesforce CLI plugin to transform the Apex code coverage JSON files created during deployments and test runs into SonarQube format or Cobertura format.
 
 ## Install
 
@@ -28,14 +28,16 @@ sf plugins install [email protected]
 
 ## Who is the Plugin For?
 
-This plugin is intended for users who deploy their Apex codebase (Apex classes and triggers) from any Salesforce DX repository (`sfdx-project.json` file), not just git-based ones. You should be running this plugin somewhere inside your Salesforce DX repository (root folder preferred). This plugin searches for your repository's `sfdx-project.json` file to know which package directories to search into. Since SonarQube relies on file-paths to map code coverage to the files in their explorer interface, the Apex files must be found in one of your package directories. 
+This plugin is intended for users who deploy their Apex codebase (Apex classes and triggers) from any Salesforce DX repository (`sfdx-project.json` file), not just git-based ones. You should be running this plugin somewhere inside your Salesforce DX repository (root folder preferred). This plugin searches for your repository's `sfdx-project.json` file to know which package directories to search into. The Apex files must be found in one of your package directories.
 
-This plugin will work if you run local tests or run all tests in an org, including tests that originate from installed managed and unlocked packages. Since files from managed and unlocked packages aren't retrieved into Salesforce DX repositories, these files cannot be included in your SonarQube scans. 
+This plugin will work if you run local tests or run all tests in an org, including tests that originate from installed managed and unlocked packages. Since files from managed and unlocked packages aren't retrieved into Salesforce DX repositories, these files cannot be included in your code coverage reports.
 
-When the plugin is unable to find the Apex file from the coverage report in your repository, it will print a warning and not add that file's coverage data to the coverage XML created by this plugin. A warning will be printed for each file not found in a package directory in your repository. See [Errors and Warnings](https://github.com/mcarvin8/apex-code-coverage-transformer?tab=readme-ov-file#errors-and-warnings) for more information.
+When the plugin is unable to find the Apex file from the Salesforce CLI coverage report in your repository, it will print a warning and not add that file's coverage data to the coverage XML created by this plugin. A warning will be printed for each file not found in a package directory in your repository. See [Errors and Warnings](https://github.com/mcarvin8/apex-code-coverage-transformer?tab=readme-ov-file#errors-and-warnings) for more information.
 
 ## Creating Code Coverage Files with the Salesforce CLI
 
+**This tool will only support the JSON coverage format from the Salesforce CLI. Do not use "json-summary" or Salesforce's cobertura output.**
+
 To create the code coverage JSON during a Salesforce CLI deployment/validation, append `--coverage-formatters json --results-dir "coverage"` to the `sf project deploy` command. This will create a coverage JSON in this relative path - `coverage/coverage/coverage.json`.
 
 ```
@@ -49,7 +51,7 @@ sf apex run test --code-coverage --result-format json --output-dir "coverage"
 sf apex get test --test-run-id <test run id> --code-coverage --result-format json --output-dir "coverage"
 ```
 
-The code coverage JSONs created by the Salesforce CLI aren't accepted by SonarQube automatically for Salesforce DX repositories and needs to be converted using this plugin.
+The code coverage JSONs created by the Salesforce CLI aren't accepted automatically for Salesforce DX repositories and needs to be converted using this plugin.
 
 **Disclaimer**: Due to existing bugs with how the Salesforce CLI reports covered lines during deployments (see [5511](https://github.com/forcedotcom/salesforcedx-vscode/issues/5511) and [1568](https://github.com/forcedotcom/cli/issues/1568)), to add support for covered lines in this plugin for deployment coverage files, I had to add a function to re-number out-of-range covered lines the CLI may report (ex: line 100 in a 98-line Apex Class is reported back as covered by the Salesforce CLI deploy command). Salesforce's coverage result may also include extra lines as covered (ex: 120 lines are included in the coverage report for a 100 line file), so the coverage percentage may vary based on how many lines the API returns in the coverage report. Once Salesforce fixes the API to correctly return covered lines in the deploy command, this function will be removed.
 
@@ -63,20 +65,22 @@ The `apex-code-coverage-transformer` has 1 command:
 
 ```
 USAGE
-  $ sf acc-transformer transform -j <value> -x <value> [--json]
+  $ sf acc-transformer transform -j <value> -x <value> -f <value> [--json]
 
 FLAGS
   -j, --coverage-json=<value> Path to the code coverage JSON file created by the Salesforce CLI deployment or test command.
-  -x, --xml=<value> [default: "coverage.xml"] Path to code coverage XML file that will be created by this plugin.
+  -x, --xml=<value>           [default: "coverage.xml"] Path to code coverage XML file that will be created by this plugin.
+  -f, --format=<value>        [default: "sonar"] Output format for the code coverage format.
+                                                 Valid options are "sonar" or "cobertura".
 
 GLOBAL FLAGS
   --json  Format output as json.
 
 DESCRIPTION
-  This plugin will convert the code coverage JSON file created by the Salesforce CLI during Apex deployments and test runs into an XML accepted by tools like SonarQube.
+  This plugin will convert the code coverage JSON file created by the Salesforce CLI during Apex deployments and test runs into SonarQube or Cobertura format.
 
 EXAMPLES
-    $ sf acc-transformer transform -j "coverage.json" -x "coverage.xml"
+    $ sf acc-transformer transform -j "coverage.json" -x "coverage.xml" -f "sonar"
 ```
 
 ## Hook
@@ -93,13 +97,15 @@ The `.apexcodecovtransformer.config.json` should look like this:
 {
   "deployCoverageJsonPath": "coverage/coverage/coverage.json",
   "testCoverageJsonPath": "coverage/test-coverage.json",
-  "coverageXmlPath": "coverage.xml"
+  "coverageXmlPath": "coverage.xml",
+  "format": "sonar"
 }
 ```
 
 - `deployCoverageJsonPath` is required to use the hook after deployments and should be the path to the code coverage JSON created by the Salesforce CLI deployment command. Recommend using a relative path.
 - `testCoverageJsonPath` is required to use the hook after test runs and should be the path to the code coverage JSON created by the Salesforce CLI test command. Recommend using a relative path.
 - `coverageXmlPath` is optional and should be the path to the code coverage XML created by this plugin. Recommend using a relative path. If this isn't provided, it will default to `coverage.xml` in the working directory.
+- `format` is optional and should be the intended output format for the code coverage XML created by this plugin. Options are "sonar" or "cobertura". If this isn't provided, it will default to "sonar".
 
 If the `.apexcodecovtransformer.config.json` file isn't found, the hook will be skipped.
 

diff --git a/messages/transformer.transform.md b/messages/transformer.transform.md
@@ -17,3 +17,7 @@ Path to the code coverage JSON file created by the Salesforce CLI deployment or
 # flags.xml.summary
 
 Path to code coverage XML file that will be created by this plugin.
+
+# flags.format.summary
+
+Output format for the coverage report.
diff --git a/src/commands/acc-transformer/transform.ts b/src/commands/acc-transformer/transform.ts
@@ -32,12 +32,21 @@ export default class TransformerTransform extends SfCommand<TransformerTransform
       exists: false,
       default: 'coverage.xml',
     }),
+    format: Flags.string({
+      summary: messages.getMessage('flags.format.summary'),
+      char: 'f',
+      required: true,
+      multiple: false,
+      default: 'sonar',
+      options: ['sonar', 'cobertura'],
+    }),
   };
 
   public async run(): Promise<TransformerTransformResult> {
     const { flags } = await this.parse(TransformerTransform);
     const jsonFilePath = resolve(flags['coverage-json']);
     const xmlFilePath = resolve(flags['xml']);
+    const format = flags['format'];
     const jsonData = await readFile(jsonFilePath, 'utf-8');
 
     let xmlData: string;
@@ -48,12 +57,12 @@ export default class TransformerTransform extends SfCommand<TransformerTransform
 
     // Determine the type of coverage data using type guards
     if (commandType === 'TestCoverageData') {
-      const result = await transformTestCoverageReport(parsedData as TestCoverageData[]);
+      const result = await transformTestCoverageReport(parsedData as TestCoverageData[], format);
       xmlData = result.xml;
       warnings = result.warnings;
       filesProcessed = result.filesProcessed;
     } else if (commandType === 'DeployCoverageData') {
-      const result = await transformDeployCoverageReport(parsedData as DeployCoverageData);
+      const result = await transformDeployCoverageReport(parsedData as DeployCoverageData, format);
       xmlData = result.xml;
       warnings = result.warnings;
       filesProcessed = result.filesProcessed;

diff --git a/src/helpers/setCoveredLinesCobertura.ts b/src/helpers/setCoveredLinesCobertura.ts
@@ -0,0 +1,45 @@
+'use strict';
+
+import { join } from 'node:path';
+
+import { getTotalLines } from './getTotalLines.js';
+import { CoberturaClass, CoberturaLine } from './types.js';
+
+export async function setCoveredLinesCobertura(
+  coveredLines: number[],
+  uncoveredLines: number[],
+  repoRoot: string,
+  filePath: string,
+  classObj: CoberturaClass
+): Promise<void> {
+  const randomLines: number[] = [];
+  const totalLines = await getTotalLines(join(repoRoot, filePath));
+
+  for (const coveredLine of coveredLines) {
+    if (coveredLine > totalLines) {
+      for (let randomLineNumber = 1; randomLineNumber <= totalLines; randomLineNumber++) {
+        if (
+          !uncoveredLines.includes(randomLineNumber) &&
+          !coveredLines.includes(randomLineNumber) &&
+          !randomLines.includes(randomLineNumber)
+        ) {
+          const randomLine: CoberturaLine = {
+            '@number': randomLineNumber,
+            '@hits': 1,
+            '@branch': 'false',
+          };
+          classObj.lines.line.push(randomLine);
+          randomLines.push(randomLineNumber);
+          break;
+        }
+      }
+    } else {
+      const coveredLineObj: CoberturaLine = {
+        '@number': coveredLine,
+        '@hits': 1,
+        '@branch': 'false',
+      };
+      classObj.lines.line.push(coveredLineObj);
+    }
+  }
+}
diff --git a/src/helpers/setCoveredLines.ts → src/helpers/setCoveredLinesSonar.ts b/src/helpers/setCoveredLines.ts → src/helpers/setCoveredLinesSonar.ts
@@ -5,7 +5,7 @@ import { join } from 'node:path';
 import { getTotalLines } from './getTotalLines.js';
 import { FileObject } from './types.js';
 
-export async function setCoveredLines(
+export async function setCoveredLinesSonar(
   coveredLines: number[],
   uncoveredLines: number[],
   repoRoot: string,

diff --git a/src/helpers/transformDeployCoverageReport.ts b/src/helpers/transformDeployCoverageReport.ts
@@ -2,50 +2,127 @@
 /* eslint-disable no-await-in-loop */
 
 import { create } from 'xmlbuilder2';
-
-import { DeployCoverageData, CoverageObject, FileObject } from './types.js';
+import { DeployCoverageData, CoverageObject, CoberturaCoverageObject, FileObject, CoberturaClass } from './types.js';
 import { getPackageDirectories } from './getPackageDirectories.js';
 import { findFilePath } from './findFilePath.js';
-import { setCoveredLines } from './setCoveredLines.js';
+import { setCoveredLinesSonar } from './setCoveredLinesSonar.js';
+import { setCoveredLinesCobertura } from './setCoveredLinesCobertura.js';
 import { normalizePathToUnix } from './normalizePathToUnix.js';
 
 export async function transformDeployCoverageReport(
-  data: DeployCoverageData
+  data: DeployCoverageData,
+  format: string
 ): Promise<{ xml: string; warnings: string[]; filesProcessed: number }> {
-  const coverageObj: CoverageObject = { coverage: { '@version': '1', file: [] } };
   const warnings: string[] = [];
   let filesProcessed: number = 0;
   const { repoRoot, packageDirectories } = await getPackageDirectories();
 
-  for (const fileName in data) {
-    if (!Object.hasOwn(data, fileName)) continue;
-    const fileInfo = data[fileName];
-    const formattedFileName = fileName.replace(/no-map[\\/]+/, '');
-    const relativeFilePath = await findFilePath(formattedFileName, packageDirectories, repoRoot);
-    if (relativeFilePath === undefined) {
-      warnings.push(`The file name ${formattedFileName} was not found in any package directory.`);
-      continue;
+  if (format === 'sonar') {
+    const coverageObj: CoverageObject = { coverage: { '@version': '1', file: [] } };
+
+    for (const fileName in data) {
+      if (!Object.hasOwn(data, fileName)) continue;
+      const fileInfo = data[fileName];
+      const formattedFileName = fileName.replace(/no-map[\\/]+/, '');
+      const relativeFilePath = await findFilePath(formattedFileName, packageDirectories, repoRoot);
+      if (relativeFilePath === undefined) {
+        warnings.push(`The file name ${formattedFileName} was not found in any package directory.`);
+        continue;
+      }
+      const uncoveredLines = Object.keys(fileInfo.s)
+        .filter((lineNumber) => fileInfo.s[lineNumber] === 0)
+        .map(Number);
+      const coveredLines = Object.keys(fileInfo.s)
+        .filter((lineNumber) => fileInfo.s[lineNumber] === 1)
+        .map(Number);
+
+      const fileObj: FileObject = {
+        '@path': normalizePathToUnix(relativeFilePath),
+        lineToCover: uncoveredLines.map((lineNumber: number) => ({
+          '@lineNumber': lineNumber,
+          '@covered': 'false',
+        })),
+      };
+
+      await setCoveredLinesSonar(coveredLines, uncoveredLines, repoRoot, relativeFilePath, fileObj);
+      filesProcessed++;
+      coverageObj.coverage.file.push(fileObj);
     }
-    const uncoveredLines = Object.keys(fileInfo.s)
-      .filter((lineNumber) => fileInfo.s[lineNumber] === 0)
-      .map(Number);
-    const coveredLines = Object.keys(fileInfo.s)
-      .filter((lineNumber) => fileInfo.s[lineNumber] === 1)
-      .map(Number);
-
-    const fileObj: FileObject = {
-      '@path': normalizePathToUnix(relativeFilePath),
-      lineToCover: uncoveredLines.map((lineNumber: number) => ({
-        '@lineNumber': lineNumber,
-        '@covered': 'false',
-      })),
+    const xml = create(coverageObj).end({ prettyPrint: true, indent: '  ' });
+    return { xml, warnings, filesProcessed };
+  } else if (format === 'cobertura') {
+    const coberturaObj: CoberturaCoverageObject = {
+      coverage: {
+        '@lines-valid': 0,
+        '@lines-covered': 0,
+        '@line-rate': 0,
+        '@branches-valid': 0,
+        '@branches-covered': 0,
+        '@branch-rate': 1,
+        '@timestamp': Date.now(),
+        '@complexity': 0,
+        '@version': '0.1',
+        sources: { source: ['.'] },
+        packages: { package: [] },
+      },
     };
 
-    // this function is only needed until Salesforce fixes the API to correctly return covered lines
-    await setCoveredLines(coveredLines, uncoveredLines, repoRoot, relativeFilePath, fileObj);
-    filesProcessed++;
-    coverageObj.coverage.file.push(fileObj);
+    for (const fileName in data) {
+      if (!Object.hasOwn(data, fileName)) continue;
+      const fileInfo = data[fileName];
+      const formattedFileName = fileName.replace(/no-map[\\/]+/, '');
+      const relativeFilePath = await findFilePath(formattedFileName, packageDirectories, repoRoot);
+      if (relativeFilePath === undefined) {
+        warnings.push(`The file name ${formattedFileName} was not found in any package directory.`);
+        continue;
+      }
+      const uncoveredLines = Object.keys(fileInfo.s)
+        .filter((lineNumber) => fileInfo.s[lineNumber] === 0)
+        .map(Number);
+      const coveredLines = Object.keys(fileInfo.s)
+        .filter((lineNumber) => fileInfo.s[lineNumber] === 1)
+        .map(Number);
+
+      const classObj: CoberturaClass = {
+        '@name': formattedFileName,
+        '@filename': normalizePathToUnix(relativeFilePath),
+        '@line-rate': (coveredLines.length / (coveredLines.length + uncoveredLines.length)).toFixed(4),
+        '@branch-rate': '1',
+        methods: {},
+        lines: {
+          line: [
+            ...uncoveredLines.map((lineNumber) => ({
+              '@number': lineNumber,
+              '@hits': 0,
+              '@branch': 'false',
+            })),
+          ],
+        },
+      };
+
+      await setCoveredLinesCobertura(coveredLines, uncoveredLines, repoRoot, relativeFilePath, classObj);
+
+      coberturaObj.coverage['@lines-valid'] += uncoveredLines.length + coveredLines.length;
+      coberturaObj.coverage['@lines-covered'] += coveredLines.length;
+
+      const packageObj = {
+        '@name': 'main',
+        '@line-rate': classObj['@line-rate'],
+        '@branch-rate': classObj['@branch-rate'],
+        classes: { class: [classObj] },
+      };
+
+      coberturaObj.coverage.packages.package.push(packageObj);
+      filesProcessed++;
+    }
+
+    coberturaObj.coverage['@line-rate'] = parseFloat(
+      (coberturaObj.coverage['@lines-covered'] / coberturaObj.coverage['@lines-valid']).toFixed(4)
+    );
+
+    const xml = create(coberturaObj).end({ prettyPrint: true, indent: '  ' });
+    return { xml, warnings, filesProcessed };
   }
-  const xml = create(coverageObj).end({ prettyPrint: true, indent: '  ' });
-  return { xml, warnings, filesProcessed };
+
+  throw new Error(`Unsupported format: ${format}`);
 }