Repository navigation
Test Runner docs could use more information on the concept of a Suite #60758
Description
Affected URL(s)
https://nodejs.org/docs/latest-v24.x/api/test.html
Description of the problem
The test runner docs could use more information regarding suites. Suites do behave subtly differently to a test with subtests. Documenting these difference is important.
For example, comparing and contrasting the difference in:
suite('s1', () => {
test('t1', () => {
assert.ok(true);
});
test('t2', () => {
assert.ok(true);
});
});And then the equivalent:
test('s1', async (ctx) => {
await ctx.test('t1', () => {
assert.ok(true);
});
await ctx.test('t2', () => {
assert.ok(true);
});
});I'm sure there is more details to mention too but this comparison stands out the most to me.
It also feels like the docs are missing this section because as you read the page top-to-bottom, you get to the Subtests section and it mentions:
This is necessary because tests do not wait for their subtests to complete, unlike tests created within suites.
Without ever actually introducing what a "suite" is.
I understand the concept of a "suite" is generally well understood in the context of a any test runner, but nonetheless the specifics for Node's version of it is important to detail as devs work to convert from other testing frameworks where they may be familiar with different assumptions for what a "suite" vs "test" is.
Activity
composiokiwiqa-stack commentedon Nov 20, 2025
composiokiwiqa-stack commentedon Nov 20, 2025
vassudanagunta commentedon Dec 20, 2025
It has been on my todo list to seek clarification on the these very questions, as I'm building a test framework on top of
node:testas well as custom reporters.Here is a related question the docs should answer, or possibly be answered by API fixes.
node:testalso allows you to nest tests within tests. In other words, you can do any of the following:Why are 3 and 4 allowed? Is it intentional? If so, are they semantically and functionally the same as 1?1 If not, what are the semantics? Or is it a bug that they are allowed?
You can also nest subtests! So why do 5 vs 6?
Footnotes
I believe I've observed behavioral differences, but I'd have to check. Let me know if you want data on this. ↩
github-actions commentedon Jul 19, 2026
This issue has been marked as stale due to 210 days of inactivity.
It will be automatically closed in 30 days if no further activity occurs. If this is still relevant, please leave a comment or update it to keep it open.
vassudanagunta commentedon Jul 19, 2026
i think this is still relevant, see my comment above
github-actions commentedon Oct 19, 2026
This issue has been marked as stale due to 90 days of inactivity.
It will be automatically closed in 30 days if no further activity occurs. If this is still relevant, please leave a comment or update it to keep it open.