如何模拟 ExceptionContext 以使用 .NET Core 3 Web API 和 Moq 进行测试

Question

为了在 .NET Core 3 中正确测试自定义 ExceptionFilterAttribute，我们需要使用 Moq 在 Xunit 测试中模拟 ExceptionContext。我该怎么做？

异常过滤器：

public class CustomExceptionFilter : ExceptionFilterAttribute
{
  public override OnException(ExceptionContext context)
  {
    /* Code here that handles exceptions */
  }
}

我到处都看过，但无法找到一种好方法来模拟这些东西，以确保不会因其他缺少的依赖项而引发异常。我怎样才能轻松地模拟 ExceptionContext？

Answer 1

问题在于，如果您试图模拟 ExceptionContext 以便 return 不同的异常类型，您实际上想要模拟一个异常，然后在实例化时使用该模拟异常ExceptionContext.

首先，要在测试中为过滤器实例化 ExceptionContext，您需要能够实例化 ActionContext。 ActionContext 与我们的测试无关，但依赖树需要它，因此我们必须尽可能少地自定义实例化它：

var actionContext = new ActionContext()
{
  HttpContext = new DefaultHttpContext(),
  RouteData = new RouteData(),
  ActionDescriptor = new ActionDescriptor()
};

在您能够实例化 ActionContext 之后，您可以实例化 ExceptionContext。在这里，我们还模拟了用于构建 ExceptionContext 的异常。这是最重要的一步，因为这是改变我们正在测试的行为的值。

// The stacktrace message and source member variables are virtual and so we can stub them here.
var mockException = new Mock<Exception>();

mockException.Setup(e => e.StackTrace)
  .Returns("Test stacktrace");
mockException.Setup(e => e.Message)
  .Returns("Test message");
mockException.Setup(e => e.Source)
  .Returns("Test source");

var exceptionContext = new ExceptionContext(actionContext, new List<FilterMetadata>())
{
  Exception = mockException.Object
};

这样做可以让您在给定不同的异常类型时充分测试异常过滤器的行为。

完整代码：

[Fact]
public void TestExceptionFilter()
{
  var actionContext = new ActionContext()
  {
    HttpContext = new DefaultHttpContext(),
    RouteData = new RouteData(),
    ActionDescriptor = new ActionDescriptor()
  };

  // The stacktrace message and source member variables are virtual and so we can stub them here.
  var mockException = new Mock<Exception>();

  mockException.Setup(e => e.StackTrace)
    .Returns("Test stacktrace");
  mockException.Setup(e => e.Message)
    .Returns("Test message");
  mockException.Setup(e => e.Source)
    .Returns("Test source");

  // the List<FilterMetadata> here doesn't have much relevance in the test but is required 
  // for instantiation. So we instantiate a new instance of it with no members to ensure
  // it does not effect the test.
  var exceptionContext = new ExceptionContext(actionContext, new List<FilterMetadata>())
  {
    Exception = mockException.Object
  };

  var filter = new CustomExceptionFilter();

  filter.OnException(exceptionContext);

  // Assumption here that your exception filter modifies status codes.
  // Just used as an example of how you can assert in this test.
  context.HttpContext.Response.StatusCode.Should().Be(500, 
    "Because the response code should match the exception thrown.");
}

如何模拟 ExceptionContext 以使用 .NET Core 3 Web API 和 Moq 进行测试

How to mock ExceptionContext for testing using .NET Core 3 Web API and Moq

c#

unit-testing

moq

xunit

.net-core