如何用FakeItEasy模拟IMongoQueryable测试MongoDB统计方法？

问题场景 #

你正在开发一个与MongoDB交互的API，需要从集合生成统计数据。现有BoxService类中的GetBoxNumberStatisticsAsync方法使用了IMongoCollection<T>.AsQueryable()扩展方法进行查询，但用FakeItEasy模拟依赖时，无法直接模拟这个扩展方法，导致该方法难以测试。

服务类核心代码：

public class BoxService : IBoxService
{
    private readonly IMongoCollection<Box> _boxCollection;

    public BoxService(IOptions<DbSettings> dbSettings, IMongoClient mongoClient)
    {
        var mongoDatabase = mongoClient.GetDatabase(dbSettings.Value.DatabaseName);
        _boxCollection = mongoDatabase.GetCollection<Box>(dbSettings.Value.BoxCollectionName);
    }

    public async Task<List<BoxStatisticsDto>> GetBoxNumberStatisticsAsync()
    {
        var boxNumberStatisticsList = new List<BoxStatisticsDto>();
        var results = await _boxCollection.AsQueryable()
            .Select(box => new { box.WarehouseId, Content = box.Content ?? string.Empty })
            .ToListAsync();

        // 后续统计计算逻辑

        return boxNumberStatisticsList;
    }
}

测试类当前实现：

public class BoxServiceTest
{
    private readonly IMongoCollection<Box> _boxCollection;
    private readonly List<Box> _boxes;
    private readonly IBoxService _boxService;

    public BoxServiceTest()
    {
        _boxCollection = A.Fake<IMongoCollection<Box>>();
        _boxes = new List<Box> {...};

        var mockOptions = A.Fake<IOptions<DbSettings>>();
        var mongoClient = A.Fake<IMongoClient>();
        var mongoDb = A.Fake<IMongoDatabase>();

        A.CallTo(() => mongoClient.GetDatabase(A<string>._, default)).Returns(mongoDb);
        A.CallTo(() => mongoDb.GetCollection<Box>(A<string>._, default)).Returns(_boxCollection);
        _boxService = new BoxService(mockOptions, mongoClient);
    }
}

解决方案 #

方法一：直接模拟AsQueryable的返回结果 #

FakeItEasy无法直接模拟扩展方法，但可以通过配置IMongoCollection<Box>的AsQueryable()调用，让它返回测试数据的IQueryable实例：

修改测试类构造函数，添加以下代码：

// 让模拟的集合返回测试数据的可查询对象
A.CallTo(() => _boxCollection.AsQueryable()).Returns(_boxes.AsQueryable());

优点：实现简单，无需修改业务代码；缺点：仅支持基础LINQ查询，如果业务逻辑中使用了MongoDB专属的查询操作（如地理空间查询、特定聚合），普通EnumerableQuery无法兼容，会导致测试与实际运行结果不一致。

方法二：使用MongoDB内存数据库（推荐） #

放弃模拟IMongoCollection，改用MongoDB的内存数据库实例，让测试逻辑完全贴近真实运行环境：

修改测试类如下：

public class BoxServiceTest
{
    private readonly IBoxService _boxService;
    private readonly List<Box> _boxes;

    public BoxServiceTest()
    {
        // 初始化测试数据
        _boxes = new List<Box> 
        {
            new Box { WarehouseId = "WH001", Content = "Books" },
            new Box { WarehouseId = "WH002", Content = null },
            // 更多测试数据
        };

        // 创建内存MongoDB客户端
        var mongoClient = new MongoClient("mongodb://localhost:27017");
        // 创建测试数据库
        var testDb = mongoClient.GetDatabase("BoxStatsTestDb");
        // 获取测试集合并插入数据
        var boxCollection = testDb.GetCollection<Box>("Boxes");
        boxCollection.InsertMany(_boxes);

        // 构造真实的DbSettings配置
        var dbSettings = Options.Create(new DbSettings
        {
            DatabaseName = "BoxStatsTestDb",
            BoxCollectionName = "Boxes"
        });

        // 实例化真实的BoxService
        _boxService = new BoxService(dbSettings, mongoClient);
    }

    [Fact]
    public async Task GetBoxNumberStatisticsAsync_ShouldReturnExpectedStats()
    {
        // 执行测试方法
        var result = await _boxService.GetBoxNumberStatisticsAsync();

        // 验证结果，例如统计每个仓库的箱子数量
        Assert.Equal(1, result.Count(s => s.WarehouseId == "WH001"));
        Assert.Equal(1, result.Count(s => s.WarehouseId == "WH002"));
        // 其他断言逻辑
    }
}

优点：能完整测试MongoDB专属查询逻辑，测试结果可信度高；缺点：需要依赖MongoDB内存实例，测试启动速度略慢，但内存数据库开销极小，基本可忽略。

方法三：封装查询逻辑为独立接口 #

通过新增接口解耦业务代码与MongoDB的直接依赖，让测试更灵活：

1. 定义查询提供者接口：

public interface IBoxQueryProvider
{
    IQueryable<Box> GetBoxQueryable();
}

2. 实现MongoDB版本的查询提供者：

public class MongoBoxQueryProvider : IBoxQueryProvider
{
    private readonly IMongoCollection<Box> _boxCollection;

    public MongoBoxQueryProvider(IOptions<DbSettings> dbSettings, IMongoClient mongoClient)
    {
        var database = mongoClient.GetDatabase(dbSettings.Value.DatabaseName);
        _boxCollection = database.GetCollection<Box>(dbSettings.Value.BoxCollectionName);
    }

    public IQueryable<Box> GetBoxQueryable()
    {
        return _boxCollection.AsQueryable();
    }
}

3. 修改BoxService依赖该接口：

public class BoxService : IBoxService
{
    private readonly IBoxQueryProvider _queryProvider;

    public BoxService(IBoxQueryProvider queryProvider)
    {
        _queryProvider = queryProvider;
    }

    public async Task<List<BoxStatisticsDto>> GetBoxNumberStatisticsAsync()
    {
        var boxNumberStatisticsList = new List<BoxStatisticsDto>();
        var results = await _queryProvider.GetBoxQueryable()
            .Select(box => new { box.WarehouseId, Content = box.Content ?? string.Empty })
            .ToListAsync();

        // 后续统计计算逻辑

        return boxNumberStatisticsList;
    }
}

4. 测试时模拟IBoxQueryProvider：

public class BoxServiceTest
{
    private readonly IBoxQueryProvider _mockQueryProvider;
    private readonly List<Box> _boxes;
    private readonly IBoxService _boxService;

    public BoxServiceTest()
    {
        _boxes = new List<Box> { /* 测试数据 */ };
        _mockQueryProvider = A.Fake<IBoxQueryProvider>();
        // 配置模拟接口返回测试数据的IQueryable
        A.CallTo(() => _mockQueryProvider.GetBoxQueryable()).Returns(_boxes.AsQueryable());
        _boxService = new BoxService(_mockQueryProvider);
    }

    [Fact]
    public async Task GetBoxNumberStatisticsAsync_ShouldCalculateCorrectly()
    {
        var result = await _boxService.GetBoxNumberStatisticsAsync();
        // 断言逻辑
    }
}

优点：完全解耦MongoDB依赖，测试不受数据库实现影响；缺点：需要额外封装接口和实现类，增加了代码量，适合业务逻辑复杂、需要频繁修改测试场景的情况。

内容的提问来源于stack exchange，提问作者cs.kali