Come scrivere il test junit per DirectoryStream

Question

Ho questa funzione in una classe chiamata Test.java e include;

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

quindi fondamentalmente restituisce tutte le cartelle come un elenco nel percorso "../../tmp". Voglio scrivere un test per questo, ed è così che ho fatto ma non funziona:

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

Ricevo il seguente errore;

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

Answer 1

Quando si utilizza @TempDirsi è liberi di non utilizzare alcuni specifici percorsi hard-coded (ad esempio "../../Temp"nello snippent).

Fondamentalmente, la directory temporanea verrà creata automaticamente da junit. Quindi nei test, puoi manipolarlo nel modo che preferisci, ad esempio creare file e directory.

Se hai bisogno di ottenere il valore del percorso della directory temporanea, puoi semplicemente invocare toString()sul campo annotato con @TempDir.

Ad esempio, per il tuo caso specifico è possibile scrivere il seguente test:

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

Nota: in generale, @TempDirutilizza il file director temporaneo di sistema predefinito y. Dipende dal sistema operativo e normalmente può essere trovato tramite la variabile d'ambiente. Ad esempio, TMPDIRsul mio sistema punta alla /tmpdirectory.