nextcloud/apps/dav/tests/unit/CalDAV/Reminder/ReminderServiceTest.php

590 lines
19 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2019, Thomas Citharel
*
* @author Georg Ehrke <oc.list@georgehrke.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Citharel <nextcloud@tcit.fr>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\DAV\Tests\unit\CalDAV\Reminder;
use OCA\DAV\CalDAV\CalDavBackend;
use OCA\DAV\CalDAV\Reminder\Backend;
use OCA\DAV\CalDAV\Reminder\INotificationProvider;
use OCA\DAV\CalDAV\Reminder\NotificationProviderManager;
use OCA\DAV\CalDAV\Reminder\ReminderService;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IGroupManager;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use Test\TestCase;
class ReminderServiceTest extends TestCase {
/** @var Backend|\PHPUnit\Framework\MockObject\MockObject */
private $backend;
/** @var NotificationProviderManager|\PHPUnit\Framework\MockObject\MockObject */
private $notificationProviderManager;
/** @var IUserManager|\PHPUnit\Framework\MockObject\MockObject */
private $userManager;
/** @var IGroupManager|\PHPUnit\Framework\MockObject\MockObject*/
private $groupManager;
/** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */
private $userSession;
/** @var CalDavBackend|\PHPUnit\Framework\MockObject\MockObject */
private $caldavBackend;
/** @var ITimeFactory|\PHPUnit\Framework\MockObject\MockObject */
private $timeFactory;
/** @var ReminderService */
private $reminderService;
public const CALENDAR_DATA = <<<EOD
BEGIN:VCALENDAR
PRODID:-//Nextcloud calendar v1.6.4
BEGIN:VEVENT
CREATED:20160602T133732
DTSTAMP:20160602T133732
LAST-MODIFIED:20160602T133732
UID:wej2z68l9h
SUMMARY:Test Event
LOCATION:Somewhere ...
DESCRIPTION:maybe ....
DTSTART;TZID=Europe/Berlin;VALUE=DATE:20160609
DTEND;TZID=Europe/Berlin;VALUE=DATE:20160610
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-PT15M
END:VALARM
BEGIN:VALARM
ACTION:DISPLAY
TRIGGER;VALUE=DATE-TIME:20160608T000000Z
END:VALARM
END:VEVENT
END:VCALENDAR
EOD;
public const CALENDAR_DATA_REPEAT = <<<EOD
BEGIN:VCALENDAR
PRODID:-//Nextcloud calendar v1.6.4
BEGIN:VEVENT
CREATED:20160602T133732
DTSTAMP:20160602T133732
LAST-MODIFIED:20160602T133732
UID:wej2z68l9h
SUMMARY:Test Event
LOCATION:Somewhere ...
DESCRIPTION:maybe ....
DTSTART;TZID=Europe/Berlin;VALUE=DATE:20160609
DTEND;TZID=Europe/Berlin;VALUE=DATE:20160610
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-PT15M
REPEAT:4
DURATION:PT2M
END:VALARM
END:VEVENT
END:VCALENDAR
EOD;
public const CALENDAR_DATA_RECURRING = <<<EOD
BEGIN:VCALENDAR
PRODID:-//Nextcloud calendar v1.6.4
BEGIN:VEVENT
CREATED:20160602T133732
DTSTAMP:20160602T133732
LAST-MODIFIED:20160602T133732
UID:wej2z68l9h
SUMMARY:Test Event
LOCATION:Somewhere ...
DESCRIPTION:maybe ....
DTSTART;TZID=Europe/Berlin;VALUE=DATE:20160609
DTEND;TZID=Europe/Berlin;VALUE=DATE:20160610
RRULE:FREQ=WEEKLY
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-PT15M
END:VALARM
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-P8D
END:VALARM
END:VEVENT
END:VCALENDAR
EOD;
public const CALENDAR_DATA_RECURRING_REPEAT = <<<EOD
BEGIN:VCALENDAR
PRODID:-//Nextcloud calendar v1.6.4
BEGIN:VEVENT
CREATED:20160602T133732
DTSTAMP:20160602T133732
LAST-MODIFIED:20160602T133732
UID:wej2z68l9h
SUMMARY:Test Event
LOCATION:Somewhere ...
DESCRIPTION:maybe ....
DTSTART;TZID=Europe/Berlin;VALUE=DATE:20160609
DTEND;TZID=Europe/Berlin;VALUE=DATE:20160610
RRULE:FREQ=WEEKLY
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-PT15M
REPEAT:4
DURATION:PT2M
END:VALARM
BEGIN:VALARM
ACTION:EMAIL
TRIGGER:-P8D
END:VALARM
END:VEVENT
END:VCALENDAR
EOD;
public const CALENDAR_DATA_NO_ALARM = <<<EOD
BEGIN:VCALENDAR
PRODID:-//Nextcloud calendar v1.6.4
BEGIN:VEVENT
CREATED:20160602T133732
DTSTAMP:20160602T133732
LAST-MODIFIED:20160602T133732
UID:wej2z68l9h
SUMMARY:Test Event
LOCATION:Somewhere ...
DESCRIPTION:maybe ....
DTSTART;TZID=Europe/Berlin;VALUE=DATE:20160609
DTEND;TZID=Europe/Berlin;VALUE=DATE:20160610
END:VEVENT
END:VCALENDAR
EOD;
protected function setUp(): void {
parent::setUp();
$this->backend = $this->createMock(Backend::class);
$this->notificationProviderManager = $this->createMock(NotificationProviderManager::class);
$this->userManager = $this->createMock(IUserManager::class);
$this->groupManager = $this->createMock(IGroupManager::class);
$this->caldavBackend = $this->createMock(CalDavBackend::class);
$this->timeFactory = $this->createMock(ITimeFactory::class);
$this->caldavBackend->method('getShares')->willReturn([]);
$this->reminderService = new ReminderService($this->backend,
$this->notificationProviderManager,
$this->userManager,
$this->groupManager,
$this->caldavBackend,
$this->timeFactory);
}
public function testOnCalendarObjectDelete():void {
$this->backend->expects($this->once())
->method('cleanRemindersForEvent')
->with(44);
$action = '\OCA\DAV\CalDAV\CalDavBackend::deleteCalendarObject';
$objectData = [
'id' => '44',
'component' => 'vevent',
];
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testOnCalendarObjectCreateSingleEntry():void {
$action = '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject';
$objectData = [
'calendardata' => self::CALENDAR_DATA,
'id' => '42',
'calendarid' => '1337',
'component' => 'vevent',
];
$this->backend->expects($this->exactly(2))
->method('insertReminder')
->withConsecutive(
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'de919af7429d3b5c11e8b9d289b411a6', 'EMAIL', true, 1465429500, false],
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', '35b3eae8e792aa2209f0b4e1a302f105', 'DISPLAY', false, 1465344000, false]
)
->willReturn(1);
$this->timeFactory->expects($this->once())
->method('getDateTime')
->with()
->willReturn(\DateTime::createFromFormat(\DateTime::ATOM, '2016-06-08T00:00:00+00:00'));
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testOnCalendarObjectCreateSingleEntryWithRepeat(): void {
$action = '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject';
$objectData = [
'calendardata' => self::CALENDAR_DATA_REPEAT,
'id' => '42',
'calendarid' => '1337',
'component' => 'vevent',
];
$this->backend->expects($this->exactly(5))
->method('insertReminder')
->withConsecutive(
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1465429500, false],
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1465429620, true],
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1465429740, true],
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1465429860, true],
[1337, 42, 'wej2z68l9h', false, 1465430400, false, '5c70531aab15c92b52518ae10a2f78a4', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1465429980, true]
)
->willReturn(1);
$this->timeFactory->expects($this->once())
->method('getDateTime')
->with()
->willReturn(\DateTime::createFromFormat(\DateTime::ATOM, '2016-06-08T00:00:00+00:00'));
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testOnCalendarObjectCreateRecurringEntry(): void {
$action = '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject';
$objectData = [
'calendardata' => self::CALENDAR_DATA_RECURRING,
'id' => '42',
'calendarid' => '1337',
'component' => 'vevent',
];
$this->backend->expects($this->exactly(2))
->method('insertReminder')
->withConsecutive(
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'de919af7429d3b5c11e8b9d289b411a6', 'EMAIL', true, 1467243900, false],
[1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', '8996992118817f9f311ac5cc56d1cc97', 'EMAIL', true, 1467158400, false]
)
->willReturn(1);
$this->timeFactory->expects($this->once())
->method('getDateTime')
->with()
->willReturn(\DateTime::createFromFormat(\DateTime::ATOM, '2016-06-29T00:00:00+00:00'));
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testOnCalendarObjectCreateEmpty():void {
$action = '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject';
$objectData = [
'calendardata' => self::CALENDAR_DATA_NO_ALARM,
'id' => '42',
'calendarid' => '1337',
'component' => 'vevent',
];
$this->backend->expects($this->never())
->method('insertReminder');
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testOnCalendarObjectCreateRecurringEntryWithRepeat():void {
$action = '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject';
$objectData = [
'calendardata' => self::CALENDAR_DATA_RECURRING_REPEAT,
'id' => '42',
'calendarid' => '1337',
'component' => 'vevent',
];
$this->backend->expects($this->exactly(6))
->method('insertReminder')
->withConsecutive(
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467243900, false],
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467244020, true],
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467244140, true],
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467244260, true],
[1337, 42, 'wej2z68l9h', true, 1467244800, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467244380, true],
[1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', '8996992118817f9f311ac5cc56d1cc97', 'EMAIL', true, 1467158400, false]
)
->willReturn(1);
$this->timeFactory->expects($this->once())
->method('getDateTime')
->with()
->willReturn(\DateTime::createFromFormat(\DateTime::ATOM, '2016-06-29T00:00:00+00:00'));
$this->reminderService->onTouchCalendarObject($action, $objectData);
}
public function testProcessReminders():void {
$this->backend->expects($this->at(0))
->method('getRemindersToProcess')
->with()
->willReturn([
[
'id' => 1,
'calendar_id' => 1337,
'object_id' => 42,
'uid' => 'wej2z68l9h',
'is_recurring' => false,
'recurrence_id' => 1465430400,
'is_recurrence_exception' => false,
'event_hash' => '5c70531aab15c92b52518ae10a2f78a4',
'alarm_hash' => 'de919af7429d3b5c11e8b9d289b411a6',
'type' => 'EMAIL',
'is_relative' => true,
'notification_date' => 1465429500,
'is_repeat_based' => false,
'calendardata' => self::CALENDAR_DATA,
'displayname' => 'Displayname 123',
'principaluri' => 'principals/users/user001',
],
[
'id' => 2,
'calendar_id' => 1337,
'object_id' => 42,
'uid' => 'wej2z68l9h',
'is_recurring' => false,
'recurrence_id' => 1465430400,
'is_recurrence_exception' => false,
'event_hash' => '5c70531aab15c92b52518ae10a2f78a4',
'alarm_hash' => 'ecacbf07d413c3c78d1ac7ad8c469602',
'type' => 'EMAIL',
'is_relative' => true,
'notification_date' => 1465429740,
'is_repeat_based' => true,
'calendardata' => self::CALENDAR_DATA_REPEAT,
'displayname' => 'Displayname 123',
'principaluri' => 'principals/users/user001',
],
[
'id' => 3,
'calendar_id' => 1337,
'object_id' => 42,
'uid' => 'wej2z68l9h',
'is_recurring' => false,
'recurrence_id' => 1465430400,
'is_recurrence_exception' => false,
'event_hash' => '5c70531aab15c92b52518ae10a2f78a4',
'alarm_hash' => '35b3eae8e792aa2209f0b4e1a302f105',
'type' => 'DISPLAY',
'is_relative' => false,
'notification_date' => 1465344000,
'is_repeat_based' => false,
'calendardata' => self::CALENDAR_DATA,
'displayname' => 'Displayname 123',
'principaluri' => 'principals/users/user001',
],
[
'id' => 4,
'calendar_id' => 1337,
'object_id' => 42,
'uid' => 'wej2z68l9h',
'is_recurring' => true,
'recurrence_id' => 1467244800,
'is_recurrence_exception' => false,
'event_hash' => 'fbdb2726bc0f7dfacac1d881c1453e20',
'alarm_hash' => 'ecacbf07d413c3c78d1ac7ad8c469602',
'type' => 'EMAIL',
'is_relative' => true,
'notification_date' => 1467243900,
'is_repeat_based' => false,
'calendardata' => self::CALENDAR_DATA_RECURRING_REPEAT,
'displayname' => 'Displayname 123',
'principaluri' => 'principals/users/user001',
],
[
'id' => 5,
'calendar_id' => 1337,
'object_id' => 42,
'uid' => 'wej2z68l9h',
'is_recurring' => true,
'recurrence_id' => 1467849600,
'is_recurrence_exception' => false,
'event_hash' => 'fbdb2726bc0f7dfacac1d881c1453e20',
'alarm_hash' => '8996992118817f9f311ac5cc56d1cc97',
'type' => 'EMAIL',
'is_relative' => true,
'notification_date' => 1467158400,
'is_repeat_based' => false,
'calendardata' => self::CALENDAR_DATA_RECURRING,
'displayname' => 'Displayname 123',
'principaluri' => 'principals/users/user001',
]
]);
$this->notificationProviderManager->expects($this->at(0))
->method('hasProvider')
->with('EMAIL')
->willReturn(true);
$provider1 = $this->createMock(INotificationProvider::class);
$this->notificationProviderManager->expects($this->at(1))
->method('getProvider')
->with('EMAIL')
->willReturn($provider1);
$this->notificationProviderManager->expects($this->at(2))
->method('hasProvider')
->with('EMAIL')
->willReturn(true);
$provider2 = $this->createMock(INotificationProvider::class);
$this->notificationProviderManager->expects($this->at(3))
->method('getProvider')
->with('EMAIL')
->willReturn($provider2);
$this->notificationProviderManager->expects($this->at(4))
->method('hasProvider')
->with('DISPLAY')
->willReturn(true);
$provider3 = $this->createMock(INotificationProvider::class);
$this->notificationProviderManager->expects($this->at(5))
->method('getProvider')
->with('DISPLAY')
->willReturn($provider3);
$this->notificationProviderManager->expects($this->at(6))
->method('hasProvider')
->with('EMAIL')
->willReturn(true);
$provider4 = $this->createMock(INotificationProvider::class);
$this->notificationProviderManager->expects($this->at(7))
->method('getProvider')
->with('EMAIL')
->willReturn($provider4);
$this->notificationProviderManager->expects($this->at(8))
->method('hasProvider')
->with('EMAIL')
->willReturn(true);
$provider5 = $this->createMock(INotificationProvider::class);
$this->notificationProviderManager->expects($this->at(9))
->method('getProvider')
->with('EMAIL')
->willReturn($provider5);
$user = $this->createMock(IUser::class);
$this->userManager->expects($this->exactly(5))
->method('get')
->with('user001')
->willReturn($user);
$provider1->expects($this->once())
->method('send')
->with($this->callback(function($vevent) {
if ($vevent->DTSTART->getDateTime()->format(\DateTime::ATOM) !== '2016-06-09T00:00:00+00:00') {
return false;
}
return true;
}, 'Displayname 123', $user));
$provider2->expects($this->once())
->method('send')
->with($this->callback(function($vevent) {
if ($vevent->DTSTART->getDateTime()->format(\DateTime::ATOM) !== '2016-06-09T00:00:00+00:00') {
return false;
}
return true;
}, 'Displayname 123', $user));
$provider3->expects($this->once())
->method('send')
->with($this->callback(function($vevent) {
if ($vevent->DTSTART->getDateTime()->format(\DateTime::ATOM) !== '2016-06-09T00:00:00+00:00') {
return false;
}
return true;
}, 'Displayname 123', $user));
$provider4->expects($this->once())
->method('send')
->with($this->callback(function($vevent) {
if ($vevent->DTSTART->getDateTime()->format(\DateTime::ATOM) !== '2016-06-30T00:00:00+00:00') {
return false;
}
return true;
}, 'Displayname 123', $user));
$provider5->expects($this->once())
->method('send')
->with($this->callback(function($vevent) {
if ($vevent->DTSTART->getDateTime()->format(\DateTime::ATOM) !== '2016-07-07T00:00:00+00:00') {
return false;
}
return true;
}, 'Displayname 123', $user));
$this->backend->expects($this->at(1))
->method('removeReminder')
->with(1);
$this->backend->expects($this->at(2))
->method('removeReminder')
->with(2);
$this->backend->expects($this->at(3))
->method('removeReminder')
->with(3);
$this->backend->expects($this->at(4))
->method('removeReminder')
->with(4);
$this->backend->expects($this->at(5))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467848700, false)
->willReturn(99);
$this->backend->expects($this->at(6))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467848820, true)
->willReturn(99);
$this->backend->expects($this->at(7))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467848940, true)
->willReturn(99);
$this->backend->expects($this->at(8))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467849060, true)
->willReturn(99);
$this->backend->expects($this->at(9))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1467849600, false, 'fbdb2726bc0f7dfacac1d881c1453e20', 'ecacbf07d413c3c78d1ac7ad8c469602', 'EMAIL', true, 1467849180, true)
->willReturn(99);
$this->backend->expects($this->at(10))
->method('removeReminder')
->with(5);
$this->backend->expects($this->at(11))
->method('insertReminder')
->with(1337, 42, 'wej2z68l9h', true, 1468454400, false, 'fbdb2726bc0f7dfacac1d881c1453e20', '8996992118817f9f311ac5cc56d1cc97', 'EMAIL', true, 1467763200, false)
->willReturn(99);
$this->timeFactory->method('getDateTime')
->willReturn(\DateTime::createFromFormat(\DateTime::ATOM, '2016-06-08T00:00:00+00:00'));
$this->reminderService->processReminders();
}
}