Moq mock带谓词参数的仓储GetFirstOrDefault始终返回null问题解决

问题场景 #

使用Moq框架对仓储层泛型方法做单元测试Mock时，带谓词参数的GetFirstOrDefault<T>方法配置Setup后调用始终返回null，但无参数的ListAll<T>方法用相同思路配置可正常返回预期结果。
涉及的方法定义如下：

• 出现Mock异常的GetFirstOrDefault<T>方法

public async Task<T> GetFirstOrDefault<T>(Expression<Func<T, bool>> predicate) where T : class
{
    return await WithQuery<T, T>(q => q.FirstOrDefaultAsync(predicate));
}

• 可正常Mock的无参ListAll<T>方法

public Task<IEnumerable<T>> ListAll<T>() where T : class
{
    return WithQuery<T, IEnumerable<T>>(async q => await q.ToListAsync());
}

错误配置示例 #

最初编写的Setup配置如下，运行测试时调用Mock方法始终返回null：

var ruleList = new List<Rule>() // 测试预置的规则数据
_mockRepository.Setup(x => x.GetFirstOrDefault<Rule>(x => It.IsAny<string>() == It.IsAny<string>())).ReturnsAsync(ruleList);

可正常运行的无参方法对照配置：

var ruleList = new List<Rule>() // 测试预置的规则数据
_mockRepository.Setup(x => x.ListAll<Rule>()).ReturnsAsync(ruleList);

问题原因 #

配置错误的核心是参数匹配规则写法有误：

• Setup中直接传入内联lambda x => It.IsAny<string>() == It.IsAny<string>()时，Moq会将这个lambda作为固定的预期参数做相等性校验，不会识别为"匹配任意谓词"的规则
• 业务代码调用方法时传入的是实际业务逻辑的lambda表达式，和Setup中写的固定表达式既不引用相等，结构也不匹配，Moq判定未命中配置的Setup规则，因此返回默认值null
• 无参的ListAll方法不需要做参数匹配，只要泛型类型对应即可命中Setup，因此可以正常返回结果

正确配置方案 #

使用It.IsAny<Expression<Func<Rule, bool>>>()匹配任意符合类型要求的谓词参数即可，如果需要根据传入的谓词动态返回对应结果，可以在Returns委托中接收传入的predicate参数做自定义处理：

_mockRepository.Setup(x => x.GetFirstOrDefault<Rule>(It.IsAny<Expression<Func<Rule, bool>>>()))
    .Returns((Expression<Func<Rule, bool>> predicate) => {
        // 如需按传入谓词过滤结果，可将predicate编译为委托后对测试数据做过滤
        return Task.FromResult<Rule>(ruleList);
    });

提示：GetFirstOrDefault<Rule>的返回值为单个Rule类型实体，如果测试数据ruleList是列表类型，实际使用时请返回列表中符合预期的单个实体，避免类型不匹配错误。

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