使用 xUnit 进行单元测试异常消息

Posted 2023-03-24

【中文标题】使用 xUnit 进行单元测试异常消息

【英文标题】：Unit test exception messages with xUnit

【发布时间】：2011-07-19 14:18:13

【问题描述】：

我目前正在将我的 MsTest 单元测试转换为 xUnit。使用 xUnit，有没有办法测试异常消息？测试异常消息而不是仅测试异常类型是否正确？

【参考方案1】：

我认为测试异常类型和消息是正确的。在 xUnit 中两者都很容易：

var exception = Assert.Throws<AuthenticationException>(() => DoSomething());
Assert.Equal(message, exception.Message);

【讨论】：

@CsabaToth 不，您需要 Assert.ThrowsAsync 来执行此操作

我确定我错过了明显的，但第一行中的 message 参数是什么？

@MarkEmbling 感谢您指出这一点——这可能是一个错字。我更新了答案。

【参考方案2】：

最好使用 Record.Exception 方法，因为它匹配 AAA 模式：

    [Fact]
    public void Divide_TwoNumbers_ExpectException()
    
        var sut = new Calculator();
        var exception = Record.Exception(() => sut.Divide(10, 0));
        Assert.IsType(typeof(DivideByZeroException), exception);
    

希望这会有所帮助...

【讨论】：

xUnit2007：不要使用 typeof(System.DivideByZeroException) 表达式来检查类型。相反，您可以使用： Assert.IsType(exception)

【参考方案3】：

类似的东西

 var ex = Record.Exception(() => DoSomeThing());
 Assert.IsType(typeof(ArgumentNullException), ex);
 Assert.True(ex.Message.Contains("Your exception message"));

【参考方案4】：

xUnit 使用 Assert.Throws 来测试异常类型。如果需要，您可以捕获异常并针对消息断言。我认为通常您想测试是否引发了预期的异常，并且确实不需要确切的消息。

Assert.Throws<ArgumentNullException>()

如果您有一个正在单元测试的自定义异常并且您想确保生成的消息是您所期望的，则可能会出现异常。或者，如果有两种方法可以抛出相同的异常类型但带有不同的消息，那么针对消息进行断言将是有价值的

【讨论】：

Throws() 返回异常——无需捕获。

【参考方案5】：

顺便说一句，Resharper 不喜欢使用 typeof，而是建议使用 Assert.IsType，例如

var ex = Record.Exception(() => new FooController(null, null));
Assert.IsType<ArgumentNullException>(ex);

【参考方案6】：

异常与您的测试的任何其他预期结果没有什么不同。测试消息是否正确是很自然的，因为两条不同的消息可能来自相同的异常类型。但是 - 我个人不认为这是强制性的，至少不是在所有例外情况下。

在我们的项目中，每个应用程序异常还附加了一个“消息”对象，因此我们仅验证 MessageId，我们不验证消息参数是否正确或消息的文本。例如，如果消息文本是“提供了错误的参数 ”，我们不会检查传递给格式 0 的参数是否符合预期 - 这不是意图。该消息具有唯一的 ID - 因此我们验证异常上的 MessageID 是“WRONG_PARAMETER_PROVIDED”。

【参考方案7】：

鉴于异步的东西，新版本将是

var ex = await Record.ExceptionAsync(() => myMethod(myParams));
Assert.IsType<SomeException>(ex);
Assert.Equal("My text of the error.", ex.Message);

【参考方案8】：

xUnit 网站还提到了“Record.Exception”构造。