Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test_runner: mark snapshot testing as stable #55897

Merged
merged 1 commit into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1129,16 +1129,6 @@ added:

Enable module mocking in the test runner.

### `--experimental-test-snapshots`

<!-- YAML
added: v22.3.0
-->

> Stability: 1.0 - Early development

Enable [snapshot testing][] in the test runner.

### `--experimental-vm-modules`

<!-- YAML
Expand Down Expand Up @@ -2468,13 +2458,13 @@ subtests inherit this value from their parent. The default value is `Infinity`.

<!-- YAML
added: v22.3.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/55897
description: Snapsnot testing is no longer experimental.
-->

> Stability: 1.0 - Early development

Regenerates the snapshot files used by the test runner for [snapshot testing][].
Node.js must be started with the `--experimental-test-snapshots` flag in order
to use this functionality.

### `--throw-deprecation`

Expand Down
4 changes: 1 addition & 3 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -937,8 +937,7 @@ compared against a set of known good values. The known good values are known as
snapshots, and are stored in a snapshot file. Snapshot files are managed by the
test runner, but are designed to be human readable to aid in debugging. Best
practice is for snapshot files to be checked into source control along with your
test files. In order to enable snapshot testing, Node.js must be started with
the [`--experimental-test-snapshots`][] command-line flag.
test files.

Snapshot files are generated by starting Node.js with the
[`--test-update-snapshots`][] command-line flag. A separate snapshot file is
Expand Down Expand Up @@ -3591,7 +3590,6 @@ Can be used to abort test subtasks when the test has been aborted.
[`--experimental-strip-types`]: cli.md#--experimental-strip-types
[`--experimental-test-coverage`]: cli.md#--experimental-test-coverage
[`--experimental-test-module-mocks`]: cli.md#--experimental-test-module-mocks
[`--experimental-test-snapshots`]: cli.md#--experimental-test-snapshots
[`--import`]: cli.md#--importmodule
[`--test-concurrency`]: cli.md#--test-concurrency
[`--test-coverage-include`]: cli.md#--test-coverage-include
Expand Down
3 changes: 0 additions & 3 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -194,9 +194,6 @@ Configures the type of test isolation used in the test runner.
.It Fl -experimental-test-module-mocks
Enable module mocking in the test runner.
.
.It Fl -experimental-test-snapshots
Enable snapshot testing in the test runner.
.
.It Fl -experimental-strip-types
Enable experimental type-stripping for TypeScript files.
.
Expand Down
9 changes: 3 additions & 6 deletions lib/internal/test_runner/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ function lazyAssertObject(harness) {
if (assertObj === undefined) {
assertObj = new SafeMap();
const assert = require('assert');
const { SnapshotManager } = require('internal/test_runner/snapshot');
const methodsToCopy = [
'deepEqual',
'deepStrictEqual',
Expand All @@ -126,12 +127,8 @@ function lazyAssertObject(harness) {
assertObj.set(methodsToCopy[i], assert[methodsToCopy[i]]);
}

const { getOptionValue } = require('internal/options');
if (getOptionValue('--experimental-test-snapshots')) {
const { SnapshotManager } = require('internal/test_runner/snapshot');
harness.snapshotManager = new SnapshotManager(harness.config.updateSnapshots);
assertObj.set('snapshot', harness.snapshotManager.createAssert());
}
harness.snapshotManager = new SnapshotManager(harness.config.updateSnapshots);
assertObj.set('snapshot', harness.snapshotManager.createAssert());
}
return assertObj;
}
Expand Down
45 changes: 21 additions & 24 deletions lib/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ const {

const { test, suite, before, after, beforeEach, afterEach } = require('internal/test_runner/harness');
const { run } = require('internal/test_runner/runner');
const { getOptionValue } = require('internal/options');

module.exports = test;
ObjectAssign(module.exports, {
Expand Down Expand Up @@ -39,28 +38,26 @@ ObjectDefineProperty(module.exports, 'mock', {
},
});

if (getOptionValue('--experimental-test-snapshots')) {
let lazySnapshot;
let lazySnapshot;

ObjectDefineProperty(module.exports, 'snapshot', {
__proto__: null,
configurable: true,
enumerable: true,
get() {
if (lazySnapshot === undefined) {
const {
setDefaultSnapshotSerializers,
setResolveSnapshotPath,
} = require('internal/test_runner/snapshot');

lazySnapshot = {
__proto__: null,
setDefaultSnapshotSerializers,
setResolveSnapshotPath,
};
}
ObjectDefineProperty(module.exports, 'snapshot', {
__proto__: null,
configurable: true,
enumerable: true,
get() {
if (lazySnapshot === undefined) {
const {
setDefaultSnapshotSerializers,
setResolveSnapshotPath,
} = require('internal/test_runner/snapshot');

lazySnapshot = {
__proto__: null,
setDefaultSnapshotSerializers,
setResolveSnapshotPath,
};
}

return lazySnapshot;
},
});
}
return lazySnapshot;
},
});
4 changes: 1 addition & 3 deletions src/node_options.cc
Original file line number Diff line number Diff line change
Expand Up @@ -691,9 +691,7 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
AddOption("--experimental-test-module-mocks",
"enable module mocking in the test runner",
&EnvironmentOptions::test_runner_module_mocks);
AddOption("--experimental-test-snapshots",
"enable snapshot testing in the test runner",
&EnvironmentOptions::test_runner_snapshots);
AddOption("--experimental-test-snapshots", "", NoOp{});
AddOption("--test-name-pattern",
"run tests whose name matches this regular expression",
&EnvironmentOptions::test_name_pattern,
Expand Down
1 change: 0 additions & 1 deletion src/node_options.h
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,6 @@ class EnvironmentOptions : public Options {
uint64_t test_coverage_functions = 0;
uint64_t test_coverage_lines = 0;
bool test_runner_module_mocks = false;
bool test_runner_snapshots = false;
bool test_runner_update_snapshots = false;
std::vector<std::string> test_name_pattern;
std::vector<std::string> test_reporter;
Expand Down
15 changes: 8 additions & 7 deletions test/parallel/test-runner-assert.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ require('../common');
const assert = require('node:assert');
const test = require('node:test');

const uncopiedKeys = [
'AssertionError',
'CallTracker',
'strict',
];
test('only methods from node:assert are on t.assert', (t) => {
const expectedKeys = Object.keys(assert).filter((key) => !uncopiedKeys.includes(key)).sort();
test('expected methods are on t.assert', (t) => {
const uncopiedKeys = [
'AssertionError',
'CallTracker',
'strict',
];
const assertKeys = Object.keys(assert).filter((key) => !uncopiedKeys.includes(key));
const expectedKeys = ['snapshot'].concat(assertKeys).sort();
assert.deepStrictEqual(Object.keys(t.assert).sort(), expectedKeys);
});

Expand Down
11 changes: 4 additions & 7 deletions test/parallel/test-runner-snapshot-tests.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Flags: --expose-internals --experimental-test-snapshots
// Flags: --expose-internals
/* eslint-disable no-template-curly-in-string */
'use strict';
const common = require('../common');
Expand Down Expand Up @@ -299,7 +299,7 @@ test('t.assert.snapshot()', async (t) => {
await t.test('fails prior to snapshot generation', async (t) => {
const child = await common.spawnPromisified(
process.execPath,
['--experimental-test-snapshots', fixture],
[fixture],
{ cwd: tmpdir.path },
);

Expand All @@ -314,7 +314,7 @@ test('t.assert.snapshot()', async (t) => {
await t.test('passes when regenerating snapshots', async (t) => {
const child = await common.spawnPromisified(
process.execPath,
['--test-update-snapshots', '--experimental-test-snapshots', fixture],
['--test-update-snapshots', fixture],
{ cwd: tmpdir.path },
);

Expand All @@ -328,7 +328,7 @@ test('t.assert.snapshot()', async (t) => {
await t.test('passes when snapshots exist', async (t) => {
const child = await common.spawnPromisified(
process.execPath,
['--experimental-test-snapshots', fixture],
[fixture],
{ cwd: tmpdir.path },
);

Expand All @@ -350,7 +350,6 @@ test('snapshots from multiple files (isolation=none)', async (t) => {
const args = [
'--test',
'--experimental-test-isolation=none',
'--experimental-test-snapshots',
fixture,
fixture2,
];
Expand All @@ -372,7 +371,6 @@ test('snapshots from multiple files (isolation=none)', async (t) => {
const args = [
'--test',
'--experimental-test-isolation=none',
'--experimental-test-snapshots',
'--test-update-snapshots',
fixture,
fixture2,
Expand All @@ -394,7 +392,6 @@ test('snapshots from multiple files (isolation=none)', async (t) => {
const args = [
'--test',
'--experimental-test-isolation=none',
'--experimental-test-snapshots',
fixture,
fixture2,
];
Expand Down
Loading