apex-code-coverage-transformer/lib/handlers/cobertura.js

Transform Salesforce Apex code coverage JSONs into other formats accepted by SonarQube, GitHub, GitLab, Azure, Bitbucket, etc.

'use strict';
import { BaseHandler } from './BaseHandler.js';
import { HandlerRegistry } from './HandlerRegistry.js';
/**
 * Handler for generating Cobertura XML coverage reports.
 *
 * Cobertura format is widely supported by many CI/CD platforms
 * including Codecov, Azure DevOps, Jenkins, and GitLab.
 *
 * @see http://cobertura.github.io/cobertura/
 */
export class CoberturaCoverageHandler extends BaseHandler {
    coverageObj;
    packageMap;
    constructor() {
        super();
        this.coverageObj = {
            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.packageMap = new Map();
    }
    processFile(filePath, fileName, lines) {
        const packageName = filePath.split('/')[0]; // Extract root directory as package name
        if (!this.packageMap.has(packageName)) {
            this.packageMap.set(packageName, {
                '@name': packageName,
                '@line-rate': 0,
                '@branch-rate': 1,
                classes: { class: [] },
            });
        }
        const packageObj = this.packageMap.get(packageName);
        const { totalLines, coveredLines } = this.calculateCoverage(lines);
        const classObj = {
            '@name': fileName,
            '@filename': filePath,
            '@line-rate': 0,
            '@branch-rate': 1,
            methods: {},
            lines: { line: [] },
        };
        for (const [lineNumber, isCovered] of Object.entries(lines)) {
            classObj.lines.line.push({
                '@number': Number(lineNumber),
                '@hits': isCovered === 1 ? 1 : 0,
                '@branch': 'false',
            });
        }
        if (totalLines > 0) {
            classObj['@line-rate'] = parseFloat((coveredLines / totalLines).toFixed(4));
        }
        this.coverageObj.coverage['@lines-valid'] += totalLines;
        this.coverageObj.coverage['@lines-covered'] += coveredLines;
        packageObj.classes.class.push(classObj);
        this.packageMap.set(packageName, packageObj);
    }
    finalize() {
        this.coverageObj.coverage.packages.package = Array.from(this.packageMap.values());
        for (const pkg of this.coverageObj.coverage.packages.package) {
            const totalLines = pkg.classes.class.reduce((sum, cls) => sum + cls['@line-rate'] * cls.lines.line.length, 0);
            const totalClasses = pkg.classes.class.reduce((sum, cls) => sum + cls.lines.line.length, 0);
            pkg['@line-rate'] = parseFloat((totalLines / totalClasses).toFixed(4));
        }
        this.coverageObj.coverage['@line-rate'] = parseFloat((this.coverageObj.coverage['@lines-covered'] / this.coverageObj.coverage['@lines-valid']).toFixed(4));
        this.coverageObj.coverage.packages.package.sort((a, b) => a['@name'].localeCompare(b['@name']));
        for (const pkg of this.coverageObj.coverage.packages.package) {
            if (pkg.classes?.class) {
                pkg.classes.class.sort((a, b) => a['@filename'].localeCompare(b['@filename']));
            }
        }
        return this.coverageObj;
    }
}
// Self-register this handler
HandlerRegistry.register({
    name: 'cobertura',
    description: 'Cobertura XML format for wide CI/CD compatibility',
    fileExtension: '.xml',
    handler: () => new CoberturaCoverageHandler(),
    compatibleWith: ['Codecov', 'Azure DevOps', 'Jenkins', 'GitLab', 'GitHub Actions'],
});
//# sourceMappingURL=cobertura.js.map