Merge pull request #6 from stschulte/new-matcher

Add new matcher toHaveReceivedCommandExactlyOnceWith

CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- matcher `toHaveReceivedCommandExactlyOnceWith` can be used to verify there are
+  no additional calls
+
+### Changed
+
+- Update dependencies. This bumps `@vitest/expect` dependency to `^3.0.1`
+
 ## [5.1.0] - 2025-01-11
 
 ### Changed

README.md

@@ -39,7 +39,7 @@ You must register the new matchers explicity (think about putting this to a [set
         },
       });
 
-  to add the custom mat chers before each test run
+  to add the custom matchers before each test run
 */
 import { expect } from "vitest";
 import {
@@ -57,6 +57,8 @@ import {
   toHaveReceivedLastCommandWith,
   toReceiveAnyCommand,
   toHaveReceivedAnyCommand,
+  toReceiveCommandExactlyOnceWith,
+  toHaveReceivedCommandExactlyOnceWith,
 } from "aws-sdk-client-mock-vitest";
 
 expect.extend({
@@ -74,6 +76,8 @@ expect.extend({
   toHaveReceivedLastCommandWith,
   toReceiveAnyCommand,
   toHaveReceivedAnyCommand,
+  toReceiveCommandExactlyOnceWith,
+  toHaveReceivedCommandExactlyOnceWith,
 });
 ```
 

package.json

@@ -38,24 +38,24 @@
     "aws-sdk-client-mock": ">=2.2.0"
   },
   "dependencies": {
-    "@vitest/expect": "^2.1.3",
-    "tslib": "^2.8.0"
+    "@vitest/expect": "^3.0.2",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.726.1",
-    "@aws-sdk/client-secrets-manager": "^3.726.1",
+    "@aws-sdk/client-s3": "^3.730.0",
+    "@aws-sdk/client-secrets-manager": "^3.730.0",
     "@eslint/js": "^9.18.0",
-    "@stylistic/eslint-plugin": "^2.12.1",
+    "@stylistic/eslint-plugin": "^2.13.0",
     "@types/eslint__js": "^8.42.3",
-    "@types/node": "^22.10.5",
-    "@vitest/coverage-v8": "^2.1.8",
-    "@vitest/eslint-plugin": "^1.1.24",
+    "@types/node": "^22.10.7",
+    "@vitest/coverage-v8": "^3.0.2",
+    "@vitest/eslint-plugin": "^1.1.25",
     "aws-sdk-client-mock": "^4.1.0",
     "eslint": "^9.18.0",
     "eslint-config-flat-gitignore": "^1.0.0",
     "eslint-plugin-perfectionist": "^4.6.0",
     "typescript": "^5.7.3",
-    "typescript-eslint": "^8.19.1",
-    "vitest": "^2.1.8"
+    "typescript-eslint": "^8.20.0",
+    "vitest": "^3.0.2"
   }
 }

src/index.ts

@@ -2,13 +2,15 @@ export type { CustomMatcher } from './matcher.js';
 export {
   toHaveReceivedAnyCommand,
   toHaveReceivedCommand,
+  toHaveReceivedCommandExactlyOnceWith,
   toHaveReceivedCommandOnce,
   toHaveReceivedCommandTimes,
   toHaveReceivedCommandWith,
   toHaveReceivedLastCommandWith,
   toHaveReceivedNthCommandWith,
   toReceiveAnyCommand,
   toReceiveCommand,
+  toReceiveCommandExactlyOnceWith,
   toReceiveCommandOnce,
   toReceiveCommandTimes,
   toReceiveCommandWith,

src/matcher.ts

@@ -15,6 +15,7 @@ import { notNull, ordinalOf } from './utils.js';
 interface AliasMatcher<R> {
   toReceiveAnyCommand: BaseMatcher<R>['toHaveReceivedAnyCommand'];
   toReceiveCommand: BaseMatcher<R>['toHaveReceivedCommand'];
+  toReceiveCommandExactlyOnceWith: BaseMatcher<R>['toHaveReceivedCommandExactlyOnceWith'];
   toReceiveCommandOnce: BaseMatcher<R>['toHaveReceivedCommandOnce'];
   toReceiveCommandTimes: BaseMatcher<R>['toHaveReceivedCommandTimes'];
   toReceiveCommandWith: BaseMatcher<R>['toHaveReceivedCommandWith'];
@@ -39,6 +40,14 @@ interface BaseMatcher<R> {
     command: AwsCommandConstructur<Input, Output>
   ): R;
 
+  toHaveReceivedCommandExactlyOnceWith<
+    Input extends object,
+    Output extends MetadataBearer,
+  >(
+    command: AwsCommandConstructur<Input, Output>,
+    input: Partial<Input>
+  ): R;
+
   toHaveReceivedCommandOnce<
     Input extends object,
     Output extends MetadataBearer,
@@ -209,9 +218,34 @@ function toHaveReceivedCommandWith(
   };
 };
 const toReceiveCommandWith = toHaveReceivedCommandWith;
-/*
 
-  */
+function toHaveReceivedCommandExactlyOnceWith(
+  this: MatcherState,
+  client: AwsStub<any, any, any>,
+  command: AwsCommandConstructur<any, any>,
+  input: Record<string, any>,
+): ExpectationResult {
+  const { isNot, utils } = this;
+  const calls = client.commandCalls(command);
+
+  const hasCallWithArgs = calls.some(call =>
+    new ObjectContaining(input).asymmetricMatch(call.args[0].input),
+  );
+
+  const pass = calls.length === 1 && hasCallWithArgs;
+
+  return {
+    message: () => {
+      const message = isNot
+        ? `expected "${command.name}" to not be called once with arguments: ${utils.printExpected(input)}`
+        : `expected "${command.name}" to be called once with arguments: ${utils.printExpected(input)}`;
+      return formatCalls(this, client, command, input, message);
+    },
+    pass,
+  };
+};
+const toReceiveCommandExactlyOnceWith = toHaveReceivedCommandExactlyOnceWith;
+
 function toHaveReceivedNthCommandWith(
   this: MatcherState,
   client: AwsStub<any, any, any>,
@@ -289,13 +323,15 @@ export type { CustomMatcher };
 export {
   toHaveReceivedAnyCommand,
   toHaveReceivedCommand,
+  toHaveReceivedCommandExactlyOnceWith,
   toHaveReceivedCommandOnce,
   toHaveReceivedCommandTimes,
   toHaveReceivedCommandWith,
   toHaveReceivedLastCommandWith,
   toHaveReceivedNthCommandWith,
   toReceiveAnyCommand,
   toReceiveCommand,
+  toReceiveCommandExactlyOnceWith,
   toReceiveCommandOnce,
   toReceiveCommandTimes,
   toReceiveCommandWith,

tests/index.test.ts

@@ -5,13 +5,15 @@ import { describe, expect, it } from 'vitest';
 import {
   toHaveReceivedAnyCommand,
   toHaveReceivedCommand,
+  toHaveReceivedCommandExactlyOnceWith,
   toHaveReceivedCommandOnce,
   toHaveReceivedCommandTimes,
   toHaveReceivedCommandWith,
   toHaveReceivedLastCommandWith,
   toHaveReceivedNthCommandWith,
   toReceiveAnyCommand,
   toReceiveCommand,
+  toReceiveCommandExactlyOnceWith,
   toReceiveCommandOnce,
   toReceiveCommandTimes,
   toReceiveCommandWith,
@@ -22,13 +24,15 @@ import {
 expect.extend({
   toHaveReceivedAnyCommand,
   toHaveReceivedCommand,
+  toHaveReceivedCommandExactlyOnceWith,
   toHaveReceivedCommandOnce,
   toHaveReceivedCommandTimes,
   toHaveReceivedCommandWith,
   toHaveReceivedLastCommandWith,
   toHaveReceivedNthCommandWith,
   toReceiveAnyCommand,
   toReceiveCommand,
+  toReceiveCommandExactlyOnceWith,
   toReceiveCommandOnce,
   toReceiveCommandTimes,
   toReceiveCommandWith,
@@ -52,7 +56,9 @@ describe('aws-sdk-client-mock-vitest', () => {
     'toReceiveLastCommandWith',
     'toReceiveNthCommandWith',
     'toReceiveAnyCommand',
-  ])('should be able to extend with %s', (matcher) => {
+    'toReceiveCommandExactlyOnceWith',
+    'toHaveReceivedCommandExactlyOnceWith',
+  ])('extend matcher to extend with %s', (matcher) => {
     expect(expect('something')).toHaveProperty(matcher);
   });