Skip to content

Add AssertionResult.Failed overload that accepts an Exception #5388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomhurst merged 7 commits into from
Apr 4, 2026
Merged

Add AssertionResult.Failed overload that accepts an Exception #5388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8dd0e16
Add AssertionResult.Failed overload that accepts an Exception (#5381)
thomhurst Apr 4, 2026
5ce2385
Add context to GroupAssertion error messages
thomhurst Apr 4, 2026
3c538ca
Propagate exceptions through all metadata.Exception guards and cache …
thomhurst Apr 4, 2026
37ede42
Propagate exceptions in remaining guard sites
thomhurst Apr 4, 2026
c09946a
Unwrap AssertionException in WaitsForAssertion to avoid double-wrapping
thomhurst Apr 4, 2026
225b65f
Address review feedback
thomhurst Apr 4, 2026
1a03024
Add integration tests for exception propagation and WaitsFor comment
thomhurst Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions TUnit.Assertions/Assertions/Enums/EnumAssertions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TEnum> me

if (exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}"));
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception));
}

#if NET
Expand Down Expand Up @@ -59,7 +59,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TEnum> me

if (exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}"));
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception));
}

#if NET
Expand Down
10 changes: 6 additions & 4 deletions TUnit.Assertions/Assertions/Regex/GroupAssertion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg

if (exception != null)
{
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}");
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception);
}

if (collection == null || collection.Count == 0)
Expand All @@ -58,7 +58,8 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg
}
catch (Exception ex)
{
return AssertionResult.Failed(ex.Message);
var groupDesc = _groupName != null ? $"group '{_groupName}'" : $"group {_groupIndex}";
return AssertionResult.Failed($"failed to get {groupDesc}: {ex.Message}", ex);
}

var groupAssertion = new ValueAssertion<string>(groupValue, _groupName ?? $"group {_groupIndex}");
Expand Down Expand Up @@ -116,7 +117,7 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg

if (exception != null)
{
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}");
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception);
}

if (match == null)
Expand All @@ -133,7 +134,8 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg
}
catch (Exception ex)
{
return AssertionResult.Failed(ex.Message);
var groupDesc = _groupName != null ? $"group '{_groupName}'" : $"group {_groupIndex}";
return AssertionResult.Failed($"failed to get {groupDesc}: {ex.Message}", ex);
}

var groupAssertion = new ValueAssertion<string>(groupValue, _groupName ?? $"group {_groupIndex}");
Expand Down
4 changes: 2 additions & 2 deletions TUnit.Assertions/Assertions/Regex/MatchAssertion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg

if (exception != null)
{
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}");
return AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception);
}

if (collection == null)
Expand All @@ -49,7 +49,7 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<Reg
}
catch (Exception ex)
{
return AssertionResult.Failed($"Failed to get match at index {_index}: {ex.Message}");
return AssertionResult.Failed($"Failed to get match at index {_index}: {ex.Message}", ex);
}

var matchAssertion = new ValueAssertion<RegexMatch>(match, $"match at index {_index}");
Expand Down
4 changes: 2 additions & 2 deletions TUnit.Assertions/Assertions/Regex/MatchIndexAssertion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<RegexMatc
{
if (exception is ArgumentOutOfRangeException || exception is InvalidOperationException)
{
return Task.FromResult(AssertionResult.Failed(exception.Message));
return Task.FromResult(AssertionResult.Failed(exception.Message, exception));
}
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}", exception));
}

// If we have a match, the assertion passed
Expand Down
4 changes: 2 additions & 2 deletions TUnit.Assertions/Assertions/Strings/ParseAssertions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<string> m

if (exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}"));
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception));
}

if (value == null)
Expand Down Expand Up @@ -141,7 +141,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<string> m

if (exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}"));
return Task.FromResult(AssertionResult.Failed($"threw {exception.GetType().Name}: {exception.Message}", exception));
}

if (value == null)
Expand Down
24 changes: 12 additions & 12 deletions TUnit.Assertions/Collections/MemoryAssertions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -65,7 +65,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -107,7 +107,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -149,7 +149,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -204,7 +204,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -250,7 +250,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -292,7 +292,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -331,7 +331,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -370,7 +370,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -409,7 +409,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -448,7 +448,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down Expand Up @@ -609,7 +609,7 @@ protected override Task<AssertionResult> CheckAsync(EvaluationMetadata<TMemory>
{
if (metadata.Exception != null)
{
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}"));
return Task.FromResult(AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception));
}

if (metadata.Value == null)
Expand Down
2 changes: 1 addition & 1 deletion TUnit.Assertions/Conditions/AsyncEnumerableAssertions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ protected override async Task<AssertionResult> CheckAsync(EvaluationMetadata<IAs
{
if (metadata.Exception != null)
{
return AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}");
return AssertionResult.Failed($"threw {metadata.Exception.GetType().Name}", metadata.Exception);
}

if (metadata.Value == null)
Expand Down
Loading
Loading