sonata-project / SonataAdminBundle

tests/Action/GetShortObjectDescriptionActionTest.php

<?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\Admin\AbstractAdmin;
use Sonata\AdminBundle\Admin\Pool;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Twig\Environment;
use Twig\Loader\ArrayLoader;

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

    /**
     * @var Environment
     */
    private $twig;

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

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

    protected function setUp(): void
    {
        $this->twig = new Environment(new ArrayLoader(['template' => 'renderedTemplate']));
        $this->pool = $this->prophesize(Pool::class);
        $this->admin = $this->prophesize(AbstractAdmin::class);
        $this->pool->getInstance(Argument::any())->willReturn($this->admin->reveal());
        $this->admin->setRequest(Argument::type(Request::class))->shouldBeCalled();
        $this->action = new GetShortObjectDescriptionAction(
            $this->twig,
            $this->pool->reveal()
        );
    }

    public function testGetShortObjectDescriptionActionInvalidAdmin(): void
    {
        $this->expectException(NotFoundHttpException::class);

        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => 42,
            'uniqid' => 'asdasd123',
        ]);

        $this->pool->getInstance('sonata.post.admin')->willReturn(null);
        $this->admin->setRequest(Argument::type(Request::class))->shouldNotBeCalled();

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

    public function testGetShortObjectDescriptionActionObjectDoesNotExist(): void
    {
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('Invalid format');

        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => 42,
            'uniqid' => 'asdasd123',
        ]);

        $this->admin->setUniqid('asdasd123')->shouldBeCalled();
        $this->admin->getObject(42)->willReturn(false);

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

    public function testGetShortObjectDescriptionActionEmptyObjectId(): void
    {
        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => '',
            'uniqid' => 'asdasd123',
            '_format' => 'html',
        ]);

        $this->admin->setUniqid('asdasd123')->shouldBeCalled();
        $this->admin->getObject(null)->willReturn(false);

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

        $this->assertInstanceOf(Response::class, $response);
    }

    public function testGetShortObjectDescriptionActionObject(): void
    {
        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => 42,
            'uniqid' => 'asdasd123',
            '_format' => 'html',
        ]);
        $object = new \stdClass();

        $this->admin->setUniqid('asdasd123')->shouldBeCalled();
        $this->admin->getObject(42)->willReturn($object);
        $this->admin->getTemplate('short_object_description')->willReturn('template');
        $this->admin->toString($object)->willReturn('bar');

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

        $this->assertSame('renderedTemplate', $response->getContent());
    }

    public function testGetShortObjectDescriptionActionEmptyObjectIdAsJson(): void
    {
        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => '',
            'uniqid' => 'asdasd123',
            '_format' => 'json',
        ]);

        $this->admin->setUniqid('asdasd123')->shouldBeCalled();

The method shouldBeCalled cannot be called on $this->admin->setUniqid('asdasd123') (of type null).

        $this->admin->getObject(null)->willReturn(false);
        $this->admin->id(false)->willReturn('');

false is of type boolean, but the function expects a object.

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

        $this->admin->toString(false)->willReturn('');

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

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

        $this->assertInstanceOf(JsonResponse::class, $response);
        $this->assertSame('{"result":{"id":"","label":""}}', $response->getContent());
    }

    public function testGetShortObjectDescriptionActionObjectAsJson(): void
    {
        $request = new Request([
            'code' => 'sonata.post.admin',
            'objectId' => 42,
            'uniqid' => 'asdasd123',
            '_format' => 'json',
        ]);
        $object = new \stdClass();

        $this->admin->setUniqid('asdasd123')->shouldBeCalled();

The method shouldBeCalled cannot be called on $this->admin->setUniqid('asdasd123') (of type null).

        $this->admin->id($object)->willReturn(42);

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

        $this->admin->getObject(42)->willReturn($object);
        $this->admin->getTemplate('short_object_description')->willReturn('template');

The method Sonata\AdminBundle\Admin\AbstractAdmin::getTemplate() has been deprecated with message: since 3.34, will be dropped in 4.0. Use TemplateRegistry services instead

The method willReturn cannot be called on $this->admin->getTemplate('short_object_description') (of type string|null).

        $this->admin->toString($object)->willReturn('bar');

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

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

        $this->assertSame('{"result":{"id":42,"label":"bar"}}', $response->getContent());
    }
}