PublicAssetManagerTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Component\Tests\Resource;
 
use ILIAS\Component\Resource\PublicAsset;
use PHPUnit\Framework\TestCase;
use ILIAS\Component\Resource as R;
use PHPUnit\Framework\Attributes\DataProvider;
 
class PublicAssetManagerTest extends TestCase
{
    protected R\PublicAssetManager $manager;
 
    protected function newPublicAsset($source, $target): PublicAsset
    {
        return new class ($source, $target) implements R\PublicAsset {
            public function __construct(
                protected string $source,
                protected string $target,
            ) {
            }
 
            public function getSource(): string
            {
                return $this->source;
            }
 
            public function getTarget(): string
            {
                return $this->target;
            }
        };
    }
 
    public function setUp(): void
    {
        $this->manager = new class () extends R\PublicAssetManager {
            public $copied = [];
            public $purged = [];
            public $madeDir = [];
 
            protected function copy(string $source, $target): void
            {
                $this->copied[] = [$source, $target];
            }
 
            protected function purge(string $path, array $dont_purge): bool
            {
                $this->purged[] = $path;
                return true;
            }
 
            protected function makeDir(string $path): void
            {
                $this->madeDir[] = $path;
            }
        };
    }
 
    #[DataProvider('provideValidBasePathData')]
    public function testDifferentBasePaths(string $base_path): void
    {
        $this->assertIsString($base_path);
        $this->manager->buildPublicFolder($base_path, '/target');
    }
 
    public static function provideValidBasePathData(): \Iterator
    {
        yield ['/var/www/ilias'];
        yield ['/var/www/html'];
        yield ['/var/www/html/ilias'];
        yield ['/srv/ilias'];
        yield ['/srv/ilias10'];
        yield ['/srv/ilias-10'];
        yield ['/srv/ilias_10'];
        yield ['/srv/ilias.10'];
        yield ['/base'];
        yield ['/base/path'];
        yield ['/base-path'];
        yield ['/base.path'];
        yield ['/var/www/vhosts/bl-a.blubs/httpdoc'];
        yield ['/var/www/v_hosts/bl-a.blubs/httpdoc'];
        yield ['/var/www/v_hosts/bl-a.blubs_one/httpdoc'];
        yield ['/srv/ilias-build/work/ilias-10.4.0'];
    }
 
    public function testTargetCanOnlyBeUsedOnce(): void
    {
        $this->expectException(\LogicException::class);
 
        $asset1 = $this->newPublicAsset("some/source", "target");
        $asset2 = $this->newPublicAsset("some/other/source", "target");
 
        $this->manager->addAssets($asset1, $asset2);
    }
 
    public function testTargetCanNotBeWithinOtherTarget1(): void
    {
        $this->expectException(\LogicException::class);
 
        $asset1 = $this->newPublicAsset("some/source", "target");
        $asset2 = $this->newPublicAsset("some/other/source", "target/sub");
 
        $this->manager->addAssets($asset1, $asset2);
    }
 
    public function testTargetCanNotBeWithinOtherTarget2(): void
    {
        $this->expectException(\LogicException::class);
 
        $asset1 = $this->newPublicAsset("some/source", "target/sub");
        $asset2 = $this->newPublicAsset("some/other/source", "target");
 
        $this->manager->addAssets($asset1, $asset2);
    }
 
    public function testBuildAssetFolderEmpty(): void
    {
        $this->manager->buildPublicFolder("/base", "/target");
        $this->assertEquals([], $this->manager->copied);
        $this->assertEquals(["/target"], $this->manager->purged);
        $this->assertEquals(["/target"], $this->manager->madeDir);
    }
 
    public function testBuildAssetFolder(): void
    {
        $this->manager->addAssets(
            $this->newPublicAsset("source1", "target1"),
            $this->newPublicAsset("source2", "second/target")
        );
 
        $this->manager->buildPublicFolder("/base", "/public");
 
        $this->assertEquals(["/public"], $this->manager->purged);
        $this->assertEquals(["/public", "/public/second"], $this->manager->madeDir);
        $this->assertEquals(
            [["/base/source1", "/public/target1"], ["/base/source2", "/public/second/target"]],
            $this->manager->copied
        );
    }
 
    public function testValidFolderPaths(): void
    {
        $this->expectNotToPerformAssertions();
 
        $this->manager->buildPublicFolder("/base", "/public");
        $this->manager->buildPublicFolder("/srv/demo10-ilias", "/public");
        $this->manager->buildPublicFolder("/srv/demo10.ilias.de", "/public");
    }
 
    #[DataProvider('provideInvalidFolderPathData')]
    public function testInvalidFolderPaths(string $ilias_base, string $target): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->manager->buildPublicFolder($ilias_base, $target);
    }
 
    public static function provideInvalidFolderPathData(): \Iterator
    {
        yield 'base - missing leading slash' => ['base', '/public'];
        yield 'base - extra trailing slash' => ['/base/', '/public'];
        yield 'base - dot only' => ['.', '/public'];
        yield 'base - dash only' => ['-', '/public'];
        yield 'base - invalid trailing dash' => ['/base/demo-', '/public'];
        yield 'base - invalid trailing dot' => ['/base/demo.', '/public'];
        yield 'base - invalid leading dash' => ['/base/.demo', '/public'];
        yield 'base - invalid leading dot' => ['/base/-demo', '/public'];
        yield 'base - invalid dot sub directory' => ['/./test', '/public'];
        yield 'base - invalid dash sub directory' => ['/-/test', '/public'];
        yield 'target - missing leading slash' => ['/base', 'public'];
        yield 'target - extra trailing slash' => ['/base', '/public/'];
        yield 'target - dot only' => ['/base', '.'];
        yield 'target - dash only' => ['/base', '-'];
        yield 'target - invalid trailing dash' => ['/base', '/public.'];
        yield 'target - invalid trailing dot' => ['/base', '/public-'];
        yield 'target - invalid leading dash' => ['/base', '/.public'];
        yield 'target - invalid leading dot' => ['/base', '/-public'];
        yield 'target - invalid dot sub directory' => ['/base', '/./public'];
        yield 'target - invalid dash sub directory' => ['/base', '/-/public'];
    }
}