PublicAssetManagerTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Component\Tests\Resource;

use PHPUnit\Framework\TestCase;
use ILIAS\Component\Dependencies\Name;
use ILIAS\Component\Resource as R;

class PublicAssetManagerTest extends TestCase
{
    protected R\PublicAssetManager $manager;

    protected function newPublicAsset($source, $target)
    {
        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;
            }
        };
    }

    public function testTargetCanOnlyBeUsedOnce()
    {
        $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()
    {
        $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()
    {
        $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()
    {
        $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()
    {
        $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");
    }

    public function testInvalidFolderPaths(string $ilias_base, string $target): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->manager->buildPublicFolder($ilias_base, $target);
    }

    public static function provideInvalidFolderPathData(): array
    {
        return [
            'base - missing leading slash' => ['base', '/public'],
            'base - extra trailing slash' => ['/base/', '/public'],
            'base - dot only' => ['.', '/public'],
            'base - dash only' => ['-', '/public'],
            'base - invalid trailing dash' => ['/base/demo-', '/public'],
            'base - invalid trailing dot' => ['/base/demo.', '/public'],
            'base - invalid leading dash' => ['/base/.demo', '/public'],
            'base - invalid leading dot' => ['/base/-demo', '/public'],
            'base - invalid dot sub directory' => ['/./test', '/public'],
            'base - invalid dash sub directory' => ['/-/test', '/public'],
            'target - missing leading slash' => ['/base', 'public'],
            'target - extra trailing slash' => ['/base', '/public/'],
            'target - dot only' => ['/base', '.'],
            'target - dash only' => ['/base', '-'],
            'target - invalid trailing dash' => ['/base', '/public.'],
            'target - invalid trailing dot' => ['/base', '/public-'],
            'target - invalid leading dash' => ['/base', '/.public'],
            'target - invalid leading dot' => ['/base', '/-public'],
            'target - invalid dot sub directory' => ['/base', '/./public'],
            'target - invalid dash sub directory' => ['/base', '/-/public'],
        ];
    }
}