Merge pull request #14 from mcarvin8/beta

fix: add support for `sf apex run test`

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.7.2-beta.1](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v1.7.1...v1.7.2-beta.1) (2024-05-09)
+
+### Bug Fixes
+
+- add support for coverage JSONs created by `sf apex run test` ([5f48b77](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/5f48b777f1ccd003d650c50ef87a0b24e2b4a73f))
+
 ## [1.7.1](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v1.7.0...v1.7.1) (2024-04-30)
 
 ### Bug Fixes

README.md

@@ -2,25 +2,29 @@
 
 [![NPM](https://img.shields.io/npm/v/apex-code-coverage-transformer.svg?label=apex-code-coverage-transformer)](https://www.npmjs.com/package/apex-code-coverage-transformer) [![Downloads/week](https://img.shields.io/npm/dw/apex-code-coverage-transformer.svg)](https://npmjs.org/package/apex-code-coverage-transformer) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/LICENSE.md)
 
-The `apex-code-coverage-transformer` is a Salesforce CLI plugin to transform the Apex Code Coverage JSON files created during deployments into the Generic Test Coverage Format (XML). This format is accepted by static code analysis tools like SonarQube.
+The `apex-code-coverage-transformer` is 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). This format is accepted by static code analysis tools like SonarQube.
 
 This plugin requires [git](https://git-scm.com/downloads) to be installed and that it can be called using the command `git`.
 
 This plugin supports code coverage metrics created for Apex Classes and Apex Triggers. This also supports multiple package directories as listed in your project's `sfdx-project.json` configuration, assuming unique file-names are used in your package directories.
 
 This plugin is intended for users who deploy their Apex codebase from a git-based repository and use SonarQube for code quality. 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. SonarQube relies on file-paths to map code coverage to the files in their file explorer interface. Since files from managed and unlocked packages aren't retrieved into git-based Salesforce repositories, these files cannot be included in your SonarQube scans. If your Apex code coverage JSON output includes managed/unlocked package files, they will not be added to the coverage XML created by this plugin. A warning will be printed for each file not found in a package directory in your git repository. See [Errors and Warnings](https://github.com/mcarvin8/apex-code-coverage-transformer?tab=readme-ov-file#errors-and-warnings) for more information.
 
-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:
+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`.
 
 ```
 sf project deploy [start/validate] -x manifest/package.xml -l RunSpecifiedTests -t {testclasses} --verbose --coverage-formatters json --results-dir coverage
 ```
 
-This will create a coverage JSON in this relative path - `coverage/coverage/coverage.json`
+To create the code coverage JSON when running tests directly in the org, append `-c -r json` to the `sf apex run test` command.
 
-This JSON isn't accepted by SonarQube automatically for git-based Salesforce repositories and needs to be converted using this plugin.
+```
+sf apex run test -c -r json
+```
+
+The code coverage JSONs created by the Salesforce CLI aren't accepted by SonarQube automatically for git-based Salesforce repositories and needs to be converted using this plugin.
 
-**Disclaimer**: Due to existing bugs with how the Salesforce CLI reports covered lines (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, 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.
+**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.
 
 ## Install
 
@@ -40,27 +44,28 @@ This command needs to be ran somewhere inside your Salesforce DX git repository,
 
 ```
 USAGE
-  $ sf apex-code-coverage transformer transform -j <value> -x <value> [--json]
+  $ sf apex-code-coverage transformer transform -j <value> -x <value> -c <value> [--json]
 
 FLAGS
-  -j, --coverage-json=<value> Path to the code coverage JSON file created by the Salesforce CLI deployment command.
-  -x, --xml=<value> [default: coverage.xml] Path to code coverage XML file that will be created by this plugin.
+  -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.
+  -c, --command=<value> [default: "deploy"] The type of Salesforce CLI command you are running. Valid options: "deploy" or "test".
 
 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 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 an XML accepted by tools like SonarQube.
 
 EXAMPLES
-    $ sf apex-code-coverage transformer transform -j "coverage.json" -x "coverage.xml"
+    $ sf apex-code-coverage transformer transform -j "coverage.json" -x "coverage.xml" -c "deploy"
 ```
 
 ## Hook
 
 A post-run hook has been configured if you elect to use it.
 
-The post-run hook will automatically transform the code coverage JSON file into a generic test coverage report XML after every Salesforce CLI deployment (`sf project deploy start`, `sf project deploy validate`, `sf project deploy report`, `sf project deploy resume` commands) if the JSON is found.
+The post-run hook will automatically transform the code coverage JSON file into a generic test coverage report XML after every Salesforce CLI deployment (`sf project deploy start`, `sf project deploy validate`, `sf project deploy report`, `sf project deploy resume` commands) and test run (`sf apex run test` command) if the JSON is found.
 
 The hook requires you to create this file in the root of your repo: `.apexcodecovtransformer.config.json`
 

messages/transformer.transform.md

@@ -4,16 +4,20 @@ Transforms the Code Coverage JSON into the Generic Test Coverage Format (XML).
 
 # description
 
-This plugin will convert the code coverage JSON file created by the Salesforce CLI during Apex deployments 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 an XML accepted by tools like SonarQube.
 
 # examples
 
-- `sf apex-code-coverage transformer transform -j "coverage.json" -x "coverage.xml"`
+- `sf apex-code-coverage transformer transform -j "coverage.json" -x "coverage.xml" -c "deploy"`
 
 # flags.coverage-json.summary
 
-Path to the code coverage JSON file created by the Salesforce CLI deployment command.
+Path to the code coverage JSON file created by the Salesforce CLI deployment or test command.
 
 # flags.xml.summary
 
 Path to code coverage XML file that will be created by this plugin.
+
+# flags.command.summary
+
+The type of Salesforce CLI command you are running.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "apex-code-coverage-transformer",
   "description": "Transforms the Apex code coverage JSON created during Salesforce deployments into the Generic Test Coverage Format (XML).",
-  "version": "1.7.1",
+  "version": "1.7.2-beta.1",
   "dependencies": {
     "@oclif/core": "^3.18.1",
     "@salesforce/core": "^6.4.7",

src/commands/apex-code-coverage/transformer/transform.ts

@@ -5,8 +5,9 @@ import { writeFile, readFile } from 'node:fs/promises';
 
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
-import { CoverageData } from '../../../helpers/types.js';
-import { convertToGenericCoverageReport } from '../../../helpers/convertToGenericCoverageReport.js';
+import { DeployCoverageData, TestCoverageData } from '../../../helpers/types.js';
+import { transformDeployCoverageReport } from '../../../helpers/transformDeployCoverageReport.js';
+import { transformTestCoverageReport } from '../../../helpers/transformTestCoverageReport.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('apex-code-coverage-transformer', 'transformer.transform');
@@ -34,16 +35,38 @@ export default class TransformerTransform extends SfCommand<TransformerTransform
       exists: false,
       default: 'coverage.xml',
     }),
+    command: Flags.string({
+      summary: messages.getMessage('flags.command.summary'),
+      char: 'c',
+      required: true,
+      default: 'deploy',
+      options: ['deploy', 'test'],
+    }),
   };
 
   public async run(): Promise<TransformerTransformResult> {
     const { flags } = await this.parse(TransformerTransform);
     const jsonFilePath = resolve(flags['coverage-json']);
     const xmlFilePath = resolve(flags['xml']);
-
+    const commandType = flags['command'];
     const jsonData = await readFile(jsonFilePath, 'utf-8');
-    const coverageData = JSON.parse(jsonData) as CoverageData;
-    const { xml: xmlData, warnings, filesProcessed } = await convertToGenericCoverageReport(coverageData);
+
+    let xmlData: string;
+    let warnings: string[] = [];
+    let filesProcessed: number = 0;
+    if (commandType === 'test') {
+      const coverageData = JSON.parse(jsonData) as TestCoverageData[];
+      const result = await transformTestCoverageReport(coverageData);
+      xmlData = result.xml;
+      warnings = result.warnings;
+      filesProcessed = result.filesProcessed;
+    } else {
+      const coverageData = JSON.parse(jsonData) as DeployCoverageData;
+      const result = await transformDeployCoverageReport(coverageData);
+      xmlData = result.xml;
+      warnings = result.warnings;
+      filesProcessed = result.filesProcessed;
+    }
 
     // Print warnings if any
     if (warnings.length > 0) {

src/helpers/convertToGenericCoverageReport.ts → src/helpers/transformDeployCoverageReport.ts

@@ -3,14 +3,14 @@
 
 import { create } from 'xmlbuilder2';
 
-import { CoverageData, CoverageObject, FileObject } from './types.js';
+import { DeployCoverageData, CoverageObject, FileObject } from './types.js';
 import { getPackageDirectories } from './getPackageDirectories.js';
 import { findFilePath } from './findFilePath.js';
 import { setCoveredLines } from './setCoveredLines.js';
 import { normalizePathToUnix } from './normalizePathToUnix.js';
 
-export async function convertToGenericCoverageReport(
-  data: CoverageData
+export async function transformDeployCoverageReport(
+  data: DeployCoverageData
 ): Promise<{ xml: string; warnings: string[]; filesProcessed: number }> {
   const coverageObj: CoverageObject = { coverage: { '@version': '1', file: [] } };
   const warnings: string[] = [];

src/helpers/transformTestCoverageReport.ts

@@ -0,0 +1,47 @@
+'use strict';
+/* eslint-disable no-await-in-loop */
+
+import { create } from 'xmlbuilder2';
+
+import { TestCoverageData, CoverageObject, FileObject } from './types.js';
+import { getPackageDirectories } from './getPackageDirectories.js';
+import { findFilePath } from './findFilePath.js';
+import { normalizePathToUnix } from './normalizePathToUnix.js';
+
+export async function transformTestCoverageReport(
+  testCoverageData: TestCoverageData[]
+): 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();
+
+  if (!Array.isArray(testCoverageData)) {
+    testCoverageData = [testCoverageData];
+  }
+
+  for (const data of testCoverageData) {
+    const { name, lines } = data;
+    const formattedFileName = name.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 fileObj: FileObject = {
+      '@path': normalizePathToUnix(relativeFilePath),
+      lineToCover: [],
+    };
+
+    for (const [lineNumber, isCovered] of Object.entries(lines)) {
+      fileObj.lineToCover.push({
+        '@lineNumber': Number(lineNumber),
+        '@covered': `${isCovered === 1}`,
+      });
+    }
+    filesProcessed++;
+    coverageObj.coverage.file.push(fileObj);
+  }
+  const xml = create(coverageObj).end({ prettyPrint: true, indent: '  ' });
+  return { xml, warnings, filesProcessed };
+}

src/helpers/types.ts

@@ -1,6 +1,6 @@
 'use strict';
 
-export interface CoverageData {
+export interface DeployCoverageData {
   [className: string]: {
     fnMap: Record<string, unknown>;
     branchMap: Record<string, unknown>;
@@ -18,6 +18,15 @@ export interface CoverageData {
   };
 }
 
+export interface TestCoverageData {
+  id: string;
+  name: string;
+  totalLines: number;
+  lines: Record<string, number>;
+  totalCovered: number;
+  coveredPercent: number;
+}
+
 export interface SfdxProject {
   packageDirectories: Array<{ path: string }>;
 }

src/hooks/postrun.ts

@@ -9,49 +9,57 @@ import TransformerTransform from '../commands/apex-code-coverage/transformer/tra
 import { ConfigFile } from '../helpers/types.js';
 
 export const postrun: Hook<'postrun'> = async function (options) {
+  let commandType: string;
   if (
     ['project:deploy:validate', 'project:deploy:start', 'project:deploy:report', 'project:deploy:resume'].includes(
       options.Command.id
     )
   ) {
-    let configFile: ConfigFile;
-    const gitOptions: Partial<SimpleGitOptions> = {
-      baseDir: process.cwd(),
-      binary: 'git',
-      maxConcurrentProcesses: 6,
-      trimmed: true,
-    };
-
-    const git: SimpleGit = simpleGit(gitOptions);
-    const repoRoot = (await git.revparse('--show-toplevel')).trim();
-    const configPath = resolve(repoRoot, '.apexcodecovtransformer.config.json');
-
-    try {
-      const jsonString: string = await readFile(configPath, 'utf-8');
-      configFile = JSON.parse(jsonString) as ConfigFile;
-    } catch (error) {
-      return;
-    }
-
-    const coverageJson: string = configFile.coverageJsonPath || '.';
-    const coverageXml: string = configFile.coverageXmlPath || 'coverage.xml';
-
-    if (coverageJson.trim() === '.') {
-      return;
-    }
-
-    const coverageJsonPath = resolve(coverageJson);
-    const coverageXmlPath = resolve(coverageXml);
-
-    if (!existsSync(coverageJsonPath)) {
-      return;
-    }
-
-    const commandArgs: string[] = [];
-    commandArgs.push('--coverage-json');
-    commandArgs.push(coverageJsonPath);
-    commandArgs.push('--xml');
-    commandArgs.push(coverageXmlPath);
-    await TransformerTransform.run(commandArgs);
+    commandType = 'deploy';
+  } else if (['apex:run:test'].includes(options.Command.id)) {
+    commandType = 'test';
+  } else {
+    return;
   }
+  let configFile: ConfigFile;
+  const gitOptions: Partial<SimpleGitOptions> = {
+    baseDir: process.cwd(),
+    binary: 'git',
+    maxConcurrentProcesses: 6,
+    trimmed: true,
+  };
+
+  const git: SimpleGit = simpleGit(gitOptions);
+  const repoRoot = (await git.revparse('--show-toplevel')).trim();
+  const configPath = resolve(repoRoot, '.apexcodecovtransformer.config.json');
+
+  try {
+    const jsonString: string = await readFile(configPath, 'utf-8');
+    configFile = JSON.parse(jsonString) as ConfigFile;
+  } catch (error) {
+    return;
+  }
+
+  const coverageJson: string = configFile.coverageJsonPath || '.';
+  const coverageXml: string = configFile.coverageXmlPath || 'coverage.xml';
+
+  if (coverageJson.trim() === '.') {
+    return;
+  }
+
+  const coverageJsonPath = resolve(coverageJson);
+  const coverageXmlPath = resolve(coverageXml);
+
+  if (!existsSync(coverageJsonPath)) {
+    return;
+  }
+
+  const commandArgs: string[] = [];
+  commandArgs.push('--coverage-json');
+  commandArgs.push(coverageJsonPath);
+  commandArgs.push('--xml');
+  commandArgs.push(coverageXmlPath);
+  commandArgs.push('--command');
+  commandArgs.push(commandType);
+  await TransformerTransform.run(commandArgs);
 };