runner.js

// https://github.com/nodejs/node/blob/fec0fbc333c58e6ebbd2322f5120830fda880eb0/lib/internal/test_runner/runner.js
'use strict'
const {
  ArrayFrom,
  ArrayPrototypeFilter,
  ArrayPrototypeForEach,
  ArrayPrototypeIncludes,
  ArrayPrototypeJoin,
  ArrayPrototypePush,
  ArrayPrototypeSlice,
  ArrayPrototypeSort,
  ObjectAssign,
  PromisePrototypeThen,
  SafePromiseAll,
  SafeSet,
  StringPrototypeRepeat
} = require('#internal/per_context/primordials')

const { spawn } = require('child_process')
const { readdirSync, statSync } = require('fs')
// TODO(aduh95): switch to internal/readline/interface when backporting to Node.js 16.x is no longer a concern.
const { createInterface } = require('readline')
const {
  codes: {
    ERR_TEST_FAILURE
  }
} = require('#internal/errors')
const { toArray } = require('#internal/streams/operators').promiseReturningOperators
const { validateArray } = require('#internal/validators')
const { getInspectPort, isUsingInspector, isInspectorMessage } = require('#internal/util/inspector')
const { kEmptyObject } = require('#internal/util')
const { createTestTree } = require('#internal/test_runner/harness')
const { kDefaultIndent, kSubtestsFailed, Test } = require('#internal/test_runner/test')
const { TapParser } = require('#internal/test_runner/tap_parser')
const { TokenKind } = require('#internal/test_runner/tap_lexer')
const {
  isSupportedFileType,
  doesPathMatchFilter
} = require('#internal/test_runner/utils')
const { basename, join, resolve } = require('path')
const { once } = require('events')

const kFilterArgs = ['--test']

// TODO(cjihrig): Replace this with recursive readdir once it lands.
function processPath (path, testFiles, options) {
  const stats = statSync(path)

  if (stats.isFile()) {
    if (options.userSupplied ||
        (options.underTestDir && isSupportedFileType(path)) ||
        doesPathMatchFilter(path)) {
      testFiles.add(path)
    }
  } else if (stats.isDirectory()) {
    const name = basename(path)

    if (!options.userSupplied && name === 'node_modules') {
      return
    }

    // 'test' directories get special treatment. Recursively add all .js,
    // .cjs, and .mjs files in the 'test' directory.
    const isTestDir = name === 'test'
    const { underTestDir } = options
    const entries = readdirSync(path)

    if (isTestDir) {
      options.underTestDir = true
    }

    options.userSupplied = false

    for (let i = 0; i < entries.length; i++) {
      processPath(join(path, entries[i]), testFiles, options)
    }

    options.underTestDir = underTestDir
  }
}

function createTestFileList () {
  const cwd = process.cwd()
  const hasUserSuppliedPaths = process.argv.length > 1
  const testPaths = hasUserSuppliedPaths
    ? ArrayPrototypeSlice(process.argv, 1)
    : [cwd]
  const testFiles = new SafeSet()

  try {
    for (let i = 0; i < testPaths.length; i++) {
      const absolutePath = resolve(testPaths[i])

      processPath(absolutePath, testFiles, { userSupplied: true })
    }
  } catch (err) {
    if (err?.code === 'ENOENT') {
      console.error(`Could not find '${err.path}'`)
      process.exit(1)
    }

    throw err
  }

  return ArrayPrototypeSort(ArrayFrom(testFiles))
}

function filterExecArgv (arg) {
  return !ArrayPrototypeIncludes(kFilterArgs, arg)
}

function getRunArgs ({ path, inspectPort }) {
  const argv = ArrayPrototypeFilter(process.execArgv, filterExecArgv)
  if (isUsingInspector()) {
    ArrayPrototypePush(argv, `--inspect-port=${getInspectPort(inspectPort)}`)
  }
  ArrayPrototypePush(argv, path)
  return argv
}

class FileTest extends Test {
  #buffer = []
  #handleReportItem ({ kind, node, nesting = 0 }) {
    const indent = StringPrototypeRepeat(kDefaultIndent, nesting + 1)

    const details = (diagnostic) => {
      return (
        diagnostic && {
          __proto__: null,
          yaml:
            `${indent}  ` +
            ArrayPrototypeJoin(diagnostic, `\n${indent}  `) +
            '\n'
        }
      )
    }

    switch (kind) {
      case TokenKind.TAP_VERSION:
        // TODO(manekinekko): handle TAP version coming from the parser.
        // this.reporter.version(node.version);
        break

      case TokenKind.TAP_PLAN:
        this.reporter.plan(indent, node.end - node.start + 1)
        break

      case TokenKind.TAP_SUBTEST_POINT:
        this.reporter.subtest(indent, node.name)
        break

      case TokenKind.TAP_TEST_POINT:
        // eslint-disable-next-line no-case-declarations
        const { todo, skip, pass } = node.status
        // eslint-disable-next-line no-case-declarations
        let directive

        if (skip) {
          directive = this.reporter.getSkip(node.reason)
        } else if (todo) {
          directive = this.reporter.getTodo(node.reason)
        } else {
          directive = kEmptyObject
        }

        if (pass) {
          this.reporter.ok(
            indent,
            node.id,
            node.description,
            details(node.diagnostics),
            directive
          )
        } else {
          this.reporter.fail(
            indent,
            node.id,
            node.description,
            details(node.diagnostics),
            directive
          )
        }
        break

      case TokenKind.COMMENT:
        if (indent === kDefaultIndent) {
          // Ignore file top level diagnostics
          break
        }
        this.reporter.diagnostic(indent, node.comment)
        break

      case TokenKind.UNKNOWN:
        this.reporter.diagnostic(indent, node.value)
        break
    }
  }

  addToReport (ast) {
    if (!this.isClearToSend()) {
      ArrayPrototypePush(this.#buffer, ast)
      return
    }
    this.reportSubtest()
    this.#handleReportItem(ast)
  }

  report () {
    this.reportSubtest()
    ArrayPrototypeForEach(this.#buffer, (ast) => this.#handleReportItem(ast))
    super.report()
  }
}

function runTestFile (path, root, inspectPort, filesWatcher) {
  const subtest = root.createSubtest(FileTest, path, async (t) => {
    const args = getRunArgs({ path, inspectPort })
    const stdio = ['pipe', 'pipe', 'pipe']
    const env = { ...process.env }
    if (filesWatcher) {
      stdio.push('ipc')
      env.WATCH_REPORT_DEPENDENCIES = '1'
    }

    const child = spawn(process.execPath, args, { signal: t.signal, encoding: 'utf8', env, stdio })

    let err

    filesWatcher?.watchChildProcessModules(child, path)

    child.on('error', (error) => {
      err = error
    })

    if (isUsingInspector()) {
      const rl = createInterface({ input: child.stderr })
      rl.on('line', (line) => {
        if (isInspectorMessage(line)) {
          process.stderr.write(line + '\n')
        }
      })
    }

    const parser = new TapParser()
    child.stderr.pipe(parser).on('data', (ast) => {
      if (ast.lexeme && isInspectorMessage(ast.lexeme)) {
        process.stderr.write(ast.lexeme + '\n')
      }
    })

    child.stdout.pipe(parser).on('data', (ast) => {
      subtest.addToReport(ast)
    })

    const { 0: { 0: code, 1: signal } } = await SafePromiseAll([
      once(child, 'exit', { signal: t.signal }),
      toArray.call(child.stdout, { signal: t.signal })
    ])

    if (code !== 0 || signal !== null) {
      if (!err) {
        err = ObjectAssign(new ERR_TEST_FAILURE('test failed', kSubtestsFailed), {
          __proto__: null,
          exitCode: code,
          signal,
          // The stack will not be useful since the failures came from tests
          // in a child process.
          stack: undefined
        })
      }

      throw err
    }
  })
  return subtest.start()
}

function run (options) {
  if (options === null || typeof options !== 'object') {
    options = kEmptyObject
  }
  const { concurrency, timeout, signal, files, inspectPort } = options

  if (files != null) {
    validateArray(files, 'options.files')
  }

  const root = createTestTree({ concurrency, timeout, signal })
  const testFiles = files ?? createTestFileList()

  PromisePrototypeThen(SafePromiseAll(testFiles, (path) => runTestFile(path, root, inspectPort)),
    () => root.postRun())

  return root.reporter
}

module.exports = { run }