test: add common.mustNotCall() #11152

cjihrig · 2017-02-03T20:00:37Z

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail().

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

Trott

Somewhat rubber-stamp-y LGTM if CI is green.

jasnell · 2017-02-03T20:55:14Z

test/common.js

+    fail(msg || 'function should not have been called');
+  };
+};
+


hmm.. the same basic thing can be accomplished using:

common.mustCall(fn, 0);

It could. The whole point is to get beautiful assertion messages though. Using common.mustCall() would yield:

Mismatched <anonymous> function calls. Expected 0, actual 1.

Additionally, common.mustCall(fn, 0) will only fail when the exit event is emitted on process. The version in this PR fails immediately. That could be very helpful for a test that otherwise will mysteriously time out because something is holding the event loop open indefinitely.

Ok, works for me

Just to add my 2 cents I also think common.mustNotCall() makes it immediately obvious what you want to happen without needing the context to know that 0 will imply it should not be called.

mhdawson

LGTM

mhdawson · 2017-02-03T22:21:25Z

test/common.js

+    fail(msg || 'function should not have been called');
+  };
+};
+


Just to add my 2 cents I also think common.mustNotCall() makes it immediately obvious what you want to happen without needing the context to know that 0 will imply it should not be called.

thefourtheye · 2017-02-04T09:09:18Z

test/common.js

@@ -497,6 +497,12 @@ function fail(msg) {
 }
 exports.fail = fail;

+exports.mustNotCall = function(msg) {
+  return function dontCall() {


Would it help to keep this function's name also as mustNotCall? Stacktrace would be better I guess.

lpinca · 2017-02-04T11:46:38Z

test/common.js

@@ -497,6 +497,12 @@ function fail(msg) {
 }
 exports.fail = fail;

+exports.mustNotCall = function(msg) {
+  return function dontCall() {
+    fail(msg || 'function should not have been called');


Can we do something to prevent this from printing stuff like

AssertionError: [object Object]

when msg is not a string?

util.format ?

On second thought I think this is not needed as the function (common.mustNotCall()) must be invoked explicitly and using a non-string argument probably doesn't make sense.

cjihrig · 2017-02-05T15:38:05Z

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

thefourtheye

LGTM if the CI is happy

jasnell · 2017-02-06T01:06:46Z

@nodejs/build @jbergstroem ... something is happening with the OSX build bot. Failing to start on every CI run

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail(). PR-URL: nodejs#11152 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

cjihrig · 2017-02-06T19:14:10Z

Landing this since the only problem is the macOS CI, which I can verify locally.

italoacasas · 2017-02-09T17:43:43Z

@cjihrig do you have time to backport this to v7.x ?

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail(). PR-URL: #11152 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail(). PR-URL: nodejs#11152 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

jasnell · 2017-03-07T19:06:51Z

This would need backport PRs to land in v6 and v4 ... there are several recent test changes that depend on this so a backport would be preferrable.

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail(). PR-URL: #11152 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

MylesBorins · 2017-05-15T19:39:05Z

backported to v6.x in bea0a6e

This commit adds a mustNotCall() helper for testing. This provides an alternative to using common.fail() as a callback, or creating a callback function for the sole purpose of calling common.fail(). PR-URL: nodejs/node#11152 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>

nodejs-github-bot added the test Issues and PRs related to the tests. label Feb 3, 2017

Trott approved these changes Feb 3, 2017

View reviewed changes

jasnell reviewed Feb 3, 2017

View reviewed changes

jasnell approved these changes Feb 3, 2017

View reviewed changes

mhdawson approved these changes Feb 3, 2017

View reviewed changes

santigimeno approved these changes Feb 4, 2017

View reviewed changes

thefourtheye reviewed Feb 4, 2017

View reviewed changes

lpinca reviewed Feb 4, 2017

View reviewed changes

cjihrig force-pushed the must-not-call branch from e28bb07 to 85a7794 Compare February 5, 2017 15:37

thefourtheye approved these changes Feb 5, 2017

View reviewed changes

hiroppy approved these changes Feb 6, 2017

View reviewed changes

cjihrig force-pushed the must-not-call branch from 85a7794 to 7dd82dd Compare February 6, 2017 19:14

cjihrig merged commit 7dd82dd into nodejs:master Feb 6, 2017

cjihrig deleted the must-not-call branch February 6, 2017 19:15

italoacasas mentioned this pull request Feb 13, 2017

Proposal - 7.6.0 (Current) #11185

Merged

jasnell added dont-land-on-v4.x labels Mar 7, 2017

gibfahn added the backport-requested-v6.x label May 15, 2017

sam-github removed the dont-land-on-v6.x label May 15, 2017

gibfahn mentioned this pull request May 15, 2017

Backporting to v6.x-staging nodejs/Release#216

Closed

MylesBorins added backported-to-v6.x and removed backport-requested-v6.x labels May 15, 2017

MylesBorins mentioned this pull request May 23, 2017

v6.11.0 proposal #13059

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add common.mustNotCall() #11152

test: add common.mustNotCall() #11152

cjihrig commented Feb 3, 2017

Trott left a comment

jasnell Feb 3, 2017

cjihrig Feb 3, 2017

Trott Feb 3, 2017 •

edited

Loading

jasnell Feb 3, 2017

mhdawson Feb 3, 2017

mhdawson left a comment

mhdawson Feb 3, 2017

thefourtheye Feb 4, 2017

lpinca Feb 4, 2017

targos Feb 4, 2017

lpinca Feb 4, 2017 •

edited

Loading

cjihrig commented Feb 5, 2017

thefourtheye left a comment

jasnell commented Feb 6, 2017

cjihrig commented Feb 6, 2017

italoacasas commented Feb 9, 2017

jasnell commented Mar 7, 2017

MylesBorins commented May 15, 2017

test: add common.mustNotCall() #11152

test: add common.mustNotCall() #11152

Conversation

cjihrig commented Feb 3, 2017

Checklist

Affected core subsystem(s)

Trott left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Trott Feb 3, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhdawson left a comment

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

Choose a reason for hiding this comment

lpinca Feb 4, 2017 • edited Loading

Choose a reason for hiding this comment

cjihrig commented Feb 5, 2017

thefourtheye left a comment

Choose a reason for hiding this comment

jasnell commented Feb 6, 2017

cjihrig commented Feb 6, 2017

italoacasas commented Feb 9, 2017

jasnell commented Mar 7, 2017

MylesBorins commented May 15, 2017

Trott Feb 3, 2017 •

edited

Loading

lpinca Feb 4, 2017 •

edited

Loading