buildkite-test-collector/jest/reporter.js

Buildkite Test Engine collectors for JavaScript test frameworks

const { randomUUID } = require('crypto')
const CI = require('../util/ci')
const uploadTestResults = require('../util/uploadTestResults')
const Paths = require('../util/paths')

class JestBuildkiteTestEngineReporter {
  constructor(globalConfig, options) {
    this._globalConfig = globalConfig
    this._options = options
    this._testResults = []
    this._testEnv = (new CI()).env();
    this._tags = options?.tags;
    this._paths = new Paths(globalConfig, this._testEnv.location_prefix)
  }

  onRunStart(results, options) {
    if (this._globalConfig.forceExit) {
      console.warn(
        `--forceExit could potentially terminate any ongoing processes that ` +
        `are attempting to send test executions to Buildkite. ` +
        `Have you considered using \`--detectOpenHandles\` to detect ` +
        'async operations that kept running after all tests finished?',
      );
    }
  }

  onRunComplete(_test, _results, _options) {
    return uploadTestResults(this._testEnv, this._tags, this._testResults, this._options)
  }

  onTestStart(test) {
  }

  onTestResult(test, testResult) {
    const prefixedTestPath = this._paths.prefixTestPath(testResult.testFilePath);

    testResult.testResults.forEach((result) => {
      let id = randomUUID()
      this._testResults.push({
        'id': id,
        'scope': result.ancestorTitles.join(' '),
        'name': result.title,
        'location': result.location ? `${prefixedTestPath}:${result.location.line}` : null,
        'file_name': prefixedTestPath,
        'result': this.testEngineResult(result),
        'failure_reason': this.testEngineFailureReason(result),
        'failure_expanded': this.testEngineFailureExpanded(result),
        'history': {
          'section': 'top',
          'start_at': testResult.perfStats.start,
          'end_at': testResult.perfStats.end,
          'duration': result.duration / 1000,
        }

      })
    })
  }


  testEngineResult(testResult) {
    // Jest test statuses:
    // - passed
    // - pending
    // - failed
    // - todo
    //
    // Buildkite Test Engine execution results:
    // - passed
    // - failed
    // - pending
    // - skipped
    // - unknown
    return {
      passed: 'passed',
      pending: 'pending',
      failed: 'failed',
      todo: 'skipped'
    }[testResult.status]
  }

  testEngineFailureMessages(testResult) {
    if (testResult.status !== 'failed') return []

    // Strip ANSI color codes from messages and split each line
    return testResult.failureMessages.join(' ').replace(/\u001b[^m]*?m/g,'').split("\n")
  }

  testEngineFailureReason(testResult) {
    return this.testEngineFailureMessages(testResult)[0]
  }

  testEngineFailureExpanded(testResult) {
    return [
      { 
        expanded: this.testEngineFailureMessages(testResult).splice(1)
      }
    ]
  }
}

module.exports = JestBuildkiteTestEngineReporter