All files / lib/internal/test_runner tap_stream.js

95.53% Statements 214/224
92.98% Branches 53/57
94.44% Functions 17/18
95.53% Lines 214/224

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 22529x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 73x 73x 73x 73x 73x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 69x 69x 69x             69x 29x 29x     29x 29x 73x 73x 29x 29x 209x 209x 29x 29x 43x 43x 43x 43x 29x 29x 35x 35x 29x 29x 10x 10x 29x 29x 282x 282x 29x 29x 282x 282x 282x 282x 282x 282x 282x 29x 29x 197x 197x 29x 29x 26x 26x 29x 29x 282x 282x 282x 282x 282x 282x 282x 45x 45x 282x 282x 282x 282x 29x 29x 1112x 1112x 1112x     1112x 1112x 1112x 29x 29x 29x 787x 787x 787x 787x 787x 29x 807x 807x 215x 215x 592x 703x 519x 519x 519x 288x 288x 231x 231x 231x 519x 216x 216x 15x 15x 15x 378x 178x 178x 15x 15x 15x 73x 73x 73x 73x 73x 599x 243x 243x 243x 146x 146x 97x 97x 97x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 73x 38x 38x 38x 38x 73x 73x 73x 73x 73x 73x 73x 73x 67x 67x 67x 67x 67x 361x 361x 361x 361x 361x 279x 279x 361x 67x 67x 67x 46x 46x 46x 46x 46x 67x 73x 73x 73x 807x 29x 29x  
'use strict';
const {
  ArrayPrototypeForEach,
  ArrayPrototypeJoin,
  ArrayPrototypePush,
  ArrayPrototypeShift,
  ObjectEntries,
  StringPrototypeReplaceAll,
  StringPrototypeSplit,
  RegExpPrototypeSymbolReplace,
} = primordials;
const { inspectWithNoCustomRetry } = require('internal/errors');
const Readable = require('internal/streams/readable');
const { isError } = require('internal/util');
const kFrameStartRegExp = /^ {4}at /;
const kLineBreakRegExp = /\n|\r\n/;
const inspectOptions = { colors: false, breakLength: Infinity };
let testModule; // Lazy loaded due to circular dependency.
 
function lazyLoadTest() {
  testModule ??= require('internal/test_runner/test');
 
  return testModule;
}
 
class TapStream extends Readable {
  #buffer;
  #canPush;
 
  constructor() {
    super();
    this.#buffer = [];
    this.#canPush = true;
  }
 
  _read() {
    this.#canPush = true;
 
    while (this.#buffer.length > 0) {
      const line = ArrayPrototypeShift(this.#buffer);

      if (!this.#tryPush(line)) {
        return;
      }
    }
  }
 
  bail(message) {
    this.#tryPush(`Bail out!${message ? ` ${tapEscape(message)}` : ''}\n`);
  }
 
  fail(indent, testNumber, description, directive) {
    this.#test(indent, testNumber, 'not ok', description, directive);
  }
 
  ok(indent, testNumber, description, directive) {
    this.#test(indent, testNumber, 'ok', description, directive);
  }
 
  plan(indent, count, explanation) {
    const exp = `${explanation ? ` # ${tapEscape(explanation)}` : ''}`;
 
    this.#tryPush(`${indent}1..${count}${exp}\n`);
  }
 
  getSkip(reason) {
    return `SKIP${reason ? ` ${tapEscape(reason)}` : ''}`;
  }
 
  getTodo(reason) {
    return `TODO${reason ? ` ${tapEscape(reason)}` : ''}`;
  }
 
  subtest(indent, name) {
    this.#tryPush(`${indent}# Subtest: ${tapEscape(name)}\n`);
  }
 
  details(indent, duration, error) {
    let details = `${indent}  ---\n`;
 
    details += jsToYaml(indent, 'duration_ms', duration);
    details += jsToYaml(indent, null, error);
    details += `${indent}  ...\n`;
    this.#tryPush(details);
  }
 
  diagnostic(indent, message) {
    this.#tryPush(`${indent}# ${tapEscape(message)}\n`);
  }
 
  version() {
    this.#tryPush('TAP version 13\n');
  }
 
  #test(indent, testNumber, status, description, directive) {
    let line = `${indent}${status} ${testNumber}`;
 
    if (description) {
      line += ` ${tapEscape(description)}`;
    }
 
    if (directive) {
      line += ` # ${directive}`;
    }
 
    line += '\n';
    this.#tryPush(line);
  }
 
  #tryPush(message) {
    if (this.#canPush) {
      this.#canPush = this.push(message);
    } else {
      ArrayPrototypePush(this.#buffer, message);
    }
 
    return this.#canPush;
  }
}
 
// In certain places, # and \ need to be escaped as \# and \\.
function tapEscape(input) {
  return StringPrototypeReplaceAll(
    StringPrototypeReplaceAll(input, '\\', '\\\\'), '#', '\\#'
  );
}
 
function jsToYaml(indent, name, value) {
  if (value === null || value === undefined) {
    return '';
  }
 
  if (typeof value !== 'object') {
    const prefix = `${indent}  ${name}: `;
 
    if (typeof value !== 'string') {
      return `${prefix}${inspectWithNoCustomRetry(value, inspectOptions)}\n`;
    }
 
    const lines = StringPrototypeSplit(value, kLineBreakRegExp);
 
    if (lines.length === 1) {
      return `${prefix}${inspectWithNoCustomRetry(value, inspectOptions)}\n`;
    }
 
    let str = `${prefix}|-\n`;
 
    for (let i = 0; i < lines.length; i++) {
      str += `${indent}    ${lines[i]}\n`;
    }
 
    return str;
  }
 
  const entries = ObjectEntries(value);
  const isErrorObj = isError(value);
  let result = '';
 
  for (let i = 0; i < entries.length; i++) {
    const { 0: key, 1: value } = entries[i];
 
    if (isErrorObj && (key === 'cause' || key === 'code')) {
      continue;
    }
 
    result += jsToYaml(indent, key, value);
  }
 
  if (isErrorObj) {
    const { kTestCodeFailure } = lazyLoadTest();
    const {
      cause,
      code,
      failureType,
      message,
      stack,
    } = value;
    let errMsg = message ?? '<unknown error>';
    let errStack = stack;
    let errCode = code;
 
    // If the ERR_TEST_FAILURE came from an error provided by user code,
    // then try to unwrap the original error message and stack.
    if (code === 'ERR_TEST_FAILURE' && failureType === kTestCodeFailure) {
      errMsg = cause?.message ?? errMsg;
      errStack = cause?.stack ?? errStack;
      errCode = cause?.code ?? errCode;
    }
 
    result += jsToYaml(indent, 'error', errMsg);
 
    if (errCode) {
      result += jsToYaml(indent, 'code', errCode);
    }
 
    if (typeof errStack === 'string') {
      const frames = [];
 
      ArrayPrototypeForEach(
        StringPrototypeSplit(errStack, kLineBreakRegExp),
        (frame) => {
          const processed = RegExpPrototypeSymbolReplace(
            kFrameStartRegExp, frame, ''
          );
 
          if (processed.length > 0 && processed.length !== frame.length) {
            ArrayPrototypePush(frames, processed);
          }
        }
      );
 
      if (frames.length > 0) {
        const frameDelimiter = `\n${indent}    `;
 
        result += `${indent}  stack: |-${frameDelimiter}`;
        result += `${ArrayPrototypeJoin(frames, `${frameDelimiter}`)}\n`;
      }
    }
  }
 
  return result;
}
 
module.exports = { TapStream };