FinderTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\MockObject\MockObject;
use ILIAS\Filesystem\DTO\Metadata;
use PHPUnit\Framework\Attributes\Depends;
use ILIAS\Data\DataSize;
use ILIAS\Filesystem;
use ILIAS\Filesystem\Finder\Finder;
use ILIAS\Filesystem\MetadataType;
use PHPUnit\Framework\TestCase;

class FinderTest extends TestCase
{
    private function getFlatFileSystemStructure(): MockObject
    {
        $fileSystem = $this->getMockBuilder(Filesystem\Filesystem::class)->getMock();

        $metadata = [
            new Metadata('file_1.txt', MetadataType::FILE),
            new Metadata('file_2.mp3', MetadataType::FILE),
            new Metadata('dir_1', MetadataType::DIRECTORY),
        ];

        $fileSystem
            ->expects($this->atLeast(1))
            ->method('listContents')
            ->willReturnCallback(function ($path) use ($metadata): array {
                if ('/' === $path) {
                    return $metadata;
                }

                return [];
            });

        return $fileSystem;
    }

    private function getNestedFileSystemStructure(): MockObject
    {
        $fileSystem = $this->getMockBuilder(Filesystem\Filesystem::class)->getMock();

        $rootMetadata = [
            new Metadata('file_1.txt', MetadataType::FILE),
            new Metadata('file_2.mp3', MetadataType::FILE),
            new Metadata('dir_1', MetadataType::DIRECTORY),
        ];

        $level1Metadata = [
            new Metadata('dir_1/file_3.log', MetadataType::FILE),
            new Metadata('dir_1/file_4.php', MetadataType::FILE),
            new Metadata('dir_1/dir_1_1', MetadataType::DIRECTORY),
            new Metadata('dir_1/dir_1_2', MetadataType::DIRECTORY),
        ];

        $level11Metadata = [
            new Metadata('dir_1/dir_1_1/file_5.cpp', MetadataType::FILE),
        ];

        $level12Metadata = [
            new Metadata('dir_1/dir_1_2/file_6.py', MetadataType::FILE),
            new Metadata('dir_1/dir_1_2/file_7.cpp', MetadataType::FILE),
            new Metadata('dir_1/dir_1_2/dir_1_2_1', MetadataType::DIRECTORY),
        ];

        $fileSystem
            ->expects($this->atLeast(1))
            ->method('listContents')
            ->willReturnCallback(function ($path) use (
                $rootMetadata,
                $level1Metadata,
                $level11Metadata,
                $level12Metadata
            ): array {
                if ('/' === $path) {
                    return $rootMetadata;
                }
                if ('dir_1' === $path) {
                    return $level1Metadata;
                }
                if ('dir_1/dir_1_1' === $path) {
                    return $level11Metadata;
                }
                if ('dir_1/dir_1_2' === $path) {
                    return $level12Metadata;
                }

                return [];
            });

        return $fileSystem;
    }

    public function testFinderWillFindNoFilesOrFoldersInAnEmptyDirectory(): void
    {
        $fileSystem = $this->getMockBuilder(Filesystem\Filesystem::class)->getMock();

        $fileSystem
            ->method('listContents')
            ->willReturn([]);

        $finder = (new Finder($fileSystem))->in(['/']);

        $this->assertEmpty(iterator_count($finder));
    }

    public function testFinderWillFindFilesAndFoldersInFlatStructure(): void
    {
        $finder = (new Finder($this->getFlatFileSystemStructure()))->in(['/']);

        $this->assertCount(3, $finder);
        $this->assertCount(1, $finder->directories());
        $this->assertCount(2, $finder->files());
    }

    public function testFinderWillFindFilesAndFoldersInNestedStructure(): void
    {
        $finder = (new Finder($this->getNestedFileSystemStructure()))->in(['/']);

        $this->assertCount(11, $finder);
        $this->assertCount(4, $finder->directories());
        $this->assertCount(7, $finder->files());
    }

    public function testFinderWillFindFilesAndFoldersForACertainDirectoryDepth(): void
    {
        $finder = (new Finder($this->getNestedFileSystemStructure()))->in(['/']);

        $level0Finder = $finder->depth(0);
        $this->assertCount(3, $level0Finder);
        $this->assertCount(1, $level0Finder->directories());
        $this->assertCount(2, $level0Finder->files());

        $greaterLevel0Finder = $finder->depth('> 0');
        $this->assertCount(8, $greaterLevel0Finder);
        $this->assertCount(3, $greaterLevel0Finder->directories());
        $this->assertCount(5, $greaterLevel0Finder->files());

        $greaterOrEqualLevel0Finder = $finder->depth('>= 0');
        $this->assertCount(11, $greaterOrEqualLevel0Finder);
        $this->assertCount(4, $greaterOrEqualLevel0Finder->directories());
        $this->assertCount(7, $greaterOrEqualLevel0Finder->files());

        $lowerOrEqualLevel1Finder = $finder->depth('<= 1');
        $this->assertCount(7, $lowerOrEqualLevel1Finder);
        $this->assertCount(3, $lowerOrEqualLevel1Finder->directories());
        $this->assertCount(4, $lowerOrEqualLevel1Finder->files());

        $lowerLevel2Finder = $finder->depth('< 2');
        $this->assertCount(7, $lowerLevel2Finder);
        $this->assertCount(3, $lowerLevel2Finder->directories());
        $this->assertCount(4, $lowerLevel2Finder->files());

        $exactlyLevel2Finder = $finder->depth(2);
        $this->assertCount(4, $exactlyLevel2Finder);
        $this->assertCount(1, $exactlyLevel2Finder->directories());
        $this->assertCount(3, $exactlyLevel2Finder->files());
    }

    public function testFinderWillNotSearchInExcludedFolders(): void
    {
        $finder = (new Finder($this->getNestedFileSystemStructure()))->in(['/']);

        $finderWithExcludedDir = $finder->exclude(['dir_1/dir_1_1']);
        $this->assertCount(9, $finderWithExcludedDir);
        $this->assertCount(3, $finderWithExcludedDir->directories());
        $this->assertCount(6, $finderWithExcludedDir->files());

        $finderWithMultipleExcludedDirs = $finder->exclude(['dir_1/dir_1_1', 'dir_1/dir_1_2/dir_1_2_1']);
        $this->assertCount(8, $finderWithMultipleExcludedDirs);
        $this->assertCount(2, $finderWithMultipleExcludedDirs->directories());
        $this->assertCount(6, $finderWithMultipleExcludedDirs->files());
    }

    public function testFinderWillFilterFilesAndFoldersByCreationTimestamp(): Filesystem\Filesystem
    {
        $now = new \DateTimeImmutable('2019-03-30 13:00:00');

        $fs = $this->getNestedFileSystemStructure();
        $fs->method('has')->willReturn(true);

        $fs
            ->expects($this->atLeast(1))
            ->method('getTimestamp')
            ->willReturnCallback(fn($path): \DateTimeImmutable => match ($path) {
                'file_1.txt' => $now,
                'file_2.mp3' => $now->modify('+1 hour'),
                'dir_1/file_3.log' => $now->modify('+2 hour'),
                'dir_1/file_4.php' => $now->modify('+3 hour'),
                'dir_1/dir_1_1/file_5.cpp' => $now->modify('+4 hour'),
                'dir_1/dir_1_2/file_6.py' => $now->modify('+5 hour'),
                'dir_1/dir_1_2/file_7.cpp' => $now->modify('+6 hour'),
                default => new \DateTimeImmutable('now'),
            });

        $finder = (new Finder($fs))->in(['/']);

        for ($i = 1; $i <= 7; $i++) {
            $this->assertCount(8 - $i, $finder->date('>= 2019-03-30 1' . (2 + $i) . ':00')->files());
        }
        $this->assertCount(3, $finder->date('>= 2019-03-30 15:00 + 2hours')->files());
        $this->assertCount(2, $finder->date('> 2019-03-30 15:00 + 2hours')->files());
        $this->assertCount(1, $finder->date('2019-03-30 15:00 + 2hours')->files());
        $this->assertCount(2, $finder->date('< 2019-03-30 15:00')->files());
        $this->assertCount(3, $finder->date('<= 2019-03-30 15:00')->files());
        $this->assertCount(2, $finder->date('<= 2019-03-30 15:00 - 1minute')->files());

        return $fs;
    }

    public function testFinderWillFilterFilesBySize(): void
    {
        $fs = $this->getNestedFileSystemStructure();
        $fs->method('has')->willReturn(true);

        $fs->expects($this->atLeast(1))
            ->method('getSize')
            ->willReturnCallback(fn($path): DataSize => match ($path) {
                'file_1.txt' => new DataSize(PHP_INT_MAX, DataSize::Byte),
                'file_2.mp3' => new DataSize(1024, DataSize::Byte),
                'dir_1/file_3.log' => new DataSize(1024 * 1024 * 1024, DataSize::Byte),
                'dir_1/file_4.php' => new DataSize(1024 * 1024 * 127, DataSize::Byte),
                'dir_1/dir_1_1/file_5.cpp' => new DataSize(1024 * 7, DataSize::Byte),
                'dir_1/dir_1_2/file_6.py' => new DataSize(1024 * 100, DataSize::Byte),
                'dir_1/dir_1_2/file_7.cpp' => new DataSize(1, DataSize::Byte),
                default => new DataSize(0, DataSize::Byte),
            });

        $finder = (new Finder($fs))->in(['/']);

        $this->assertCount(1, $finder->size('< 1Ki')->files());
        $this->assertCount(2, $finder->size('<= 1Ki')->files());
        $this->assertCount(6, $finder->size('>= 1Ki')->files());
        $this->assertCount(5, $finder->size('> 1Ki')->files());
        $this->assertCount(1, $finder->size('1Ki')->files());

        $this->assertCount(3, $finder->size('> 1Mi')->files());
        $this->assertCount(2, $finder->size('>= 1Gi')->files());
    }

    #[Depends('testFinderWillFilterFilesAndFoldersByCreationTimestamp')]
    public function testSortingWorksAsExpected(Filesystem\Filesystem $fs): void
    {
        $finder = (new Finder($fs))->in(['/']);

        $this->assertEquals('file_1.txt', $finder->files()->sortByTime()->getIterator()->current()->getPath());
        $this->assertEquals(
            'dir_1/dir_1_2/file_7.cpp',
            $finder->files()->sortByTime()->reverseSorting()->getIterator()->current()->getPath()
        );

        $this->assertEquals('dir_1', $finder->sortByName()->getIterator()->current()->getPath());
        $this->assertEquals('file_2.mp3', $finder->sortByName()->reverseSorting()->getIterator()->current()->getPath());

        $this->assertEquals('dir_1', $finder->sortByType()->getIterator()->current()->getPath());
        $this->assertEquals('file_2.mp3', $finder->sortByType()->reverseSorting()->getIterator()->current()->getPath());

        $customSortFinder = $finder->sort(function (Metadata $left, Metadata $right): int {
            if ('dir_1/dir_1_1/file_5.cpp' === $left->getPath()) {
                return -1;
            }

            return 1;
        });
        $this->assertEquals('dir_1/dir_1_1/file_5.cpp', $customSortFinder->getIterator()->current()->getPath());
        $all = array_values(iterator_to_array($customSortFinder->reverseSorting()->getIterator()));
        $last = $all[iterator_count($customSortFinder) - 1];
        $this->assertEquals('dir_1/dir_1_1/file_5.cpp', $last->getPath());
    }
}