test_runner: add `describe.only` and `it.only` shorthands #46604

richiemccoll · 2023-02-10T09:17:17Z

This PR adds support for describe.only and it.only shorthands in the test_runner. It follows the existing semantics for how only works.

nodejs-github-bot · 2023-02-10T09:17:22Z

Review requested:

@nodejs/test_runner

benjamingr · 2023-02-10T21:35:58Z

doc/api/test.md

@@ -808,6 +808,11 @@ Shorthand for skipping a suite, same as [`describe([name], { skip: true }[, fn])
 Shorthand for marking a suite as `TODO`, same as
 [`describe([name], { todo: true }[, fn])`][describe options].

+## `describe.only([name][, options][, fn])`


If we do this, we should also support test.only

test does not currently support test.skip() or test.todo(), and I would prefer to keep it that way.

I think there is definitely value in having shorthands for the test API - especially skip and only. However, for the scope of this commit, it's only about adding the extra shorthand to the describe/it API. This keeps the options consistent.

@cjihrig are there any issues in particular you see with adding a shorthand API for the test interface in a future PR?

There is no technical reason - just a desire to keep the API surface area smaller. The Test class in particular is important because everything else builds on top of it. And, it already supports skip, todo, and only functionality, so I would prefer to not implement another way of doing the same thing.

MoLow · 2023-02-13T08:39:26Z

@richiemccoll is this ready for review?

richiemccoll · 2023-02-13T09:14:42Z

@MoLow Yes I was just checking the tests locally this morning before marking it for review. It should be ready now.

aduh95 · 2023-02-13T09:25:33Z

@richiemccoll can you amend the commit message to adhere to our guidelines? The first word should be an imperative word, which describe technically is, but is not used as such (IIUC), making the commit message hard to understand.

node/doc/contributing/pull-requests.md

Lines 168 to 169 in 5af2021

    
           * be prefixed with the name of the changed [subsystem](#appendix-subsystems) 
        
             and start with an imperative verb. Check the output of `git log --oneline

May I suggest test_runner: add `describe.only` and `it.only` shorthands?

doc/api/test.md

richiemccoll · 2023-02-13T09:43:52Z

@aduh95 Thanks. Commit message updated and pushed the doc metadata changes.

test/message/test_runner_only_tests.js

cjihrig · 2023-02-13T23:24:55Z

test/message/test_runner_only_tests.out

+  duration_ms: *
+  ...
+# Subtest: subtest should run
+ok 14 - subtest should run # SKIP 'only' option not set


The test title says this should run, but it is skipped.

Ah - yes, I left these ones in here as they should work after @MoLow's nesting describe/test PR #46544 is merged. Once that's landed I'll rebase this PR and re-run these tests/update the output.

At the moment they are skipped with both the shorthand and the explicit { only: true } passed.

@richiemccoll #46544 has landed, can you please rebase this PR?

I've rebased after your PR landed and updated these tests which now run. Commit here 6f069ef.

test/message/test_runner_only_tests.out

awaiting #46544

nodejs-github-bot · 2023-02-16T23:49:07Z

CI: https://ci.nodejs.org/job/node-test-pull-request/49588/

nodejs-github-bot · 2023-02-21T21:23:02Z

CI: https://ci.nodejs.org/job/node-test-pull-request/49852/

nodejs-github-bot · 2023-02-21T22:28:05Z

Landed in 0093fd3

PR-URL: nodejs#46604 Fixes: nodejs#46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

PR-URL: #46604 Backport-PR-URL: #46839 Fixes: #46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

PR-URL: #46604 Fixes: #46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

@antongolub

…ds by @antongolub https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

nodejs-github-bot added dont-land-on-v14.x needs-ci PRs that need a full CI run. test_runner labels Feb 10, 2023

benjamingr reviewed Feb 10, 2023

View reviewed changes

richiemccoll force-pushed the test-runner/describe-it-only-shorthands branch from 9f9585a to e89d473 Compare February 13, 2023 08:36

richiemccoll force-pushed the test-runner/describe-it-only-shorthands branch from e89d473 to e32726d Compare February 13, 2023 08:55

richiemccoll marked this pull request as ready for review February 13, 2023 09:14

aduh95 reviewed Feb 13, 2023

View reviewed changes

doc/api/test.md Show resolved Hide resolved

doc/api/test.md Show resolved Hide resolved

richiemccoll force-pushed the test-runner/describe-it-only-shorthands branch from e32726d to 6c6a7dd Compare February 13, 2023 09:42

richiemccoll changed the title ~~test_runner: describe it only shorthand~~ test_runner: add describe.only and it.only shorthands Feb 13, 2023

MoLow previously approved these changes Feb 13, 2023

View reviewed changes

aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Feb 13, 2023

aduh95 reviewed Feb 13, 2023

View reviewed changes

test/message/test_runner_only_tests.js Show resolved Hide resolved

cjihrig reviewed Feb 13, 2023

View reviewed changes

richiemccoll force-pushed the test-runner/describe-it-only-shorthands branch 2 times, most recently from c7c895a to 73b66f0 Compare February 14, 2023 09:02

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 16, 2023

github-actions bot mentioned this pull request Feb 18, 2023

CI Reliability 2023-02-18 nodejs/reliability#499

Open

32 tasks

test_runner: add describe.only and it.only shorthands

6f069ef

richiemccoll force-pushed the test-runner/describe-it-only-shorthands branch from 73b66f0 to 6f069ef Compare February 20, 2023 09:46

MoLow approved these changes Feb 20, 2023

View reviewed changes

MoLow added the request-ci Add this label to start a Jenkins CI on a PR. label Feb 21, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 21, 2023

MoLow added the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 21, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 21, 2023

nodejs-github-bot merged commit 0093fd3 into nodejs:main Feb 21, 2023

MoLow pushed a commit to MoLow/node that referenced this pull request Feb 25, 2023

test_runner: add describe.only and it.only shorthands

c0e13de

PR-URL: nodejs#46604 Fixes: nodejs#46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

MoLow pushed a commit to MoLow/node that referenced this pull request Feb 25, 2023

test_runner: add describe.only and it.only shorthands

c0887dc

PR-URL: nodejs#46604 Fixes: nodejs#46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

MoLow added the backport-open-v18.x Indicate that the PR has an open backport. label Feb 25, 2023

MoLow pushed a commit to MoLow/node that referenced this pull request Feb 25, 2023

test_runner: add describe.only and it.only shorthands

6ef4886

PR-URL: nodejs#46604 Fixes: nodejs#46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

juanarbol pushed a commit that referenced this pull request Mar 3, 2023

test_runner: add describe.only and it.only shorthands

bbe1f7d

PR-URL: #46604 Backport-PR-URL: #46839 Fixes: #46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

juanarbol mentioned this pull request Mar 3, 2023

V18.15.0 proposal #46920

Merged

juanarbol pushed a commit that referenced this pull request Mar 5, 2023

test_runner: add describe.only and it.only shorthands

0a690ef

PR-URL: #46604 Backport-PR-URL: #46839 Fixes: #46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

targos pushed a commit that referenced this pull request Mar 13, 2023

test_runner: add describe.only and it.only shorthands

aa41f27

PR-URL: #46604 Fixes: #46562 Reviewed-By: Moshe Atlow <moshe@atlow.co.il>

targos mentioned this pull request Mar 14, 2023

v19.8.0 release proposal #47087

Merged

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 17, 2023

feat(node): extend test API shorthands

21f83ea

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 17, 2023

feat(node): extend test API shorthands

a96d4c6

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub mentioned this pull request May 17, 2023

feat(node): extend test API shorthands DefinitelyTyped/DefinitelyTyped#65521

Merged

7 tasks

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 17, 2023

feat(node): extend test API shorthands

757e4a5

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 17, 2023

feat(node): extend test API shorthands

29c2e47

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 17, 2023

feat(node): extend test API shorthands

ed22cea

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 18, 2023

feat(node): extend test API shorthands

6dd497a

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

antongolub added a commit to antongolub-forks/DefinitelyTyped that referenced this pull request May 18, 2023

feat(node): extend test API shorthands

2ce3d41

https://nodejs.org/en/blog/release/v20.2.0 https://nodejs.org/en/blog/release/v18.15.0 nodejs/node#47909 nodejs/node#46604

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test_runner: add `describe.only` and `it.only` shorthands #46604

test_runner: add `describe.only` and `it.only` shorthands #46604

richiemccoll commented Feb 10, 2023 •

edited

nodejs-github-bot commented Feb 10, 2023

benjamingr Feb 10, 2023

cjihrig Feb 11, 2023

richiemccoll Feb 13, 2023

cjihrig Feb 13, 2023

MoLow commented Feb 13, 2023

richiemccoll commented Feb 13, 2023

aduh95 commented Feb 13, 2023

richiemccoll commented Feb 13, 2023

cjihrig Feb 13, 2023

richiemccoll Feb 14, 2023

MoLow Feb 18, 2023

richiemccoll Feb 20, 2023

nodejs-github-bot commented Feb 16, 2023

nodejs-github-bot commented Feb 21, 2023

nodejs-github-bot commented Feb 21, 2023

test_runner: add describe.only and it.only shorthands #46604

test_runner: add describe.only and it.only shorthands #46604

Conversation

richiemccoll commented Feb 10, 2023 • edited

nodejs-github-bot commented Feb 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MoLow commented Feb 13, 2023

richiemccoll commented Feb 13, 2023

aduh95 commented Feb 13, 2023

richiemccoll commented Feb 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nodejs-github-bot commented Feb 16, 2023

nodejs-github-bot commented Feb 21, 2023

nodejs-github-bot commented Feb 21, 2023

test_runner: add `describe.only` and `it.only` shorthands #46604

test_runner: add `describe.only` and `it.only` shorthands #46604

richiemccoll commented Feb 10, 2023 •

edited