jaxon-php / jaxon-mono

jaxon-attributes/tests/TestAttributes/MetadataCacheTest.php

<?php
declare(strict_types=1);

namespace Jaxon\Attributes\Tests\TestAttributes;

use Jaxon\Attributes\Tests\AttributeTrait;
use Jaxon\Attributes\Tests\Attr\Ajax\Attribute;
use Jaxon\Attributes\Tests\Attr\Ajax\ClassAttribute;
use Jaxon\Attributes\Tests\Attr\Ajax\ClassExcluded;
use Jaxon\Attributes\Tests\Attr\Ajax\Component\NodeBaseComponent;
use Jaxon\Attributes\Tests\Attr\Ajax\DiAttributeError;
use Jaxon\Exception\SetupException;
use PHPUnit\Framework\TestCase;

use function Jaxon\Attributes\_register;
use function Jaxon\jaxon;
use function realpath;

class MetadataCacheTest extends TestCase
{
    use AttributeTrait;

    /**
     * @var string
     */
    private $sCacheDir;

    /**
     * @throws SetupException
     */
    public function setUp(): void
    {
        $this->sCacheDir = realpath(__DIR__ . '/../cache');
        @mkdir($this->sCacheDir);

It seems like you do not handle an error condition for mkdir(). This can introduce security issues, and is generally not recommended.

        jaxon()->di()->getPluginManager()->registerPlugins();
        _register();

        jaxon()->di()->val('jaxon_metadata_cache_dir', $this->sCacheDir);
    }

    /**
     * @throws SetupException
     */
    public function tearDown(): void
    {
        jaxon()->reset();
        parent::tearDown();

        // Delete the temp dir and all its content
        // $aFiles = scandir($this->sCacheDir);
        // foreach ($aFiles as $sFile)
        // {
        //     if($sFile !== '.' && $sFile !== '..')
        //     {
        //         @unlink($this->sCacheDir . DIRECTORY_SEPARATOR . $sFile);
        //     }
        // }
        // @rmdir($this->sCacheDir);
    }

    /**
     * @throws SetupException
     */
    public function testUploadAndExcludeWriteCache()
    {
        $xMetadata = $this->getAttributes(Attribute::class, ['saveFiles', 'doNot']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();
        $aExcluded = $xMetadata->getExceptMethods();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(Attribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aExcluded);
        $this->assertEquals('doNot', $aExcluded[0]);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('saveFiles', $aProperties);
        $this->assertCount(1, $aProperties['saveFiles']);
        $this->assertEquals("'user-files'", $aProperties['saveFiles']['upload']);
    }

    /**
     * @throws SetupException
     */
    public function testUploadAndExcludeReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(Attribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();
        $aExcluded = $xMetadata->getExceptMethods();

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aExcluded);
        $this->assertEquals('doNot', $aExcluded[0]);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('saveFiles', $aProperties);
        $this->assertCount(1, $aProperties['saveFiles']);
        $this->assertEquals("'user-files'", $aProperties['saveFiles']['upload']);
    }

    /**
     * @throws SetupException
     */
    public function testDatabagWriteCache()
    {
        $xMetadata = $this->getAttributes(Attribute::class, ['withBags']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(Attribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('withBags', $aProperties);
        $this->assertCount(1, $aProperties['withBags']);
        $this->assertCount(2, $aProperties['withBags']['bags']);
        $this->assertEquals('user.name', $aProperties['withBags']['bags'][0]);
        $this->assertEquals('page.number', $aProperties['withBags']['bags'][1]);
    }

    /**
     * @throws SetupException
     */
    public function testDatabagReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(Attribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('withBags', $aProperties);
        $this->assertCount(1, $aProperties['withBags']);
        $this->assertCount(2, $aProperties['withBags']['bags']);
        $this->assertEquals('user.name', $aProperties['withBags']['bags'][0]);
        $this->assertEquals('page.number', $aProperties['withBags']['bags'][1]);
    }

    /**
     * @throws SetupException
     */
    public function testCallbackWriteCache()
    {
        $xMetadata = $this->getAttributes(Attribute::class, ['withCallbacks']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(Attribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('withCallbacks', $aProperties);
        $this->assertCount(1, $aProperties['withCallbacks']);
        $this->assertCount(2, $aProperties['withCallbacks']['callback']);
        $this->assertEquals('jaxon.callback.first', $aProperties['withCallbacks']['callback'][0]);
        $this->assertEquals('jaxon.callback.second', $aProperties['withCallbacks']['callback'][1]);
    }

    /**
     * @throws SetupException
     */
    public function testCallbackReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(Attribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('withCallbacks', $aProperties);
        $this->assertCount(1, $aProperties['withCallbacks']);
        $this->assertCount(2, $aProperties['withCallbacks']['callback']);
        $this->assertEquals('jaxon.callback.first', $aProperties['withCallbacks']['callback'][0]);
        $this->assertEquals('jaxon.callback.second', $aProperties['withCallbacks']['callback'][1]);
    }

    /**
     * @throws SetupException
     */
    public function testCallbacksWriteCache()
    {
        $xMetadata = $this->getAttributes(Attribute::class, ['cbSingle', 'cbMultiple', 'cbParams']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(Attribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(3, $aProperties);
        $this->assertArrayHasKey('cbSingle', $aProperties);
        $this->assertArrayHasKey('cbMultiple', $aProperties);
        $this->assertArrayHasKey('cbParams', $aProperties);

        $this->assertCount(1, $aProperties['cbSingle']['__before']);
        $this->assertCount(2, $aProperties['cbMultiple']['__before']);
        $this->assertCount(2, $aProperties['cbParams']['__before']);
        $this->assertArrayHasKey('funcBefore', $aProperties['cbSingle']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['cbMultiple']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['cbMultiple']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['cbParams']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['cbParams']['__before']);
        $this->assertIsArray($aProperties['cbSingle']['__before']['funcBefore']);
        $this->assertIsArray($aProperties['cbMultiple']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['cbMultiple']['__before']['funcBefore2']);
        $this->assertIsArray($aProperties['cbParams']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['cbParams']['__before']['funcBefore2']);

        $this->assertCount(1, $aProperties['cbSingle']['__after']);
        $this->assertCount(3, $aProperties['cbMultiple']['__after']);
        $this->assertCount(1, $aProperties['cbParams']['__after']);
        $this->assertArrayHasKey('funcAfter', $aProperties['cbSingle']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter2', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter3', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['cbParams']['__after']);
        $this->assertIsArray($aProperties['cbSingle']['__after']['funcAfter']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter1']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter2']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter3']);
        $this->assertIsArray($aProperties['cbParams']['__after']['funcAfter1']);
    }

    /**
     * @throws SetupException
     */
    public function testCallbacksReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(Attribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(3, $aProperties);
        $this->assertArrayHasKey('cbSingle', $aProperties);
        $this->assertArrayHasKey('cbMultiple', $aProperties);
        $this->assertArrayHasKey('cbParams', $aProperties);

        $this->assertCount(1, $aProperties['cbSingle']['__before']);
        $this->assertCount(2, $aProperties['cbMultiple']['__before']);
        $this->assertCount(2, $aProperties['cbParams']['__before']);
        $this->assertArrayHasKey('funcBefore', $aProperties['cbSingle']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['cbMultiple']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['cbMultiple']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['cbParams']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['cbParams']['__before']);
        $this->assertIsArray($aProperties['cbSingle']['__before']['funcBefore']);
        $this->assertIsArray($aProperties['cbMultiple']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['cbMultiple']['__before']['funcBefore2']);
        $this->assertIsArray($aProperties['cbParams']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['cbParams']['__before']['funcBefore2']);

        $this->assertCount(1, $aProperties['cbSingle']['__after']);
        $this->assertCount(3, $aProperties['cbMultiple']['__after']);
        $this->assertCount(1, $aProperties['cbParams']['__after']);
        $this->assertArrayHasKey('funcAfter', $aProperties['cbSingle']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter2', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter3', $aProperties['cbMultiple']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['cbParams']['__after']);
        $this->assertIsArray($aProperties['cbSingle']['__after']['funcAfter']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter1']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter2']);
        $this->assertIsArray($aProperties['cbMultiple']['__after']['funcAfter3']);
        $this->assertIsArray($aProperties['cbParams']['__after']['funcAfter1']);
    }

    /**
     * @throws SetupException
     */
    public function testContainerWriteCache()
    {
        $xMetadata = $this->getAttributes(Attribute::class, ['di1', 'di2']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(Attribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(2, $aProperties);
        $this->assertArrayHasKey('di1', $aProperties);
        $this->assertArrayHasKey('di2', $aProperties);
        $this->assertCount(2, $aProperties['di1']['__di']);
        $this->assertCount(2, $aProperties['di2']['__di']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['di1']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Attr\Ajax\FontService', $aProperties['di1']['__di']['fontService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['di2']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\TextService', $aProperties['di2']['__di']['textService']);
    }

    /**
     * @throws SetupException
     */
    public function testContainerReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(Attribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(2, $aProperties);
        $this->assertArrayHasKey('di1', $aProperties);
        $this->assertArrayHasKey('di2', $aProperties);
        $this->assertCount(2, $aProperties['di1']['__di']);
        $this->assertCount(2, $aProperties['di2']['__di']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['di1']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Attr\Ajax\FontService', $aProperties['di1']['__di']['fontService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['di2']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\TextService', $aProperties['di2']['__di']['textService']);
    }

    /**
     * @throws SetupException
     */
    public function testClassWriteCache()
    {
        $xMetadata = $this->getAttributes(ClassAttribute::class, []);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(ClassAttribute::class, $xMetadata);

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('*', $aProperties);
        $this->assertCount(5, $aProperties['*']);
        $this->assertArrayHasKey('bags', $aProperties['*']);
        $this->assertArrayHasKey('callback', $aProperties['*']);
        $this->assertArrayHasKey('__before', $aProperties['*']);
        $this->assertArrayHasKey('__after', $aProperties['*']);
        $this->assertArrayHasKey('__di', $aProperties['*']);

        $this->assertCount(2, $aProperties['*']['bags']);
        $this->assertEquals('user.name', $aProperties['*']['bags'][0]);
        $this->assertEquals('page.number', $aProperties['*']['bags'][1]);

        $this->assertCount(2, $aProperties['*']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['*']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['*']['__before']);
        $this->assertIsArray($aProperties['*']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['*']['__before']['funcBefore2']);

        $this->assertCount(3, $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter2', $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter3', $aProperties['*']['__after']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter1']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter2']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter3']);

        $this->assertCount(3, $aProperties['*']['__di']);
        $this->assertArrayHasKey('colorService', $aProperties['*']['__di']);
        $this->assertArrayHasKey('textService', $aProperties['*']['__di']);
        $this->assertArrayHasKey('fontService', $aProperties['*']['__di']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['*']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\TextService', $aProperties['*']['__di']['textService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Attr\Ajax\FontService', $aProperties['*']['__di']['fontService']);
    }

    /**
     * @throws SetupException
     */
    public function testClassReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(ClassAttribute::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('*', $aProperties);
        $this->assertCount(5, $aProperties['*']);
        $this->assertArrayHasKey('bags', $aProperties['*']);
        $this->assertArrayHasKey('callback', $aProperties['*']);
        $this->assertArrayHasKey('__before', $aProperties['*']);
        $this->assertArrayHasKey('__after', $aProperties['*']);
        $this->assertArrayHasKey('__di', $aProperties['*']);

        $this->assertCount(2, $aProperties['*']['bags']);
        $this->assertEquals('user.name', $aProperties['*']['bags'][0]);
        $this->assertEquals('page.number', $aProperties['*']['bags'][1]);

        $this->assertCount(2, $aProperties['*']['__before']);
        $this->assertArrayHasKey('funcBefore1', $aProperties['*']['__before']);
        $this->assertArrayHasKey('funcBefore2', $aProperties['*']['__before']);
        $this->assertIsArray($aProperties['*']['__before']['funcBefore1']);
        $this->assertIsArray($aProperties['*']['__before']['funcBefore2']);

        $this->assertCount(3, $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter1', $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter2', $aProperties['*']['__after']);
        $this->assertArrayHasKey('funcAfter3', $aProperties['*']['__after']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter1']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter2']);
        $this->assertIsArray($aProperties['*']['__after']['funcAfter3']);

        $this->assertCount(3, $aProperties['*']['__di']);
        $this->assertArrayHasKey('colorService', $aProperties['*']['__di']);
        $this->assertArrayHasKey('textService', $aProperties['*']['__di']);
        $this->assertArrayHasKey('fontService', $aProperties['*']['__di']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\ColorService', $aProperties['*']['__di']['colorService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Service\TextService', $aProperties['*']['__di']['textService']);
        $this->assertEquals('Jaxon\Attributes\Tests\Attr\Ajax\FontService', $aProperties['*']['__di']['fontService']);
    }

    /**
     * @throws SetupException
     */
    public function testClassExcludeWriteCache()
    {
        $xMetadata = $this->getAttributes(ClassExcluded::class,
            ['doNot', 'withBags', 'withCallbacks', 'cbSingle']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();
        $aExcluded = $xMetadata->getExceptMethods();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(ClassExcluded::class, $xMetadata);

        $this->assertTrue($bExcluded);
        $this->assertEmpty($aProperties);
        $this->assertEmpty($aExcluded);
    }

    /**
     * @throws SetupException
     */
    public function testClassExcludeReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(ClassExcluded::class);

        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();
        $aExcluded = $xMetadata->getExceptMethods();

        $this->assertTrue($bExcluded);
        $this->assertEmpty($aProperties);
        $this->assertEmpty($aExcluded);
    }

    /**
     * @throws SetupException
     */
    public function testNodeComponentExport()
    {
        $xMetadata = $this->getAttributes(NodeBaseComponent::class,
            ['item', 'html', 'render', 'clear', 'visible'], []);
        $aBaseMethods = $xMetadata->getExportBaseMethods();

        // Save the class metadata in the cache.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadataCache->save(NodeBaseComponent::class, $xMetadata);

        // The 'html' and 'render' methods are returned.
        $this->assertCount(2, $aBaseMethods);
    }

    /**
     * @throws SetupException
     */
    public function testNodeComponentExportReadCache()
    {
        // Read the class metadata from the cache, and run the same tests.
        $xMetadataCache = jaxon()->di()->getMetadataCache();
        $xMetadata = $xMetadataCache->read(NodeBaseComponent::class);

        $aBaseMethods = $xMetadata->getExportBaseMethods();

        // The 'html' and 'render' methods are returned.
        $this->assertCount(2, $aBaseMethods);
    }

    public function testContainerAttributeWrongClassType()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DiAttributeError::class, ['diWrongClassType']);
    }
}