Skip to content

Commit

Permalink
fix!: Correct expect.assertions() count on CommandWith commands (#209)
Browse files Browse the repository at this point in the history
  • Loading branch information
@lobbin
lobbin authored Mar 17, 2024
1 parent 6debb61 commit 65d53a7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 24 deletions.
27 changes: 3 additions & 24 deletions packages/aws-sdk-client-mock-jest/src/jestMatchers.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -332,16 +332,7 @@ const baseMatchers: { [P in keyof AwsSdkJestMockBaseMatchers<unknown>]: MatcherF
check: ({commandCalls}) => {
const matchCount = commandCalls
.map(call => call.args[0].input) // eslint-disable-line @typescript-eslint/no-unsafe-return
.map(received => {
try {
expect(received).toEqual(
expect.objectContaining(input),
);
return true;
} catch (e) {
return false;
}
})
.map(received => this.equals(received, expect.objectContaining(input)))
.reduce((acc, val) => acc + Number(val), 0);

return {pass: matchCount > 0, data: {matchCount}};
Expand Down Expand Up @@ -382,13 +373,7 @@ const baseMatchers: { [P in keyof AwsSdkJestMockBaseMatchers<unknown>]: MatcherF

let pass = false;
if (received instanceof command) {
try {
expect(received.input).toEqual(
expect.objectContaining(input),
);
pass = true;
} catch (e) { // eslint-disable-line no-empty
}
pass = this.equals(received.input, expect.objectContaining(input));
}

return {
Expand Down Expand Up @@ -443,13 +428,7 @@ const baseMatchers: { [P in keyof AwsSdkJestMockBaseMatchers<unknown>]: MatcherF

let pass = false;
if (received instanceof command) {
try {
expect(received.input).toEqual(
expect.objectContaining(input),
);
pass = true;
} catch (e) { // eslint-disable-line no-empty
}
pass = this.equals(received.input, expect.objectContaining(input));
}

return {
Expand Down
40 changes: 40 additions & 0 deletions packages/aws-sdk-client-mock-jest/test/jestMatchers.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ afterEach(() => {

describe('toHaveReceivedCommand', () => {
it('passes on receiving Command', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -29,6 +31,8 @@ SNSClient received <green>"PublishCommand"</color> <red>0</color> times"
});

it('fails on receiving Command with not', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -42,6 +46,9 @@ Calls:
});

it('fails on more arguments', async () => {
// We only expect 1 assertion here due to expected "internal error" in toHaveReceivedCommand
expect.assertions(1);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -53,6 +60,8 @@ Calls:

describe('toHaveReceivedCommandTimes', () => {
it('passes on receiving Command twice', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand All @@ -74,6 +83,8 @@ Calls:
});

it('fails on receiving Command twice with not', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd1);
Expand All @@ -91,6 +102,8 @@ Calls:

describe('toHaveReceivedCommandWith', () => {
it('passes on receiving Command with partial match', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand All @@ -99,6 +112,8 @@ describe('toHaveReceivedCommandWith', () => {
});

it('fails on not receiving Command', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -112,6 +127,8 @@ Calls:
});

it('fails on receiving Command with partial match with not', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -125,6 +142,8 @@ Calls:
});

it('passes on match with asymmetric matcher', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -134,6 +153,8 @@ Calls:
});

it('fails on unmatch with asymmetric matcher', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -151,6 +172,8 @@ Calls:

describe('toHaveReceivedNthCommandWith', () => {
it('passes on receiving second Command with partial match', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand All @@ -159,6 +182,8 @@ describe('toHaveReceivedNthCommandWith', () => {
});

it('fails on not receiving second Command', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd1);
Expand All @@ -182,6 +207,8 @@ Calls:
});

it('fails on receiving second Command with not', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand All @@ -204,6 +231,8 @@ Calls:
});

it('fails on receiving less Commands than the nth requested', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -216,6 +245,8 @@ Calls:
});

it('passes on match with asymmetric matcher', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand All @@ -226,6 +257,8 @@ Calls:
});

it('fails on unmatch with asymmetric matcher', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(publishCmd2);
Expand Down Expand Up @@ -253,6 +286,8 @@ Calls:

describe('toHaveReceivedNthSpecificCommandWith', () => {
it('passes on receiving second Command with partial match', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);
await sns.send(subscribeCmd1);
Expand All @@ -262,6 +297,8 @@ describe('toHaveReceivedNthSpecificCommandWith', () => {
});

it('fails on receiving less Commands than the nth expected', async () => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(publishCmd1);

Expand All @@ -280,13 +317,16 @@ describe('toHaveReceivedAnyCommand', () => {
${publishCmd1}
${subscribeCmd1}
`('passes on receiving any command', async ({ command }: { command: AwsCommand<any, any> }) => {
expect.assertions(2);

const sns = new SNSClient({});
await sns.send(command); // eslint-disable-line @typescript-eslint/no-unsafe-argument

expect(() => expect(snsMock).toHaveReceivedAnyCommand()).not.toThrow();
});

it('fails on not receiving any command', () => {
expect.assertions(2);
expect(() => expect(snsMock).toHaveReceivedAnyCommand()).toThrowErrorMatchingInlineSnapshot(`
"Expected SNSClient to receive any command
SNSClient received any command <red>0</color> times"
Expand Down

0 comments on commit 65d53a7

Please sign in to comment.