tests/Unit/Libraries/Cms/MVC/Controller/BaseControllerTest.php - 5.4-dev - githubmirror/joomla-cms

tests/Unit/Libraries/Cms/MVC/Controller/BaseControllerTest.php
808 строк25 KB
Christian Heel
[5.4][PHP8.5] Using null as an array offset is now deprecated (unit tests) (#46203)
16 окт 2025, 20:02
16 окт 2025, 20:02fba1b61
<?php

/**
 * @package     Joomla.UnitTest
 * @subpackage  Base
 *
 * @copyright   (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
 * @license     GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\Tests\Unit\Libraries\Cms\MVC\Controller;

use Exception;
use Joomla\CMS\Application\CMSApplication;
use Joomla\CMS\Application\CMSApplicationInterface;
use Joomla\CMS\Application\CMSWebApplicationInterface;
use Joomla\CMS\Document\Document;
use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\MVC\Factory\LegacyFactory;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\MVC\Model\BaseModel;
use Joomla\CMS\MVC\View\AbstractView;
use Joomla\CMS\User\CurrentUserInterface;
use Joomla\CMS\User\CurrentUserTrait;
use Joomla\CMS\User\User;
use Joomla\Input\Input;
use Joomla\Tests\Unit\UnitTestCase;

/**
 * Test class for \Joomla\CMS\MVC\Controller\BaseController
 *
 * @package     Joomla.UnitTest
 * @subpackage  MVC
 *
 * @testdox     The BaseController
 *
 * @since       4.2.0
 */
class BaseControllerTest extends UnitTestCase
{
    /**
     * @testdox  contains the right dependencies
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testInjectedDependencies()
    {
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $app        = $this->createStub(CMSApplicationInterface::class);
        $input      = new Input();

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $app, $input) extends BaseController {
            public function getMVCFactory(): MVCFactoryInterface
            {
                return $this->factory;
            }

            public function getApplication(): CMSApplication
            {
                return $this->app;
            }

            public function getInput(): Input
            {
                return $this->input;
            }
        };

        $this->assertEquals($mvcFactory, $controller->getMVCFactory());
        $this->assertEquals($input, $controller->getInput());
    }

    /**
     * @testdox  gets the injected name
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetInjectedName()
    {
        $controller = new class (['name' => 'unit test', 'base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
        };

        $this->assertEquals('unit test', $controller->getName());
    }

    /**
     * @testdox  compiles its own name
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetCompiledName()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
        };

        $this->assertStringContainsStringIgnoringCase('base', $controller->getName());
    }

    /**
     * @testdox  lists the correct tasks
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testAvailableTasks()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function unit()
            {
            }
        };

        $this->assertEquals(['unit', 'display'], $controller->getTasks());
    }

    /**
     * @testdox  can unregister a task
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testUnregisterTask()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function list()
            {
                return $this->taskMap;
            }
        };
        $controller->unregisterTask('list');

        $this->assertNotContains('list', $controller->list());
    }

    /**
     * @testdox  executes a task
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testExecuteTask()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function unit()
            {
                return 'unit test';
            }
        };

        $this->assertEquals('unit test', $controller->execute('unit'));
        $this->assertEquals('unit', $controller->getTask());
    }

    /**
     * @testdox  can execute the injected default task
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testExecuteInjectedDefaultTask()
    {
        $controller = new class (['default_task' => 'unit', 'base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function unit()
            {
                return 'unit test';
            }
        };

        $this->assertEquals('unit test', $controller->execute('unit'));
        $this->assertEquals('unit', $controller->getTask());
    }

    /**
     * @testdox  executes the display default task
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testExecuteDisplayDefaultTask()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function display($cachable = false, $urlparams = [])
            {
                return 'unit test';
            }
        };

        $this->assertEquals('unit test', $controller->execute(''));
        $this->assertEquals('', $controller->getTask());
    }

    /**
     * @testdox  throws an exception when a task doesn't exist
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testExecuteTaskWhichDoesntExist()
    {
        $controller = new class (['default_task' => 'invalid', 'base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
        };

        $this->expectException(\Exception::class);

        $controller->execute('unit');
    }

    /**
     * @testdox  returns the correct model
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetModel()
    {
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $model      = new class (['name' => 'test']) extends BaseModel {
        };
        $mvcFactory->method('createModel')->willReturn($model);

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
        };

        $this->assertEquals($model, $controller->getModel());
    }

    /**
     * @testdox  returns the correct model with an injected prefix
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetModelWithInjectedPrefix()
    {
        $mvcFactory = $this->createMock(LegacyFactory::class);
        $mvcFactory->expects($this->once())->method('createModel')->with($this->equalTo('Unit'), $this->equalTo('Test'));

        $controller = new class (['model_prefix' => 'Test', 'base_path' => __DIR__], $mvcFactory, $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
        };
        $controller->getModel('Unit');
    }

    /**
     * @testdox  returns the correct model with the app name prefix
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetModelWithAppNamePrefix()
    {
        $mvcFactory = $this->createMock(MVCFactoryInterface::class);
        $mvcFactory->expects($this->once())->method('createModel')->with($this->equalTo('Unit'), $this->equalTo('Test'));

        $app = $this->createStub(CMSApplicationInterface::class);
        $app->method('getName')->willReturn('Test');

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };
        $controller->getModel('Unit');
    }

    /**
     * @testdox  returns false when no model is available
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetNullModel()
    {
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
        };

        $this->assertFalse($controller->getModel());
    }

    /**
     * @testdox  returns the correct model with the identity from the app
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetModelWithIdentity()
    {
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $model      = new class (['name' => 'test']) extends BaseModel implements CurrentUserInterface {
            use CurrentUserTrait;

            public function getUser(): User
            {
                return $this->getCurrentUser();
            }
        };
        $mvcFactory->method('createModel')->willReturn($model);

        $user = new User();
        $app  = $this->createStub(CMSApplicationInterface::class);
        $app->method('getIdentity')->willReturn($user);

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };

        $this->assertEquals($user, $controller->getModel()->getUser());
    }

    /**
     * @testdox  returns the correct view
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetView()
    {
        $view = new class (['name' => 'test']) extends AbstractView {
            public function display($tpl = null)
            {
            }
        };
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $mvcFactory->method('createView')->willReturn($view);
        $app = $this->createStub(CMSApplicationInterface::class);
        $app->method('getName')->willReturn('Test');

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };

        $this->assertEquals($view, $controller->getView('testGetView'));
    }

    /**
     * @testdox  returns the correct view with an injected prefix
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetViewWithInjectedPrefix()
    {
        $mvcFactory = $this->createMock(LegacyFactory::class);
        $mvcFactory->expects($this->once())->method('createView')->with($this->equalTo('Unit'), $this->equalTo('TestView'))
            ->willReturn($this->createStub(AbstractView::class));

        $controller = new class (['name' => 'Test', 'base_path' => __DIR__], $mvcFactory, $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
        };
        $controller->getView('Unit');
    }

    /**
     * @testdox  throws an exception when no view is available
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetNullView()
    {
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
        };

        $this->expectException(\Exception::class);

        $controller->getView('testGetNullView');
    }

    /**
     * @testdox  returns the correct view with the identity from the app
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testGetViewWithIdentity()
    {
        $view = new class (['name' => 'test']) extends AbstractView implements CurrentUserInterface {
            use CurrentUserTrait;

            public function display($tpl = null)
            {
            }

            public function getUser(): User
            {
                return $this->getCurrentUser();
            }
        };
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $mvcFactory->method('createView')->willReturn($view);

        $user = new User();
        $app  = $this->createStub(CMSApplicationInterface::class);
        $app->method('getName')->willReturn('Test');
        $app->method('getIdentity')->willReturn($user);

        $controller = new class (['base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };

        $this->assertEquals($user, $controller->getView('testGetViewWithIdentity')->getUser());
    }

    /**
     * @testdox  gets the injected view path
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testInjectViewPath()
    {
        $path       = \dirname(__DIR__);
        $controller = new class (['view_path' => $path, 'base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function getPaths()
            {
                return $this->paths;
            }
        };

        $this->arrayHasKey('view', $controller->getPaths());
        $this->assertEquals([$path . '/'], $controller->getPaths()['view']);
    }

    /**
     * @testdox  can add a view path
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testAddViewPath()
    {
        $controller = new class (['name' => 'unit test', 'base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class)) extends BaseController {
            public function getPaths()
            {
                return $this->paths;
            }
        };

        $controller->addViewPath(__DIR__);

        $this->arrayHasKey('view', $controller->getPaths());
        $this->assertContains(__DIR__ . '/', $controller->getPaths()['view']);
    }

    /**
     * @testdox  can display
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testDisplay()
    {
        $doc = $this->createStub(Document::class);
        $doc->method('getType')->willReturn('html');
        $app = $this->createStub(CMSWebApplicationInterface::class);
        $app->method('getName')->willReturn('Test');
        $app->method('getDocument')->willReturn($doc);

        $view             = new class (['name' => 'test']) extends AbstractView {
            public $value = null;

            public function display($tpl = null)
            {
                $this->value = 'unit test';
            }
        };
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $mvcFactory->method('createView')->willReturn($view);

        $controller = new class (['default_view' => 'unit', 'base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };

        $controller->display(false);

        $this->assertEquals('unit test', $view->value);
    }

    /**
     * @testdox  can display and sets a model on the view
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testDisplayWithModel()
    {
        $doc = $this->createStub(Document::class);
        $doc->method('getType')->willReturn('html');
        $app = $this->createStub(CMSWebApplicationInterface::class);
        $app->method('getName')->willReturn('Test');
        $app->method('getDocument')->willReturn($doc);

        $model = new class (['name' => 'test']) extends BaseModel {
        };

        $view = new class (['name' => 'test']) extends AbstractView {
            public function display($tpl = null)
            {
            }
        };
        $mvcFactory = $this->createStub(MVCFactoryInterface::class);
        $mvcFactory->method('createView')->willReturn($view);
        $mvcFactory->method('createModel')->willReturn($model);

        $controller = new class (['default_view' => 'modeltest', 'base_path' => __DIR__], $mvcFactory, $app, new Input()) extends BaseController {
        };

        $controller->display(false);

        $this->assertEquals($model, $view->getModel());
    }

    /**
     * @testdox  can check the edit id when it exists in user state
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testCheckEditIdExist()
    {
        $app = $this->createStub(CMSWebApplicationInterface::class);
        $app->method('getUserState')->willReturn([1]);

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function checkEditId($context, $id)
            {
                return parent::checkEditId($context, $id);
            }
        };

        $this->assertTrue($controller->checkEditId('', 1));
    }

    /**
     * @testdox  cannot check the edit id when it doesn't exists in user state
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testCheckEditIdNotExist()
    {
        $app = $this->createStub(CMSWebApplicationInterface::class);
        $app->method('getUserState')->willReturn([1]);

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function checkEditId($context, $id)
            {
                return parent::checkEditId($context, $id);
            }
        };

        $this->assertFalse($controller->checkEditId('', 2));
    }

    /**
     * @testdox  cannot check the edit id when it is empty
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testCheckEditEmptyId()
    {
        $app = $this->createStub(CMSWebApplicationInterface::class);
        $app->method('getUserState')->willReturn([1]);

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function checkEditId($context, $id)
            {
                return parent::checkEditId($context, $id);
            }
        };

        $this->assertTrue($controller->checkEditId('', 0));
    }

    /**
     * @testdox  can hold the edit id in app user state
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testHoldEditId()
    {
        $app = $this->createMock(CMSWebApplicationInterface::class);
        $app->expects($this->once())->method('setUserState')->with($this->equalTo('unit.id'), $this->equalTo([1]));

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function holdEditId($context, $id)
            {
                return parent::holdEditId($context, $id);
            }
        };
        $controller->holdEditId('unit', 1);
    }

    /**
     * @testdox  cannot hold an empty edit id in app user state
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testHoldEditEmptyId()
    {
        $app = $this->createMock(CMSWebApplicationInterface::class);
        $app->expects($this->never())->method('setUserState');

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function holdEditId($context, $id)
            {
                return parent::holdEditId($context, $id);
            }
        };
        $controller->holdEditId('unit', 0);
    }

    /**
     * @testdox  can release the edit id from app user state
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testReleaseEditId()
    {
        $app = $this->createMock(CMSWebApplicationInterface::class);
        $app->method('getUserState')->willReturn([1, 2]);
        $app->expects($this->once())->method('setUserState')->with($this->equalTo('unit.id'), $this->equalTo([1 => 2]));

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function releaseEditId($context, $id)
            {
                return parent::releaseEditId($context, $id);
            }
        };
        $controller->releaseEditId('unit', 1);
    }

    /**
     * @testdox  cannot release the edit id from app user state when it doesn't exist
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testReleaseInvalidEditId()
    {
        $app = $this->createMock(CMSWebApplicationInterface::class);
        $app->method('getUserState')->willReturn([2]);
        $app->expects($this->never())->method('setUserState');

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function releaseEditId($context, $id)
            {
                return parent::releaseEditId($context, $id);
            }
        };
        $controller->releaseEditId('unit', 1);
    }

    /**
     * @testdox  sets the correct redirect, message and type
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testSetRedirect()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
            public function getRedirect()
            {
                return $this->redirect;
            }

            public function getMessage()
            {
                return $this->message;
            }

            public function getMessageType()
            {
                return $this->messageType;
            }
        };
        $controller->setRedirect('unit/test', 'unit', 'test');

        $this->assertEquals('unit/test', $controller->getRedirect());
        $this->assertEquals('unit', $controller->getMessage());
        $this->assertEquals('test', $controller->getMessageType());
    }

    /**
     * @testdox  sets the correct redirect and has the default type 'message'
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testSetRedirectWithEmptyType()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
            public function getMessageType()
            {
                return $this->messageType;
            }
        };
        $controller->setRedirect('unit/test');

        $this->assertEquals('message', $controller->getMessageType());
    }

    /**
     * @testdox  does a redirect on the internal app instance
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testRedirect()
    {
        $app = $this->createMock(CMSWebApplicationInterface::class);
        $app->expects($this->once())->method('redirect')->with($this->equalTo('unit/test'));
        $app->expects($this->once())->method('enqueueMessage')->with($this->equalTo('unit test'));

        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $app, new Input()) extends BaseController {
            public function redirect()
            {
                $this->redirect = 'unit/test';
                $this->message  = 'unit test';

                return parent::redirect();
            }
        };

        $this->assertFalse($controller->redirect());
    }

    /**
     * @testdox  sets the correct message and type
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testSetMessage()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
            public function getMessage()
            {
                return $this->message;
            }

            public function getMessageType()
            {
                return $this->messageType;
            }
        };

        $this->assertEmpty($controller->setMessage('unit', 'test'));
        $this->assertEquals('unit', $controller->getMessage());
        $this->assertEquals('test', $controller->getMessageType());
    }

    /**
     * @testdox  returns the old message when a second time set
     *
     * @return  void
     *
     * @since   4.2.0
     */
    public function testSetMessageTwice()
    {
        $controller = new class (['base_path' => __DIR__], $this->createStub(MVCFactoryInterface::class), $this->createStub(CMSApplicationInterface::class), new Input()) extends BaseController {
            public function getMessage()
            {
                return $this->message;
            }
        };
        $controller->setMessage('unit');

        $this->assertEquals('unit', $controller->setMessage('test'));
    }
}