microsoft
Openness for Caller Argument Expression in Assert failure messages
Description
With .Net 6 Caller Argument Expression was added, this could be used in testfx to provide the expression which failed the check. Doing this could provider consumers more out of the box detail about what caused the assert to fail without having to manually provide messages.
Sample Code change
#if !NET6_0_OR_GREATER
public static void IsNull(object value)
{
IsNull(value, string.Empty, null);
}
#endif
public static void IsNull(
object value,
#if !NET6_0_OR_GREATER
string message)
#else
[CallerArgumentExpression("value")]string message = "")
#endif
{
IsNull(value, message, null);
}
Work required
- Add .Net 6 as a built/packaged runtime
- Modify Assert code to make the flows without a message removed in .Net 6 so that code like
Assert.IsNull(myParam)execute passingmyParamas the message.
Change in behavior
Currently a failing call to Assert.IsNull without a message will just return Assert.IsNull failed. This would change to Assert.IsNull failed. myParam which could be considered a breaking change and a result a no-go.
Reopening the issue as changes are reverted. Long story short we misidentified the impact and as it is introducing some breaking changes we will postpone its fix in v4 of MSTest.
Just to confirm, is [CallerArgumentExpression] not supported at all currently by MSTest? Meaning no methods using the attribute would be able to be unit tested using MSTest?
If your method has some argument marked with the CallerArgumentExpression attribute there is no problem for the method to be tested. The goal of this ticket is to rewrite MSTest assertions methods to be using this attribute so that if the user provides no custom message we can provide a better default message (being the caller expression).