Sonata\AdminBundle\Tests\Command\ExplainAdminCommandTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	setUp()	0	100	1
B	testExecute()	0	62	1
A	testExecuteEmptyValidator()	0	53	1
A	testExecuteNonAdminService()	0	10	1
A	testExecuteWithNonClassMetadata()	0	49	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Tests\Command;

use InvalidArgumentException;
use PHPUnit\Framework\TestCase;
use Sonata\AdminBundle\Admin\AdminInterface;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\AdminBundle\Builder\DatagridBuilderInterface;
use Sonata\AdminBundle\Builder\ListBuilderInterface;
use Sonata\AdminBundle\Command\ExplainAdminCommand;
use Sonata\AdminBundle\Controller\CRUDController;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Sonata\AdminBundle\Route\RouteCollection;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Constraints\NotNull;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface;
use Symfony\Component\Validator\Mapping\GenericMetadata;

/**
 * @author Andrej Hudec <pulzarraider@gmail.com>
 */
class ExplainAdminCommandTest extends TestCase
{
    /**
     * @var Application
     */
    private $application;

    /**
     * @var AdminInterface
     */
    private $admin;

    /**
     * @var MetadataFactoryInterface
     */
    private $validatorFactory;

    protected function setUp(): void
    {
        $this->application = new Application();

        $container = new Container();

        $this->admin = $this->createMock(AdminInterface::class);

        $this->admin
            ->method('getCode')
            ->willReturn('foo');

        $this->admin
            ->method('getClass')
            ->willReturn('Acme\Entity\Foo');

        $this->admin
            ->method('getBaseControllerName')
            ->willReturn(CRUDController::class);

        $routeCollection = new RouteCollection('foo', 'fooBar', 'foo-bar', CRUDController::class);
        $routeCollection->add('list');
        $routeCollection->add('edit');

        $this->admin
            ->method('getRoutes')
            ->willReturn($routeCollection);

        $fieldDescription1 = $this->createMock(FieldDescriptionInterface::class);

        $fieldDescription1
            ->method('getType')
            ->willReturn('text');

        $fieldDescription1
            ->method('getTemplate')
            ->willReturn('@SonataAdmin/CRUD/foo_text.html.twig');

        $fieldDescription2 = $this->createMock(FieldDescriptionInterface::class);

        $fieldDescription2
            ->method('getType')
            ->willReturn('datetime');

        $fieldDescription2
            ->method('getTemplate')
            ->willReturn('@SonataAdmin/CRUD/bar_datetime.html.twig');

        $this->admin
            ->method('getListFieldDescriptions')
            ->willReturn([
                'fooTextField' => $fieldDescription1,
                'barDateTimeField' => $fieldDescription2,
            ]);

        $this->admin
            ->method('getFilterFieldDescriptions')
            ->willReturn([
                'fooTextField' => $fieldDescription1,
                'barDateTimeField' => $fieldDescription2,
            ]);

        $this->admin
            ->method('getFormTheme')
            ->willReturn(['@Foo/bar.html.twig']);

        $this->admin
            ->method('getFormFieldDescriptions')
            ->willReturn([
                'fooTextField' => $fieldDescription1,
                'barDateTimeField' => $fieldDescription2,
            ]);

        $this->admin
            ->method('isChild')
            ->willReturn(true);

        $this->admin
            ->method('getParent')
            ->willReturnCallback(function () {
                $adminParent = $this->createMock(AdminInterface::class);

                $adminParent
                    ->method('getCode')
                    ->willReturn('foo_child');

                return $adminParent;
            });

        $container->set('acme.admin.foo', $this->admin);

        $pool = new Pool($container, '', '');
        $pool->setAdminServiceIds(['acme.admin.foo', 'acme.admin.bar']);

        $this->validatorFactory = $this->createMock(MetadataFactoryInterface::class);

        $command = new ExplainAdminCommand($pool, $this->validatorFactory);

        $this->application->add($command);
    }

    public function testExecute(): void
    {
        $metadata = $this->createMock(ClassMetadata::class);

        $this->validatorFactory->expects($this->once())

The method expects() does not seem to exist on object<Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface>.

            ->method('getMetadataFor')
            ->with($this->equalTo('Acme\Entity\Foo'))
            ->willReturn($metadata);

        $propertyMetadata = $this->getMockForAbstractClass(GenericMetadata::class);
        $propertyMetadata->constraints = [
            new NotNull(),
            new Length(['min' => 2, 'max' => 50, 'groups' => ['create', 'edit']]),
        ];

        $metadata->properties = ['firstName' => $propertyMetadata];

        $getterMetadata = $this->getMockForAbstractClass(GenericMetadata::class);
        $getterMetadata->constraints = [
            new NotNull(),
            new Email(['groups' => ['registration', 'edit']]),
        ];

        $metadata->getters = ['email' => $getterMetadata];

        $modelManager = $this->createMock(ModelManagerInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getModelManager')
            ->willReturn($modelManager);

        $formBuilder = $this->createMock(FormBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

             ->method('getFormBuilder')
             ->willReturn($formBuilder);

        $datagridBuilder = $this->createMock(DatagridBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getDatagridBuilder')
            ->willReturn($datagridBuilder);

        $listBuilder = $this->createMock(ListBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getListBuilder')
            ->willReturn($listBuilder);

        $command = $this->application->find('sonata:admin:explain');
        $commandTester = new CommandTester($command);
        $commandTester->execute(['command' => $command->getName(), 'admin' => 'acme.admin.foo']);

        $this->assertSame(sprintf(
            str_replace("\n", PHP_EOL, file_get_contents(__DIR__.'/../Fixtures/Command/explain_admin.txt')),
            \get_class($this->admin),
            \get_class($modelManager),
            \get_class($formBuilder),
            \get_class($datagridBuilder),
            \get_class($listBuilder)
        ), $commandTester->getDisplay());
    }

    public function testExecuteEmptyValidator(): void
    {
        $metadata = $this->createMock(ClassMetadata::class);

        $this->validatorFactory->expects($this->once())

The method expects() does not seem to exist on object<Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface>.

            ->method('getMetadataFor')
            ->with($this->equalTo('Acme\Entity\Foo'))
            ->willReturn($metadata);

        $metadata->properties = [];
        $metadata->getters = [];

        $modelManager = $this->createMock(ModelManagerInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getModelManager')
            ->willReturn($modelManager);

        $formBuilder = $this->createMock(FormBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

             ->method('getFormBuilder')
             ->willReturn($formBuilder);

        $datagridBuilder = $this->createMock(DatagridBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getDatagridBuilder')
            ->willReturn($datagridBuilder);

        $listBuilder = $this->createMock(ListBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getListBuilder')
            ->willReturn($listBuilder);

        $command = $this->application->find('sonata:admin:explain');
        $commandTester = new CommandTester($command);
        $commandTester->execute(['command' => $command->getName(), 'admin' => 'acme.admin.foo']);

        $this->assertSame(sprintf(
            str_replace(
                "\n",
                PHP_EOL,
                file_get_contents(__DIR__.'/../Fixtures/Command/explain_admin_empty_validator.txt')
            ),
            \get_class($this->admin),
            \get_class($modelManager),
            \get_class($formBuilder),
            \get_class($datagridBuilder),
            \get_class($listBuilder)
        ), $commandTester->getDisplay());
    }

    public function testExecuteNonAdminService(): void
    {
        $command = $this->application->find('sonata:admin:explain');
        $commandTester = new CommandTester($command);

        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Admin service "nonexistent.service" not found in admin pool. Did you mean "acme.admin.bar" or one of those: []');

        $commandTester->execute(['command' => $command->getName(), 'admin' => 'nonexistent.service']);
    }

    public function testExecuteWithNonClassMetadata(): void
    {
        $metadata = $this->createStub(GenericMetadata::class);

        $this->validatorFactory->expects($this->once())

The method expects() does not seem to exist on object<Symfony\Component\Validator\Mapping\Factory\MetadataFactoryInterface>.

            ->method('getMetadataFor')
            ->with($this->equalTo('Acme\Entity\Foo'))
            ->willReturn($metadata);

        $metadata->properties = [];
        $metadata->getters = [];

        $modelManager = $this->createStub(ModelManagerInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getModelManager')
            ->willReturn($modelManager);

        $formBuilder = $this->createStub(FormBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getFormBuilder')
            ->willReturn($formBuilder);

        $datagridBuilder = $this->createStub(DatagridBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getDatagridBuilder')
            ->willReturn($datagridBuilder);

        $listBuilder = $this->createStub(ListBuilderInterface::class);

        $this->admin

The method method() does not seem to exist on object<Sonata\AdminBundle\Admin\AdminInterface>.

            ->method('getListBuilder')
            ->willReturn($listBuilder);

        $command = $this->application->find('sonata:admin:explain');
        $commandTester = new CommandTester($command);

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage(
            sprintf(
                'Cannot read metadata properties of Acme\Entity\Foo because its metadata is an instance of %s instead of Symfony\Component\Validator\Mapping\ClassMetadata',
                \get_class($metadata)
            )
        );

        $commandTester->execute(['command' => $command->getName(), 'admin' => 'acme.admin.foo']);
    }
}