Модульное тестирование WatchService

Question

Как мне выполнить модульное тестирование службы часов следующим образом:

/**
 * Function to look for changes in a determinate directory
 * @param directory is the directory where to look for the changes
 * @return return a boolean that is true if have changes or false if not
 */

private static boolean watchDirectory(final String directory){

    boolean flag = false;

    Path path = Paths.get(directory);
    try {
        // get watch service which will monitor the directory
        WatchService watcher = path.getFileSystem().newWatchService();
        // associate watch service with the directory to listen to the event types
        path.register(watcher, StandardWatchEventKinds.ENTRY_CREATE);
        System.out.println("\nMonitoring directory for changes...");
        // listen to events
        WatchKey watchKey = watcher.take();
        // get list of events as they occur
        List<WatchEvent<?>> events = watchKey.pollEvents();

        for (WatchEvent event : events) {
            flag = false;
            //check if the events refers to a new file created
            if (event.kind() == StandardWatchEventKinds.ENTRY_CREATE) {
                flag = true;

                System.out.println("Created: " + event.context().toString() + " ;");
            }
        }
    } catch (IOException | InterruptedException e) {
        e.printStackTrace();
    }
    return flag;
}

Он ищет изменения в каталоге, если создается новый файл, он возвращает флаг со значением true, если я не нашел измененийвернуть флаг как ложный.

Answer 1

Используйте правило JUnit TemporaryFolder, оно позволяет создавать временные папки и временные файлы.Тесту просто нужно ввести временный путь в производственный код тестируемого модуля.

@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
private File etcHost;

@Before
public void set_file_with_content() throws Exception {
    etcHost = temporaryFolder.newFile();        
}

@Test
public void on_etc_hosts_change_do_something() throws IOException {
    // given
    try(BufferedWriter bufferedWriter = Files.newBufferedWriter(etcHost.toPath(), UTF_8, WRITE)) {
        bufferedWriter.write("127.0.0.1 xxxxx.local");
    }

    // when
    try (BufferedWriter bufferedWriter = Files.newBufferedWriter(etcHost.toPath(), UTF_8, WRITE)) {
        bufferedWriter.write("127.1.1.1 zzzzz.local");
        bufferedWriter.newLine();
        bufferedWriter.write("127.0.0.1 xxxxx.local");
    }

    // then
    ...
}

Это может работать для простых уведомлений.Но вы должны знать, что WatchService зависит от базовой реализации, которая зависит от ОС и файловой системы.Это означает, что если вы разрабатываете в Windows и код работает в Linux, этот код может работать не совсем так.Даже больше, если вы разрабатываете на Linux и производственный запуск также на Linux, но способ, которым производственный монтирует файл или папку, может помешать правильному просмотру пути;обычно это может происходить в контейнерах.

---

Приведенный выше код кажется мне некорректным, сначала .take() не находится в цикле, поэтому после опроса событий метод завершится.И WatchKey не сбрасывается после обработки каждого события.Вы можете захотеть что-то подобное:

try (WatchService watchService = FileSystems.getDefault().newWatchService()) {
    watchedParent.register(watchService, ENTRY_MODIFY, ENTRY_CREATE, OVERFLOW, ENTRY_DELETE);

    WatchKey wk;
    while ((wk = watchService.take()) != null) {
        for (WatchEvent<?> event : wk.pollEvents()) {
            if(event.kind() == OVERFLOW) { continue; }

            Path changedRelativePath = (Path) event.context();
            if (watchedFile.getFileName().equals(changedRelativePath)) {
                ...
            }
        }
        wk.reset();
    }
}

Answer 2

Вы можете использовать JUnit для тестирования WatchService.

Ссылка : https://github.com/bbejeck/Java-7/blob/master/src/test/java/bbejeck/nio/files/watch/WatchDirectoryTest.java