Ecodev / graphql-doctrine

tests/Attribute/Reader/ReaderTest.php

<?php

declare(strict_types=1);

namespace GraphQLTests\Doctrine\Attribute\Reader;

use GraphQL\Doctrine\Attribute\Argument;
use GraphQL\Doctrine\Attribute\Exclude;
use GraphQL\Doctrine\Attribute\Field;
use GraphQL\Doctrine\Attribute\Filter;
use GraphQL\Doctrine\Attribute\FilterGroupCondition;
use GraphQL\Doctrine\Attribute\Reader\Reader;
use GraphQL\Doctrine\Attribute\Sorting;
use GraphQLTests\Doctrine\Blog\Model\AbstractModel;
use GraphQLTests\Doctrine\Blog\Model\Post;
use GraphQLTests\Doctrine\Blog\Model\User;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;
use ReturnTypeWillChange;

class ReaderTest extends TestCase
{
    private Reader $reader;

    protected function setUp(): void
    {
        $this->reader = new Reader();
    }

    public function testGetRecursiveClassAttributesWithFilter(): void
    {
        $actual = $this->reader->getRecursiveClassAttributes(new ReflectionClass(Post::class), Filter::class);

        self::assertCount(2, $actual);
        self::assertCount(1, $actual[Post::class]);
        self::assertContainsOnlyInstancesOf(Filter::class, $actual[Post::class]);
        self::assertCount(1, $actual[AbstractModel::class]);
        self::assertContainsOnlyInstancesOf(Filter::class, $actual[AbstractModel::class]);
    }

    public function testGetRecursiveClassAttributesWithSorting(): void
    {
        $actual = $this->reader->getRecursiveClassAttributes(new ReflectionClass(Post::class), Sorting::class);

        self::assertCount(2, $actual);
        self::assertCount(2, $actual[Post::class]);
        self::assertContainsOnlyInstancesOf(Sorting::class, $actual[Post::class]);
        self::assertCount(1, $actual[AbstractModel::class]);
        self::assertContainsOnlyInstancesOf(Sorting::class, $actual[AbstractModel::class]);
    }

    public function testGetClassAttribute(): void
    {
        self::assertInstanceOf(
            Filter::class,
            $this->reader->getAttribute(new ReflectionClass(Post::class), Filter::class)
        );
    }

    public function testGetPropertyAttribute(): void
    {
        self::assertInstanceOf(
            FilterGroupCondition::class,
            $this->reader->getAttribute(new ReflectionProperty(Post::class, 'status'), FilterGroupCondition::class)
        );
    }

    public function testGetMethodAttribute(): void
    {
        self::assertInstanceOf(
            Field::class,
            $this->reader->getAttribute(new ReflectionMethod(Post::class, 'getBody'), Field::class)
        );
    }

    public function testGetParameterAttribute(): void
    {
        self::assertInstanceOf(
            Argument::class,
            $this->reader->getAttribute((new ReflectionMethod(User::class, 'getPosts'))->getParameters()[0], Argument::class)
        );
    }

    public function testWillThrowIfUniqueAttributeIsUsedMultipleTimes(): void
    {
        $mock = new class() {
            #[Exclude]
            /** @phpstan-ignore-next-line */
            #[Exclude]
            /**
             * @phpstan-ignore-next-line
             */
            private $foo;

The private property $foo is not used, and could be removed.

        };

        $this->expectExceptionMessage('Attribute "GraphQL\Doctrine\Attribute\Exclude" must not be repeated');
        $this->reader->getAttribute(new ReflectionProperty($mock, 'foo'), Exclude::class);
    }

    public function testWillThrowIfReaderIsUsedWithOtherAttributes(): void
    {
        $mock = new class() {
            /**
             * @phpstan-ignore-next-line
             */
            #[ReturnTypeWillChange]
            private function foo(): void
            {
            }
        };

        $this->expectExceptionMessage('GraphQL\Doctrine\Attribute\Reader\Reader cannot be used for attribute than are not part of `ecodev/graphql-doctrine`.');
        // @phpstan-ignore-next-line
        $this->reader->getAttribute(new ReflectionMethod($mock, 'foo'), ReturnTypeWillChange::class);
    }
}