ilServicesAdministrativeNotificationTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use ILIAS\DI\Container;
 
class ilServicesAdministrativeNotificationTest extends TestCase
{
    private ?Container $dic_backup;
    protected MockObject $rbacreview_mock;
 
    protected function setUp(): void
    {
        global $DIC;
        $this->dic_backup = is_object($DIC) ? clone $DIC : $DIC;
 
        $DIC = new Container();
        $DIC['ilDB'] = $this->createMock(ilDBInterface::class);
        $this->rbacreview_mock = $DIC['rbacreview'] = $this->createMock(ilRbacReview::class);
    }
 
    protected function tearDown(): void
    {
        global $DIC;
        $DIC = $this->dic_backup;
    }
 
    public function testBasisc(): void
    {
        $notification = new ilADNNotification();
        $this->assertSame(0, $notification->getId());
 
        $notification->setTitle('Title');
        $notification->setActive(true);
        $notification->setType(ilADNNotification::TYPE_WARNING);
        $notification->setTypeDuringEvent(ilADNNotification::TYPE_ERROR);
 
        $this->assertTrue($notification->isActive());
        $this->assertFalse($notification->isDuringEvent());
    }
 
    public function testVisibilityByDate(): void
    {
        $notification = new ilADNNotification();
        $user_mock = $this->createMock(ilObjUser::class);
        $user_mock->expects($this->atLeast(1))
                  ->method('getId')
                  ->willReturn(42);
 
        $notification->setPermanent(true);
        $this->assertTrue($notification->isVisibleForUser($user_mock));
 
        $notification->setPermanent(false);
 
        $notification->setDisplayStart(new DateTimeImmutable("-2 hours"));
        $notification->setEventStart(new DateTimeImmutable("-1 hours"));
        $notification->setDisplayEnd(new DateTimeImmutable("+2 hours"));
        $notification->setEventEnd(new DateTimeImmutable("+1 hours"));
        $this->assertTrue($notification->isVisibleForUser($user_mock));
 
        $notification->setDisplayStart(new DateTimeImmutable("+1 hours"));
        $notification->setEventStart(new DateTimeImmutable("+2 hours"));
        $notification->setDisplayEnd(new DateTimeImmutable("+4 hours"));
        $notification->setEventEnd(new DateTimeImmutable("+3 hours"));
        $this->assertFalse($notification->isVisibleForUser($user_mock));
    }
 
    public function testVisibilityByRole(): void
    {
        $notification = new ilADNNotification();
        $user_mock = $this->createMock(ilObjUser::class);
        $user_mock->expects($this->atLeast(1))
                  ->method('getId')
                  ->willReturn(42);
 
        $notification->setPermanent(true);
        $notification->setLimitToRoles(true);
        $notification->setLimitedToRoleIds([2, 22, 222]);
 
        $this->rbacreview_mock->expects($this->once())
                              ->method('isAssignedToAtLeastOneGivenRole')
                              ->with(42, [2, 22, 222])
                              ->willReturn(true);
 
        $this->assertTrue($notification->isVisibleForUser($user_mock));
    }
 
    public function testVisibilityByRoleNotGranted(): void
    {
        $notification = new ilADNNotification();
        $user_mock = $this->createMock(ilObjUser::class);
        $user_mock->expects($this->atLeast(1))
                  ->method('getId')
                  ->willReturn(42);
 
        $notification->setPermanent(true);
        $notification->setLimitToRoles(true);
        $notification->setLimitedToRoleIds([2, 22, 222]);
 
        $this->rbacreview_mock->expects($this->once())
                              ->method('isAssignedToAtLeastOneGivenRole')
                              ->with(42, [2, 22, 222])
                              ->willReturn(false);
 
        $this->assertFalse($notification->isVisibleForUser($user_mock));
    }
 
    public function testDateConfigurationWithOptionalEvent(): void
    {
        $now = new DateTimeImmutable();
        $dates = static fn(?string $display_start, ?string $display_end, ?string $event_start, ?string $event_end): array => [
            ilADNNotificationUIFormGUI::F_DISPLAY_DATE_START => $display_start === null ? null : $now->modify($display_start),
            ilADNNotificationUIFormGUI::F_DISPLAY_DATE_END => $display_end === null ? null : $now->modify($display_end),
            ilADNNotificationUIFormGUI::F_EVENT_DATE_START => $event_start === null ? null : $now->modify($event_start),
            ilADNNotificationUIFormGUI::F_EVENT_DATE_END => $event_end === null ? null : $now->modify($event_end),
        ];
 
        $this->assertTrue(ilADNNotificationUIFormGUI::isValidDateConfiguration(null));
        // no event at all
        $this->assertTrue(ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', null, null)));
        // event within the display time
        $this->assertTrue(
            ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+3 hours', '+1 hour', '+2 hours'))
        );
        // display time is required to have a duration
        $this->assertFalse(ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+0 days', null, null)));
        // only one event date
        $this->assertFalse(ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', '+1 hour', null)));
        $this->assertFalse(ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', null, '+1 hour')));
        // event without duration or outside of the display time
        $this->assertFalse(
            ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', '+1 hour', '+1 hour'))
        );
        $this->assertFalse(
            ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', '-1 hour', '+1 hour'))
        );
        $this->assertFalse(
            ilADNNotificationUIFormGUI::isValidDateConfiguration($dates('+0 days', '+1 day', '+1 hour', '+2 days'))
        );
    }
 
    public function testEventWithoutDurationIsNeverActive(): void
    {
        $notification = new ilADNNotification();
        $notification->setPermanent(false);
        $notification->setType(ilADNNotification::TYPE_WARNING);
        $notification->setTypeDuringEvent(ilADNNotification::TYPE_ERROR);
        $display_start = new DateTimeImmutable('-1 hours');
        $notification->setDisplayStart($display_start);
        $notification->setDisplayEnd(new DateTimeImmutable('+1 hours'));
        $notification->setEventStart($display_start);
        $notification->setEventEnd($display_start);
 
        $this->assertFalse($notification->isDuringEvent());
        $this->assertSame(ilADNNotification::TYPE_WARNING, $notification->getActiveType());
    }
}