使用Xunit和Moq时，Mock方法返回Task<bool>类型转换报错如何解决？

问题重现 #

目标Repository代码 #

public class ComplaintRepository : IComplaintRepository
{
    private readonly IAppDbContext _context;
    public ComplaintRepository(IAppDbContext context)
    {
        _context = context;
    }

    public async Task<bool> AddAsync(Complaint complaint, CancellationToken token)
    {
        await Task.Run(() => _context.Complaints.AddAsync(complaint));
        return await SaveAsync(token);
    }

    private async Task<bool> SaveAsync(CancellationToken token)
    {
        if (await _context.SaveChangesAsync(token) > 0)
            return true;
        else
            return false;
    }   
}

测试代码（报错版本） #

public class ComplaintRepositoryTests
{
    [Fact]
    public async void AddAsync_WithValidComplaint_ShouldReturnTrue()
    {
        // Arrange
        var mockContext = new Mock<IAppDbContext>();
        mockContext.Setup(x => x.Complaints.AddAsync(It.IsAny<Complaint>(), It.IsAny<CancellationToken>()))
                   .Returns(Task.FromResult(true));
        mockContext.Setup(x => x.SaveChangesAsync(It.IsAny<CancellationToken>()))
                   .ReturnsAsync(1);

        var complaintRepository = new ComplaintRepository(mockContext.Object);
        var complaint = new Complaint();

        // Act
        var result = await complaintRepository.AddAsync(complaint, CancellationToken.None);

        // Assert
        Assert.True(result);
        mockContext.Verify(x => x.Complaints.AddAsync(It.IsAny<Complaint>(), It.IsAny<CancellationToken>()), Times.Once());
        mockContext.Verify(x => x.SaveChangesAsync(It.IsAny<CancellationToken>()), Times.Once());
    }
}

错误信息 #

cannot convert from 'System.Threading.Tasks.Task<bool>' to 'System.Threading.Tasks.ValueTask<Microsoft.EntityFrameworkCore.ChangeTracking.EntityEntry<CCMP.Domain.Complaints.Complaint>>'

错误原因 #

EF Core中DbSet<T>.AddAsync（对应你的IAppDbContext.Complaints.AddAsync）的返回类型是ValueTask<EntityEntry<Complaint>>，但你在Moq Setup里错误地返回了Task<bool>类型的结果，两者类型不兼容，导致编译错误。

解决方案 #

1. 修正Moq的Setup代码 #

将AddAsync的返回值改为符合要求的ValueTask<EntityEntry<Complaint>>类型：

public class ComplaintRepositoryTests
{
    [Fact]
    public async Task AddAsync_WithValidComplaint_ShouldReturnTrue() // 建议用Task代替void，避免异步测试的潜在问题
    {
        // Arrange
        var mockContext = new Mock<IAppDbContext>();
        // 模拟AddAsync返回正确的ValueTask类型
        mockContext.Setup(x => x.Complaints.AddAsync(It.IsAny<Complaint>(), It.IsAny<CancellationToken>()))
                   .Returns(ValueTask.FromResult(Mock.Of<EntityEntry<Complaint>>()));
        mockContext.Setup(x => x.SaveChangesAsync(It.IsAny<CancellationToken>()))
                   .ReturnsAsync(1);

        var complaintRepository = new ComplaintRepository(mockContext.Object);
        var complaint = new Complaint();

        // Act
        var result = await complaintRepository.AddAsync(complaint, CancellationToken.None);

        // Assert
        Assert.True(result);
        mockContext.Verify(x => x.Complaints.AddAsync(It.IsAny<Complaint>(), It.IsAny<CancellationToken>()), Times.Once());
        mockContext.Verify(x => x.SaveChangesAsync(It.IsAny<CancellationToken>()), Times.Once());
    }
}

2. 优化Repository中的异步代码 #

原Repository里的await Task.Run(() => _context.Complaints.AddAsync(complaint))是冗余的，因为AddAsync本身就是异步方法，直接await即可，不需要用Task.Run包裹（这会造成不必要的线程切换）：

public async Task<bool> AddAsync(Complaint complaint, CancellationToken token)
{
    // 直接await AddAsync，不需要Task.Run，同时传入CancellationToken参数
    await _context.Complaints.AddAsync(complaint, token);
    return await SaveAsync(token);
}

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