apex-code-coverage-transformer 1.0.0

package/README.md

@@ -0,0 +1,48 @@
+# Apex Code Coverage Transformer
+
+[![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-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/apex-code-coverage-transformer/main/LICENSE.txt)
+
+The `apex-code-coverage-transformer` is a simple plugin to transform the JSON file for Apex Code Coverage into Generic Test Coverage Format (XML). This format is accepted by static code analysis tools like SonarQube.
+
+Here is how you can create the JSON file with the Salesforce CLI:
+
+```
+sf project deploy 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`
+
+This JSON isn't accepted by SonarQube automatically and needs to be converted using this plugin.
+
+## Install
+
+```bash
+sf plugins install apex-code-coverage-transformer@x.y.z
+```
+
+## Commands
+
+The `apex-code-coverage-transformer` has 1 command:
+
+- `sf apex-code-coverage transformer transform`
+
+## `sf apex-code-coverage transformer transform`
+
+```
+USAGE
+  $ sf apex-code-coverage transformer transform -j <value> -x <value> -d <value> [--json]
+
+FLAGS
+  -j, --json=<value> The path to the JSON file created by the Salesforce CLI for code coverage.
+  -x, --xml=<value> [default: coverage.xml] Output path for the XML file created by this plugin
+  -d, --dx-directory=<value> [default: force-app/main/default] The root directory containing your Salesforce metadata.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  This plugin will convert the JSON file created by the Salesforce CLI during Apex deployments into the Generic Test Coverage Format.
+
+EXAMPLES
+    $ apex-code-coverage transformer transform -j "test.json" -x "coverage.xml" -d "force-app/main/default"
+```

package/lib/commands/apex-code-coverage/transformer/transform.d.ts

@@ -0,0 +1,15 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type TransformerTransformResult = {
+    path: string;
+};
+export default class TransformerTransform extends SfCommand<TransformerTransformResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        'dx-directory': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        json: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        xml: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<TransformerTransformResult>;
+}

package/lib/commands/apex-code-coverage/transformer/transform.js

@@ -0,0 +1,78 @@
+'use strict';
+import * as fs from 'node:fs';
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('apex-code-coverage-transformer', 'transformer.transform');
+export default class TransformerTransform extends SfCommand {
+    static summary = messages.getMessage('summary');
+    static description = messages.getMessage('description');
+    static examples = messages.getMessages('examples');
+    static flags = {
+        'dx-directory': Flags.directory({
+            summary: messages.getMessage('flags.dx-directory.summary'),
+            char: 'd',
+            required: true,
+            exists: true,
+            default: 'force-app/main/default',
+        }),
+        'json': Flags.string({
+            summary: messages.getMessage('flags.json.summary'),
+            char: 'j',
+            required: true,
+            exists: true,
+        }),
+        'xml': Flags.string({
+            summary: messages.getMessage('flags.xml.summary'),
+            char: 'x',
+            required: true,
+            exists: true,
+            default: 'coverage.xml',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(TransformerTransform);
+        const jsonFilePath = flags['json'];
+        const xmlFilePath = flags['xml'];
+        const dxDirectory = flags['dx-directory'];
+        const jsonData = fs.readFileSync(jsonFilePath, 'utf-8');
+        const coverageData = JSON.parse(jsonData);
+        const xmlData = convertToGenericTestReport(coverageData, dxDirectory);
+        // Write the XML data to the XML file
+        try {
+            fs.writeFileSync(xmlFilePath, xmlData);
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            this.log(`The XML data has been written to ${xmlFilePath}`);
+        }
+        catch (error) {
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+            this.error(`Error writing XML data to file: ${error}`);
+        }
+        return { path: xmlFilePath };
+    }
+}
+function convertToGenericTestReport(data, dxDirectory) {
+    let xml = '<?xml version="1.0"?>\n<coverage version="1">\n';
+    for (const className in data) {
+        if (Object.prototype.hasOwnProperty.call(data, className)) {
+            const classInfo = data[className];
+            const formattedClassName = className.replace('no-map/', '');
+            const classPath = `${dxDirectory}/classes/${formattedClassName}.cls`;
+            xml += `\t<file path="${classPath}">\n`;
+            for (const lineNumber in classInfo.s) {
+                if (Object.prototype.hasOwnProperty.call(classInfo.s, lineNumber)) {
+                    const count = classInfo.s[lineNumber];
+                    const covered = count > 0 ? 'true' : 'false';
+                    // only add uncovered lines
+                    if (covered === 'false') {
+                        xml += `\t\t<lineToCover lineNumber="${lineNumber}" covered="${covered}"/>\n`;
+                    }
+                }
+            }
+            xml += '\t</file>\n';
+        }
+    }
+    xml += '</coverage>';
+    return xml;
+}
+//# sourceMappingURL=transform.js.map

package/lib/commands/apex-code-coverage/transformer/transform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.js","sourceRoot":"","sources":["../../../../src/commands/apex-code-coverage/transformer/transform.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AACb,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,QAAQ,CAAC,kCAAkC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,gCAAgC,EAAE,uBAAuB,CAAC,CAAC;AAMlG,MAAM,CAAC,OAAO,OAAO,oBAAqB,SAAQ,SAAqC;IAC9E,MAAM,CAAU,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACzD,MAAM,CAAU,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IACjE,MAAM,CAAU,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAE5D,MAAM,CAAU,KAAK,GAAG;QAC7B,cAAc,EAAE,KAAK,CAAC,SAAS,CAAC;YAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,4BAA4B,CAAC;YAC1D,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,wBAAwB;SAClC,CAAC;QACF,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;YAClD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;SACb,CAAC;QACF,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC;YAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC;YACjD,IAAI,EAAE,GAAG;YACT,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,cAAc;SACxB,CAAC;KACH,CAAC;IAEK,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACzD,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC;QAE1C,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAiB,CAAC;QAC1D,MAAM,OAAO,GAAG,0BAA0B,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QAEtE,qCAAqC;QACrC,IAAI,CAAC;YACH,EAAE,CAAC,aAAa,CAAC,WAAqB,EAAE,OAAO,CAAC,CAAC;YACjD,4EAA4E;YAC5E,IAAI,CAAC,GAAG,CAAC,oCAAoC,WAAW,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,4EAA4E;YAC5E,IAAI,CAAC,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;IAC/B,CAAC;;AAGH,SAAS,0BAA0B,CAAC,IAAkB,EAAE,WAAmB;IACzE,IAAI,GAAG,GAAG,iDAAiD,CAAC;IAE5D,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;QAC3B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;YACxD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAClC,MAAM,kBAAkB,GAAG,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,GAAG,WAAW,YAAY,kBAAkB,MAAM,CAAC;YACrE,GAAG,IAAI,iBAAiB,SAAS,MAAM,CAAC;YAExC,KAAK,MAAM,UAAU,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC;gBACnC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC;oBAChE,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;oBACtC,MAAM,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;oBAC7C,2BAA2B;oBAC3B,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;wBACtB,GAAG,IAAI,gCAAgC,UAAU,cAAc,OAAO,OAAO,CAAC;oBAClF,CAAC;gBACL,CAAC;YACL,CAAC;YACD,GAAG,IAAI,aAAa,CAAC;QACzB,CAAC;IACL,CAAC;IACD,GAAG,IAAI,aAAa,CAAC;IACrB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/helpers/types.d.ts

@@ -0,0 +1,20 @@
+export interface CoverageData {
+    [className: string]: {
+        fnMap: Record<string, unknown>;
+        branchMap: Record<string, unknown>;
+        path: string;
+        f: Record<string, unknown>;
+        b: Record<string, unknown>;
+        s: Record<string, number>;
+        statementMap: Record<string, {
+            start: {
+                line: number;
+                column: number;
+            };
+            end: {
+                line: number;
+                column: number;
+            };
+        }>;
+    };
+}

package/lib/helpers/types.js

@@ -0,0 +1,3 @@
+'use strict';
+export {};
+//# sourceMappingURL=types.js.map

package/lib/helpers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/helpers/types.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/lib/index.js

@@ -0,0 +1,2 @@
+export default {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,eAAe,EAAE,CAAC"}

package/messages/transformer.transform.md

@@ -0,0 +1,23 @@
+# summary
+
+Transforms the Code Coverage JSON into the Generic Test Data Format (XML).
+
+# description
+
+This plugin will convert the JSON file created by the Salesforce CLI during Apex deployments
+
+# examples
+
+- `sf apex-code-coverage transformer transform --json "path-to-cli-coverage.json"`
+
+# flags.dx-directory.summary
+
+Directory containing Salesforce metadata (default: `force-app/main/default`).
+
+# flags.json.summary
+
+Path to the JSON file created by the Salesforce CLI deployment command.
+
+# flags.xml.summary
+
+XML file created by this plugin (default: `coverage.xml`).