ilTermsOfServiceHelperTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilTermsOfServiceHelperTest extends ilTermsOfServiceBaseTest
{
    public function testDocumentCanBeAccepted(): void
    {
        $dataGatewayFactory = $this->getMockBuilder(ilTermsOfServiceDataGatewayFactory::class)->getMock();
        $dataGateway = $this->createMock(ilTermsOfServiceAcceptanceDataGateway::class);

        $dataGateway
            ->expects($this->once())
            ->method('trackAcceptance')
            ->with($this->isInstanceOf(ilTermsOfServiceAcceptanceEntity::class));

        $dataGatewayFactory
            ->method('getByName')
            ->willReturn($dataGateway);

        $helper = new ilTermsOfServiceHelper(
            $dataGatewayFactory,
            $this->createMock(ilTermsOfServiceDocumentEvaluation::class),
            $this->createMock(ilTermsOfServiceCriterionTypeFactoryInterface::class),
            $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock()
        );

        $user = $this
            ->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getLanguage', 'getId', 'getLogin', 'writeAccepted', 'hasToAcceptTermsOfServiceInSession'])
            ->getMock();

        $user
            ->method('getId')
            ->willReturn(-1);

        $user
            ->method('getLogin')
            ->willReturn('phpunit');

        $user
            ->expects($this->once())
            ->method('writeAccepted');

        $user
            ->expects($this->once())
            ->method('hasToAcceptTermsOfServiceInSession')
            ->with(false);

        $document = $this
            ->getMockBuilder(ilTermsOfServiceDocument::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['content', 'id', 'criteria', 'title'])
            ->getMock();

        $document
            ->expects($this->atLeast(1))
            ->method('content')
            ->willReturn('phpunit');

        $document
            ->expects($this->atLeast(1))
            ->method('title')
            ->willReturn('phpunit');

        $document
            ->expects($this->atLeast(1))
            ->method('id')
            ->willReturn(1);

        $document
            ->expects($this->atLeast(1))
            ->method('criteria')
            ->willReturn([]);

        $helper->trackAcceptance($user, $document);
    }

    public function testAcceptanceHistoryCanBeDeleted(): void
    {
        $dataGatewayFactory = $this->getMockBuilder(ilTermsOfServiceDataGatewayFactory::class)->getMock();
        $dataGateway = $this->createMock(ilTermsOfServiceAcceptanceDataGateway::class);

        $dataGateway
            ->expects($this->once())
            ->method('deleteAcceptanceHistoryByUser')
            ->with($this->isInstanceOf(ilTermsOfServiceAcceptanceEntity::class));

        $dataGatewayFactory
            ->method('getByName')
            ->willReturn($dataGateway);

        $helper = new ilTermsOfServiceHelper(
            $dataGatewayFactory,
            $this->createMock(ilTermsOfServiceDocumentEvaluation::class),
            $this->createMock(ilTermsOfServiceCriterionTypeFactoryInterface::class),
            $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock()
        );

        $user = $this
            ->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId', 'getLogin'])
            ->getMock();

        $user
            ->method('getId')
            ->willReturn(-1);

        $user
            ->method('getLogin')
            ->willReturn('phpunit');

        $helper->deleteAcceptanceHistoryByUser($user->getId());
    }

    public function testLatestAcceptanceHistoryEntityCanBeLoadedForUser(): void
    {
        $dataGatewayFactory = $this->getMockBuilder(ilTermsOfServiceDataGatewayFactory::class)->getMock();
        $dataGateway = $this->createMock(ilTermsOfServiceAcceptanceDataGateway::class);

        $entity = new ilTermsOfServiceAcceptanceEntity();
        $entity = $entity->withId(4711);

        $dataGateway
            ->expects($this->atLeast(1))
            ->method('loadCurrentAcceptanceOfUser')
            ->with($this->isInstanceOf(ilTermsOfServiceAcceptanceEntity::class))
            ->willReturn($entity);

        $dataGatewayFactory
            ->method('getByName')
            ->willReturn($dataGateway);

        $helper = new ilTermsOfServiceHelper(
            $dataGatewayFactory,
            $this->createMock(ilTermsOfServiceDocumentEvaluation::class),
            $this->createMock(ilTermsOfServiceCriterionTypeFactoryInterface::class),
            $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock()
        );

        $user = $this
            ->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId', 'getLogin'])
            ->getMock();

        $user
            ->method('getId')
            ->willReturn(-1);

        $user
            ->method('getLogin')
            ->willReturn('phpunit');

        $this->assertInstanceOf(ilTermsOfServiceAcceptanceEntity::class, $helper->getCurrentAcceptanceForUser($user));
        $this->assertSame($entity, $helper->getCurrentAcceptanceForUser($user));
    }

    public function testAcceptanceHistoryEntityCanBeLoadedById(): void
    {
        $dataGatewayFactory = $this->getMockBuilder(ilTermsOfServiceDataGatewayFactory::class)->getMock();
        $dataGateway = $this->createMock(ilTermsOfServiceAcceptanceDataGateway::class);

        $entity = new ilTermsOfServiceAcceptanceEntity();
        $entity = $entity->withId(4711);

        $dataGateway
            ->expects($this->atLeast(1))
            ->method('loadById')
            ->willReturn($entity);

        $dataGatewayFactory
            ->method('getByName')
            ->willReturn($dataGateway);

        $helper = new ilTermsOfServiceHelper(
            $dataGatewayFactory,
            $this->createMock(ilTermsOfServiceDocumentEvaluation::class),
            $this->createMock(ilTermsOfServiceCriterionTypeFactoryInterface::class),
            $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock()
        );

        $user = $this
            ->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId', 'getLogin'])
            ->getMock();

        $user
            ->method('getId')
            ->willReturn(-1);

        $user
            ->method('getLogin')
            ->willReturn('phpunit');

        $this->assertInstanceOf(ilTermsOfServiceAcceptanceEntity::class, $helper->getById($entity->getId()));
        $this->assertSame($entity, $helper->getById($entity->getId()));
    }

    public function testDocumentMustBeResigned(): void
    {
        $dataGatewayFactory = $this->getMockBuilder(ilTermsOfServiceDataGatewayFactory::class)->getMock();
        $dataGateway = $this->createMock(ilTermsOfServiceAcceptanceDataGateway::class);

        $entity1 = new ilTermsOfServiceAcceptanceEntity();
        $entity1 = $entity1
            ->withId(4711)
            ->withSerializedCriteria(
                (new ilTermsOfServiceAcceptanceHistoryCriteriaBag('[' . implode(',', [
                    '{"id":"usr_language","value":{"lng":"de"}}',
                    '{"id":"usr_global_role","value":{"role_id":4711}}'
                ]) . ']'))->toJson()
            );

        $entity2 = $entity1->withId(0);

        $dataGateway
            ->expects($this->exactly(3))
            ->method('loadCurrentAcceptanceOfUser')
            ->willReturnOnConsecutiveCalls($entity1, $entity2, $entity1);
        $dataGatewayFactory
            ->method('getByName')
            ->willReturn($dataGateway);

        $tos_object = $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock();
        $tos_object->method('getStatus')->willReturn(true);
        $tos_object->method('shouldReevaluateOnLogin')->willReturn(true);

        $user = $this
            ->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId', 'getLogin', 'isAnonymous', 'getAgreeDate'])
            ->getMock();
        $user
            ->method('getId')
            ->willReturn(4711);
        $user
            ->method('getLogin')
            ->willReturn('phpunit');
        $user
            ->method('isAnonymous')
            ->willReturn(false);
        $user
            ->method('getAgreeDate')
            ->willReturn((new ILIAS\Data\Factory())->clock()->system()->now()->format('Y-m-d H:i:s'));

        $logger = $logger = $this
            ->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $document_evaluation = $this->createMock(ilTermsOfServiceDocumentEvaluation::class);
        $document_evaluation->expects($this->exactly(4))
            ->method('hasDocument')
            ->willReturnOnConsecutiveCalls(true, false, true, true);
        $document_evaluation->method('withContextUser')->with($user)->willReturn($document_evaluation);
        $document_evaluation->expects($this->exactly(2))->method('evaluateDocument')
            ->with($this->isInstanceOf(ilTermsOfServiceHistorizedDocument::class))
            ->willReturnOnConsecutiveCalls(false, true);

        $helper = new ilTermsOfServiceHelper(
            $dataGatewayFactory,
            $document_evaluation,
            $this->createMock(ilTermsOfServiceCriterionTypeFactoryInterface::class),
            $tos_object
        );

        $this->assertTrue($helper->hasToResignAcceptance($user, $logger));
        $this->assertFalse($helper->hasToResignAcceptance($user, $logger));
        $this->assertFalse($helper->hasToResignAcceptance($user, $logger));
        $this->assertFalse($helper->hasToResignAcceptance($user, $logger));
    }
}