ilTermsOfServiceUserHasGlobalRoleCriterionTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Legacy\Legacy;
use PHPUnit\Framework\MockObject\MockObject;

class ilTermsOfServiceUserHasGlobalRoleCriterionTest extends ilTermsOfServiceCriterionBaseTest
{
    protected ilRbacReview $rbacReview;
    protected ilLanguage $lng;
    protected int $expectedInitialValue = 2;
    protected int $expectedAfterFormSubmitValue = 4;
    protected string $userRoleTitle = 'User';
    protected string $adminRoleTitle = 'Administrator';

    protected function setUp(): void
    {
        parent::setUp();

        $this->lng = $this->getLanguageMock();

        $this->lng
            ->method('txt')
            ->willReturn('dummy');
    }

    protected function getInstance(): ilTermsOfServiceUserHasGlobalRoleCriterion
    {
        $this->rbacReview = $this->getRbacReviewMock();

        $criterion = new ilTermsOfServiceUserHasGlobalRoleCriterion(
            $this->rbacReview,
            $this->getObjectDataCacheMock()
        );

        return $criterion;
    }

    public function testInstanceCanBeCreated(): ilTermsOfServiceUserHasGlobalRoleCriterion
    {
        $criterion = $this->getInstance();

        $this->assertSame('usr_global_role', $criterion->getTypeIdent());
        $this->assertFalse($criterion->hasUniqueNature());

        return $criterion;
    }

    protected function buildForm(
        ilTermsOfServiceCriterionTypeGUI $gui,
        string $httpCriterionSelectionBodyParameter
    ): ilPropertyFormGUI {
        $form = $this->getFormMock();

        $radioGroup = $this->getRadioGroupMock();

        $radioGroup
            ->method('getPostVar')
            ->willReturn($httpCriterionSelectionBodyParameter);

        $form->addItem($radioGroup);

        $gui->appendOption(
            $radioGroup,
            new ilTermsOfServiceCriterionConfig(['role_id' => $this->expectedInitialValue])
        );

        return $form;
    }

    public function testFormUserInterfaceElementsAreProperlyBuilt(
        ilTermsOfServiceUserHasGlobalRoleCriterion $criterion
    ): ilTermsOfServiceUserHasGlobalRoleCriterion {
        $httpCriterionSelectionBodyParameter = 'criterion';
        $httpCriterionConfigBodyParameter = $criterion->getTypeIdent() . '_role_id';

        $gui = $criterion->ui($this->lng);

        $this->assertInstanceOf(ilTermsOfServiceUserHasGlobalRoleCriterionGUI::class, $gui);

        $form = $this->buildForm($gui, $httpCriterionSelectionBodyParameter);

        $roleSelection = $form->getItemByPostVar($httpCriterionConfigBodyParameter);
        $this->assertInstanceOf(ilSelectInputGUI::class, $roleSelection);
        $this->assertEquals($roleSelection->getValue(), (string) $this->expectedInitialValue);

        return $criterion;
    }

    public function testValuesFromFormUserInterfaceElementsCanBeRetrieved(
        ilTermsOfServiceUserHasGlobalRoleCriterion $criterion
    ): void {
        $httpCriterionSelectionBodyParameter = 'criterion';
        $httpCriterionConfigBodyParameter = $criterion->getTypeIdent() . '_role_id';

        $gui = $criterion->ui($this->lng);

        $form = $this->buildForm($gui, $httpCriterionSelectionBodyParameter);

        $form
            ->expects($this->once())
            ->method('getInput')
            ->with($httpCriterionConfigBodyParameter)
            ->willReturnCallback(function () {
                return $this->expectedAfterFormSubmitValue;
            });

        $value = $gui->getConfigByForm($form);

        $this->assertInstanceOf(ilTermsOfServiceCriterionConfig::class, $value);
        $this->assertSame($this->expectedAfterFormSubmitValue, $value['role_id']);
        $this->assertEquals($this->getCriterionConfig(['role_id' => $this->expectedAfterFormSubmitValue]), $value);
    }

    public function testTypeIdentPresentationIsANonEmptyString(
        ilTermsOfServiceUserHasGlobalRoleCriterion $criterion
    ): void {
        $gui = $criterion->ui($this->lng);

        $actual = $gui->getIdentPresentation();

        $this->assertIsString($actual);
        $this->assertNotEmpty($actual);
    }

    public function objectCacheProvider(): array
    {
        return [
            'Administrator Role Id' => [$this->expectedInitialValue, $this->adminRoleTitle],
            'User Role Id' => [$this->expectedAfterFormSubmitValue, $this->userRoleTitle],
            'Invalid Role Id' => [-1, ''],
        ];
    }

    public function testValuePresentationMatchesExpectation(int $roleId, string $roleTitle): void
    {
        $rbacReview = $this->getRbacReviewMock();
        $objectDataCache = $this->getObjectDataCacheMock();

        $objectDataCache
            ->method('lookupTitle')
            ->with($roleId)
            ->willReturn($roleTitle);

        $criterion = new ilTermsOfServiceUserHasGlobalRoleCriterion($rbacReview, $objectDataCache);
        $gui = $criterion->ui($this->lng);

        $actual = $gui->getValuePresentation(
            $this->getCriterionConfig(['role_id' => $roleId]),
            $this->getUiFactoryMock()
        );

        $this->assertInstanceOf(Component::class, $actual);
        $this->assertInstanceOf(Legacy::class, $actual);
        $this->assertSame($roleTitle, $actual->getContent());
    }

    public function failingConfigProvider(): array
    {
        $criterion = $this->getInstance();

        return [
            'Array' => [$criterion, $this->getCriterionConfig(['role_id' => []])],
            'Object' => [$criterion, $this->getCriterionConfig(['role_id' => new stdClass()])],
            'Double' => [$criterion, $this->getCriterionConfig(['role_id' => 1.424])],
            'String' => [$criterion, $this->getCriterionConfig(['role_id' => 'phpunit'])],
            'Wrong Key Provided for Extracting Role' => [
                $criterion,
                $this->getCriterionConfig(['another_config_key' => true])
            ],
            'Empty Configuration' => [$criterion, $this->getCriterionConfig()],
        ];
    }

    public function testEvaluationFailsIfConfiguredRoleDoesNotMatchTheExpectedFormat(
        ilTermsOfServiceUserHasGlobalRoleCriterion $criterion,
        ilTermsOfServiceCriterionConfig $config
    ): void {
        $user = $this->getUserMock();

        $this->assertFalse($criterion->evaluate($user, $config));
    }

    public function testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole(): void
    {
        $user = $this->getUserMock();
        $criterion = $this->getInstance();

        $this->rbacReview
            ->expects($this->once())
            ->method('isGlobalRole')
            ->willReturn(false);

        $this->assertFalse(
            $criterion->evaluate($user, $this->getCriterionConfig(['role_id' => $this->expectedAfterFormSubmitValue]))
        );
    }

    public function testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole(): void
    {
        $user = $this->getUserMock();
        $criterion = $this->getInstance();

        $this->rbacReview
            ->expects($this->once())
            ->method('isGlobalRole')
            ->willReturn(true);

        $this->rbacReview
            ->expects($this->once())
            ->method('isAssigned')
            ->willReturn(false);

        $this->assertFalse(
            $criterion->evaluate($user, $this->getCriterionConfig(['role_id' => $this->expectedAfterFormSubmitValue]))
        );
    }

    public function testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole(): void
    {
        $user = $this->getUserMock();
        $criterion = $this->getInstance();

        $this->rbacReview
            ->expects($this->once())
            ->method('isGlobalRole')
            ->willReturn(true);

        $this->rbacReview
            ->expects($this->once())
            ->method('isAssigned')
            ->willReturn(true);

        $this->assertTrue(
            $criterion->evaluate($user, $this->getCriterionConfig(['role_id' => $this->expectedAfterFormSubmitValue]))
        );
    }
}