ilTermsOfServiceDocumentCriterionAssignmentConstraintTest.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */

use ILIAS\Data\Factory;
use PHPUnit\Framework\MockObject\MockObject;

class ilTermsOfServiceDocumentCriterionAssignmentConstraintTest extends ilTermsOfServiceCriterionBaseTest
{
    protected function getCriterionTypeFactoryMock() : ilTermsOfServiceCriterionTypeFactoryInterface
    {
        $criterionTypeFactory = $this
            ->getMockBuilder(ilTermsOfServiceCriterionTypeFactoryInterface::class)
            ->getMock();

        return $criterionTypeFactory;
    }

    protected function getCriterionTypeMock(string $typeIdent) : ilTermsOfServiceCriterionType
    {
        $criterionType = $this
            ->getMockBuilder(ilTermsOfServiceCriterionType::class)
            ->getMock();

        $criterionType
            ->expects($this->any())
            ->method('getTypeIdent')
            ->willReturn($typeIdent);

        return $criterionType;
    }

    protected function getTypeMockForConstraint() : ilTermsOfServiceCriterionTypeFactoryInterface
    {
        $criterionTypeFactory = $this->getCriterionTypeFactoryMock();

        $criterionType1 = $this->getCriterionTypeMock('dummy');

        $criterionType1
            ->expects($this->any())
            ->method('hasUniqueNature')
            ->willReturn(false);

        $criterionTypeFactory
            ->expects($this->any())
            ->method('getTypesByIdentMap')
            ->willReturn([
                $criterionType1->getTypeIdent() => $criterionType1,
            ]);

        $criterionTypeFactory
            ->expects($this->any())
            ->method('findByTypeIdent')
            ->willReturn($criterionType1);

        return $criterionTypeFactory;
    }

    public function criteriaAssignmentProvider() : array
    {
        $criterionAssignment1 = $this
            ->getMockBuilder(ilTermsOfServiceDocumentCriterionAssignment::class)
            ->disableOriginalConstructor()
            ->setMethods(['getId', 'getCriterionValue', 'getCriterionId'])
            ->getMock();

        $criterionAssignment1
            ->expects($this->any())
            ->method('getId')
            ->willReturn(1);

        $criterionAssignment1
            ->expects($this->any())
            ->method('getCriterionId')
            ->willReturn('usr_global_role');

        $criterionAssignment1
            ->expects($this->any())
            ->method('getCriterionValue')
            ->willReturn($this->getCriterionConfig(['role_id' => 4]));

        $criterionAssignment2 = $this
            ->getMockBuilder(ilTermsOfServiceDocumentCriterionAssignment::class)
            ->disableOriginalConstructor()
            ->setMethods(['getId', 'getCriterionValue', 'getCriterionId'])
            ->getMock();

        $criterionAssignment2
            ->expects($this->any())
            ->method('getId')
            ->willReturn(1);

        $criterionAssignment2
            ->expects($this->any())
            ->method('getCriterionId')
            ->willReturn('usr_language');

        $criterionAssignment2
            ->expects($this->any())
            ->method('getCriterionValue')
            ->willReturn($this->getCriterionConfig(['lng' => 'de']));

        $criterionAssignment3 = $this
            ->getMockBuilder(ilTermsOfServiceDocumentCriterionAssignment::class)
            ->setMethods(['getId', 'getCriterionValue', 'getCriterionId'])
            ->disableOriginalConstructor()
            ->getMock();

        $criterionAssignment3
            ->expects($this->any())
            ->method('getId')
            ->willReturn(0);

        $criterionAssignment3
            ->expects($this->any())
            ->method('getCriterionId')
            ->willReturn('usr_language');

        $criterionAssignment3
            ->expects($this->any())
            ->method('getCriterionValue')
            ->willReturn($this->getCriterionConfig(['lng' => 'de']));

        $criterionAssignment4 = $this
            ->getMockBuilder(ilTermsOfServiceDocumentCriterionAssignment::class)
            ->disableOriginalConstructor()
            ->setMethods(['getId', 'getCriterionValue', 'getCriterionId'])
            ->getMock();

        $criterionAssignment4
            ->expects($this->any())
            ->method('getId')
            ->willReturn(0);

        $criterionAssignment4
            ->expects($this->any())
            ->method('getCriterionId')
            ->willReturn('usr_global_role');

        $criterionAssignment4
            ->expects($this->any())
            ->method('getCriterionValue')
            ->willReturn($this->getCriterionConfig(['role_id' => 6]));

        return [
            [$criterionAssignment1, $criterionAssignment2, $criterionAssignment3, $criterionAssignment4]
        ];
    }

    public function testConstraintAcceptanceWorksAsExpected(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            new Factory(),
            $this->getLanguageMock()
        );

        $this->assertTrue($constraint->accepts($criterionAssignment1));
        $this->assertTrue($constraint->accepts($criterionAssignment2));
        $this->assertFalse($constraint->accepts($criterionAssignment3));
        $this->assertTrue($constraint->accepts($criterionAssignment4));
    }

    public function testConstraintCheckWorksAsExpected(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            new Factory(),
            $this->getLanguageMock()
        );

        $raised = false;

        try {
            $constraint->check($criterionAssignment4);
        } catch (UnexpectedValueException $e) {
            $raised = true;
        }

        $this->assertFalse($raised);

        try {
            $constraint->check($criterionAssignment3);
            $raised = false;
        } catch (UnexpectedValueException $e) {
            $this->assertEquals('The passed assignment must be unique for the document!', $e->getMessage());
            $raised = true;
        }

        $this->assertTrue($raised);
    }

    public function testConstraintProblemDetectionWorksAsExpected(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            new Factory(),
            $this->getLanguageMock()
        );

        $this->assertNull($constraint->problemWith($criterionAssignment1));
        $this->assertNull($constraint->problemWith($criterionAssignment2));
        $this->assertNull($constraint->problemWith($criterionAssignment4));
        $this->assertIsString($constraint->problemWith($criterionAssignment3));
    }

    public function testConstraintRestrictionWorksAsExpected(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $dataFavtgory = new Factory();

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            $dataFavtgory,
            $this->getLanguageMock()
        );

        $ok = $dataFavtgory->ok($criterionAssignment1);
        $ok2 = $dataFavtgory->ok($criterionAssignment3);
        $error = $dataFavtgory->error('An error occurred');

        $result = $constraint->applyTo($ok);
        $this->assertTrue($result->isOk());

        $result = $constraint->applyTo($ok2);
        $this->assertTrue($result->isError());

        $result = $constraint->applyTo($error);
        $this->assertSame($error, $result);
    }

    public function testConstraintProblemBuilderWorksAsExpected(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            new Factory(),
            $this->getLanguageMock()
        );

        $newConstraint = $constraint->withProblemBuilder(function () {
            return 'phpunit';
        });
        $this->assertEquals('phpunit', $newConstraint->problemWith($criterionAssignment3));
    }

    public function testConstraintExposesCorrectErrorMessagesAfterMultiAccept(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document1 = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document1
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $this->getTypeMockForConstraint(),
            $document1,
            new Factory(),
            $this->getLanguageMock()
        );

        $criterionAssignment5 = clone $criterionAssignment3;

        $constraint->accepts($criterionAssignment1);
        $constraint->accepts($criterionAssignment2);
        $constraint->accepts($criterionAssignment3);
        $constraint->accepts($criterionAssignment4);
        $constraint->accepts($criterionAssignment5);

        $this->assertEquals(
            'The passed assignment must be unique for the document!',
            $constraint->problemWith($criterionAssignment3)
        );
        $this->assertEquals(
            'The passed assignment must be unique for the document!',
            $constraint->problemWith($criterionAssignment5)
        );
    }

    public function testCriterionWithSameNatureIsNotAcceptedWhenAlreadyAssigned(
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment1,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment2,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment3,
        ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment4
    ) : void {
        $document = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->setMethods(['criteria'])
            ->getMock();

        $document
            ->expects($this->any())
            ->method('criteria')
            ->willReturn([$criterionAssignment1, $criterionAssignment2]);

        $criterionTypeFactory = $this->getCriterionTypeFactoryMock();

        $criterionType1 = $this->getCriterionTypeMock('usr_global_role');
        $criterionType2 = $this->getCriterionTypeMock('usr_language');

        $criterionType1
            ->expects($this->any())
            ->method('hasUniqueNature')
            ->willReturn(false);

        $criterionType2
            ->expects($this->any())
            ->method('hasUniqueNature')
            ->willReturn(true);

        $criterionTypeFactory
            ->expects($this->any())
            ->method('findByTypeIdent')
            ->willReturn($criterionType2);

        $constraint = new ilTermsOfServiceDocumentCriterionAssignmentConstraint(
            $criterionTypeFactory,
            $document,
            new Factory(),
            $this->getLanguageMock()
        );

        $criterionWithSameNature = $this
            ->getMockBuilder(ilTermsOfServiceDocumentCriterionAssignment::class)
            ->setMethods(['getId', 'getCriterionValue', 'getCriterionId'])
            ->disableOriginalConstructor()
            ->getMock();

        $criterionWithSameNature
            ->expects($this->any())
            ->method('getId')
            ->willReturn(0);

        $criterionWithSameNature
            ->expects($this->any())
            ->method('getCriterionId')
            ->willReturn('usr_language');

        $criterionWithSameNature
            ->expects($this->any())
            ->method('getCriterionValue')
            ->willReturn($this->getCriterionConfig(['lng' => 'ru']));

        $this->assertFalse($constraint->accepts($criterionWithSameNature));
    }
}