test: add mustCallAtLeast

PR-URL: #12935
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Author: refack

test/common/README.md

@@ -182,9 +182,9 @@ Gets IP of localhost
 
 Array of IPV6 hosts.
 
-### mustCall([fn][, expected])
-*fn[<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
-*expected[<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = 1
+### mustCall([fn][, exact])
+*`fn`[<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) default = `common.noop`
+*`exact`[<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = 1
 * return [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
 
 Returns a function that calls `fn`. If the returned function has not been called
@@ -193,6 +193,17 @@ fail.
 
 If `fn` is not provided, `common.noop` will be used.
 
+### mustCallAtLeast([fn][, minimum])
+*`fn`[<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) default = `common.noop`
+*`minimum`[<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) default = 1
+* return [<Function>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
+
+Returns a function that calls `fn`. If the returned function has not been called
+at least `minimum` number of times when the test is complete, then the test will
+fail.
+
+If `fn` is not provided, `common.noop` will be used.
+
 ### nodeProcessAborted(exitCode, signal)
 *`exitCode`[<Number>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
 *`signal`[<String>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)

test/common/index.js

@@ -406,36 +406,49 @@ function runCallChecks(exitCode) {
 if(exitCode!==0)return;
 
 constfailed=mustCallChecks.filter(function(context){
-returncontext.actual!==context.expected;
+if('minimum'incontext){
+context.messageSegment=`at least ${context.minimum}`;
+returncontext.actual<context.minimum;
+}else{
+context.messageSegment=`exactly ${context.exact}`;
+returncontext.actual!==context.exact;
+}
 });
 
 failed.forEach(function(context){
-console.log('Mismatched %s function calls. Expected %d, actual %d.',
+console.log('Mismatched %s function calls. Expected %s, actual %d.',
 context.name,
-context.expected,
+context.messageSegment,
 context.actual);
 console.log(context.stack.split('\n').slice(2).join('\n'));
 });
 
 if(failed.length)process.exit(1);
 }
 
+exports.mustCall=function(fn,exact){
+return_mustCallInner(fn,exact,'exact');
+};
 
-exports.mustCall=function(fn,expected){
+exports.mustCallAtLeast=function(fn,minimum){
+return_mustCallInner(fn,minimum,'minimum');
+};
+
+function_mustCallInner(fn,criteria,field){
 if(typeoffn==='number'){
-expected=fn;
+criteria=fn;
 fn=noop;
 }elseif(fn===undefined){
 fn=noop;
 }
 
-if(expected===undefined)
-expected=1;
-elseif(typeofexpected!=='number')
-thrownewTypeError(`Invalid expected value: ${expected}`);
+if(criteria===undefined)
+criteria=1;
+elseif(typeofcriteria!=='number')
+thrownewTypeError(`Invalid ${field} value: ${criteria}`);
 
 constcontext={
-expected: expected,
+[field]: criteria,
 actual: 0,
 stack: (newError()).stack,
 name: fn.name||'<anonymous>'
@@ -450,7 +463,7 @@ exports.mustCall = function(fn, expected) {
 context.actual++;
 returnfn.apply(this,arguments);
 };
-};
+}
 
 exports.hasMultiLocalhost=functionhasMultiLocalhost(){
 constTCP=process.binding('tcp_wrap').TCP;

test/fixtures/failmustcall1.js

@@ -0,0 +1,3 @@
+constcommon=require('../common');
+constf=common.mustCall(()=>{},2);
+f();

test/fixtures/failmustcall2.js

@@ -0,0 +1,3 @@
+constcommon=require('../common');
+constf=common.mustCallAtLeast(()=>{},2);
+f();

test/parallel/test-common.js

@@ -2,14 +2,54 @@
 constcommon=require('../common');
 constassert=require('assert');
 
+const{join}=require('path');
+const{execFile}=require('child_process');
+
 common.globalCheck=false;
 global.gc=42;// Not a valid global unless --expose_gc is set.
 assert.deepStrictEqual(common.leakedGlobals(),['gc']);
 
 assert.throws(function(){
 common.mustCall(common.noop,'foo');
-},/^TypeError:Invalidexpectedvalue:foo$/);
+},/^TypeError:Invalidexactvalue:foo$/);
 
 assert.throws(function(){
 common.mustCall(common.noop,/foo/);
-},/^TypeError:Invalidexpectedvalue:\/foo\/$/);
+},/^TypeError:Invalidexactvalue:\/foo\/$/);
+
+constfnOnce=common.mustCall(()=>{});
+fnOnce();
+constfnTwice=common.mustCall(()=>{},2);
+fnTwice();
+fnTwice();
+constfnAtLeast1Called1=common.mustCallAtLeast(()=>{},1);
+fnAtLeast1Called1();
+constfnAtLeast1Called2=common.mustCallAtLeast(()=>{},1);
+fnAtLeast1Called2();
+fnAtLeast1Called2();
+constfnAtLeast2Called2=common.mustCallAtLeast(()=>{},2);
+fnAtLeast2Called2();
+fnAtLeast2Called2();
+constfnAtLeast2Called3=common.mustCallAtLeast(()=>{},2);
+fnAtLeast2Called3();
+fnAtLeast2Called3();
+fnAtLeast2Called3();
+
+constfailFixtures=[
+[
+join(common.fixturesDir,'failmustcall1.js'),
+'Mismatched <anonymous> function calls. Expected exactly 2, actual 1.'
+],[
+join(common.fixturesDir,'failmustcall2.js'),
+'Mismatched <anonymous> function calls. Expected at least 2, actual 1.'
+]
+];
+for(constpoffailFixtures){
+const[file,expected]=p;
+execFile(process.argv[0],[file],common.mustCall((ex,stdout,stderr)=>{
+assert.ok(ex);
+assert.strictEqual(stderr,'');
+constfirstLine=stdout.split('\n').shift();
+assert.strictEqual(firstLine,expected);
+}));
+}