如何设计幂等性单元测试：解决文件操作测试重复执行失效问题

一、避免重复测试失败的方案 #

1. 使用临时文件/目录（推荐） #

借助JUnit 5的@TempDir注解，为每个测试用例自动创建独立的临时目录，所有测试文件都放在这个临时空间里，测试结束后框架会自动清理。这样每次测试都是全新的环境，完全不会受之前测试的影响。示例代码：

@TempDir
Path tempDir;

@Test
void testLoadFileSuccess() throws IOException {
    // 在临时目录创建测试文件
    Path testFile = tempDir.resolve("test.txt");
    Files.writeString(testFile, "测试内容");

    // 调用待测试方法
    yourClassInstance.loadFile(testFile);

    // 断言文件已被删除
    assertFalse(Files.exists(testFile));
}

2. 测试前重置文件状态 #

如果必须使用固定路径的文件，就在每个测试执行前（比如@BeforeEach方法中）强制重置文件状态：

private Path testFile = Paths.get("test.txt");

@BeforeEach
void setUp() throws IOException {
    // 清理可能残留的错误文件或原文件
    Files.deleteIfExists(testFile);
    Files.deleteIfExists(testFile.resolveSibling("ERROR_" + testFile.getFileName()));
    // 重新创建干净的测试文件
    Files.writeString(testFile, "测试内容");
}

确保每次测试启动时，文件系统都处于预期的初始状态。

3. 使用内存文件系统 #

用Jimfs这类内存文件系统替代真实磁盘，所有文件操作都在内存中完成，完全不会修改磁盘文件。示例：

@Test
void testLoadFileWithJimfs() throws IOException {
    FileSystem fs = Jimfs.newFileSystem();
    Path testFile = fs.getPath("/test.txt");
    Files.writeString(testFile, "测试内容");

    yourClassInstance.loadFile(testFile);

    // 断言文件已被删除
    assertFalse(Files.exists(testFile));
}

二、验证Files.move和Files.delete的调用 #

1. Mock静态方法（Mockito 3.4+） #

因为Files是静态工具类，可使用Mockito的mockStatic来模拟并验证其静态方法调用：

@Test
void testLoadFileFailureTriggersMove() throws IOException {
    Path testFile = Paths.get("test.txt");
    // 模拟Files类的静态方法
    try (MockedStatic<Files> mockedFiles = Mockito.mockStatic(Files.class)) {
        // 让Files.exists返回true，避免空指针
        mockedFiles.when(() -> Files.exists(testFile)).thenReturn(true);
        // 触发方法进入catch分支（这里假设内部逻辑会抛出RuntimeException）
        doThrow(new RuntimeException()).when(yourClassInstance).internalLogicMethod();
        yourClassInstance.loadFile(testFile);

        // 验证Files.move被调用，参数符合预期
        Path errorFile = testFile.resolveSibling("ERROR_" + testFile.getFileName());
        mockedFiles.verify(() -> Files.move(testFile, errorFile));
    }
}

@Test
void testLoadFileSuccessTriggersDelete() throws IOException {
    Path testFile = Paths.get("test.txt");
    try (MockedStatic<Files> mockedFiles = Mockito.mockStatic(Files.class)) {
        mockedFiles.when(() -> Files.exists(testFile)).thenReturn(true);
        yourClassInstance.loadFile(testFile);

        // 验证Files.delete被调用
        mockedFiles.verify(() -> Files.delete(testFile));
    }
}

2. 封装文件操作（更优雅的方案） #

把文件操作封装成独立的服务类，通过依赖注入到目标类中，这样就能用普通Mockito mock这个服务类，验证方法调用，同时提升代码的可维护性：

// 封装文件操作的服务类
public class FileOperator {
    public void move(Path source, Path target) throws IOException {
        Files.move(source, target);
    }

    public void delete(Path path) throws IOException {
        Files.delete(path);
    }
}

// 修改目标类，注入FileOperator
public class YourClass {
    private final FileOperator fileOperator;

    public YourClass(FileOperator fileOperator) {
        this.fileOperator = fileOperator;
    }

    public void loadFile(Path filename) throws IOException {
        try {
            // 内部逻辑
        } catch (RuntimeException ex) {
            fileOperator.move(filename, filename.resolveSibling("ERROR_" + filename.getFileName()));
            return;
        }
        fileOperator.delete(filename);
    }
}

// 测试时mock FileOperator
@Test
void testLoadFileFailure() throws IOException {
    FileOperator mockFileOperator = mock(FileOperator.class);
    YourClass yourInstance = new YourClass(mockFileOperator);
    Path testFile = Paths.get("test.txt");

    // 触发catch分支
    doThrow(new RuntimeException()).when(yourInstance).internalLogicMethod();
    yourInstance.loadFile(testFile);

    // 验证move方法被调用
    verify(mockFileOperator).move(testFile, testFile.resolveSibling("ERROR_" + testFile.getFileName()));
}

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