feat: add Within and WithCancellation to verification result

[vbreuss]

This PR extends Mockolate’s verification results with awaitable behavior by adding Within(...) and WithCancellation(...), enabling verifications to wait for interactions to occur (or time out / be canceled). It also updates verification exception messaging and expands test and API-surface coverage accordingly.

Key changes:

• Add Within(TimeSpan) and WithCancellation(CancellationToken) to VerificationResult<TVerify> and introduce async verification plumbing (IAsyncVerificationResult).
• Update verification extension methods to translate timeout/cancellation into MockVerificationException messages.
• Add/extend unit tests and update API baseline snapshots for supported TFMs.

---

• Fixes Support .Within(TimeSpan timeout) when verifing interactions #494

[Copilot]

Pull request overview

This PR extends Mockolate’s verification results with awaitable behavior by adding Within(...) and WithCancellation(...), enabling verifications to wait for interactions to occur (or time out / be canceled). It also updates verification exception messaging and expands test and API-surface coverage accordingly.

Changes:

• Add Within(TimeSpan) and WithCancellation(CancellationToken) to VerificationResult<TVerify> and introduce async verification plumbing (IAsyncVerificationResult).
• Update verification extension methods to translate timeout/cancellation into MockVerificationException messages.
• Add/extend unit tests and update API baseline snapshots for supported TFMs.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
Tests/Mockolate.Tests/Verify/VerificationResultTests.cs	Converts the test class to sealed partial to support splitting async-specific tests into a companion file.
Tests/Mockolate.Tests/Verify/VerificationResultTests.AsyncTests.cs	Adds new tests for Within(...)/WithCancellation(...) behavior and timeout messaging.
Tests/Mockolate.Tests/Verify/VerificationResultExtensionsTests.cs	Adds coverage ensuring extension methods throw MockVerificationException with timeout messaging for multiple verification variants.
Tests/Mockolate.Api.Tests/Expected/Mockolate_netstandard2.0.txt	Updates API baseline to include new interface and new VerificationResult<TVerify> members.
Tests/Mockolate.Api.Tests/Expected/Mockolate_net8.0.txt	Updates API baseline to include new interface and new VerificationResult<TVerify> members.
Tests/Mockolate.Api.Tests/Expected/Mockolate_net10.0.txt	Updates API baseline to include new interface and new VerificationResult<TVerify> members.
Source/Mockolate/Verify/VerificationResultExtensions.cs	Wraps verification calls to convert timeout exceptions into MockVerificationException messages.
Source/Mockolate/Verify/VerificationResult.cs	Implements awaitable verification (Within/WithCancellation) and async wait logic via interaction notifications.
Source/Mockolate/Verify/IAsyncVerificationResult.cs	Introduces an async verification interface for awaitable verification results.
Source/Mockolate/Internals/TaskExtensions.cs	Adds a small polyfill-like helper to await a TaskCompletionSource with cancellation across TFMs.
Source/Mockolate/Exceptions/MockVerificationTimeoutException.cs	Adds a dedicated internal exception for timeout/cancellation during awaitable verification.

Comments suppressed due to low confidence (1)

Source/Mockolate/Exceptions/MockVerificationTimeoutException.cs:8

• The XML summary says this exception represents a general verification error, but the type is specifically for timeouts/cancellation during awaitable verification. Updating the summary to mention timeouts will make the intent clearer and avoid confusion with MockVerificationException.

/// <summary>
///     Represents a verification error on the mock.
/// </summary>
internal class MockVerificationTimeoutException : MockException

[github-actions]

Test Results

    21 files  ±  0      21 suites  ±0   6m 4s ⏱️ +57s
 2 779 tests + 21   2 778 ✅ + 21  1 💤 ±0  0 ❌ ±0 
18 670 runs  +147  18 669 ✅ +147  1 💤 ±0  0 ❌ ±0 

Results for commit 8c57ab1. ± Comparison against base commit ddabf6d.

♻️ This comment has been updated with latest results.

[github-actions]

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)

AMD EPYC 7763 2.62GHz, 1 CPU, 4 logical and 2 physical cores

.NET SDK 10.0.103

[Host] : .NET 10.0.3 (10.0.3, 10.0.326.7603), X64 RyuJIT x86-64-v3
Job=InProcess  Toolchain=InProcessEmitToolchain  IterationCount=15

LaunchCount=1  WarmupCount=10

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Simple_Mockolate	1.534 μs	0.0202 μs	0.0189 μs	0.2460	-	4.02 KB
Simple_Moq	181.281 μs	0.7334 μs	0.6501 μs	0.4883	-	14.55 KB
Simple_NSubstitute	5.687 μs	0.0356 μs	0.0316 μs	0.5493	0.0076	9.09 KB
Simple_FakeItEasy	6.285 μs	0.0501 μs	0.0469 μs	0.4959	-	8.11 KB

[Copilot]

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.1% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

This is addressed in release v1.5.0.