Class ilTermsOfServiceUserHasGlobalRoleCriterionTest. More...

Inheritance diagram for ilTermsOfServiceUserHasGlobalRoleCriterionTest:

Collaboration diagram for ilTermsOfServiceUserHasGlobalRoleCriterionTest:

Public Member Functions
	testInstanceCanBeCreated ()

	testFormUserInterfaceElementsAreProperlyBuilt (ilTermsOfServiceUserHasGlobalRoleCriterion $criterion)

	testValuesFromFormUserInterfaceElementsCanBeRetrieved (ilTermsOfServiceUserHasGlobalRoleCriterion $criterion)
	testFormUserInterfaceElementsAreProperlyBuilt More...

	testTypeIdentPresentationIsANonEmptyString (ilTermsOfServiceUserHasGlobalRoleCriterion $criterion)
	testFormUserInterfaceElementsAreProperlyBuilt More...

	objectCacheProvider ()

	failingConfigProvider ()

	testEvaluationFailsIfConfiguredRoleDoesNotMatchTheExpectedFormat (ilTermsOfServiceUserHasGlobalRoleCriterion $criterion, ilTermsOfServiceCriterionConfig $config)

	testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole ()

	testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole ()

	testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole ()

Protected Member Functions
	setUp ()

	getInstance ()

	buildForm (ilTermsOfServiceCriterionTypeGUI $gui, string $httpCriterionSelectionBodyParameter)

Protected Member Functions inherited from ilTermsOfServiceCriterionBaseTest
	getRbacReviewMock ()

	getObjectDataCacheMock ()

	getRadioGroupMock ()

	getFormMock ()

	getUserMock ()

Protected Member Functions inherited from ilTermsOfServiceBaseTest
	setUp ()

	getLanguageMock ()

	getUiFactoryMock ()

	setGlobalVariable (string $name, $value)

	getCriterionConfig ($value=null)

Protected Attributes
ilRbacReview	$rbacReview

ilLanguage	$lng

int	$expectedInitialValue = 2

int	$expectedAfterFormSubmitValue = 4

string	$userRoleTitle = 'User'

string	$adminRoleTitle = 'Administrator'

Protected Attributes inherited from ilTermsOfServiceBaseTest
Container	$dic

Detailed Description

Class ilTermsOfServiceUserHasGlobalRoleCriterionTest.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 29 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

Member Function Documentation

◆ buildForm()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::buildForm	(	ilTermsOfServiceCriterionTypeGUI	$gui,
		string	$httpCriterionSelectionBodyParameter
	)

protected

Parameters

ilTermsOfServiceCriterionTypeGUI	$gui
string	$httpCriterionSelectionBodyParameter

Returns: MockObject&ilPropertyFormGUI

Definition at line 84 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ilTermsOfServiceCriterionTypeGUI\appendOption(), ilTermsOfServiceCriterionBaseTest\getFormMock(), and ilTermsOfServiceCriterionBaseTest\getRadioGroupMock().

Referenced by testFormUserInterfaceElementsAreProperlyBuilt(), and testValuesFromFormUserInterfaceElementsCanBeRetrieved().

      : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ failingConfigProvider()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::failingConfigProvider ( )

Definition at line 212 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ilTermsOfServiceBaseTest\getCriterionConfig(), and getInstance().

                                            : 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()],
         ];
     }

Here is the call graph for this function:

◆ getInstance()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::getInstance ( )

protected

Returns: ilTermsOfServiceUserHasGlobalRoleCriterion

Definition at line 54 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ilTermsOfServiceCriterionBaseTest\getObjectDataCacheMock(), and ilTermsOfServiceCriterionBaseTest\getRbacReviewMock().

Referenced by failingConfigProvider(), testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole(), testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole(), testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole(), and testInstanceCanBeCreated().

                                     : ilTermsOfServiceUserHasGlobalRoleCriterion
     {
         $this->rbacReview = $this->getRbacReviewMock();
 
         $criterion = new ilTermsOfServiceUserHasGlobalRoleCriterion(
             $this->rbacReview,
             $this->getObjectDataCacheMock()
         );
 
         return $criterion;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ objectCacheProvider()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::objectCacheProvider ( )

Definition at line 174 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References $adminRoleTitle, $expectedAfterFormSubmitValue, $expectedInitialValue, $userRoleTitle, ilTermsOfServiceBaseTest\getCriterionConfig(), ilTermsOfServiceCriterionBaseTest\getObjectDataCacheMock(), ilTermsOfServiceCriterionBaseTest\getRbacReviewMock(), ilTermsOfServiceBaseTest\getUiFactoryMock(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ setUp()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::setUp ( )

protected

Definition at line 40 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ilTermsOfServiceBaseTest\getLanguageMock(), and ILIAS\Repository\lng().

                               : void
     {
         parent::setUp();
 
         $this->lng = $this->getLanguageMock();
 
         $this->lng
             ->method('txt')
             ->willReturn('dummy');
     }

Here is the call graph for this function:

◆ testEvaluationFailsIfConfiguredRoleDoesNotMatchTheExpectedFormat()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testEvaluationFailsIfConfiguredRoleDoesNotMatchTheExpectedFormat	(	ilTermsOfServiceUserHasGlobalRoleCriterion	$criterion,
		ilTermsOfServiceCriterionConfig	$config
	)

Parameters

ilTermsOfServiceUserHasGlobalRoleCriterion	$criterion
ilTermsOfServiceCriterionConfig	$config	failingConfigProvider

Definition at line 234 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ilTermsOfServiceUserHasGlobalRoleCriterion\evaluate(), and ilTermsOfServiceCriterionBaseTest\getUserMock().

      : void {
         $user = $this->getUserMock();
 
         $this->assertFalse($criterion->evaluate($user, $config));
     }

Here is the call graph for this function:

◆ testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testEvaluationFailsIfConfiguredRoleIsNotAGlobalRole ( )

Definition at line 243 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References getInstance(), and ilTermsOfServiceCriterionBaseTest\getUserMock().

                                                                          : 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]))
         );
     }

Here is the call graph for this function:

◆ testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testEvaluationFailsIfUserIsNotAssignedToConfiguredGlobalRole ( )

Definition at line 258 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References getInstance(), and ilTermsOfServiceCriterionBaseTest\getUserMock().

                                                                                   : 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]))
         );
     }

Here is the call graph for this function:

◆ testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testEvaluationSucceedsIfUserIsAssignedToDefinedGlobalRole ( )

Definition at line 278 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References getInstance(), and ilTermsOfServiceCriterionBaseTest\getUserMock().

                                                                                : 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]))
         );
     }

Here is the call graph for this function:

◆ testFormUserInterfaceElementsAreProperlyBuilt()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testFormUserInterfaceElementsAreProperlyBuilt ( ilTermsOfServiceUserHasGlobalRoleCriterion $criterion )

Parameters

ilTermsOfServiceUserHasGlobalRoleCriterion $criterion testInstanceCanBeCreated

Returns: ilTermsOfServiceUserHasGlobalRoleCriterion

Definition at line 111 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References buildForm(), ilTermsOfServiceUserHasGlobalRoleCriterion\getTypeIdent(), ILIAS\Repository\lng(), and ilTermsOfServiceUserHasGlobalRoleCriterion\ui().

      : 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;
     }

Here is the call graph for this function:

◆ testInstanceCanBeCreated()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testInstanceCanBeCreated ( )

Returns: ilTermsOfServiceUserHasGlobalRoleCriterion

Definition at line 69 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References getInstance().

                                               : ilTermsOfServiceUserHasGlobalRoleCriterion
     {
         $criterion = $this->getInstance();
 
         $this->assertSame('usr_global_role', $criterion->getTypeIdent());
         $this->assertFalse($criterion->hasUniqueNature());
 
         return $criterion;
     }

Here is the call graph for this function:

◆ testTypeIdentPresentationIsANonEmptyString()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testTypeIdentPresentationIsANonEmptyString ( ilTermsOfServiceUserHasGlobalRoleCriterion $criterion )

testFormUserInterfaceElementsAreProperlyBuilt

Parameters

ilTermsOfServiceUserHasGlobalRoleCriterion $criterion

Definition at line 163 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References ILIAS\Repository\lng(), and ilTermsOfServiceUserHasGlobalRoleCriterion\ui().

      : void {
         $gui = $criterion->ui($this->lng);
 
         $actual = $gui->getIdentPresentation();
 
         $this->assertIsString($actual);
         $this->assertNotEmpty($actual);
     }

Here is the call graph for this function:

◆ testValuesFromFormUserInterfaceElementsCanBeRetrieved()

ilTermsOfServiceUserHasGlobalRoleCriterionTest::testValuesFromFormUserInterfaceElementsCanBeRetrieved ( ilTermsOfServiceUserHasGlobalRoleCriterion $criterion )

testFormUserInterfaceElementsAreProperlyBuilt

Parameters

ilTermsOfServiceUserHasGlobalRoleCriterion $criterion

Definition at line 134 of file ilTermsOfServiceUserHasGlobalRoleCriterionTest.php.

References $expectedAfterFormSubmitValue, buildForm(), ilTermsOfServiceBaseTest\getCriterionConfig(), ilTermsOfServiceUserHasGlobalRoleCriterion\getTypeIdent(), ILIAS\Repository\lng(), and ilTermsOfServiceUserHasGlobalRoleCriterion\ui().

      : 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);
     }