@small-tech/tap-monkey/tests/index.js

A tap formatter that’s also a monkey.

import test from 'tape'
import tapMonkey from '../index.js'
import { context } from '../index.js'
import strip from 'strip-ansi'

// Since Tap Monkey pipes stdin, this will leave a handle open.
// We have to destroy stdin when all tests are done for the 
// runner to exit properly.
// See https://github.com/nodejs/node/issues/32291

test.onFinish(() => {
  process.stdin.destroy()
})

//
// Test handler and general tests.
//

test('test handler', t => {
  context.quiet = false
  tapMonkey.testHandler({name: 'mock'})
  tapMonkey.spinner.stop()

  t.strictEquals(tapMonkey.spinner._spinner.interval, 300, 'spinner interval is as expected')
  t.strictEquals(tapMonkey.spinner._spinner.frames[0], '  🙈 ', 'animation frame 1 is correct')
  t.strictEquals(tapMonkey.spinner._spinner.frames[1], '  🙈 ', 'animation frame 2 is correct')
  t.strictEquals(tapMonkey.spinner._spinner.frames[2], '  🙉 ', 'animation frame 3 is correct')
  t.strictEquals(tapMonkey.spinner._spinner.frames[3], '  🙊 ', 'animation frame 4 is correct')

  t.true(strip(tapMonkey.spinner.text).includes('Running mock tests'), 'test name is displayed correctly')
  
  context.quiet = true
  tapMonkey.testHandler({name: 'quiet mock'})
  tapMonkey.spinner.stop()
  
  t.false(strip(tapMonkey.spinner.text).includes('Running quiet mock tests'), 'test name not displayed in quiet mode')
    
  t.end()
})

//
// Pass handler tests.
//

test('pass handler', t => {
  // Quiet passes (the default)
  context.quiet = true
  const quietPass = 'a quiet pass'
  tapMonkey.passHandler({ name: quietPass })
  t.false(tapMonkey.spinner.text.includes(quietPass), 'quiet mode should not display passed tests')
  
  // Loud passes.
  context.quiet = false
  const loudPass = 'a loud pass'
  tapMonkey.passHandler({ name: loudPass })
  t.true(tapMonkey.spinner.text.includes(loudPass), 'passed tests should display when quiet mode is off')
  
  t.end()
})

//
// Fail handler tests.
//

test('fail handler', t => {
  // Capture console log temporarily.
  const originalConsoleLog = console.log
  let output = ''
  const capturedConsoleLog = (...args) => output += args.join(' ')
  console.log = capturedConsoleLog

  const mockAssertionWithTypeError = {
    type: 'assert',
    raw: 'not ok 2 TypeError: Cannot convert undefined or null to object',
    ok: false,
    number: 2,
    name: 'TypeError: Cannot convert undefined or null to object',
    error: {
      operator: 'error',
      expected: undefined,
      actual: undefined,
      at: {
        file: '/var/home/aral/Projects/nodekit/node_modules/tape-promise/node_modules/onetime/index.js',
        line: '30',
        character: '12'
      },
      stack: 'TypeError: Cannot convert undefined or null to object\n' +
        'at Function.keys (<anonymous>)\n' +
        'at sortResults (file:///var/home/aral/Projects/nodekit/tests/files.js:17:10)\n' +
        'at file:///var/home/aral/Projects/nodekit/tests/files.js:101:58\n' +
        'at processTicksAndRejections (node:internal/process/task_queues:96:5)\n',
      raw: '    operator: error\n' +
        '    at: bound (/var/home/aral/Projects/nodekit/node_modules/tape-promise/node_modules/onetime/index.js:30:12)\n' +
        '    stack: |-\n' +
        'TypeError: Cannot convert undefined or null to object\n' +
        'at Function.keys (<anonymous>)\n' +
        'at sortResults (file:///var/home/aral/Projects/nodekit/tests/files.js:17:10)\n' +
        'at file:///var/home/aral/Projects/nodekit/tests/files.js:101:58\n' +
        'at processTicksAndRejections (node:internal/process/task_queues:96:5)'
    },
    test: 10
  }

  tapMonkey.failHandler(mockAssertionWithTypeError)
  tapMonkey.spinner.stop()
  console.log = originalConsoleLog

  t.true(output.includes('TypeError: Cannot convert undefined or null to object'), 'output includes main error message')
  t.true(output.includes('~/Projects/nodekit/node_modules/tape-promise/node_modules/onetime/index.js:30:12'), 'error location shown')
  
  // Test a regular assertion failure.
  
  output = ''
  console.log = capturedConsoleLog
  
  const regularFailedAssertion = {
    type: 'assert',
    raw: 'not ok 8 quiet mode should not display passed tests',
    ok: false,
    number: 8,
    name: 'quiet mode should not display passed tests',
    error: {
      operator: 'ok',
      expected: 'true',
      actual: 'false',
      at: undefined,
      stack: 'Error: quiet mode should not display passed tests\n' +
        'at Test.assert [as _assert] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:314:54)\n' +
        'at Test.bound [as _assert] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.assert (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:433:10)\n' +
        'at Test.bound [as true] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.<anonymous> (file:///var/home/aral/Projects/tap-monkey/tests/index.js:50:9)\n' +
        'at Test.bound [as _cb] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.run (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:117:31)\n' +
        'at Test.bound [as run] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Immediate.next [as _onImmediate] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/results.js:88:19)\n' +
        'at processImmediate (node:internal/timers:466:21)\n',
      raw: '    operator: ok\n' +
        '    expected: true\n' +
        '    actual:   false\n' +
        '    stack: |-\n' +
        'Error: quiet mode should not display passed tests\n' +
        'at Test.assert [as _assert] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:314:54)\n' +
        'at Test.bound [as _assert] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.assert (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:433:10)\n' +
        'at Test.bound [as true] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.<anonymous> (file:///var/home/aral/Projects/tap-monkey/tests/index.js:50:9)\n' +
        'at Test.bound [as _cb] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Test.run (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:117:31)\n' +
        'at Test.bound [as run] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/test.js:99:32)\n' +
        'at Immediate.next [as _onImmediate] (/var/home/aral/Projects/tap-monkey/node_modules/tape/lib/results.js:88:19)\n' +
        'at processImmediate (node:internal/timers:466:21)'
    },
    test: 2
  }
  
  tapMonkey.failHandler(regularFailedAssertion)
  tapMonkey.spinner.stop()
  console.log = originalConsoleLog
  
  t.true(output.includes('operator: ok'), 'output should include operator')
  t.true(output.includes('expected: true'), 'output should include expected field')
  t.true(output.includes('actual  : false'), 'output should include actual field')

  t.end()
})

//
// Bail out handler tests.
//

test('bailout handler', t => {
  // Setup.
  const _error = console.error
  let output = ''
  console.error = string => output += string
  
  const _exit = process.exit
  let exitCalledWithCorrectCode = false
  process.exit = code => exitCalledWithCorrectCode = code === 1

  // Test.
  tapMonkey.spinner.start()
  const mockRaw = 'mock raw event contents'
  tapMonkey.bailOutHandler({ raw: mockRaw })
  
  t.strictEquals(tapMonkey.spinner.isSpinning, false, 'spinner has stopped')
  t.true(output.includes(mockRaw), 'output includes mock event raw string')
  t.true(exitCalledWithCorrectCode, 'exit is called')
  
  // Tear down.
  console.error = _error
  process.exit = _exit
  
  t.end()
})

//
// Comment handler tests.
//

test('comment handler', t => {
  // Setup.
  const originalConsoleLog = console.log
  const capturedConsoleLog = (...args) => output += args.join(' ')

  console.log = capturedConsoleLog
  let output = ''

  // Test regular comment.
  const regularCommentPrefix = '   🢂 '
  const regularComment = 'a regular comment'

  tapMonkey.commentHandler({ raw: regularComment })
  tapMonkey.spinner.stop()
  console.log = originalConsoleLog

  t.equals(output, `${regularCommentPrefix} ${regularComment}`, 'regular comment is formatted correctly')
  
  // Test coverage comments.
  output = ''
  console.log = capturedConsoleLog
  
  const coverageTap = [
    '----------|---------|----------|---------|---------|-----------------------',
    '   File   | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s     ',
    '----------|---------|----------|---------|---------|-----------------------',
    'All files |   70.37 |    71.42 |      50 |   70.37 |                       ',
    ' index.js |   70.37 |    71.42 |      50 |   70.37 | 59-61,105-131,135-152 ',
    '----------|---------|----------|---------|---------|-----------------------'
  ]
  
  const expectedCoverageOutput = '╭───────────┬─────────┬──────────┬─────────┬─────────┬────────────────────────╮│    File   │ % Stmts │ % Branch │ % Funcs │ % Lines │ Uncovered Line #s      │├───────────┼─────────┼──────────┼─────────┼─────────┼────────────────────────┤│ All files │   70.37 │    71.42 │      50 │   70.37 │                        ││  index.js │   70.37 │    71.42 │      50 │   70.37 │ 59─61,105─131,135─152  │╰───────────┴─────────┴──────────┴─────────┴─────────┴────────────────────────╯'
  
  coverageTap.forEach(line => {
    tapMonkey.commentHandler({ raw: line })
  })
  tapMonkey.spinner.stop()
  console.log = originalConsoleLog
  
  // Assertions.
  t.equals(output.trim(), expectedCoverageOutput, 'formatted coverage output is correct')
  
  // Test too many borders in coverage error.
  t.throws(() => {
    tapMonkey.commentHandler({ raw: coverageTap[0] })
  }, 'too many borders in coverage output error should throw')
  
  t.end()
})

//
// Output handler tests.
//

test ('output handler', t => {
  const vacuumPack = string => string.replace(/\s/g, '')
  const originalConsoleLog = console.log
  const capturedConsoleLog = (...args) => output += args.join(' ')

  console.log = capturedConsoleLog
  let output = ''
  
  // Test: all tests passing.

  const mockAllTestsPassingResults = {
    asserts: [1, 2, 3],
    pass: [1, 2, 3],
    fail: [] 
  }  

  tapMonkey.outputHandler(mockAllTestsPassingResults)
  console.log = originalConsoleLog

  t.strictEquals(tapMonkey.spinner.isSpinning, false, 'spinner has stopped')
  t.true(vacuumPack(output).includes('Alltestspassing!Total3Passing3Failing0'))
  
  // Test: failing tests.
  
  output = ''
  console.log = capturedConsoleLog
  
  const mockFailingTests = {
    asserts: [1, 2, 3],
    pass: [1],
    fail: [2, 3] 
  }
  
  tapMonkey.outputHandler(mockFailingTests)
  console.log = originalConsoleLog
  
  t.true(vacuumPack(output).includes('Therearefailedtests.Total3Passing1Failing2'))
  t.end()
})