ilCtrlEventTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\HTTP\Wrapper\ArrayBasedRequestWrapper;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\HTTP\Response\Sender\ResponseSenderStrategy;
use Psr\Http\Message\ServerRequestInterface;
use ILIAS\HTTP\Wrapper\RequestWrapper;

class ilCtrlEventTest extends TestCase
{
    private ilCtrlSubject $subject;

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

    public function testObserverAttachment(): void
    {
        // Default Attachment
        $mocked_observer = $this->createMock(ilCtrlObserver::class);
        $mocked_subject = $this->createMock(ilCtrlSubject::class);
        $mocked_ilctrl = $this->getMockedCtrl($mocked_subject);
        $mocked_subject->expects($this->once())
                       ->method('attach')
                       ->with($mocked_observer, ilCtrlEvent::ALL);

        $mocked_ilctrl->attachObserver($mocked_observer);

        $mocked_subject->expects($this->once())
                       ->method('detach')
                       ->with($mocked_observer, ilCtrlEvent::ALL);
        $mocked_ilctrl->detachObserver($mocked_observer);

        // Command Class Attachment
        $mocked_observer = $this->createMock(ilCtrlObserver::class);
        $mocked_subject = $this->createMock(ilCtrlSubject::class);
        $mocked_ilctrl = $this->getMockedCtrl($mocked_subject);
        $mocked_subject->expects($this->once())
                       ->method('attach')
                       ->with($mocked_observer, ilCtrlEvent::COMMAND_CLASS_FORWARD);

        $mocked_ilctrl->attachObserver($mocked_observer, ilCtrlEvent::COMMAND_CLASS_FORWARD);

        $mocked_subject->expects($this->once())
                       ->method('detach')
                       ->with($mocked_observer, ilCtrlEvent::COMMAND_CLASS_FORWARD);
        $mocked_ilctrl->detachObserver($mocked_observer, ilCtrlEvent::COMMAND_CLASS_FORWARD);

        // Command Determination Attachment
        $mocked_observer = $this->createMock(ilCtrlObserver::class);
        $mocked_subject = $this->createMock(ilCtrlSubject::class);
        $mocked_ilctrl = $this->getMockedCtrl($mocked_subject);
        $mocked_subject->expects($this->once())
                       ->method('attach')
                       ->with($mocked_observer, ilCtrlEvent::COMMAND_DETERMINATION);

        $mocked_ilctrl->attachObserver($mocked_observer, ilCtrlEvent::COMMAND_DETERMINATION);

        $mocked_subject->expects($this->once())
                       ->method('detach')
                       ->with($mocked_observer, ilCtrlEvent::COMMAND_DETERMINATION);
        $mocked_ilctrl->detachObserver($mocked_observer, ilCtrlEvent::COMMAND_DETERMINATION);
    }

    public function testNotifyEvents(): void
    {
        require_once __DIR__ . '/Data/GUI/class.ilCtrlBaseClass1TestGUI.php';
        $base_class = new ilCtrlBaseClass1TestGUI();

        $mocked_ilctrl = $this->getMockedCtrl();

        $mocked_observer = $this->createMock(ilCtrlObserver::class);
        $mocked_ilctrl->attachObserver($mocked_observer, ilCtrlEvent::ALL);
        $consecutive = [
            [ilCtrlEvent::COMMAND_CLASS_FORWARD, ilCtrlBaseClass1TestGUI::class],
            [ilCtrlEvent::COMMAND_DETERMINATION, 'fallback']
        ];
        $mocked_observer
            ->expects($this->exactly(2))
            ->method('update')
            ->willReturnCallback(
                function ($event, $cmd) use (&$consecutive) {
                    $expected = array_shift($consecutive);
                    $this->assertEquals($expected, [$event, $cmd]);
                }
            );

        $mocked_ilctrl->forwardCommand($base_class);
        $command = $mocked_ilctrl->getCmd('fallback');
    }

    private function getMockedCtrl(?ilCtrlSubject $subject = null): ilCtrlInterface
    {
        return new ilCtrl(
            $this->createMock(ilCtrlStructureInterface::class),
            $this->createMock(ilCtrlTokenRepositoryInterface::class),
            $this->createMock(ilCtrlPathFactoryInterface::class),
            $this->createMock(ilCtrlContextInterface::class),
            $this->createMock(ResponseSenderStrategy::class),
            $this->createMock(ServerRequestInterface::class),
            $this->createMock(RequestWrapper::class),
            $this->createMock(RequestWrapper::class),
            $this->createMock(Refinery::class),
            $this->createMock(ilComponentFactory::class),
            $subject ?? $this->subject,
            $this->createMock(ilCtrlQueryParserInterface::class),
        );
    }
}