junit-bark/bin/junit-bark.js

JUnit XML reporter for Alsatian

#!/usr/bin/env node
const fs = require("fs")

const getStdin = require("get-stdin")
const junitReportBuilder = require("junit-report-builder")
const tmp = require("tmp")

const resultRegex = new RegExp(/^[not]*\s*ok \d+ (.+)$/m);

(async () => {
    const tap = await getStdin()
    const tapLines = tap.split(/\r?\n/)
    const junitBuilder = junitReportBuilder.newBuilder()
    const outputFile = tmp.fileSync()

    let currentSuite
    let currentSuiteName
    let stdOut = ""
    let lastTestCase
    let lastTestCaseStdOut
    let lastTestCaseFailed = false
    let readingErrorBlock = false
    let tapVersionRead = false
    let skipNextLine = true

    tapLines.forEach(tapLine => {
        tapLine = `${tapLine}\n`

        if (!tapVersionRead && !tapLine.startsWith("TAP version ")) {
            // have not seen the tap version yet, store lines
            stdOut += tapLine

            return
        } else if (!tapVersionRead && tapLine.startsWith("TAP version ")) {
            // found tap version, skip next line and begin processing
            tapVersionRead = true
            skipNextLine = true

            return
        }

        if (skipNextLine) {
            skipNextLine = false
            return
        }

        let type = "extra"
        let ok = false
        let name = ""

        // parse tap line
        if (tapLine.startsWith("#")) {
            type = "comment"
        } else if (tapLine.match(resultRegex)) {
            type = "result"
            ok = tapLine.startsWith("ok")
            name = tapLine.match(resultRegex)[1]
        }

        // add line as a suite, case or stdout line
        if (type === "comment") {
            // test suite

            if (tapLine.startsWith("# FIXTURE ")) {
                // strip prefix and newline from comment to get suite name
                currentSuiteName = tapLine.replace("# FIXTURE ", "").replace(/\n/, "")

                currentSuite = junitBuilder.testSuite().name(currentSuiteName)
            }
        }
        else if (type === "extra") {
            // test case output
            stdOut += tapLine

            if (
              // the last test case failed and tap line is the start of an error block
              // OR we are currently reading an error block
              (lastTestCase && lastTestCaseFailed && tapLine.startsWith(" ---"))
              || readingErrorBlock
            ) {
                if (!readingErrorBlock) {
                    // start of error block after failed test
                    readingErrorBlock = true
                } else if (readingErrorBlock && tapLine.startsWith(" ...")) {
                    // end of error block
                    readingErrorBlock = false
                }

                // append to last test output and remove from current test
                lastTestCaseStdOut += tapLine
                stdOut = ""

                if (!readingErrorBlock) {
                    // flush standard out when error block has been read
                    lastTestCase.standardOutput(lastTestCaseStdOut)
                }
            }
        } else if (type === "result") {
            // test case result
            let testCase = currentSuite.testCase()
                .className(currentSuiteName)
                .name(name)

            lastTestCase = testCase
            lastTestCaseStdOut = stdOut
            lastTestCaseFailed = ok
            readingErrorBlock = false

            if (ok) {
                // test passed, no error expected so flush output now
                testCase.standardOutput(stdOut)
            } else {
                testCase.failure()

                lastTestCaseFailed = true
            }

            stdOut = ""
        }
    });

    if (lastTestCaseFailed && stdOut === "") {
        // no error block after last test, flush standard out
        lastTestCase.standardOutput(lastTestCaseStdOut)
    }

    // write to temp file because crappy API ¯\_(ツ)_/¯
    junitBuilder.writeTo(outputFile.name)

    console.log(
        // cleanup leading and trailing space before standard out CDATA
        fs.readFileSync(outputFile.name)
            .toString()
            .replace(/<system-out>.*?<!\[CDATA\[/gs, "<system-out><![CDATA[")
            .replace(/\n\]\]>.*?<\/system-out>/gs, "]]></system-out>")
    )
})()