Skip to content

Report more actual and expected assertion values #7127

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
Evangelink merged 1 commit into from
Dec 16, 2025
Merged

Report more actual and expected assertion values #7127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/TestFramework/TestFramework/Assertions/Assert.Count.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ private static void ThrowAssertCountFailed(string assertionName, int expectedCou
userMessage,
expectedCount,
actualCount);
ThrowAssertFailed($"Assert.{assertionName}", finalMessage);
ThrowAssertFailed($"Assert.{assertionName}", finalMessage, expectedCount, actualCount);
}

[DoesNotReturn]
Expand Down
4 changes: 2 additions & 2 deletions src/TestFramework/TestFramework/Assertions/Assert.EndsWith.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public static void EndsWith([NotNull] string? expectedSuffix, [NotNull] string?
{
string userMessage = BuildUserMessageForExpectedSuffixExpressionAndValueExpression(message, expectedSuffixExpression, valueExpression);
string finalMessage = string.Format(CultureInfo.CurrentCulture, FrameworkMessages.EndsWithFail, value, expectedSuffix, userMessage);
ThrowAssertFailed("Assert.EndsWith", finalMessage);
ThrowAssertFailed("Assert.EndsWith", finalMessage, expectedSuffix, value);
}
}

Expand Down Expand Up @@ -152,7 +152,7 @@ public static void DoesNotEndWith([NotNull] string? notExpectedSuffix, [NotNull]
{
string userMessage = BuildUserMessageForNotExpectedSuffixExpressionAndValueExpression(message, notExpectedSuffixExpression, valueExpression);
string finalMessage = string.Format(CultureInfo.CurrentCulture, FrameworkMessages.DoesNotEndWithFail, value, notExpectedSuffix, userMessage);
ThrowAssertFailed("Assert.DoesNotEndWith", finalMessage);
ThrowAssertFailed("Assert.DoesNotEndWith", finalMessage, notExpectedSuffix, value);
}
}
}
12 changes: 6 additions & 6 deletions src/TestFramework/TestFramework/Assertions/Assert.IComparable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ private static void ThrowAssertIsGreaterThanFailed<T>(T lowerBound, T value, str
userMessage,
ReplaceNulls(lowerBound),
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsGreaterThan", finalMessage);
ThrowAssertFailed("Assert.IsGreaterThan", finalMessage, lowerBound, value);
}

[DoesNotReturn]
Expand All @@ -319,7 +319,7 @@ private static void ThrowAssertIsGreaterThanOrEqualToFailed<T>(T lowerBound, T v
userMessage,
ReplaceNulls(lowerBound),
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsGreaterThanOrEqualTo", finalMessage);
ThrowAssertFailed("Assert.IsGreaterThanOrEqualTo", finalMessage, lowerBound, value);
}

[DoesNotReturn]
Expand All @@ -331,7 +331,7 @@ private static void ThrowAssertIsLessThanFailed<T>(T upperBound, T value, string
userMessage,
ReplaceNulls(upperBound),
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsLessThan", finalMessage);
ThrowAssertFailed("Assert.IsLessThan", finalMessage, upperBound, value);
}

[DoesNotReturn]
Expand All @@ -343,7 +343,7 @@ private static void ThrowAssertIsLessThanOrEqualToFailed<T>(T upperBound, T valu
userMessage,
ReplaceNulls(upperBound),
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsLessThanOrEqualTo", finalMessage);
ThrowAssertFailed("Assert.IsLessThanOrEqualTo", finalMessage, upperBound, value);
}

[DoesNotReturn]
Expand All @@ -354,7 +354,7 @@ private static void ThrowAssertIsPositiveFailed<T>(T value, string userMessage)
FrameworkMessages.IsPositiveFailMsg,
userMessage,
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsPositive", finalMessage);
ThrowAssertFailed("Assert.IsPositive", finalMessage, actual: value);
}

[DoesNotReturn]
Expand All @@ -365,6 +365,6 @@ private static void ThrowAssertIsNegativeFailed<T>(T value, string userMessage)
FrameworkMessages.IsNegativeFailMsg,
userMessage,
ReplaceNulls(value));
ThrowAssertFailed("Assert.IsNegative", finalMessage);
ThrowAssertFailed("Assert.IsNegative", finalMessage, actual: value);
}
}
4 changes: 2 additions & 2 deletions src/TestFramework/TestFramework/Assertions/Assert.StartsWith.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public static void StartsWith([NotNull] string? expectedPrefix, [NotNull] string
{
string userMessage = BuildUserMessageForExpectedPrefixExpressionAndValueExpression(message, expectedPrefixExpression, valueExpression);
string finalMessage = string.Format(CultureInfo.CurrentCulture, FrameworkMessages.StartsWithFail, value, expectedPrefix, userMessage);
ThrowAssertFailed("Assert.StartsWith", finalMessage);
ThrowAssertFailed("Assert.StartsWith", finalMessage, expectedPrefix, value);
}
}

Expand Down Expand Up @@ -150,7 +150,7 @@ public static void DoesNotStartWith([NotNull] string? notExpectedPrefix, [NotNul
{
string userMessage = BuildUserMessageForNotExpectedPrefixExpressionAndValueExpression(message, notExpectedPrefixExpression, valueExpression);
string finalMessage = string.Format(CultureInfo.CurrentCulture, FrameworkMessages.DoesNotStartWithFail, value, notExpectedPrefix, userMessage);
ThrowAssertFailed("Assert.DoesNotStartWith", finalMessage);
ThrowAssertFailed("Assert.DoesNotStartWith", finalMessage, notExpectedPrefix, value);
}
}
}
4 changes: 2 additions & 2 deletions src/TestFramework/TestFramework/Assertions/Assert.ThrowsException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ private static async Task<ThrowsExceptionState> IsThrowsAsyncFailingAsync<TExcep
userMessage,
typeof(TException),
ex.GetType());
ThrowAssertFailed("Assert." + assertMethodName, finalMessage);
ThrowAssertFailed("Assert." + assertMethodName, finalMessage, actual: ex);
}, ex);
}

Expand Down Expand Up @@ -578,7 +578,7 @@ private static ThrowsExceptionState IsThrowsFailing<TException>(Action action, b
userMessage,
typeof(TException),
ex.GetType());
ThrowAssertFailed("Assert." + assertMethodName, finalMessage);
ThrowAssertFailed("Assert." + assertMethodName, finalMessage, actual: ex);
}, ex);
}

Expand Down
12 changes: 8 additions & 4 deletions src/TestFramework/TestFramework/Assertions/Assert.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ internal static void ThrowAssertFailed(string assertionName, string? message)
/// </param>
[DoesNotReturn]
[StackTraceHidden]
internal static void ThrowAssertFailed<T>(string assertionName, string? message, T? expected, T? actual)
internal static void ThrowAssertFailed<T>(string assertionName, string? message, T? expected = default, T? actual = default)
{
AssertFailedException exception = new(
string.Format(CultureInfo.CurrentCulture, FrameworkMessages.AssertionFailed, assertionName, message));
Expand All @@ -79,14 +79,17 @@ internal static void ThrowAssertFailed<T>(string assertionName, string? message,
throw exception;
}

private static bool HasKnownGoodToString([NotNullWhen(true)] object? value)
private static bool HasKnownGoodToString<T>([NotNullWhen(true)] T? value)
{
if (value is null)
{
return false;
}

Type type = value.GetType();
Type type = typeof(T);

// Unwrap nullable value types
type = Nullable.GetUnderlyingType(type) ?? type;

// Primitive types and string
if (type.IsPrimitive || type == typeof(string))
Expand All @@ -101,7 +104,8 @@ private static bool HasKnownGoodToString([NotNullWhen(true)] object? value)
|| type == typeof(TimeSpan)
|| type == typeof(Guid)
|| type == typeof(Uri)
|| type.IsEnum;
|| type.IsEnum
|| typeof(Exception).IsAssignableFrom(type);
}

/// <summary>
Expand Down
Loading