From 95972aac8d5134a638299bb54f51b6a825c61acd Mon Sep 17 00:00:00 2001 From: Moshe Atlow Date: Thu, 4 May 2023 11:34:23 +0300 Subject: [PATCH] test: migrate a pseudo_tty test to use assertSnapshot PR-URL: https://github.com/nodejs/node/pull/47803 Reviewed-By: Geoffrey Booth Reviewed-By: Benjamin Gruenbaum --- test/common/assertSnapshot.js | 18 ++++-- .../test-runner/output/default_output.js} | 2 +- .../output/default_output.snapshot | 57 +++++++++++++++++++ test/parallel/test-runner-output.mjs | 13 +++-- .../test_runner_default_reporter.out | 57 ------------------- test/pseudo-tty/testcfg.py | 2 +- .../pty_helper.py => tools/pseudo-tty.py | 2 + 7 files changed, 83 insertions(+), 68 deletions(-) rename test/{pseudo-tty/test_runner_default_reporter.js => fixtures/test-runner/output/default_output.js} (93%) create mode 100644 test/fixtures/test-runner/output/default_output.snapshot delete mode 100644 test/pseudo-tty/test_runner_default_reporter.out rename test/pseudo-tty/pty_helper.py => tools/pseudo-tty.py (98%) mode change 100644 => 100755 diff --git a/test/common/assertSnapshot.js b/test/common/assertSnapshot.js index 962e7d649a9663..ed9db64e654dcc 100644 --- a/test/common/assertSnapshot.js +++ b/test/common/assertSnapshot.js @@ -1,14 +1,14 @@ 'use strict'; const common = require('.'); const path = require('node:path'); +const test = require('node:test'); const fs = require('node:fs/promises'); const assert = require('node:assert/strict'); - -const stackFramesRegexp = /(\s+)((.+?)\s+\()?(?:\(?(.+?):(\d+)(?::(\d+))?)\)?(\s+\{)?(\n|$)/g; +const stackFramesRegexp = /(\s+)((.+?)\s+\()?(?:\(?(.+?):(\d+)(?::(\d+))?)\)?(\s+\{)?(\[\d+m)?(\n|$)/g; const windowNewlineRegexp = /\r/g; -function replaceStackTrace(str, replacement = '$1*$7\n') { +function replaceStackTrace(str, replacement = '$1*$7$8\n') { return str.replace(stackFramesRegexp, replacement); } @@ -50,11 +50,19 @@ async function assertSnapshot(actual, filename = process.argv[1]) { * assertSnapshot.transform(assertSnapshot.replaceStackTrace, assertSnapshot.replaceWindowsLineEndings) * @param {string} filename * @param {function(string): string} [transform] + * @param {object} [options] - control how the child process is spawned + * @param {boolean} [options.tty] - whether to spawn the process in a pseudo-tty * @returns {Promise} */ -async function spawnAndAssert(filename, transform = (x) => x) { +async function spawnAndAssert(filename, transform = (x) => x, { tty = false } = {}) { + if (tty && common.isWindows) { + test({ skip: 'Skipping pseudo-tty tests, as pseudo terminals are not available on Windows.' }); + return; + } const flags = common.parseTestFlags(filename); - const { stdout, stderr } = await common.spawnPromisified(process.execPath, [...flags, filename]); + const executable = tty ? 'tools/pseudo-tty.py' : process.execPath; + const args = tty ? [process.execPath, ...flags, filename] : [...flags, filename]; + const { stdout, stderr } = await common.spawnPromisified(executable, args); await assertSnapshot(transform(`${stdout}${stderr}`), filename); } diff --git a/test/pseudo-tty/test_runner_default_reporter.js b/test/fixtures/test-runner/output/default_output.js similarity index 93% rename from test/pseudo-tty/test_runner_default_reporter.js rename to test/fixtures/test-runner/output/default_output.js index 1596603b217660..b0392f3737b1d6 100644 --- a/test/pseudo-tty/test_runner_default_reporter.js +++ b/test/fixtures/test-runner/output/default_output.js @@ -3,7 +3,7 @@ process.env.FORCE_COLOR = '1'; delete process.env.NODE_DISABLE_COLORS; delete process.env.NO_COLOR; -require('../common'); +require('../../../common'); const test = require('node:test'); test('should pass', () => {}); diff --git a/test/fixtures/test-runner/output/default_output.snapshot b/test/fixtures/test-runner/output/default_output.snapshot new file mode 100644 index 00000000000000..dca844bb8402aa --- /dev/null +++ b/test/fixtures/test-runner/output/default_output.snapshot @@ -0,0 +1,57 @@ +[32m✔ should pass [90m(*ms)[39m[39m +[31m✖ should fail [90m(*ms)[39m[39m + Error: fail + *[39m + *[39m + *[39m + *[39m + *[39m + *[39m + *[39m + +[90m﹣ should skip [90m(*ms)[39m # SKIP[39m +▶ parent + [31m✖ should fail [90m(*ms)[39m[39m + Error: fail + *[39m + *[39m + *[39m + *[39m + *[39m + + [31m✖ should pass but parent fail [90m(*ms)[39m[39m + [32m'test did not finish before its parent and was cancelled'[39m + +[31m▶ [39mparent [90m(*ms)[39m + +[34mℹ tests 6[39m +[34mℹ suites 0[39m +[34mℹ pass 1[39m +[34mℹ fail 3[39m +[34mℹ cancelled 1[39m +[34mℹ skipped 1[39m +[34mℹ todo 0[39m +[34mℹ duration_ms *[39m + +[31m✖ failing tests:[39m + +[31m✖ should fail [90m(*ms)[39m[39m + Error: fail + *[39m + *[39m + *[39m + *[39m + *[39m + *[39m + *[39m + +[31m✖ should fail [90m(*ms)[39m[39m + Error: fail + *[39m + *[39m + *[39m + *[39m + *[39m + +[31m✖ should pass but parent fail [90m(*ms)[39m[39m + [32m'test did not finish before its parent and was cancelled'[39m diff --git a/test/parallel/test-runner-output.mjs b/test/parallel/test-runner-output.mjs index 977c20d9efed7b..3c2463c069a70c 100644 --- a/test/parallel/test-runner-output.mjs +++ b/test/parallel/test-runner-output.mjs @@ -10,16 +10,20 @@ function replaceTestDuration(str) { .replaceAll(/duration_ms [0-9.]+/g, 'duration_ms *'); } +const color = '(\\[\\d+m)'; +const stackTraceBasePath = new RegExp(`${color}\\(${process.cwd()}/?${color}(.*)${color}\\)`, 'g'); + function replaceSpecDuration(str) { return str .replaceAll(/\(0(\r?\n)ms\)/g, '(ZEROms)') .replaceAll(/[0-9.]+ms/g, '*ms') - .replaceAll(/duration_ms [0-9.]+/g, 'duration_ms *'); + .replaceAll(/duration_ms [0-9.]+/g, 'duration_ms *') + .replace(stackTraceBasePath, '$3'); } const defaultTransform = snapshot .transform(snapshot.replaceWindowsLineEndings, snapshot.replaceStackTrace, replaceTestDuration); const specTransform = snapshot - .transform(snapshot.replaceWindowsLineEndings, snapshot.replaceStackTrace, replaceSpecDuration); + .transform(replaceSpecDuration, snapshot.replaceWindowsLineEndings, snapshot.replaceStackTrace); const tests = [ @@ -40,10 +44,11 @@ const tests = [ { name: 'test-runner/output/name_pattern.js' }, { name: 'test-runner/output/name_pattern_with_only.js' }, { name: 'test-runner/output/unresolved_promise.js' }, -].map(({ name, transform }) => ({ + { name: 'test-runner/output/default_output.js', transform: specTransform, tty: true }, +].map(({ name, tty, transform }) => ({ name, fn: common.mustCall(async () => { - await snapshot.spawnAndAssert(fixtures.path(name), transform ?? defaultTransform); + await snapshot.spawnAndAssert(fixtures.path(name), transform ?? defaultTransform, { tty }); }), })); diff --git a/test/pseudo-tty/test_runner_default_reporter.out b/test/pseudo-tty/test_runner_default_reporter.out deleted file mode 100644 index 6787ceb6af708e..00000000000000 --- a/test/pseudo-tty/test_runner_default_reporter.out +++ /dev/null @@ -1,57 +0,0 @@ -[32m* should pass [90m(*ms)[39m[39m -[31m* should fail [90m(*ms)[39m[39m - Error: fail - at * [90m(*)[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - -[90m* should skip [90m(*ms)[39m # SKIP[39m -* parent - [31m* should fail [90m(*ms)[39m[39m - Error: fail - at * [90m(*)[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - - [31m* should pass but parent fail [90m(*ms)[39m[39m - [32m'test did not finish before its parent and was cancelled'[39m - -[31m* [39mparent [90m(*ms)[39m - -[34m* tests 6[39m -[34m* suites 0[39m -[34m* pass 1[39m -[34m* fail 3[39m -[34m* cancelled 1[39m -[34m* skipped 1[39m -[34m* todo 0[39m -[34m* duration_ms *[39m - -[31m* failing tests:[39m - -[31m* should fail [90m(*ms)[39m[39m - Error: fail - at * [90m(*)[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - -[31m* should fail [90m(*ms)[39m[39m - Error: fail - at * [90m(*)[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - [90m at *[39m - -[31m* should pass but parent fail [90m(*ms)[39m[39m - [32m'test did not finish before its parent and was cancelled'[39m diff --git a/test/pseudo-tty/testcfg.py b/test/pseudo-tty/testcfg.py index df380ad31eff1e..4751188b44d30a 100644 --- a/test/pseudo-tty/testcfg.py +++ b/test/pseudo-tty/testcfg.py @@ -36,7 +36,7 @@ from functools import reduce FLAGS_PATTERN = re.compile(r"//\s+Flags:(.*)") -PTY_HELPER = join(dirname(__file__), 'pty_helper.py') +PTY_HELPER = join(dirname(__file__), '../../tools/pseudo-tty.py') class TTYTestCase(test.TestCase): diff --git a/test/pseudo-tty/pty_helper.py b/tools/pseudo-tty.py old mode 100644 new mode 100755 similarity index 98% rename from test/pseudo-tty/pty_helper.py rename to tools/pseudo-tty.py index a61ef1cc0eda0b..96300a679a58b3 --- a/test/pseudo-tty/pty_helper.py +++ b/tools/pseudo-tty.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python3 + import errno import os import pty