Sonata\AdminBundle\Tests\Action\RetrieveAutocompleteItemsActionTest

Complexity

Total Complexity

11

Size/Duplication

Total Lines	287
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	10	1
A	testRetrieveAutocompleteItemsActionNotGranted()	0	14	1
A	testRetrieveAutocompleteItemsActionDisabledFormelememt()	0	27	1
A	testRetrieveAutocompleteItemsTooShortSearchString()	0	31	1
A	testRetrieveAutocompleteItems()	0	32	1
A	testRetrieveAutocompleteItemsComplexPropertyArray()	0	32	1
A	testRetrieveAutocompleteItemsComplexProperty()	0	25	1
A	configureAutocompleteItemsDatagrid()	0	34	1
A	configureFormConfig()	0	18	1
A	configureFormConfigComplexProperty()	0	18	1
A	configureFormConfigComplexPropertyArray()	0	18	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\Action;

use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Sonata\AdminBundle\Action\GetShortObjectDescriptionAction;
use Sonata\AdminBundle\Action\RetrieveAutocompleteItemsAction;
use Sonata\AdminBundle\Admin\AbstractAdmin;
use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
use Sonata\AdminBundle\Admin\Pool;
use Sonata\AdminBundle\Datagrid\Pager;
use Sonata\AdminBundle\Tests\Fixtures\Filter\FooFilter;
use Sonata\CoreBundle\Model\Metadata;
use Sonata\DatagridBundle\Datagrid\DatagridInterface;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormConfigInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

final class RetrieveAutocompleteItemsActionTest extends TestCase
{
    /**
     * @var Pool
     */
    private $pool;

    /**
     * @var GetShortObjectDescriptionAction
     */
    private $action;

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

    protected function setUp(): void
    {
        $this->admin = $this->prophesize(AbstractAdmin::class);
        $this->admin->setRequest(Argument::type(Request::class))->shouldBeCalled();
        $this->pool = $this->prophesize(Pool::class);
        $this->pool->getInstance(Argument::any())->willReturn($this->admin->reveal());
        $this->action = new RetrieveAutocompleteItemsAction(

It seems like new \Sonata\AdminBundle\Action\RetrieveAutocompleteItemsAction($this->pool->reveal()) of type object<Sonata\AdminBundle\Action\RetrieveAutocompleteItemsAction> is incompatible with the declared type object<Sonata\AdminBundle\Action\GetShortObjectDescriptionAction> of property $action.

            $this->pool->reveal()
        );
    }

    public function testRetrieveAutocompleteItemsActionNotGranted(): void
    {
        $this->expectException(AccessDeniedException::class);

        $request = new Request([
            'admin_code' => 'foo.admin',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $this->admin->hasAccess('create')->willReturn(false);

The method willReturn cannot be called on $this->admin->hasAccess('create') (of type boolean).

        $this->admin->hasAccess('edit')->willReturn(false);

The method willReturn cannot be called on $this->admin->hasAccess('edit') (of type boolean).

        $action = $this->action;
        $action($request);
    }

    public function testRetrieveAutocompleteItemsActionDisabledFormelememt(): void
    {
        $this->expectException(AccessDeniedException::class);
        $this->expectExceptionMessage('Autocomplete list can`t be retrieved because the form element is disabled or read_only.');

        $object = new \stdClass();
        $request = new Request([
            'admin_code' => 'foo.admin',
            'field' => 'barField',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $fieldDescription = $this->prophesize(FieldDescriptionInterface::class);

        $this->configureFormConfig('barField', true);

        $this->admin->getNewInstance()->willReturn($object);
        $this->admin->setSubject($object)->shouldBeCalled();

The method shouldBeCalled cannot be called on $this->admin->setSubject($object) (of type null).

        $this->admin->hasAccess('create')->willReturn(true);

The method willReturn cannot be called on $this->admin->hasAccess('create') (of type boolean).

        $this->admin->getFormFieldDescriptions()->willReturn(null);

The method willReturn cannot be called on $this->admin->getFormFieldDescriptions() (of type array<integer,object<Sonata\AdminBundle\Admin\FieldDescriptionInterface>>).

        $this->admin->getFormFieldDescription('barField')->willReturn($fieldDescription->reveal());

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

        $fieldDescription->getTargetEntity()->willReturn(Foo::class);
        $fieldDescription->getName()->willReturn('barField');

        $action = $this->action;
        $action($request);
    }

    public function testRetrieveAutocompleteItemsTooShortSearchString(): void
    {
        $object = new \stdClass();
        $request = new Request([
            'admin_code' => 'foo.admin',
            'field' => 'barField',
            'q' => 'so',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $targetAdmin = $this->prophesize(AbstractAdmin::class);
        $fieldDescription = $this->prophesize(FieldDescriptionInterface::class);

        $this->configureFormConfig('barField');

        $this->admin->getNewInstance()->willReturn($object);
        $this->admin->setSubject($object)->shouldBeCalled();

The method shouldBeCalled cannot be called on $this->admin->setSubject($object) (of type null).

        $this->admin->hasAccess('create')->willReturn(true);

The method willReturn cannot be called on $this->admin->hasAccess('create') (of type boolean).

        $this->admin->getFormFieldDescription('barField')->willReturn($fieldDescription->reveal());

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

        $this->admin->getFormFieldDescriptions()->willReturn(null);

The method willReturn cannot be called on $this->admin->getFormFieldDescriptions() (of type array<integer,object<Sonata\AdminBundle\Admin\FieldDescriptionInterface>>).

        $targetAdmin->checkAccess('list')->shouldBeCalled();
        $fieldDescription->getTargetEntity()->willReturn(Foo::class);
        $fieldDescription->getName()->willReturn('barField');
        $fieldDescription->getAssociationAdmin()->willReturn($targetAdmin->reveal());

        $action = $this->action;
        $response = $action($request);

        $this->isInstanceOf(Response::class, $response);
        $this->assertSame('application/json', $response->headers->get('Content-Type'));
        $this->assertSame('{"status":"KO","message":"Too short search string."}', $response->getContent());
    }

    public function testRetrieveAutocompleteItems(): void
    {
        $entity = new \stdClass();

$entity is not used, you could remove the assignment.

        $request = new Request([
            'admin_code' => 'foo.admin',
            'field' => 'barField',
            'q' => 'sonata',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $targetAdmin = $this->prophesize(AbstractAdmin::class);

$targetAdmin is not used, you could remove the assignment.

        $datagrid = $this->prophesize(DatagridInterface::class);

$datagrid is not used, you could remove the assignment.

        $metadata = $this->prophesize(Metadata::class);

$metadata is not used, you could remove the assignment.

        $pager = $this->prophesize(Pager::class);

$pager is not used, you could remove the assignment.

        $fieldDescription = $this->prophesize(FieldDescriptionInterface::class);

$fieldDescription is not used, you could remove the assignment.

        $this->configureFormConfig('barField');

        $datagrid = $this->configureAutocompleteItemsDatagrid();
        $filter = new FooFilter();
        $filter->initialize('foo');

        $datagrid->hasFilter('foo')->willReturn(true);
        $datagrid->getFilter('foo')->willReturn($filter);
        $datagrid->setValue('foo', null, 'sonata')->shouldBeCalled();

        $action = $this->action;
        $response = $action($request);

        $this->isInstanceOf(Response::class, $response);
        $this->assertSame('application/json', $response->headers->get('Content-Type'));
        $this->assertSame('{"status":"OK","more":false,"items":[{"id":123,"label":"FOO"}]}', $response->getContent());
    }

    public function testRetrieveAutocompleteItemsComplexPropertyArray(): void
    {
        $request = new Request([
            'admin_code' => 'foo.admin',
            'field' => 'barField',
            'q' => 'sonata',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $this->configureFormConfigComplexPropertyArray('barField');
        $datagrid = $this->configureAutocompleteItemsDatagrid();

        $filter = new FooFilter();
        $filter->initialize('entity.property');

        $datagrid->hasFilter('entity.property')->willReturn(true);
        $datagrid->getFilter('entity.property')->willReturn($filter);
        $filter2 = new FooFilter();
        $filter2->initialize('entity2.property2');

        $datagrid->hasFilter('entity2.property2')->willReturn(true);
        $datagrid->getFilter('entity2.property2')->willReturn($filter2);

        $datagrid->setValue('entity__property', null, 'sonata')->shouldBeCalled();
        $datagrid->setValue('entity2__property2', null, 'sonata')->shouldBeCalled();

        $action = $this->action;
        $response = $action($request);

        $this->isInstanceOf(Response::class, $response);
        $this->assertSame('application/json', $response->headers->get('Content-Type'));
        $this->assertSame('{"status":"OK","more":false,"items":[{"id":123,"label":"FOO"}]}', $response->getContent());
    }

    public function testRetrieveAutocompleteItemsComplexProperty(): void
    {
        $request = new Request([
            'admin_code' => 'foo.admin',
            'field' => 'barField',
            'q' => 'sonata',
        ], [], [], [], [], ['REQUEST_METHOD' => 'GET', 'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest']);

        $this->configureFormConfigComplexProperty('barField');
        $datagrid = $this->configureAutocompleteItemsDatagrid();

        $filter = new FooFilter();
        $filter->initialize('entity.property');

        $datagrid->hasFilter('entity.property')->willReturn(true);
        $datagrid->getFilter('entity.property')->willReturn($filter);
        $datagrid->setValue('entity__property', null, 'sonata')->shouldBeCalled();

        $action = $this->action;
        $response = $action($request);

        $this->isInstanceOf(Response::class, $response);
        $this->assertSame('application/json', $response->headers->get('Content-Type'));
        $this->assertSame('{"status":"OK","more":false,"items":[{"id":123,"label":"FOO"}]}', $response->getContent());
    }

    private function configureAutocompleteItemsDatagrid()
    {
        $entity = new \stdClass();

        $targetAdmin = $this->prophesize(AbstractAdmin::class);
        $datagrid = $this->prophesize(DatagridInterface::class);
        $metadata = $this->prophesize(Metadata::class);
        $pager = $this->prophesize(Pager::class);
        $fieldDescription = $this->prophesize(FieldDescriptionInterface::class);

        $this->admin->getNewInstance()->willReturn($entity);
        $this->admin->setSubject($entity)->shouldBeCalled();

The method shouldBeCalled cannot be called on $this->admin->setSubject($entity) (of type null).

        $this->admin->hasAccess('create')->willReturn(true);

The method willReturn cannot be called on $this->admin->hasAccess('create') (of type boolean).

        $this->admin->getFormFieldDescription('barField')->willReturn($fieldDescription->reveal());

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

        $this->admin->getFormFieldDescriptions()->willReturn(null);

The method willReturn cannot be called on $this->admin->getFormFieldDescriptions() (of type array<integer,object<Sonata\AdminBundle\Admin\FieldDescriptionInterface>>).

        $this->admin->id($entity)->willReturn(123);

The method willReturn cannot be called on $this->admin->id($entity) (of type string).

        $targetAdmin->checkAccess('list')->shouldBeCalled();
        $targetAdmin->setFilterPersister(null)->shouldBeCalled();
        $targetAdmin->getDatagrid()->willReturn($datagrid->reveal());
        $targetAdmin->getObjectMetadata($entity)->willReturn($metadata->reveal());
        $metadata->getTitle()->willReturn('FOO');

        $datagrid->setValue('_per_page', null, 10)->shouldBeCalled();
        $datagrid->setValue('_page', null, 1)->shouldBeCalled();
        $datagrid->buildPager()->willReturn(null);
        $datagrid->getPager()->willReturn($pager->reveal());
        $pager->getResults()->willReturn([$entity]);
        $pager->isLastPage()->willReturn(true);
        $fieldDescription->getTargetEntity()->willReturn(Foo::class);
        $fieldDescription->getName()->willReturn('barField');
        $fieldDescription->getAssociationAdmin()->willReturn($targetAdmin->reveal());

        return $datagrid;
    }

    private function configureFormConfig($field, $disabled = false): void
    {
        $form = $this->prophesize(Form::class);
        $formType = $this->prophesize(Form::class);
        $formConfig = $this->prophesize(FormConfigInterface::class);

        $this->admin->getForm()->willReturn($form->reveal());

The method willReturn() does not seem to exist on object<Symfony\Component\Form\Form>.

        $form->get($field)->willReturn($formType->reveal());
        $formType->getConfig()->willReturn($formConfig->reveal());
        $formConfig->getAttribute('disabled')->willReturn($disabled);
        $formConfig->getAttribute('property')->willReturn('foo');
        $formConfig->getAttribute('callback')->willReturn(null);
        $formConfig->getAttribute('minimum_input_length')->willReturn(3);
        $formConfig->getAttribute('items_per_page')->willReturn(10);
        $formConfig->getAttribute('req_param_name_page_number')->willReturn('_page');
        $formConfig->getAttribute('to_string_callback')->willReturn(null);
        $formConfig->getAttribute('target_admin_access_action')->willReturn('list');
    }

    private function configureFormConfigComplexProperty($field): void
    {
        $form = $this->prophesize(Form::class);
        $formType = $this->prophesize(Form::class);
        $formConfig = $this->prophesize(FormConfigInterface::class);

        $this->admin->getForm()->willReturn($form->reveal());

The method willReturn() does not seem to exist on object<Symfony\Component\Form\Form>.

        $form->get($field)->willReturn($formType->reveal());
        $formType->getConfig()->willReturn($formConfig->reveal());
        $formConfig->getAttribute('disabled')->willReturn(false);
        $formConfig->getAttribute('property')->willReturn('entity.property');
        $formConfig->getAttribute('callback')->willReturn(null);
        $formConfig->getAttribute('minimum_input_length')->willReturn(3);
        $formConfig->getAttribute('items_per_page')->willReturn(10);
        $formConfig->getAttribute('req_param_name_page_number')->willReturn('_page');
        $formConfig->getAttribute('to_string_callback')->willReturn(null);
        $formConfig->getAttribute('target_admin_access_action')->willReturn('list');
    }

    private function configureFormConfigComplexPropertyArray($field): void
    {
        $form = $this->prophesize(Form::class);
        $formType = $this->prophesize(Form::class);
        $formConfig = $this->prophesize(FormConfigInterface::class);

        $this->admin->getForm()->willReturn($form->reveal());

The method willReturn() does not seem to exist on object<Symfony\Component\Form\Form>.

        $form->get($field)->willReturn($formType->reveal());
        $formType->getConfig()->willReturn($formConfig->reveal());
        $formConfig->getAttribute('disabled')->willReturn(false);
        $formConfig->getAttribute('property')->willReturn(['entity.property', 'entity2.property2']);
        $formConfig->getAttribute('callback')->willReturn(null);
        $formConfig->getAttribute('minimum_input_length')->willReturn(3);
        $formConfig->getAttribute('items_per_page')->willReturn(10);
        $formConfig->getAttribute('req_param_name_page_number')->willReturn('_page');
        $formConfig->getAttribute('to_string_callback')->willReturn(null);
        $formConfig->getAttribute('target_admin_access_action')->willReturn('list');
    }
}