feat: support async `Because` reason by vbreuss · Pull Request #880 · Testably/aweXpect

vbreuss · 2026-01-18T15:07:56Z

This PR adds support for asynchronous Because reasons in the aweXpect assertion library, allowing users to provide a Task<string> as the reason for an expectation.

Key Changes:

Introduces IBecauseReason interface to support both synchronous and asynchronous reason handling
Adds AsyncBecauseReason struct to handle Task<string> reasons
Updates ExpectationResult to accept Task<string> in Because() method

Copilot

Pull request overview

This PR adds support for asynchronous Because reasons in the aweXpect assertion library, allowing users to provide a Task<string> as the reason for an expectation.

Changes:

Introduces IBecauseReason interface to support both synchronous and asynchronous reason handling
Adds AsyncBecauseReason struct to handle Task<string> reasons
Updates ExpectationResult to accept Task<string> in Because() method

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
Source/aweXpect.Core/Core/Helpers/IBecauseReason.cs	New interface defining async contract for applying reasons to constraint results
Source/aweXpect.Core/Core/Helpers/BecauseReason.cs	Updated to implement `IBecauseReason` interface with async return type
Source/aweXpect.Core/Core/Helpers/AsyncBecauseReason.cs	New struct implementing async reason handling for `Task<string>`
Source/aweXpect.Core/Core/ExpectationBuilder.cs	Adds overload to support `Task<string>` reasons
Source/aweXpect.Core/Results/ExpectationResult.cs	Adds `Because(Task<string>)` overloads for async reason support
Source/aweXpect.Core/Core/Nodes/Node.cs	Updates abstract method signature to use `IBecauseReason`
Source/aweXpect.Core/Core/Nodes/ExpectationNode.cs	Refactors to apply reason asynchronously after constraint evaluation
Source/aweXpect.Core/Core/Nodes/AndNode.cs	Updates to use `IBecauseReason` interface
Source/aweXpect.Core/Core/Nodes/OrNode.cs	Updates to use `IBecauseReason` interface
Source/aweXpect.Core/Core/Nodes/WhichNode.cs	Updates to use `IBecauseReason` interface
Tests/aweXpect.Core.Tests/Core/BecauseTests.cs	Adds test coverage for async `Because` functionality with Action and Func delegates
Tests/aweXpect.Core.Tests/TestHelpers/DummyNode.cs	Updates test helper to use `IBecauseReason` interface
Tests/aweXpect.Core.Api.Tests/ApiAcceptance.cs	Removes `[Explicit]` attribute to enable API acceptance test

Copilot · 2026-01-18T15:08:29Z

+
+internal interface IBecauseReason
+{
+


Remove unnecessary blank line inside the interface definition.

Suggested change

Copilot · 2026-01-18T15:08:29Z

 	/// </summary>
 	[TestCase]
-	[Explicit]
 	public async Task AcceptApiChanges()


The removal of the [Explicit] attribute enables this test to run automatically. This test updates the expected public API to match the current API surface, which should typically require manual intervention. Ensure this change is intentional and that the API changes in this PR have been reviewed and approved before allowing automatic execution of this test.

sonarqubecloud · 2026-01-18T15:15:30Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
97.5% Coverage on New Code
2.2% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-01-18T15:16:34Z

Test Results

23 files - 27 23 suites - 27 7m 8s ⏱️ - 1m 37s
19 517 tests - 27 19 516 ✅ - 26 1 💤 - 1 0 ❌ ±0
101 000 runs - 63 100 999 ✅ - 62 1 💤 - 1 0 ❌ ±0

Results for commit f3f91af. ± Comparison against base commit 9f92c67.

This pull request removes 3108 and adds 3081 tests. Note that renamed tests count towards both.

aweXpect.Core.Tests.Core.BecauseTests ‑ Delegate_ShouldApplyBecauseReason
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message20cc43aa-2219-49ff-985e-9d7595049dff")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message2b6658e6-358e-4410-b52b-748c522d78ad")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message45c0374c-ab57-4936-a68e-f3981ceb6f1e")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message646cbbcb-e3bb-4ce1-b0ba-3266b3390b9d")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message788c38be-8beb-4e04-a473-15ce11c642f0")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message8c3d46d1-dfe5-419c-b8d0-664ffac9b62b")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message3b60baff-0457-4ac3-9465-10b71c079416")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message74812392-9c68-4bcc-9714-d1923c48602d")
aweXpect.Core.Tests.Core.Exceptions.SkipExceptionTests ‑ Message_ShouldBeSet(message: "message885e1ccc-dde1-4e50-b5eb-0294922a3837")
…

aweXpect.Core.Tests.Core.BecauseTests ‑ ActionDelegate_ShouldApplyAsyncBecauseReason
aweXpect.Core.Tests.Core.BecauseTests ‑ ActionDelegate_ShouldApplyBecauseReason
aweXpect.Core.Tests.Core.BecauseTests ‑ FuncDelegate_ShouldApplyAsyncBecauseReason
aweXpect.Core.Tests.Core.BecauseTests ‑ FuncDelegate_ShouldApplyBecauseReason
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message19fc54ab-1635-4940-9217-39108a40e640")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message3ce11f0f-57b9-46d8-91e9-cc74ae5e17d0")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message3f6c0126-18da-463a-85a8-49a7746e6266")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message4288edf7-86b0-4a5b-afe3-2500f37202d0")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "message9ddb7627-7d12-417d-87fa-760d129f3fa1")
aweXpect.Core.Tests.Core.Exceptions.FailExceptionTests ‑ Message_ShouldBeSet(message: "messageb93c025c-9c43-46d1-a55c-b3514d94d5cf")
…

github-actions · 2026-01-18T15:17:04Z

🚀 Benchmark Results

Details

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

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

.NET SDK 10.0.102

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

LaunchCount=1  WarmupCount=10

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Bool_aweXpect	266.1 ns	5.14 ns	4.29 ns	0.0424	-	712 B
Bool_FluentAssertions	253.4 ns	5.81 ns	5.15 ns	0.0567	-	952 B
Equivalency_aweXpect	300,783.6 ns	3,260.17 ns	3,049.57 ns	20.0195	0.4883	335452 B
Equivalency_FluentAssertions	2,729,955.1 ns	44,951.63 ns	42,047.78 ns	285.1563	46.8750	4804906 B
Int_GreaterThan_aweXpect	270.8 ns	3.83 ns	3.59 ns	0.0486	-	816 B
Int_GreaterThan_FluentAssertions	271.3 ns	4.50 ns	4.21 ns	0.0730	-	1224 B
ItemsCount_AtLeast_aweXpect	518.4 ns	3.15 ns	2.79 ns	0.0811	-	1368 B
ItemsCount_AtLeast_FluentAssertions	511.8 ns	9.32 ns	8.72 ns	0.1192	-	2008 B
String_aweXpect	503.3 ns	3.40 ns	3.01 ns	0.0677	-	1136 B
String_FluentAssertions	1,319.3 ns	12.25 ns	11.45 ns	0.2346	-	3944 B
StringArray_aweXpect	1,943.0 ns	27.65 ns	25.87 ns	0.1564	-	2632 B
StringArray_FluentAssertions	1,338.6 ns	18.67 ns	16.55 ns	0.2480	-	4152 B
StringArrayInAnyOrder_aweXpect	2,593.1 ns	5.42 ns	5.07 ns	0.1678	-	2824 B
StringArrayInAnyOrder_FluentAssertions	87,771.6 ns	432.16 ns	383.10 ns	3.4180	-	58598 B

) by Valentin Breuß

github-actions · 2026-01-19T05:00:13Z

This is addressed in release v2.30.0.

feat: support async Because reason

f3f91af

vbreuss self-assigned this Jan 18, 2026

vbreuss added the enhancement New feature or request label Jan 18, 2026

Copilot AI review requested due to automatic review settings January 18, 2026 15:07

Copilot AI reviewed Jan 18, 2026

View reviewed changes

vbreuss merged commit 23cb7fa into main Jan 18, 2026
14 checks passed

vbreuss deleted the topic/async-because branch January 18, 2026 15:29

github-actions Bot added a commit that referenced this pull request Jan 18, 2026

Update benchmark for 23cb7fa: feat: support async Because reason (#880

3bca61b

) by Valentin Breuß

github-actions Bot added a commit that referenced this pull request Jan 18, 2026

Update benchmark for 23cb7fa: feat: support async Because reason (#880

a8aad68

) by Valentin Breuß

github-actions Bot added the state: released The issue is released label Jan 19, 2026

This was referenced Jan 19, 2026

chore: Bump the awexpect group with 2 updates Testably/Mockolate#379

Merged

chore: Bump the awexpect group with 1 update Testably/aweXpect.Migration#94

Closed

chore: Bump the awexpect group with 1 update Mockerade/Mockolate#75

Open

dependabot Bot mentioned this pull request Feb 9, 2026

chore: Bump aweXpect from 2.18.0 to 2.30.0 Testably/aweXpect.Chronology#84

Closed

This was referenced Mar 30, 2026

chore: Bump aweXpect from 2.18.0 to 2.31.0 Testably/aweXpect.Chronology#92

Merged

chore: Bump the awexpect group with 2 updates Testably/Mockolate.Migration#7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: support async `Because` reason#880

feat: support async `Because` reason#880
vbreuss merged 1 commit intomainfrom
topic/async-because

vbreuss commented Jan 18, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

Copilot AI Jan 18, 2026

Uh oh!

sonarqubecloud Bot commented Jan 18, 2026

Uh oh!

github-actions Bot commented Jan 18, 2026

Uh oh!

github-actions Bot commented Jan 18, 2026

Uh oh!

Uh oh!

github-actions Bot commented Jan 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

vbreuss commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Changes:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jan 18, 2026

Quality Gate passed

Uh oh!

github-actions Bot commented Jan 18, 2026

Test Results

Uh oh!

github-actions Bot commented Jan 18, 2026

🚀 Benchmark Results

Uh oh!

Uh oh!

github-actions Bot commented Jan 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vbreuss commented Jan 18, 2026 •

edited

Loading