Skip to content

doc, test: clarify the behavior of todo tests #52204

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.

Sign up for GitHub

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

Closed
cjihrig wants to merge 2 commits into from
Closed

doc, test: clarify the behavior of todo tests #52204

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04d9c45
test: add test for skip+todo combinations
cjihrig Mar 24, 2024
6ade087
doc: add section explaining todo tests
cjihrig Mar 24, 2024
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
Next Next commit
test: add test for skip+todo combinations 
This commit adds a regression test for the edge case where a
test runner test is marked as both todo and skip.

Refs: #49013
  • Loading branch information
@cjihrig
cjihrig committed Mar 24, 2024
commit 04d9c459e080d8909c390f8650f143af39124224
32 changes: 32 additions & 0 deletions test/parallel/test-runner-todo-skip-tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
'use strict';
const common = require('../common');
const { strictEqual } = require('node:assert');
const { run, suite, test } = require('node:test');

if (!process.env.NODE_TEST_CONTEXT) {
const stream = run({ files: [__filename] });

stream.on('test:fail', common.mustNotCall());
stream.on('test:pass', common.mustCall((event) => {
strictEqual(event.skip, true);
strictEqual(event.todo, undefined);
}, 4));
} else {
test('test options only', { skip: true, todo: true }, common.mustNotCall());

test('test context calls only', common.mustCall((t) => {
t.todo();
t.skip();
}));

test('todo test with context skip', { todo: true }, common.mustCall((t) => {
t.skip();
}));

// Note - there is no test for the skip option and t.todo() because the skip
// option prevents the test from running at all. This is verified by other
// tests.

// Suites don't have the context methods, so only test the options combination.
suite('suite options only', { skip: true, todo: true }, common.mustNotCall());
}