All files / lib/internal/test_runner test.js

100% Statements 482/482
98.34% Branches 119/121
96.96% Functions 32/33
100% Lines 482/482

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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 48329x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 29x 204x 204x 204x 204x 204x 204x 204x 204x 3x 3x 204x 204x 5x 5x 204x 204x 4x 4x 204x 204x 4x 4x 204x 204x 28x 28x 28x 28x 28x 204x 29x 29x 29x 297x 297x 297x 297x 297x 297x 80x 80x 297x 297x 12x 12x 297x 297x 29x 29x 297x 297x 29x 29x 29x 29x 29x 29x 29x 281x 268x 268x 268x 268x 268x 268x 268x 268x 268x 268x 268x 297x 297x 4x 4x 297x 297x 13x 13x 297x 297x 31x 31x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 297x 29x 29x 613x 613x 29x 29x 186x 186x 29x 29x 287x 186x 186x 183x 183x 287x 29x 29x 287x 287x 29x 29x 555x 555x 555x 555x 375x 375x 375x 375x 375x 375x 74x 74x 301x 301x 301x 301x 301x 375x 375x 375x 33x 33x 268x 375x 14x 14x 268x 268x 268x 268x 268x 555x 29x 29x 268x 4x 268x 4x 4x 264x 197x 197x 268x 268x 231x 231x 268x 268x 268x 268x 268x 268x 2x 2x 2x 2x 268x 268x 268x 268x 40x 40x 268x 268x 2x 2x 2x 2x 2x 2x 2x 2x 268x 268x 268x 268x 29x 29x 23x 17x 17x 6x 6x 6x 6x 6x 6x 6x 6x 23x 29x 29x 66x 3x 3x 63x 63x 63x 63x 66x 29x 29x 213x 3x 3x 210x 210x 210x 213x 29x 29x 4x 4x 4x 29x 29x 4x 4x 4x 29x 29x 15x 15x 29x 29x 252x 252x 252x 252x 186x 186x 186x 186x 186x 186x 66x 66x 252x 29x 29x 204x 204x 204x 29x 29x 261x 261x 261x 261x 261x 261x 261x 261x 20x 20x 20x 20x 20x 20x 20x 2x 2x 2x 2x 2x 20x 14x 10x 261x 241x 241x 197x 207x 207x 258x 47x 8x 47x 39x 39x 47x 254x 254x 254x 254x 261x 29x 29x 313x 313x 313x 313x 313x 1x 1x 313x 313x 313x 313x 268x 268x 268x 23x 23x 23x 268x 268x 63x 63x 268x 313x 313x 5x 5x 5x 5x 5x 313x 313x 287x 287x 287x 287x 287x 313x 29x 29x 284x 54x 54x 284x 284x 29x 29x 268x 268x 268x 268x 268x 268x 268x 268x 268x 268x 268x 268x 14x 267x 254x 254x 268x 268x 268x 268x 268x 29x 29x 268x 268x 268x 268x 268x 268x 35x 268x 10x 10x 268x 268x 205x 268x 63x 63x 268x 268x 268x 268x 3x 3x 268x 29x 29x 29x 29x 29x 57x 57x 29x 29x 29x 6x 6x 6x 6x 6x 6x 29x 29x 5x 5x 29x 29x 6x 6x 6x 6x 10x 10x 6x 6x 6x 6x 29x 29x 29x  
'use strict';
const {
  ArrayPrototypePush,
  ArrayPrototypeReduce,
  ArrayPrototypeShift,
  ArrayPrototypeUnshift,
  FunctionPrototype,
  Number,
  PromiseResolve,
  ReflectApply,
  SafeMap,
} = primordials;
const { AsyncResource } = require('async_hooks');
const {
  codes: {
    ERR_TEST_FAILURE,
  },
  kIsNodeError,
} = require('internal/errors');
const { getOptionValue } = require('internal/options');
const { TapStream } = require('internal/test_runner/tap_stream');
const { createDeferredCallback } = require('internal/test_runner/utils');
const {
  createDeferredPromise,
  kEmptyObject,
} = require('internal/util');
const { isPromise } = require('internal/util/types');
const { isUint32 } = require('internal/validators');
const { cpus } = require('os');
const { bigint: hrtime } = process.hrtime;
const kCallbackAndPromisePresent = 'callbackAndPromisePresent';
const kCancelledByParent = 'cancelledByParent';
const kParentAlreadyFinished = 'parentAlreadyFinished';
const kSubtestsFailed = 'subtestsFailed';
const kTestCodeFailure = 'testCodeFailure';
const kDefaultIndent = '    ';
const noop = FunctionPrototype;
const isTestRunner = getOptionValue('--test');
const testOnlyFlag = !isTestRunner && getOptionValue('--test-only');
// TODO(cjihrig): Use uv_available_parallelism() once it lands.
const rootConcurrency = isTestRunner ? cpus().length : 1;
 
class TestContext {
  #test;
 
  constructor(test) {
    this.#test = test;
  }
 
  diagnostic(message) {
    this.#test.diagnostic(message);
  }
 
  runOnly(value) {
    this.#test.runOnlySubtests = !!value;
  }
 
  skip(message) {
    this.#test.skip(message);
  }
 
  todo(message) {
    this.#test.todo(message);
  }
 
  test(name, options, fn) {
    // eslint-disable-next-line no-use-before-define
    const subtest = this.#test.createSubtest(Test, name, options, fn);
 
    return subtest.start();
  }
}
 
class Test extends AsyncResource {
  constructor(options) {
    super('Test');
 
    let { fn, name, parent, skip } = options;
    const { concurrency, only, todo } = options;
 
    if (typeof fn !== 'function') {
      fn = noop;
    }
 
    if (typeof name !== 'string' || name === '') {
      name = fn.name || '<anonymous>';
    }
 
    if (!(parent instanceof Test)) {
      parent = null;
    }
 
    if (parent === null) {
      this.concurrency = rootConcurrency;
      this.indent = '';
      this.indentString = kDefaultIndent;
      this.only = testOnlyFlag;
      this.reporter = new TapStream();
      this.runOnlySubtests = this.only;
      this.testNumber = 0;
    } else {
      const indent = parent.parent === null ? parent.indent :
        parent.indent + parent.indentString;
 
      this.concurrency = parent.concurrency;
      this.indent = indent;
      this.indentString = parent.indentString;
      this.only = only ?? !parent.runOnlySubtests;
      this.reporter = parent.reporter;
      this.runOnlySubtests = !this.only;
      this.testNumber = parent.subtests.length + 1;
    }
 
    if (isUint32(concurrency) && concurrency !== 0) {
      this.concurrency = concurrency;
    }
 
    if (testOnlyFlag && !this.only) {
      skip = '\'only\' option not set';
    }
 
    if (skip) {
      fn = noop;
    }
 
    this.fn = fn;
    this.name = name;
    this.parent = parent;
    this.cancelled = false;
    this.skipped = !!skip;
    this.isTodo = !!todo;
    this.startTime = null;
    this.endTime = null;
    this.passed = false;
    this.error = null;
    this.diagnostics = [];
    this.message = typeof skip === 'string' ? skip :
      typeof todo === 'string' ? todo : null;
    this.activeSubtests = 0;
    this.pendingSubtests = [];
    this.readySubtests = new SafeMap();
    this.subtests = [];
    this.waitingOn = 0;
    this.finished = false;
  }
 
  hasConcurrency() {
    return this.concurrency > this.activeSubtests;
  }
 
  addPendingSubtest(deferred) {
    this.pendingSubtests.push(deferred);
  }
 
  async processPendingSubtests() {
    while (this.pendingSubtests.length > 0 && this.hasConcurrency()) {
      const deferred = ArrayPrototypeShift(this.pendingSubtests);
      await deferred.test.run();
      deferred.resolve();
    }
  }
 
  addReadySubtest(subtest) {
    this.readySubtests.set(subtest.testNumber, subtest);
  }
 
  processReadySubtestRange(canSend) {
    const start = this.waitingOn;
    const end = start + this.readySubtests.size;
 
    for (let i = start; i < end; i++) {
      const subtest = this.readySubtests.get(i);
 
      // Check if the specified subtest is in the map. If it is not, return
      // early to avoid trying to process any more tests since they would be
      // out of order.
      if (subtest === undefined) {
        return;
      }
 
      // Call isClearToSend() in the loop so that it is:
      // - Only called if there are results to report in the correct order.
      // - Guaranteed to only be called a maximum of once per call to
      //   processReadySubtestRange().
      canSend = canSend || this.isClearToSend();
 
      if (!canSend) {
        return;
      }
 
      if (i === 1 && this.parent !== null) {
        this.reporter.subtest(this.indent, this.name);
      }
 
      // Report the subtest's results and remove it from the ready map.
      subtest.finalize();
      this.readySubtests.delete(i);
    }
  }
 
  createSubtest(Factory, name, options, fn, overrides) {
    if (typeof name === 'function') {
      fn = name;
    } else if (name !== null && typeof name === 'object') {
      fn = options;
      options = name;
    } else if (typeof options === 'function') {
      fn = options;
    }
 
    if (options === null || typeof options !== 'object') {
      options = kEmptyObject;
    }
 
    let parent = this;
 
    // If this test has already ended, attach this test to the root test so
    // that the error can be properly reported.
    if (this.finished) {
      while (parent.parent !== null) {
        parent = parent.parent;
      }
    }
 
    const test = new Factory({ __proto__: null, fn, name, parent, ...options, ...overrides });
 
    if (parent.waitingOn === 0) {
      parent.waitingOn = test.testNumber;
    }
 
    if (this.finished) {
      test.startTime = test.startTime || hrtime();
      test.fail(
        new ERR_TEST_FAILURE(
          'test could not be started because its parent finished',
          kParentAlreadyFinished
        )
      );
    }
 
    ArrayPrototypePush(parent.subtests, test);
    return test;
  }
 
  cancel() {
    if (this.endTime !== null) {
      return;
    }
 
    this.fail(
      new ERR_TEST_FAILURE(
        'test did not finish before its parent and was cancelled',
        kCancelledByParent
      )
    );
    this.cancelled = true;
  }
 
  fail(err) {
    if (this.error !== null) {
      return;
    }
 
    this.endTime = hrtime();
    this.passed = false;
    this.error = err;
  }
 
  pass() {
    if (this.endTime !== null) {
      return;
    }
 
    this.endTime = hrtime();
    this.passed = true;
  }
 
  skip(message) {
    this.skipped = true;
    this.message = message;
  }
 
  todo(message) {
    this.isTodo = true;
    this.message = message;
  }
 
  diagnostic(message) {
    ArrayPrototypePush(this.diagnostics, message);
  }
 
  start() {
    // If there is enough available concurrency to run the test now, then do
    // it. Otherwise, return a Promise to the caller and mark the test as
    // pending for later execution.
    if (!this.parent.hasConcurrency()) {
      const deferred = createDeferredPromise();
 
      deferred.test = this;
      this.parent.addPendingSubtest(deferred);
      return deferred.promise;
    }
 
    return this.run();
  }
 
  getRunArgs() {
    const ctx = new TestContext(this);
    return { ctx, args: [ctx] };
  }
 
  async run() {
    this.parent.activeSubtests++;
    this.startTime = hrtime();
 
    try {
      const { args, ctx } = this.getRunArgs();
      ArrayPrototypeUnshift(args, this.fn, ctx); // Note that if it's not OK to mutate args, we need to first clone it.
 
      if (this.fn.length === args.length - 1) {
        // This test is using legacy Node.js error first callbacks.
        const { promise, cb } = createDeferredCallback();
 
        ArrayPrototypePush(args, cb);
        const ret = ReflectApply(this.runInAsyncScope, this, args);
 
        if (isPromise(ret)) {
          this.fail(new ERR_TEST_FAILURE(
            'passed a callback but also returned a Promise',
            kCallbackAndPromisePresent
          ));
          await ret;
        } else {
          await promise;
        }
      } else {
        // This test is synchronous or using Promises.
        await ReflectApply(this.runInAsyncScope, this, args);
      }
 
      this.pass();
    } catch (err) {
      if (err?.code === 'ERR_TEST_FAILURE' && kIsNodeError in err) {
        this.fail(err);
      } else {
        this.fail(new ERR_TEST_FAILURE(err, kTestCodeFailure));
      }
    }
 
    // Clean up the test. Then, try to report the results and execute any
    // tests that were pending due to available concurrency.
    this.postRun();
  }
 
  postRun() {
    let failedSubtests = 0;
 
    // If the test was failed before it even started, then the end time will
    // be earlier than the start time. Correct that here.
    if (this.endTime < this.startTime) {
      this.endTime = hrtime();
    }
 
    // The test has run, so recursively cancel any outstanding subtests and
    // mark this test as failed if any subtests failed.
    for (let i = 0; i < this.subtests.length; i++) {
      const subtest = this.subtests[i];
 
      if (!subtest.finished) {
        subtest.cancel();
        subtest.postRun();
      }
 
      if (!subtest.passed) {
        failedSubtests++;
      }
    }
 
    if (this.passed && failedSubtests > 0) {
      const subtestString = `subtest${failedSubtests > 1 ? 's' : ''}`;
      const msg = `${failedSubtests} ${subtestString} failed`;
 
      this.fail(new ERR_TEST_FAILURE(msg, kSubtestsFailed));
    }
 
    if (this.parent !== null) {
      this.parent.activeSubtests--;
      this.parent.addReadySubtest(this);
      this.parent.processReadySubtestRange(false);
      this.parent.processPendingSubtests();
    }
  }
 
  isClearToSend() {
    return this.parent === null ||
      (
        this.parent.waitingOn === this.testNumber && this.parent.isClearToSend()
      );
  }
 
  finalize() {
    // By the time this function is called, the following can be relied on:
    // - The current test has completed or been cancelled.
    // - All of this test's subtests have completed or been cancelled.
    // - It is the current test's turn to report its results.
 
    // Report any subtests that have not been reported yet. Since all of the
    // subtests have finished, it's safe to pass true to
    // processReadySubtestRange(), which will finalize all remaining subtests.
    this.processReadySubtestRange(true);
 
    // Output this test's results and update the parent's waiting counter.
    if (this.subtests.length > 0) {
      this.reporter.plan(this.subtests[0].indent, this.subtests.length);
    } else {
      this.reporter.subtest(this.indent, this.name);
    }
 
    this.report();
    this.parent.waitingOn++;
    this.finished = true;
  }
 
  report() {
    // Duration is recorded in BigInt nanoseconds. Convert to seconds.
    const duration = Number(this.endTime - this.startTime) / 1_000_000_000;
    const message = `- ${this.name}`;
    let directive;
 
    if (this.skipped) {
      directive = this.reporter.getSkip(this.message);
    } else if (this.isTodo) {
      directive = this.reporter.getTodo(this.message);
    }
 
    if (this.passed) {
      this.reporter.ok(this.indent, this.testNumber, message, directive);
    } else {
      this.reporter.fail(this.indent, this.testNumber, message, directive);
    }
 
    this.reporter.details(this.indent, duration, this.error);
 
    for (let i = 0; i < this.diagnostics.length; i++) {
      this.reporter.diagnostic(this.indent, this.diagnostics[i]);
    }
  }
}
 
class ItTest extends Test {
  constructor(opt) { super(opt); } // eslint-disable-line no-useless-constructor
  getRunArgs() {
    return { ctx: {}, args: [] };
  }
}
class Suite extends Test {
  constructor(options) {
    super(options);
 
    this.runInAsyncScope(this.fn);
    this.fn = () => {};
    this.finished = true; // Forbid adding subtests to this suite
  }
 
  start() {
    return this.run();
  }
 
  async run() {
    this.parent.activeSubtests++;
    this.startTime = hrtime();
    const subtests = this.skipped ? [] : this.subtests;
    await ArrayPrototypeReduce(subtests, async (prev, subtest) => {
      await prev;
      await subtest.run();
    }, PromiseResolve());
    this.pass();
    this.postRun();
  }
}
 
module.exports = { kDefaultIndent, kSubtestsFailed, kTestCodeFailure, Test, Suite, ItTest };