集成测试：固定装置多于自动装置

目录

介绍

背景

使用代码

兴趣点

---

介绍

已显示在AutoFixture中使用的固定装置(fixture)对于测试自动化是一个非常有用的概念。固定装置(fixture)不仅对单元测试有用，而且该概念也可以在集成测试中重用。在本文中，将解释什么是固定装置(fixture)，以及该概念如何用于单元测试和集成测试。固定装置(fixture)总是有一个共同点：它们为您管理测试的“安排”部分，这不仅对单元测试，而且对所有类型的测试都是有用的。

背景

您对.NET Core应用程序的TDD有一定的经验，这将非常有帮助，其中包括模拟，最好是此处使用的.NET Core 3.1。拥有固定装置(fixture)的经验也很有用，但不是必需的。本文中显示的示例基于xUnit，但是概念和技术也可以应用于其他单元测试框架。

使用代码

首先，我们看一下要测试的代码。这里是：

[Route("api/[controller]")]
[ApiController]
public class SearchEngineController : ControllerBase
{
   private readonly ISearchEngineService _searchEngineService;

   public SearchEngineController(ISearchEngineService searchEngineService)
   {
       _searchEngineService = searchEngineService;
   }

   [HttpGet("{queryEntry}", Name = "GetNumberOfCharacters")]
   public async Task<ActionResult<int>> GetNumberOfCharacters(string queryEntry)
   {
       var numberOfCharacters = 
           await _searchEngineService.GetNumberOfCharactersFromSearchQuery(queryEntry);
       return Ok(numberOfCharacters);
   }
}

从上面的代码中可以清楚地看出，它只是一个控制器方法，它调用某些接口方法并返回带有OK状态码（200）的结果。这是该接口的实现。

public class SearchEngineService : ISearchEngineService
{
   private readonly HttpClient _httpClient;

   public SearchEngineService(HttpClient httpClient)
   {
       _httpClient = httpClient;
   }

   public async Task<int> GetNumberOfCharactersFromSearchQuery(string toSearchFor)
   {
       var result = await _httpClient.GetAsync($"/search?q={toSearchFor}");
       var content = await result.Content.ReadAsStringAsync();
       return content.Length;
   }
}

此代码也非常简单。Web请求完成，并返回结果的长度。

这是在Startup类中添加依赖项的方式：

public void ConfigureServices(IServiceCollection services)
{
   services.AddControllers();
   var googleLocation = Configuration["Google"];
   services.AddHttpClient<ISearchEngineService, SearchEngineService>(c =>
            c.BaseAddress = new Uri(googleLocation))
            .SetHandlerLifetime(TimeSpan.FromMinutes(5))
            .AddPolicyHandler(GetRetryPolicy());
}

现在清楚的是，我们需要能够模拟两个依赖关系：

• 内部依赖项：这是ISearchEngineService的实例注入控制器。
• 外部依赖项：这是设置为添加HttpClient内容基址的搜索引擎（url）。对于集成测试，我们需要模拟一下，因为我们对其是否给出相同的响应并保持在线状态没有任何影响。

内部依赖项的模拟通常是出于单元测试的目的，使用Moq可以如本文所述。外部依赖项的模拟通常是出于集成测试目的而进行的，如本文所述，使用WireMock ，此处提供的一些代码来自此。此处显示的所有代码在GitHub上也可用。

这是使用固定装置(fixture)进行单元测试的样子：

[Fact]
public async Task GetTest()
{
   // arrange
   var fixture = new Fixture().Customize(new AutoMoqCustomization());
   var service = fixture.Freeze<Mock<ISearchEngineService>>();
   service.Setup(a => a.GetNumberOfCharactersFromSearchQuery(It.IsNotNull<string>()))
                .ReturnsAsync(8);
   var controller = fixture.Build<SearchEngineController>().OmitAutoProperties().Create();

   // act
   var response = await controller.GetNumberOfCharacters("Hoi");

   // assert
   Assert.Equal(8, ((OkObjectResult)response.Result).Value);
   service.Verify(s => s.GetNumberOfCharactersFromSearchQuery("Hoi"), Times.Once);
}

我们在这里看到的是以下内容：

1. 第一步是创建固定装置。
2. 之后， 调用Freeze方法（在Create方法之前）以指定内部依赖性，我们希望在测试结束时进行一些验证。
3. 内部依赖关系需要与Setup方法一起设置。
4. 在测试方法的assert部分中，我们验证对内部依赖项（service实例）的调用。

如测试的实现，需要一个NuGet包：AutoFixture.AutoMoq。

从.NET Core的最新版本开始，集成测试变得更加容易。与单元测试的主要区别在于集成更加真实（因此配置性更差）。在Startup类和Program类都包括在内。使用实际的内部依赖关系来代替模拟/存根(stubs)。只有外部依赖项需要模拟，因为它们可以脱机，具有变化的行为或不稳定，所有这些都不应破坏测试。这是使用固定装置(fixture)进行集成测试的方法：

[Fact]
public async Task GetTest()
{
   // arrange
   using (var fixture = new Fixture<Startup>())
   {
      using (var mockServer = fixture.FreezeServer("Google"))
      {
          SetupStableServer(mockServer, "Response");
          var controller = fixture.Create<SearchEngineController>();

          // act
          var response = await controller.GetNumberOfCharacters("Hoi");

          // assert
          var request = mockServer.LogEntries.Select(a => a.RequestMessage).Single();
          Assert.Contains("Hoi", request.RawQuery);
          Assert.Equal(8, ((OkObjectResult)response.Result).Value);
       }
    }
}

private void SetupStableServer(FluentMockServer fluentMockServer, string response)
{
    fluentMockServer.Given(Request.Create().UsingGet())
    .RespondWith(Response.Create().WithBody(response, encoding: Encoding.UTF8)
    .WithStatusCode(HttpStatusCode.OK));
}

我们在这里看到的是类似的：

1. 第一步是使用Startup类创建固定装置(fixture)，一旦Create方法被调用，它就初始化所有依赖项。
2. 之后，调用FreezeServer方法（在该Create方法之前）以设置外部依赖关系，我们希望在测试结束时进行一些验证。
3. 内部依赖性需要使用一种自写SetupStableServer方法来设置，该方法描述某个请求需要某个响应。这将在此处更详细地说明。
4. 在测试方法的assert部分中，我们验证发送到外部依赖项（模拟服务）的Web请求。

实现诸如测试，需要另一个NuGet包：ConnectingApps.IntegrationFixture。

从上面的代码可以清楚地看到，使用固定装置(fixture)进行集成测试的方式与使用固定装置(fixture)进行单元测试的方式基本相同。但是，除了安排和验证内部依赖项外，还需要使用外部依赖项来完成。他的建议听起来很明显，但是在不使用夹具的情况下进行集成测试时，需要大量的样板以作解释。

兴趣点

在研究固定装置(fixture)，使用固定装置(fixture)并撰写本文时，对我来说清楚的是，固定装置(fixture)的概念可以以多种方式使用。AutoFixture在编写单元测试的安排部分时很有用，但其固定装置(fixture)也可用于其他类型测试的（安排部分）。它使我们作为开发人员不必编写大量样板代码。