jaxon-php / jaxon-mono

jaxon-annotations/tests/TestAnnotation/DocBlockAnnotationTest.php

<?php

namespace Jaxon\Annotations\Tests\TestAnnotation;

use Jaxon\Annotations\Tests\AnnotationTrait;
use Jaxon\Annotations\Tests\Attr\Ajax\DocBlockAnnotated;
use Jaxon\Annotations\Tests\Attr\Ajax\DocBlockClassAnnotated;
use Jaxon\Annotations\Tests\Attr\Ajax\DocBlockClassExcluded;
use Jaxon\Exception\SetupException;
use PHPUnit\Framework\TestCase;

use function Jaxon\jaxon;
use function mkdir;
use function rmdir;
use function Jaxon\Annotations\_register;

class DocBlockAnnotationTest extends TestCase
{
    use AnnotationTrait;

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

    /**
     * @throws SetupException
     */
    public function setUp(): void
    {
        $this->sCacheDir = __DIR__ . '/../tmp';
        @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_annotations_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);

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

            }
        }
        @rmdir($this->sCacheDir);

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

    }

    /**
     * @throws SetupException
     */
    public function testUploadAndExcludeAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockAnnotated::class, ['saveFiles', 'doNot']);
        $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 testDatabagAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockAnnotated::class, ['withBags']);
        $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 testCallbackAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockAnnotated::class, ['withCallback']);
        $bExcluded = $xMetadata->isExcluded();
        $aProperties = $xMetadata->getProperties();

        $this->assertFalse($bExcluded);

        $this->assertCount(1, $aProperties);
        $this->assertArrayHasKey('withCallback', $aProperties);
        $this->assertCount(1, $aProperties['withCallback']);
        $this->assertIsArray($aProperties['withCallback']['callback']);
        $this->assertEquals('jaxon.ajax.callback.test', $aProperties['withCallback']['callback'][0]);
    }

    /**
     * @throws SetupException
     */
    public function testHooksAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockAnnotated::class,
            ['cbSingle', 'cbMultiple', 'cbParams']);
        $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 testContainerAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockAnnotated::class, ['di1', 'di2']);
        $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\Annotations\Tests\Service\ColorService', $aProperties['di1']['__di']['colorService']);
        $this->assertEquals('Jaxon\Annotations\Tests\Attr\Ajax\FontService', $aProperties['di1']['__di']['fontService']);
        $this->assertEquals('Jaxon\Annotations\Tests\Service\ColorService', $aProperties['di2']['__di']['colorService']);
        $this->assertEquals('Jaxon\Annotations\Tests\Service\TextService', $aProperties['di2']['__di']['textService']);
    }

    /**
     * @throws SetupException
     */
    public function testClassAnnotation()
    {
        $xMetadata = $this->getAttributes(DocBlockClassAnnotated::class, []);
        // $this->assertEquals('', json_encode($aProperties));
        $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->assertCount(2, $aProperties['*']['bags']);
        $this->assertEquals('user.name', $aProperties['*']['bags'][0]);
        $this->assertEquals('page.number', $aProperties['*']['bags'][1]);

        $this->assertIsArray($aProperties['*']['callback']);
        $this->assertEquals('jaxon.ajax.callback.test', $aProperties['*']['callback'][0]);

        $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\Annotations\Tests\Service\ColorService', $aProperties['*']['__di']['colorService']);
        $this->assertEquals('Jaxon\Annotations\Tests\Service\TextService', $aProperties['*']['__di']['textService']);
        $this->assertEquals('Jaxon\Annotations\Tests\Attr\Ajax\FontService', $aProperties['*']['__di']['fontService']);
    }

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

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

    public function testUploadAnnotationErrorFieldName()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['saveFileErrorFieldName']);
    }

    public function testUploadAnnotationErrorFieldNumber()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['saveFileErrorFieldNumber']);
    }

    public function testDatabagAnnotationErrorName()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['withBagsErrorName']);
    }

    public function testDatabagAnnotationErrorNumber()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['withBagsErrorNumber']);
    }

    public function testContainerAnnotationErrorAttr()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['diErrorAttr']);
    }

    public function testContainerAnnotationErrorClass()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['diErrorClass']);
    }

    public function testContainerAnnotationErrorOneParam()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['diErrorOneParam']);
    }

    public function testContainerAnnotationErrorThreeParams()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['diErrorThreeParams']);
    }

    public function testCbBeforeAnnotationErrorName()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbBeforeErrorName']);
    }

    public function testCbBeforeAnnotationErrorParam()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbBeforeErrorParam']);
    }

    public function testCbBeforeAnnotationErrorNumber()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbBeforeErrorNumber']);
    }

    public function testCbAfterAnnotationErrorName()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbAfterErrorName']);
    }

    public function testCbAfterAnnotationErrorParam()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbAfterErrorParam']);
    }

    public function testCbAfterAnnotationErrorNumber()
    {
        $this->expectException(SetupException::class);
        $this->getAttributes(DocBlockAnnotated::class, ['cbAfterErrorNumber']);
    }
}