coverage.js

/**
 * Coverage module loads a Cobertura Format XML file containing code coverage information and reformats it into an
 * object for POSTing to the Coveralls API.
 * @module ./coverage
 * @example
 * // create queue
 * const queue = new require(./queue.js).Queue()
 * queue.process((job, done) => {
 *   console.log('Job with id ' + job.id + ' is being processed');
 *   setTimeout(done, 3000);
 * });
 * var data = {key: 'value'};
 * queue.add(data);
 * @requires module:dotenv For loading in API token
 * @requires module:xml2js For converting XML to object
 * @version 0.9.0
 * @author Miles Wells [<k1o0@3tk.co>]
 * @license Apache-2.0
 */

const fs = require('fs'),
    xml2js = require('xml2js'),
    crypto = require('crypto'),
    parser = new xml2js.Parser(),
    path = require('path');
var timestamp;

var token = process.env.COVERALLS_TOKEN;


/**
 * Loads file containing source code, returns a hash and line count
 * @param {String} path - Path to the source code file.
 * @returns {Object} key `Hash` contains MD5 digest string of file; `count` contains number of lines in source file
 */
function md5(path) {
    const hash = crypto.createHash('md5'); // Creating hash object
    const buf = fs.readFileSync(path, 'utf-8'); // Read in file
    const count = buf.split(/\r\n|\r|\n/).length; // Count the number of lines
    hash.update(buf, 'utf-8'); // Update hash

    return {hash: hash.digest('hex'), count: count};
}


/**
 * Formats list of classes from XML file and return object formatted for the Coveralls API.
 * @see {@link https://docs.coveralls.io/api-reference|Coveralls API docs}
 * @param {Array} classList - An array of class objects from the loaded XML file.
 * @param {String} srcPath - The root path of the code repository.
 * @param {String} sha - The commit SHA for this coverage test.
 * @returns {Object}
 * @todo Generalize path default
 */
async function formatCoverage(classList, srcPath, sha) {
    var job = {};
    var sourceFiles = [];
    var digest;
    srcPath = typeof srcPath != 'undefined' ? srcPath : process.env.REPO_PATH; // default to home dir
    // For each class, create file object containing array of lines covered and add to sourceFile array
    await Promise.all(classList.map(async c => {
        let file = {}; // Initialize file object
        let fullPath = c.$.filename.startsWith(srcPath) ? c.$.filename : path.join(srcPath, c.$.filename);
        digest = md5(fullPath); // Create digest and line count for file
        let lines = new Array(digest.count).fill(null); // Initialize line array the size of source code file
        c.lines[0].line.forEach(ln => {
            let n = Number(ln.$.number);
            if (n <= digest.count) {
                lines[n] = Number(ln.$.hits);
            }
        });
        // create source file object
        file.name = c.$.filename;
        file.source_digest = digest.hash;
        file.coverage = lines; // file.coverage[0] == line 1
        sourceFiles.push(file);
    }));

    job.repo_token = token; // env secret token
    job.service_name = `coverage/${process.env.USERDOMAIN}`;
    // The associated pull request ID of the build. Used for updating the status and/or commenting.
    job.service_pull_request = '';
    job.source_files = sourceFiles;
    job.commit_sha = sha;
    job.run_at = timestamp; // "2013-02-18 00:52:48 -0800"
    return job;
}

/**
 * Loads a code coverage XML file in Cobertura Format and returns payload object for Coveralls API
 * @see {@link https://docs.coveralls.io/api-reference|Coveralls API docs}
 * @param {String} path - Path to the XML file containing coverage information.
 * @param {String} sha - The commit SHA for this coverage test
 * @param {String} repo - The repo to which the commit belongs
 * @param {Array} submodules - A list of submodules for separating coverage into
 * @see {@link https://github.com/cobertura/cobertura/wiki|Cobertura Wiki}
 */
function coverage(path, repo, sha, submodules) {
    return fs.promises.readFile(path)  // Read in XML file
        .then(parser.parseStringPromise) // Parse XML
        .then(result => {
            // Extract root code path
            const rootPath = (result.coverage.sources[0].source[0] || process.env.REPO_PATH)
                .replace(/[\/|\\]+$/, '');
            timestamp = new Date(result.coverage.$.timestamp * 1000); // Convert UNIX timestamp to Date object
            let classes = []; // Initialize classes array

            const packages = result.coverage.packages[0].package;
            packages.forEach(pkg => { classes.push(pkg.classes[0].class); }); // Get all classes
            classes = classes.reduce((acc, val) => acc.concat(val), []); // Flatten

            // The submodules
            const byModule = {'main': []};
            submodules.forEach((x) => { byModule[x] = []; });  // initialize submodules

            // Sort into piles
            byModule['main'] = classes.filter(function (e) {
                if (e.$.filename.search(/(tests\\|_.*test|docs\\)/i) !== -1) return false; // Filter out tests and docs
                if (!Array.isArray(e.lines[0].line)) return false; // Filter out files with no functional lines
                for (let submodule of submodules) {
                    if (e.$.filename.startsWith(submodule)) {
                        byModule[submodule].push(e);
                        return false;
                    }
                }
                return true;
            });
            // Select module
            let modules = byModule[repo] || byModule['main'];
            return formatCoverage(modules, rootPath, sha);
        });
}


// Export Coverage
module.exports = coverage;