@plugjs/expect5/src/execution/executor.ts

Unit Testing for the PlugJS Build System ========================================

import assert from 'node:assert'
import { EventEmitter } from 'node:events'

import { Hook, Spec, Suite } from './executable'

import type { Executor } from './executable'

/* ========================================================================== */

export interface ExecutionFailure {
  number: number,
  error: Error,
  source: Suite | Spec | Hook,
  type: 'suite' | 'spec' | 'hook',
}

export interface ExecutionEvents {
  'suite:start': (suite: Suite) => void
  'suite:done': (suite: Suite, time: number) => void

  'spec:start': (spec: Spec) => void
  'spec:error': (spec: Spec, failure: ExecutionFailure) => void
  'spec:skip': (spec: Spec, time: number) => void
  'spec:pass': (spec: Spec, time: number, slow: boolean) => void
  'spec:fail': (spec: Spec, time: number, failure: ExecutionFailure) => void

  'hook:start': (hook: Hook) => void
  'hook:error': (hook: Hook, failure: ExecutionFailure) => void
  'hook:skip': (hook: Hook, time: number) => void
  'hook:pass': (hook: Hook, time: number) => void
  'hook:fail': (hook: Hook, time: number, failure: ExecutionFailure) => void
}

interface SuiteRecord {
  type: 'suite'
  name: string
  records: (SuiteRecord | SpecRecord | HookRecord)[]
}

interface SpecRecord {
  type: 'spec'
  name: string
  result: 'passed' | 'failed' | 'skipped'
  failure?: number
  slow?: boolean
  ms: number
}

interface HookRecord {
  type: 'hook'
  name: string
  result: 'failed'
  failure: number
}

export type Record = SuiteRecord | SpecRecord | HookRecord

export interface Execution {
  on<E extends keyof ExecutionEvents>(event: E, listener: ExecutionEvents[E]): this
  off<E extends keyof ExecutionEvents>(event: E, listener: ExecutionEvents[E]): this
  once<E extends keyof ExecutionEvents>(event: E, listener: ExecutionEvents[E]): this
  result: Promise<ExecutionResult>
}

export interface ExecutionResult {
  passed: number
  failed: number
  skipped: number
  time: number
  failures: ExecutionFailure[]
  records: Record[]
}

/* ========================================================================== */

export function runSuite(suite: Suite): Execution {
  const _emitter = new EventEmitter()

  let resolve: (value: ExecutionResult | PromiseLike<ExecutionResult>) => void
  let reject: (reason?: any) => void
  const promise = new Promise<ExecutionResult>((_resolve, _reject) => {
    resolve = _resolve
    reject = _reject
  })

  const result: ExecutionResult = {
    time: 0,
    passed: 0,
    failed: 0,
    skipped: 0,
    failures: [],
    records: [],
  }

  const execution: Execution = {
    result: promise,
    on: (event: string, listener: (...args: any[]) => void): Execution => {
      _emitter.on(event, listener)
      return execution
    },
    off: (event: string, listener: (...args: any[]) => void): Execution => {
      _emitter.off(event, listener)
      return execution
    },
    once: (event: string, listener: (...args: any[]) => void): Execution => {
      _emitter.once(event, listener)
      return execution
    },
  }

  const start = (executable: Suite | Spec | Hook): ReturnType<Executor['start']> => {
    const type: 'suite' | 'spec' | 'hook' =
      executable instanceof Suite ? 'suite' :
      executable instanceof Spec ? 'spec' :
      executable instanceof Hook ? 'hook' :
      /* coverage ignore next */
      assert.fail(`Unable to start ${Object.getPrototypeOf(executable)?.constructor?.name}`)

    const now = Date.now()
    _emitter.emit(`${type}:start`, executable)

    let done = false
    let failure: ExecutionFailure | undefined

    return {
      done(skipped: boolean = false): void {
        const time = Date.now() - now
        done = true

        if (type === 'suite') {
          _emitter.emit(`${type}:done`, executable, time)
          return
        }

        if (failure) {
          _emitter.emit(`${type}:fail`, executable, time, failure)
          if (type === 'spec') result.failed ++
        } else if (skipped) {
          _emitter.emit(`${type}:skip`, executable, time)
          if (type === 'spec') result.skipped ++
        } else {
          const slow = time >= (executable.timeout * 0.75)
          _emitter.emit(`${type}:pass`, executable, time, slow)
          if (type === 'spec') result.passed ++
        }
      },
      notify(error: Error): void {
        const number = result.failures.length + 1
        const fail = { error, number, source: executable, type }
        result.failures.push(fail)

        // notify error after done, or include in failure?
        if (failure || done) {
          _emitter.emit(`${type}:error`, executable, fail)
        } else {
          failure = fail
        }
      },
    }
  }

  // Record of all our suites / specs / hooks
  const suiteRecords: SuiteRecord[] = [ { type: 'suite', name: '', records: [] } ]

  execution.on('suite:start', (current) => {
    const record: SuiteRecord = { type: 'suite', name: current.name, records: [] }
    suiteRecords[suiteRecords.length - 1]!.records.push(record)
    suiteRecords.push(record)
  })

  execution.on('suite:done', () => {
    if (suiteRecords.length > 1) suiteRecords.pop()
  })

  execution.on('spec:skip', (spec, ms) => {
    const record: SpecRecord = { type: 'spec', name: spec.name, result: 'skipped', ms }
    suiteRecords[suiteRecords.length - 1]!.records.push(record)
  })

  execution.on('spec:pass', (spec, ms) => {
    const record: SpecRecord = { type: 'spec', name: spec.name, result: 'passed', ms }
    suiteRecords[suiteRecords.length - 1]!.records.push(record)
    if (ms >= (spec.timeout * 0.75)) record.slow = true
  })

  execution.on('spec:fail', (spec, ms, { number }) => {
    const record: SpecRecord = { type: 'spec', name: spec.name, result: 'failed', failure: number, ms }
    suiteRecords[suiteRecords.length - 1]!.records.push(record)
  })

  execution.on('hook:fail', (hook, _, { number }) => {
    const record: HookRecord = { type: 'hook', name: hook.name, result: 'failed', failure: number }
    suiteRecords[suiteRecords.length - 1]!.records.push(record)
  })

  // Start the execution
  setImmediate(() => Promise.resolve().then(async () => {
    const now = Date.now()
    await suite.setup()
    await suite.execute({ start })

    result.time = Date.now() - now
    result.records.push(...suiteRecords[0]!.records)

    resolve(result)
  }).catch((error) => reject(error)))

  return execution
}