使用Mockito模拟FileSystem的新手求助：测试含listFiles方法的代码

作为Mockito新手，你已经迈出了正确的第一步——Mock了FileSystem实例，也用TemporaryFolder创建了测试用的真实文件，但核心问题在于：Mock的FileSystem不会自动关联你创建的临时文件，我们需要手动Stub listFiles 方法，让它返回你期望的文件迭代结果。

下面是完整的测试实现步骤和代码示例：

核心思路 #

我们要做的不是让Mock的FileSystem真的去扫描临时文件夹，而是控制它的返回值：把你创建的临时文件转换成LocatedFileStatus对象，再包装成RemoteIterator，最后让Mock的listFiles方法返回这个迭代器。

完整测试代码示例 #

import org.junit.Rule;
import org.junit.Test;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnit;
import org.mockito.junit.MockitoRule;
import org.junit.rules.TemporaryFolder;
import org.apache.hadoop.fs.FileSystem;
import org.apache.hadoop.fs.LocatedFileStatus;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.fs.RemoteIterator;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import static org.mockito.Mockito.*;
import static org.junit.Assert.*;

public class YourTargetServiceTest {

    // 初始化Mockito和临时文件夹规则
    @Rule
    public MockitoRule mockitoRule = MockitoJUnit.rule();
    @Rule
    public TemporaryFolder temporaryFolder = new TemporaryFolder();

    // Mock目标依赖：FileSystem
    @Mock
    private FileSystem mockFileSystem;

    // 实例化你要测试的服务类（假设它依赖FileSystem）
    private YourTargetService serviceUnderTest = new YourTargetService(mockFileSystem);

    @Test
    public void testFileListingLogic() throws IOException {
        // 1. 创建测试用的临时目录和文件
        File sourceDir = temporaryFolder.newFolder("sourceDirectory");
        Path sourceDirPath = new Path(sourceDir.getAbsolutePath());
        // 直接在临时目录下创建文件，TemporaryFolder会自动处理路径
        File hdfsFile1 = temporaryFolder.newFile("sourceDirectory/hdfsFile1.txt");
        File hdfsFile2 = temporaryFolder.newFile("sourceDirectory/hdfsFile2.txt");

        // 2. 构建LocatedFileStatus列表（因为直接实例化它比较麻烦，用Mock更高效）
        List<LocatedFileStatus> mockFileStatusList = new ArrayList<>();
        
        LocatedFileStatus status1 = mock(LocatedFileStatus.class);
        when(status1.getPath()).thenReturn(new Path(hdfsFile1.getAbsolutePath()));
        // 如果你的业务逻辑需要其他属性（比如文件大小），继续Stub对应的方法
        // when(status1.getLen()).thenReturn(1024L);
        
        LocatedFileStatus status2 = mock(LocatedFileStatus.class);
        when(status2.getPath()).thenReturn(new Path(hdfsFile2.getAbsolutePath()));
        
        mockFileStatusList.add(status1);
        mockFileStatusList.add(status2);

        // 3. Mock RemoteIterator，模拟迭代行为
        RemoteIterator<LocatedFileStatus> mockIterator = mock(RemoteIterator.class);
        // 模拟hasNext的返回顺序：两次true，最后false结束迭代
        when(mockIterator.hasNext())
                .thenReturn(true)
                .thenReturn(true)
                .thenReturn(false);
        // 模拟next的返回值，对应上面的hasNext
        when(mockIterator.next())
                .thenReturn(status1)
                .thenReturn(status2);

        // 4. Stub FileSystem的listFiles方法，让它返回我们的Mock迭代器
        when(mockFileSystem.listFiles(sourceDirPath, true)).thenReturn(mockIterator);

        // 5. 调用你要测试的业务方法
        serviceUnderTest.yourMethodToTest(sourceDirPath);

        // 6. 验证行为和结果
        // 确认FileSystem的listFiles方法被正确调用
        verify(mockFileSystem).listFiles(sourceDirPath, true);
        // 根据你的业务逻辑添加断言，比如验证方法是否正确处理了这两个文件
        // assertEquals(2, serviceUnderTest.getProcessedFileCount());
    }
}

关键细节说明 #

1. 关于LocatedFileStatus的Mock：
   它的构造方法通常是包级私有或需要大量Hadoop内部参数，直接实例化成本很高，用Mockito Mock它只需要Stub你业务逻辑用到的方法（比如getPath()、getLen()）即可。

2. RemoteIterator的行为模拟：
   必须保证hasNext()的返回次数和next()的返回值数量对应，最后一次hasNext()返回false，避免迭代时抛出NoSuchElementException。

3. Mock的核心思想：
   我们并没有让Mock的FileSystem真的去访问磁盘，而是完全控制它的返回结果，这样测试就不会依赖外部环境，也更稳定快速。

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