使用xUnit测试调用第三方API的无返回值Repository方法的疑问

问题背景 #

你正在通过第三方API向数据库插入记录，项目结构如下：

Repository 代码 #

public class MyRepository
{
    public void InsertRecord(Customer c)
    {
     //调用第三方API/方法执行插入操作
    }
}

Controllers 代码 #

public IActionResult AddCustomer (Customer model)
{
    try
    {
        _myRepo.InsertRecord(model)
    }
    catch (Exception1 ex)
    {
       //向页面返回错误信息
    }
    catch (Exception2 ext)
    {
       //向页面返回错误信息
    }
}

你计划用xUnit测试MyRepository而非Controller，当前测试代码（剔除无效部分）如下：

[Fact]
public void InsertRecordMock
{
     Mock<Customer> cust;
     // 设置cust对象
     _myRepo.InsertRecord(cust);    
}

你遇到两个核心问题：

1. 直接测试会实际写入数据库，单元测试不应依赖外部资源，但API是第三方的，该如何处理？
2. InsertRecord是无返回值的void方法，多数测试示例针对有返回值的方法，不知道如何测试这种场景？

问题解答 #

1. 隔离第三方API依赖，避免操作真实数据库 #

单元测试的核心是隔离外部依赖，第三方API属于外部资源，你需要通过抽象层将其与MyRepository解耦：

步骤1：定义第三方API的抽象接口

把第三方API的调用逻辑封装到一个接口中：

public interface IThirdPartyDataService
{
    // 对应第三方API的插入方法
    void InsertCustomer(Customer customer);
}

步骤2：修改MyRepository依赖抽象接口

让MyRepository通过构造函数注入这个接口，不再直接调用第三方API：

public class MyRepository
{
    private readonly IThirdPartyDataService _thirdPartyService;

    // 通过构造函数注入依赖
    public MyRepository(IThirdPartyDataService thirdPartyService)
    {
        _thirdPartyService = thirdPartyService;
    }

    public void InsertRecord(Customer c)
    {
        // 调用抽象后的方法，而非直接调用第三方API
        _thirdPartyService.InsertCustomer(c);
    }
}

步骤3：测试时Mock抽象接口

使用Mock框架（比如Moq）创建IThirdPartyDataService的Mock实例，这样测试时不会触发真实的第三方API调用：

// 测试类中初始化Mock和Repository
var mockThirdParty = new Mock<IThirdPartyDataService>();
var myRepo = new MyRepository(mockThirdParty.Object);

2. 测试无返回值的void方法 #

void方法的测试分为两种场景：验证方法正常执行时的行为、验证异常抛出场景。

场景1：验证正常执行时的依赖调用

测试InsertRecord是否正确调用了第三方API的方法，并且参数传递正确：

[Fact]
public void InsertRecord_ValidCustomer_CallsThirdPartyServiceOnce()
{
    // Arrange
    var mockThirdParty = new Mock<IThirdPartyDataService>();
    var myRepo = new MyRepository(mockThirdParty.Object);
    // 创建真实的Customer实体（实体类无需Mock）
    var testCustomer = new Customer 
    { 
        Id = 1, 
        Name = "Test User" 
        // 设置其他必要属性
    };

    // Act
    myRepo.InsertRecord(testCustomer);

    // Assert
    // 验证第三方服务的InsertCustomer方法被调用了1次，且参数为testCustomer
    mockThirdParty.Verify(
        service => service.InsertCustomer(testCustomer), 
        Times.Once,
        "第三方API未被正确调用或参数错误"
    );
}

场景2：验证异常抛出情况

测试当第三方API抛出指定异常时，InsertRecord是否会正确传递该异常（如果你的Repository没有捕获异常的话）：

[Fact]
public void InsertRecord_ThirdPartyThrowsException1_ThrowsException1()
{
    // Arrange
    var mockThirdParty = new Mock<IThirdPartyDataService>();
    // 配置Mock，当调用InsertCustomer时抛出Exception1
    mockThirdParty.Setup(service => service.InsertCustomer(It.IsAny<Customer>()))
                  .Throws<Exception1>();
    var myRepo = new MyRepository(mockThirdParty.Object);
    var testCustomer = new Customer();

    // Act & Assert
    // 验证调用InsertRecord时会抛出Exception1
    Assert.Throws<Exception1>(() => myRepo.InsertRecord(testCustomer));
}

同理，你可以用同样的方式测试Exception2的抛出场景。

内容的提问来源于stack exchange，提问作者He-Man