test_runner: add resetCalls to MockFunctionContext

fossamagna · targos · commit 6bc7b7e6f497 · 2022-12-13T09:42:42.000Z
This commit allows tests in test runner to reset the calls of mock function Refs: #45326 (comment) PR-URL: #45710 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
diff --git a/doc/api/test.md b/doc/api/test.md
@@ -870,6 +870,14 @@ test('changes a mock behavior once', (t) => {
 });
 ```
 
+### `ctx.resetCalls()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+Resets the call history of the mock function.
+
 ### `ctx.restore()`
 
 <!-- YAML
diff --git a/lib/internal/test_runner/mock.js b/lib/internal/test_runner/mock.js
@@ -77,6 +77,10 @@ class MockFunctionContext {
     }
   }
 
+  resetCalls() {
+    this.#calls = [];
+  }
+
   trackCall(call) {
     ArrayPrototypePush(this.#calls, call);
   }
diff --git a/test/parallel/test-runner-mocking.js b/test/parallel/test-runner-mocking.js
@@ -780,6 +780,23 @@ test('local mocks are auto restored after the test finishes', async (t) => {
   assert.strictEqual(originalBar, obj.bar);
 });
 
+test('reset mock calls', (t) => {
+  const sum = (arg1, arg2) => arg1 + arg2;
+  const difference = (arg1, arg2) => arg1 - arg2;
+  const fn = t.mock.fn(sum, difference);
+
+  assert.strictEqual(fn(1, 2), -1);
+  assert.strictEqual(fn(2, 1), 1);
+  assert.strictEqual(fn.mock.calls.length, 2);
+  assert.strictEqual(fn.mock.callCount(), 2);
+
+  fn.mock.resetCalls();
+  assert.strictEqual(fn.mock.calls.length, 0);
+  assert.strictEqual(fn.mock.callCount(), 0);
+
+  assert.strictEqual(fn(3, 2), 1);
+});
+
 test('uses top level mock', () => {
   function sum(a, b) {
     return a + b;

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,10 @@ class MockFunctionContext {`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`
	`80`	`+ resetCalls() {`
	`81`	`+ this.#calls = [];`
	`82`	`+ }`
	`83`	`+`
`80`	`84`	`trackCall(call) {`
`81`	`85`	`ArrayPrototypePush(this.#calls, call);`
`82`	`86`	`}`