如何在C#10(.NET 6)集成测试中Mock Elasticsearch索引？

在.NET 6中测试Elasticsearch索引且不依赖真实数据，有两种实用方案，按需选择：

如果仅需验证业务逻辑对ES客户端调用的正确性，无需ES真实行为，直接用Moq mock Nest的IElasticClient接口即可。

• 先安装依赖包：

  Install-Package Moq
  Install-Package Nest
  

• 示例代码：
  假设你有依赖ES的业务服务：

  public class ProductSearchService
  {
      private readonly IElasticClient _elasticClient;
  
      public ProductSearchService(IElasticClient elasticClient)
      {
          _elasticClient = elasticClient;
      }
  
      public async Task<List<Product>> SearchProducts(string keyword)
      {
          var response = await _elasticClient.SearchAsync<Product>(s => s
              .Index("products")
              .Query(q => q.Match(m => m.Field(f => f.Name).Query(keyword))));
  
          return response.Documents.ToList();
      }
  }
  
  public class Product
  {
      public int Id { get; set; }
      public string Name { get; set; } = string.Empty;
  }
  

  测试类中mock客户端并预设返回结果：

  public class ProductSearchServiceTests
  {
      [Fact]
      public async Task SearchProducts_ReturnsMockedData_WhenKeywordMatches()
      {
          // 创建Mock的IElasticClient
          var mockClient = new Mock<IElasticClient>();
  
          // 准备虚拟测试数据
          var mockProducts = new List<Product>
          {
              new Product { Id = 1, Name = "Test Product 1" },
              new Product { Id = 2, Name = "Test Product 2" }
          };
  
          // 配置SearchAsync方法的返回值
          mockClient.Setup(c => c.SearchAsync<Product>(It.IsAny<Func<SearchDescriptor<Product>, ISearchRequest>>(), It.IsAny<CancellationToken>()))
              .ReturnsAsync(new SearchResponse<Product>
              {
                  Documents = mockProducts,
                  IsValid = true
              });
  
          // 注入mock客户端到业务服务
          var service = new ProductSearchService(mockClient.Object);
  
          // 执行测试并验证结果
          var result = await service.SearchProducts("Test");
          Assert.Equal(2, result.Count);
          Assert.Contains(result, p => p.Name == "Test Product 1");
      }
  }
  

如果需要验证索引映射、查询语法正确性，或依赖ES真实行为，用Testcontainers启动临时ES容器，测试前创建索引并插入虚拟数据，测试后自动销毁。

• 安装依赖包：

  Install-Package Testcontainers.Elasticsearch
  Install-Package Nest
  

• 示例代码：

  public class ElasticsearchIntegrationTests : IAsyncLifetime
  {
      private readonly ElasticsearchContainer _elasticsearchContainer;
      private IElasticClient _elasticClient;
  
      public ElasticsearchIntegrationTests()
      {
          // 初始化ES容器，指定版本
          _elasticsearchContainer = new ElasticsearchBuilder()
              .WithImage("docker.elastic.co/elasticsearch/elasticsearch:8.10.0")
              .WithEnvironment("discovery.type", "single-node")
              .WithEnvironment("xpack.security.enabled", "false")
              .Build();
      }
  
      public async Task InitializeAsync()
      {
          // 启动容器
          await _elasticsearchContainer.StartAsync();
  
          // 创建ES客户端
          var settings = new ConnectionSettings(new Uri(_elasticsearchContainer.GetConnectionString()))
              .DefaultIndex("test-products");
          _elasticClient = new ElasticClient(settings);
  
          // 创建索引并插入虚拟测试数据
          await _elasticClient.Indices.CreateAsync("test-products", c => c
              .Map<Product>(m => m.AutoMap()));
  
          await _elasticClient.BulkAsync(b => b
              .IndexMany(new List<Product>
              {
                  new Product { Id = 1, Name = "Mock Product A" },
                  new Product { Id = 2, Name = "Mock Product B" }
              }));
      }
  
      public async Task DisposeAsync()
      {
          // 停止并销毁容器
          await _elasticsearchContainer.StopAsync();
      }
  
      [Fact]
      public async Task SearchProducts_ReturnsCorrectData_FromTempElasticsearch()
      {
          // 执行查询
          var response = await _elasticClient.SearchAsync<Product>(s => s
              .Index("test-products")
              .Query(q => q.Match(m => m.Field(f => f.Name).Query("Mock"))));
  
          // 验证结果
          Assert.True(response.IsValid);
          Assert.Equal(2, response.Documents.Count());
      }
  }
  

• Mock方案适合快速测试业务逻辑，无需依赖外部服务，但无法验证ES特有的语法或映射问题。
• 临时ES实例方案更贴近生产环境，但需要本地安装Docker，测试耗时稍长。

内容的提问来源于stack exchange，提问作者greatdsa