如何为 DirectoryStream 编写 junit 测试

Question

我在一个名为 Test.java 的 class 中有这个函数，它包含；

public List<Path> getAllFoldersInTmp(String directory) throws IOException {
    final List<Path> files = new ArrayList<>();
    try (DirectoryStream<Path> stream = Files.newDirectoryStream(Path.of(directory))) {
        for (Path entry : stream) {
            if (Files.isDirectory(entry)) {
                files.add(entry);
            }
        }
    }
    return files;
}

所以基本上 returns 所有文件夹都作为“../../tmp”路径中的列表。我想为它写一个测试，我就是这样做的，但它不起作用：

import java.io.File;
import java.io.IOException;
import java.nio.file.Path;
import org.junit.jupiter.api.Test;

class Testing{
    
    @Autowired
    Test test;
    @TempDir
    Path directory;
    
    @Test
    public void givenDir_whenUsingDirectoryStream_thenListAllFiles() throws IOException {
    
        File fileOne = directory.resolve("file1").toFile();
        File fileTwo = directory.resolve("file2").toFile();
    
        System.out.println(test.getAllFoldersInTmp("../../Temp")); //since the fileone and fileTwo are stored in `Temp/someRandomNumber` directory
    
    }
}

我收到以下错误；

 ..\..\Temp
java.nio.file.NoSuchFileException: ..\..\Temp

Answer 1

使用 @TempDir 时，您可以自由选择不使用某些特定的 hard-coded 路径（例如代码片段中的 "../../Temp"）。

基本上，junit 会自动为您创建临时目录。然后在测试中，您可以按照您想要的方式操作它，例如创建文件和目录。

如果您需要获取临时目录路径的值，您可以简单地在注释为@TempDir的字段上调用toString()。

例如，对于您的特定情况，可以编写以下测试：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

import java.io.IOException;
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertEquals;

class FoldersResolverTest {

    @TempDir
    Path directory;

    // assume FoldersResolver wrapps getAllFoldersInTmp 
    FoldersResolver foldersResolver = new FoldersResolver();

    @Test
    void directoriesAreFoundAndFilesAreSkipped() throws IOException {

        Path fileOne = directory.resolve("file1");
        Path fileTwo = directory.resolve("file2");
        Path directoryOne = directory.resolve("directory1");
        Path directoryTwo = directory.resolve("directory2");

        Files.createFile(fileOne);
        Files.createFile(fileTwo);
        Files.createDirectory(directoryOne);
        Files.createDirectory(directoryTwo);

        // note directory.toString() returns path to the temporary folder created by junit
        List<Path> actual = foldersResolver.getAllFoldersInTmp(directory.toString());

        List<Path> expected = List.of(directoryOne.getFileName(), directoryTwo.getFileName());
        assertEquals(expected, actual);
    }
}

注意：一般来说，@TempDir使用默认的系统临时文件目录y。这取决于操作系统，通常可以通过环境变量找到。例如，我系统上的 TMPDIR 指向 /tmp 目录。

如何为 DirectoryStream 编写 junit 测试

How to write junit test for DirectoryStream

java

spring-boot

unit-testing

junit4

junit-jupiter