Skip to main content

aweXpect.Mockolate

Nuget

aweXpect.Mockolate contains expectations to verify interactions with mocks from Mockolate.

Features​

Interaction count​

Verify that a method was called a specific number of times:

var mock = Mock.Create<IMyService>();
mock.MyMethod();

await That(mock.VerifyMock.Invoked.MyMethod()).Once();             // Exactly once
await That(mock.VerifyMock.Invoked.MyMethod()).Twice();            // Exactly twice
await That(mock.VerifyMock.Invoked.MyMethod()).Never();            // Never called
await That(mock.VerifyMock.Invoked.MyMethod()).AtLeastOnce();      // At least once
await That(mock.VerifyMock.Invoked.MyMethod()).AtLeastTwice();     // At least twice
await That(mock.VerifyMock.Invoked.MyMethod()).AtLeast(3.Times()); // At least 3 times
await That(mock.VerifyMock.Invoked.MyMethod()).AtMostOnce();       // At most once
await That(mock.VerifyMock.Invoked.MyMethod()).AtMostTwice();      // At most twice
await That(mock.VerifyMock.Invoked.MyMethod()).AtMost(4.Times());  // At most 4 times
await That(mock.VerifyMock.Invoked.MyMethod()).Exactly(2.Times()); // Exactly 2 times

Interaction order​

Verify that methods were called in a specific sequence:

var mock = Mock.Create<IMyService>();
mock.MyMethod(1);
mock.MyMethod(2);
mock.MyMethod(3);
mock.MyMethod(4);

// Verifies MyMethod(1), then MyMethod(2), then MyMethod(4) were called in order
await That(mock.VerifyMock.Invoked.MyMethod(It.Is(1))).Then(
    m => m.Invoked.MyMethod(It.Is(2)),
    m => m.Invoked.MyMethod(It.Is(4))
);

Additional Verifications​

All interactions are verified​

With AllInteractionsAreVerified you can check whether all interactions with the mock have actually been verified. This helps to detect unintended or forgotten calls.

var mock = Mock.Create<IMyService>();
mock.MyMethod(1);
mock.MyMethod(2);

await That(mock.VerifyMock.Invoked.MyMethod(It.IsAny<int>())).AtLeastOnce();
 // Succeeds, because the verification applies to both method calls.
await That(mock.VerifyMock).AllInteractionsAreVerified();

All setups are used​

With AllSetupsAreUsed you can check whether all defined setups on the mock have actually been used. This ensures that no setup configurations remain unused.

var mock = Mock.Create<IMyService>();
mock.SetupMock.Method.MyMethod(It.Is(1)).Returns(10);
mock.SetupMock.Method.MyMethod(It.Is(2)).Returns(20);

mock.MyMethod(1);

// Fails, because the setup for MyMethod(2) was never used.
await That(mock.VerifyMock).AllSetupsAreUsed();

Web Extensions​

JSON Content​

You can precisely verify JSON content in HTTP requests during your tests. This feature is especially useful for testing HTTP clients and web APIs.

// Verifies that a request was sent with a JSON body equivalent to { "foo": 1, "bar": "baz" }
httpClient.SetupMock.Method
    .PostAsync(It.IsAny<Uri>(), It.IsHttpContent().WithJsonMatching(new { foo = 1, bar = \"baz\" }))
    .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK));

// You can also provide a string representation of the JSON and it ignores formatting differences or property order
httpClient.SetupMock.Method
    .PostAsync(It.IsAny<Uri>(), It.IsHttpContent().WithJson("{\"bar\": \"baz\", \"foo\": 1}"))
    .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK));