Skip to content

test_runner: unwrap error message in TAP reporter - #48942

Merged
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
cjihrig:tap-error
Jul 29, 2023
Merged

test_runner: unwrap error message in TAP reporter#48942
nodejs-github-bot merged 2 commits into
nodejs:mainfrom
cjihrig:tap-error

Conversation

@cjihrig

@cjihrig cjihrig commented Jul 27, 2023

Copy link
Copy Markdown
Contributor

The TAP reporter unwraps errors that come from user code. It was not properly unwrapping the error message when the failure originated from a test hook. This lead to difficult to debug errors when TAP output was used. This commit updates the TAP reporter to properly unwrap the error message.

Fixes: #48941

cjihrig
test_runner: unwrap error message in TAP reporter
5c57d1f 
The TAP reporter unwraps errors that come from user code. It
was not properly unwrapping the error message when the failure
originated from a test hook. This lead to difficult to debug
errors when TAP output was used. This commit updates the TAP
reporter to properly unwrap the error message.

Fixes: nodejs#48941
@cjihrig
cjihrig requested a review from mcollina July 27, 2023 16:06
@nodejs-github-bot

ghost commented Jul 27, 2023

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/test_runner

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. test_runner Issues and PRs related to the test runner subsystem. labels Jul 27, 2023
cjihrig
cjihrig commented Jul 27, 2023
View reviewed changes
Comment thread test/fixtures/test-runner/output/hooks.snapshot
type: 'suite'
failureType: 'hookFailed'
error: 'failed running before hook'
error: 'before'

ghost Jul 27, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it looks like these error messages are actually less helpful - these are the actual message from the error objects thrown in the test.

ghost Jul 27, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cjihrig and why is there no stack? 😅

ghost Jul 27, 2023 •
edited by atlowChemi
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that just the snapshot behavior?

ghost Jul 27, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check out lines 61 and 62 (in the TAP reporter, the error is serialized to YAML, not a nice to read error like the spec reporter)

@cjihrig cjihrig mentioned this pull request Jul 27, 2023
Closed
MoLow
MoLow approved these changes Jul 27, 2023
View reviewed changes

ghost left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice

mcollina
mcollina approved these changes Jul 28, 2023
View reviewed changes

ghost left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mcollina mcollina added the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jul 28, 2023
@github-actions github-actions Bot removed the request-ci Add this label to start a Jenkins CI on a PR. Only starts once the PR has an approving review. label Jul 28, 2023
@nodejs-github-bot

ghost commented Jul 28, 2023

Copy link
Copy Markdown
Collaborator

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

@github-actions github-actions Bot mentioned this pull request Jul 29, 2023
Open
23 tasks
@nodejs-github-bot

ghost commented Jul 29, 2023

Copy link
Copy Markdown
Collaborator

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

@cjihrig cjihrig added author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-squash PRs the Commit Queue should land as one squashed commit. and removed needs-ci PRs that need a full CI run. labels Jul 29, 2023
@MoLow MoLow added the commit-queue PRs queued for automated landing through the Commit Queue. label Jul 29, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue PRs queued for automated landing through the Commit Queue. label Jul 29, 2023
@nodejs-github-bot
nodejs-github-bot merged commit bef3942 into nodejs:main Jul 29, 2023
@nodejs-github-bot

ghost commented Jul 29, 2023

Copy link
Copy Markdown
Collaborator

Landed in bef3942

@cjihrig
cjihrig deleted the tap-error branch July 29, 2023 18:38
This was referenced Jul 30, 2023
Open
Open
Open
Open
Open
@UlisesGascon UlisesGascon mentioned this pull request Aug 15, 2023
Merged
@targos targos mentioned this pull request Nov 28, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@atlowChemi atlowChemi atlowChemi approved these changes
@mcollina mcollina mcollina approved these changes
@benjamingr benjamingr benjamingr approved these changes
@MoLow MoLow MoLow approved these changes

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. commit-queue-squash PRs the Commit Queue should land as one squashed commit. test_runner Issues and PRs related to the test runner subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

test_runner: incorrect unwrapping of errors in after() when using the tap reporter

6 participants

@cjihrig @nodejs-github-bot @mcollina @benjamingr @MoLow @atlowChemi