Как выполнить модульное тестирование промежуточного программного обеспечения обработчика исключений - PullRequest
Новая
       6

Как выполнить модульное тестирование промежуточного программного обеспечения обработчика исключений

1 голос
/ 18 февраля 2020

Я пытаюсь использовать пользовательский обработчик ошибок, чтобы вернуть правильно отформатированные исключения для моего. NET Core 3 API. Обработчик работает отлично, у меня возникла проблема с написанием соответствующих модульных тестов для тестирования обработчика. Я зарегистрировал промежуточное программное обеспечение для этого следующим образом: 

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env, IEnvService envService)
    {
        if (envService.IsNonProductionEnv())
        {
            app.UseExceptionHandler("/Error-descriptive");
        }
        else
        {
            app.UseExceptionHandler("/Error");
        }

        ...

     }

Вот код для конечной точки «Описательная ошибка»: 

    public IActionResult ErrorDescriptive()
    {
        if (!_env.IsNonProductionEnv())            
            throw new InvalidOperationException("This endpoint cannot be invoked in a production environment.");

        IExceptionHandlerFeature exFeature = HttpContext.Features.Get<IExceptionHandlerFeature>();

        return Problem(detail: exFeature.Error.StackTrace, title: exFeature.Error.Message);
     }

Проблема, с которой я имею дело конкретно, заключается в этой строке : 

IExceptionHandlerFeature exFeature = HttpContext.Features.Get<IExceptionHandlerFeature>();

У меня проблемы с тем, чтобы заставить это работать с точки зрения модульного тестирования, потому что (насколько я знаю) эта строка кода получает самое последнее исключение от сервера. Есть ли способ, которым я могу как-то установить исключение, которое он получает от HttpContext в моем тесте? Кроме того, поскольку здесь используется HttpContext, нужно ли мне каким-то образом включать его макетную версию, например DefaultHttpContext?

1 Ответ

0 голосов
/ 03 мая 2020

Этого можно добиться, введя интерфейс IHttpContextAccessor в свой контроллер. Этот интерфейс обеспечивает абстракцию для доступа к объекту HttpContext, в основном за пределами ваших веб-библиотек.

Чтобы использовать его, вам нужно services.AddHttpContextAccessor(); в вашем файле запуска. Затем вы можете добавить его в свой контроллер. 

[ApiController]
public class ErrorController
{
    private readonly ILogger<ErrorController> logger;
    private readonly IHttpContextAccessor httpContextAccessor;

    public ErrorController(ILogger<ErrorController> logger, IHttpContextAccessor httpContextAccessor){
        this.logger = logger;
        this.httpContextAccessor = httpContextAccessor ?? throw new ArgumentNullException(nameof(httpContextAccessor));
    }
}

Затем в своем методе вы используете HttpContext из интерфейса доступа вместо базового класса. 

[Route("/error-development")]
public IActionResult HandleErrorDevelopment() 
{
     var exceptionFeature = this.httpContextAccessor.HttpContext.Features.Get<IExceptionHandlerFeature>();
     var error = exceptionFeature.Error;
}

Поскольку мы сейчас работаем против внедренного интерфейса, вы можете смоделировать его в своих модульных тестах. Просто помните, что вы должны издеваться над всей цепью, которую вы называете. (Я использую xUnit и Moq в этом примере). 

public ErrorControllerTests() {
     this.httpContextAccessorMock = new Mock<IHttpContextAccessor>();
     this.httpContextMock = new Mock<HttpContext>();
     this.featureCollectionMock = new Mock<IFeatureCollection>();
     this.exceptionHandlerFeatureMock = new Mock<IExceptionHandlerFeature>();

     this.httpContextAccessorMock.Setup(ca => ca.HttpContext).Returns(this.httpContextMock.Object);
     this.httpContextMock.Setup(c => c.Features).Returns(this.featureCollectionMock.Object);
     this.featureCollectionMock.Setup(fc => fc.Get<IExceptionHandlerFeature>()).Returns(this.exceptionHandlerFeatureMock.Object);

     this.controller = new ErrorController(null, this.httpContextAccessorMock.Object);
}

[Fact]
public void HandleErrorDevelopment() {
    Exception thrownException;
    try{
        throw new ApplicationException("A thrown application exception");
    }
    catch(Exception ex){
        thrownException = ex;
    }
    this.exceptionHandlerFeatureMock.Setup(ehf => ehf.Error).Returns(thrownException);

    var result = this.controller.HandleErrorDevelopment();
    var objectResult = result as ObjectResult;
    Assert.NotNull(objectResult);
    Assert.Equal(500, objectResult.StatusCode);
    var problem = objectResult.Value as ProblemDetails;
    Assert.NotNull(problem);
    Assert.Equal(thrownException.Message, problem.Title);
    Assert.Equal(thrownException.StackTrace, problem.Detail);
}

ВАЖНО : Вы не можете использовать метод ControllerBase.Problem(). Эта реализация опирается на ControllerBase.HttpContext для получения объекта ProblemDetailsFactory.

Вы можете увидеть его в исходном коде . Поскольку ваши юнит-тесты не имеют установленного контекста, он выдаст NullReferenceException.

Фабрика - не что иное, как помощник в создании объекта ProblemDetails. Снова вы можете увидеть реализацию Default на GitHub .

Я закончил тем, что создал свой собственный закрытый метод для создания этого объекта. 

private ProblemDetails CreateProblemDetails(
     int? statusCode = null,
     string title = null,
     string type = null,
     string detail = null,
     string instance = null){

     statusCode ??= 500;
     var problemDetails = new ProblemDetails
     {
          Status = statusCode.Value,
          Title = title,
          Type = type,
          Detail = detail,
          Instance = instance,
     };

     var traceId = Activity.Current?.Id ?? this.httpContextAccessor.HttpContext?.TraceIdentifier;
     if (traceId != null)
     {
         problemDetails.Extensions["traceId"] = traceId;
     }

     return problemDetails;
}

Полный метод обработки ошибок выглядит вот так. 

[Route("/error-development")]
public IActionResult HandleErrorDevelopment() {
      var exceptionFeature = this.httpContextAccessor.HttpContext.Features.Get<IExceptionHandlerFeature>();
      var error = exceptionFeature.Error;
      this.logger?.LogError(error, "Unhandled exception");
      var problem = this.CreateProblemDetails(title: error.Message, detail: error.StackTrace);
       return new ObjectResult(problem){
           StatusCode = problem.Status
       };
}

Для производства я предоставляю пользователю или c сообщение общего назначения для отображения пользователю, или я добавляю исключение с пользовательской обработкой в ​​коде, который уже имеет удобное для пользователя сообщение, которое будет отображается 

if (error is HandledApplicationException)
{
    // handled exceptions with user-friendly message.
    problem = this.CreateProblemDetails(title: error.Message);
}
else {
    // unhandled exceptions. Provice a generic error message to display to the end user.
    problem = this.CreateProblemDetails(title: "An unexpected exception occured. Please try again or contact IT support.");
}
...