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.

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

Jump to bottom

test: replace third argument in assert.strictEqual #19162

Closed
wants to merge 2 commits into from
Closed

test: replace third argument in assert.strictEqual #19162

wants to merge 2 commits into from

Conversation

ryzokuken
Copy link
Contributor

@ryzokuken ryzokuken commented Mar 6, 2018 •
edited
Loading

Replace the third argument in assert.strictEqual with something much
more informative so that it display relevant information when the
test fails

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • commit message follows commit guidelines
Affected core subsystem(s)

test

@ryzokuken
test: replace third argument in assert.strictEqual
88bf6fa 
Replace the third argument in assert.strictEqual with something much
more informative so that it display relevant information when the
test fails
@nodejs-github-bot nodejs-github-bot added the test Issues and PRs related to the tests. label Mar 6, 2018
@ryzokuken
Copy link
Contributor Author

@Trott here it is! 😄

@Trott
Copy link
Member

Trott commented Mar 6, 2018

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

apapirovski
apapirovski reviewed Mar 6, 2018
View reviewed changes
Copy link
Member

@apapirovski apapirovski left a comment

Choose a reason for hiding this comment

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

This would be better with no message at all which will then show a comparison of the two values.

apapirovski
apapirovski reviewed Mar 6, 2018
View reviewed changes
Copy link
Member

@apapirovski apapirovski left a comment

Choose a reason for hiding this comment

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

But if we do put a message in, it should be similar to the one above it and mention at what index the error occurred and for what hash. At least that's information that's not provided by the default strictEqual message.

@ryzokuken
Copy link
Contributor Author

@apapirovski is it better now? Let me know if anything is amiss.

@apapirovski
Copy link
Member

Lite CI for the change: https://ci.nodejs.org/job/node-test-pull-request-lite/224/

lpinca
lpinca approved these changes Mar 6, 2018
View reviewed changes
Copy link
Member

@lpinca lpinca left a comment

Choose a reason for hiding this comment

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

LGTM but I agree with @apapirovski. Almost all strictEqual assertions are better without the message argument.

@ryzokuken
Copy link
Contributor Author

@lpinca @apapirovski so, should I remove it altogether? As it is, it does give us some extra information (hash and index)

@BridgeAR
Copy link
Member

BridgeAR commented Mar 6, 2018

In this case it is probably fine to have the extra message. Otherwise it is difficult to see what test case just ran.

@apapirovski
Copy link
Member

I'm fine with it either way. It offers a bit more info since it provides the hash and index, which would make debugging a tiny bit easier. Admittedly that can also be gleaned from the comparison value but it's a bit less convenient.

jasnell pushed a commit that referenced this pull request Mar 6, 2018
@ryzokuken @jasnell
test: add more information to assert.strictEqual
78a7536 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell
Copy link
Member

jasnell commented Mar 6, 2018

Landed in 78a7536

@jasnell jasnell closed this Mar 6, 2018
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
a42c959 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Mar 6, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
cd71a52 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
7b4c9a4 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 6, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
c81a391 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 7, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
6787913 
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@ryzokuken @MayaLekova
test: add more information to assert.strictEqual
9a75a2a 
PR-URL: nodejs#19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell pushed a commit to jasnell/node that referenced this pull request Aug 17, 2018
@ryzokuken @jasnell
test: add more information to assert.strictEqual
2578cdb 
PR-URL: nodejs#19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Sep 6, 2018
@ryzokuken @MylesBorins
test: add more information to assert.strictEqual
f64100a 
Backport-PR-URL: #22380
PR-URL: #19162
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Sep 6, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@apapirovski apapirovski apapirovski approved these changes

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@tniessen tniessen tniessen approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees
No one assigned
Labels
test Issues and PRs related to the tests.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@ryzokuken @Trott @apapirovski @BridgeAR @jasnell @lpinca @cjihrig @tniessen @gireeshpunathil @nodejs-github-bot