如何用NSubstitute对Hangfire循环作业进行单元测试？

由于未看到你具体的测试代码，以下列出常见错误写法及对应的正确实现，帮你排查问题：

常见错误点 #

• 直接调用ConfigureJob但未模拟Hangfire调度API（如RecurringJob.AddOrUpdate），导致测试依赖真实Hangfire环境
• 未隔离PermanentlyDeleteItemsAsync的外部依赖（如数据库、第三方服务），测试耦合真实资源
• 测试异步方法时未使用await，导致测试提前结束，无法验证逻辑执行结果
• 未验证Hangfire循环作业的核心配置参数（如CRON表达式、作业ID）

正确测试示例 #

假设你的ItemService基础结构如下：

public interface IItemService
{
    Task PermanentlyDeleteItemsAsync();
}

public interface IJobConfigurationService
{
    void ConfigureJob();
}

public class ItemService : IItemService, IJobConfigurationService
{
    private readonly IRecurringJobScheduler _jobScheduler;
    private readonly IItemRepository _itemRepo;

    public ItemService(IRecurringJobScheduler jobScheduler, IItemRepository itemRepo)
    {
        _jobScheduler = jobScheduler;
        _itemRepo = itemRepo;
    }

    public void ConfigureJob()
    {
        _jobScheduler.AddOrUpdate<IItemService>(
            "delete-old-items-job",
            s => s.PermanentlyDeleteItemsAsync(),
            "0 0 * * *"); // 每天凌晨执行
    }

    public async Task PermanentlyDeleteItemsAsync()
    {
        var itemsToDelete = await _itemRepo.GetItemsToPermanentlyDeleteAsync();
        await _itemRepo.BatchDeleteAsync(itemsToDelete);
    }
}

1. 测试ConfigureJob（验证作业配置） #

先封装Hangfire调度接口解耦静态依赖：

public interface IRecurringJobScheduler
{
    void AddOrUpdate<T>(string jobId, Expression<Func<T, Task>> methodCall, string cronExpression);
}

public class HangfireRecurringJobScheduler : IRecurringJobScheduler
{
    public void AddOrUpdate<T>(string jobId, Expression<Func<T, Task>> methodCall, string cronExpression)
    {
        RecurringJob.AddOrUpdate(jobId, methodCall, cronExpression);
    }
}

编写测试验证配置参数：

[Test]
public void ConfigureJob_ShouldSetUpRecurringJobWithCorrectParams()
{
    // Arrange
    var mockScheduler = Substitute.For<IRecurringJobScheduler>();
    var service = new ItemService(mockScheduler, Substitute.For<IItemRepository>());

    // Act
    service.ConfigureJob();

    // Assert
    mockScheduler.Received(1).AddOrUpdate<IItemService>(
        "delete-old-items-job",
        Arg.Any<Expression<Func<IItemService, Task>>>(),
        "0 0 * * *");
}

2. 测试PermanentlyDeleteItemsAsync（验证作业逻辑） #

[Test]
public async Task PermanentlyDeleteItemsAsync_ShouldDeleteTargetItems()
{
    // Arrange
    var mockRepo = Substitute.For<IItemRepository>();
    var testItems = new List<Item> { new Item { Id = 1 }, new Item { Id = 2 } };
    mockRepo.GetItemsToPermanentlyDeleteAsync().Returns(testItems);

    var service = new ItemService(Substitute.For<IRecurringJobScheduler>(), mockRepo);

    // Act
    await service.PermanentlyDeleteItemsAsync();

    // Assert
    await mockRepo.Received(1).BatchDeleteAsync(testItems);
}

关键注意事项 #

• 解耦Hangfire静态依赖：通过自定义调度接口隔离Hangfire，避免测试依赖真实调度环境
• 异步方法必须等待：测试异步方法时，测试方法需标记为async Task并await目标方法
• 聚焦核心逻辑：配置方法重点验证调度参数，作业方法重点验证业务逻辑（如数据操作）的执行

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