Как написать тест junit для DirectoryStream

Question

У меня есть эта функция в классе Test.java, и она включает;

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;
}

поэтому в основном он возвращает все папки в виде списка по пути "../../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вы можете не использовать определенные жестко заданные пути (например, "../../Temp"во фрагменте).

По сути, временный каталог будет создан для вас автоматически с помощью junit. Затем в тестах вы можете манипулировать им по своему усмотрению, например, создавать файлы и каталоги.

Если вам нужно получить значение временного пути к каталогу, вы можете просто вызвать toString()поле с пометкой @TempDir.

Например, для вашего конкретного случая можно написать следующий тест:

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каталог.