diff options
Diffstat (limited to 'apps/dav/tests/unit/CalDAV/WebcalCaching')
3 files changed, 510 insertions, 351 deletions
diff --git a/apps/dav/tests/unit/CalDAV/WebcalCaching/ConnectionTest.php b/apps/dav/tests/unit/CalDAV/WebcalCaching/ConnectionTest.php new file mode 100644 index 00000000000..c29415ecef3 --- /dev/null +++ b/apps/dav/tests/unit/CalDAV/WebcalCaching/ConnectionTest.php @@ -0,0 +1,176 @@ +<?php + +declare(strict_types=1); +/** + * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\DAV\Tests\unit\CalDAV\WebcalCaching; + +use OCA\DAV\CalDAV\WebcalCaching\Connection; +use OCP\Http\Client\IClient; +use OCP\Http\Client\IClientService; +use OCP\Http\Client\IResponse; +use OCP\Http\Client\LocalServerException; +use OCP\IAppConfig; +use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; + +use Test\TestCase; + +class ConnectionTest extends TestCase { + + private IClientService&MockObject $clientService; + private IAppConfig&MockObject $config; + private LoggerInterface&MockObject $logger; + private Connection $connection; + + public function setUp(): void { + $this->clientService = $this->createMock(IClientService::class); + $this->config = $this->createMock(IAppConfig::class); + $this->logger = $this->createMock(LoggerInterface::class); + $this->connection = new Connection($this->clientService, $this->config, $this->logger); + } + + #[\PHPUnit\Framework\Attributes\DataProvider('runLocalURLDataProvider')] + public function testLocalUrl($source): void { + $subscription = [ + 'id' => 42, + 'uri' => 'sub123', + 'refreshreate' => 'P1H', + 'striptodos' => 1, + 'stripalarms' => 1, + 'stripattachments' => 1, + 'source' => $source, + 'lastmodified' => 0, + ]; + + $client = $this->createMock(IClient::class); + $this->clientService->expects(self::once()) + ->method('newClient') + ->with() + ->willReturn($client); + + $this->config->expects(self::once()) + ->method('getValueString') + ->with('dav', 'webcalAllowLocalAccess', 'no') + ->willReturn('no'); + + $localServerException = new LocalServerException(); + $client->expects(self::once()) + ->method('get') + ->willThrowException($localServerException); + $this->logger->expects(self::once()) + ->method('warning') + ->with('Subscription 42 was not refreshed because it violates local access rules', ['exception' => $localServerException]); + + $this->connection->queryWebcalFeed($subscription); + } + + public function testInvalidUrl(): void { + $subscription = [ + 'id' => 42, + 'uri' => 'sub123', + 'refreshreate' => 'P1H', + 'striptodos' => 1, + 'stripalarms' => 1, + 'stripattachments' => 1, + 'source' => '!@#$', + 'lastmodified' => 0, + ]; + + $client = $this->createMock(IClient::class); + $this->config->expects(self::never()) + ->method('getValueString'); + $client->expects(self::never()) + ->method('get'); + + $this->connection->queryWebcalFeed($subscription); + + } + + /** + * @param string $result + * @param string $contentType + */ + #[\PHPUnit\Framework\Attributes\DataProvider('urlDataProvider')] + public function testConnection(string $url, string $result, string $contentType): void { + $client = $this->createMock(IClient::class); + $response = $this->createMock(IResponse::class); + $subscription = [ + 'id' => 42, + 'uri' => 'sub123', + 'refreshreate' => 'P1H', + 'striptodos' => 1, + 'stripalarms' => 1, + 'stripattachments' => 1, + 'source' => $url, + 'lastmodified' => 0, + ]; + + $this->clientService->expects($this->once()) + ->method('newClient') + ->with() + ->willReturn($client); + + $this->config->expects($this->once()) + ->method('getValueString') + ->with('dav', 'webcalAllowLocalAccess', 'no') + ->willReturn('no'); + + $client->expects($this->once()) + ->method('get') + ->with('https://foo.bar/bla2') + ->willReturn($response); + + $response->expects($this->once()) + ->method('getBody') + ->with() + ->willReturn($result); + $response->expects($this->once()) + ->method('getHeader') + ->with('Content-Type') + ->willReturn($contentType); + + $this->connection->queryWebcalFeed($subscription); + } + + public static function runLocalURLDataProvider(): array { + return [ + ['localhost/foo.bar'], + ['localHost/foo.bar'], + ['random-host/foo.bar'], + ['[::1]/bla.blub'], + ['[::]/bla.blub'], + ['192.168.0.1'], + ['172.16.42.1'], + ['[fdf8:f53b:82e4::53]/secret.ics'], + ['[fe80::200:5aee:feaa:20a2]/secret.ics'], + ['[0:0:0:0:0:0:10.0.0.1]/secret.ics'], + ['[0:0:0:0:0:ffff:127.0.0.0]/secret.ics'], + ['10.0.0.1'], + ['another-host.local'], + ['service.localhost'], + ]; + } + + public static function urlDataProvider(): array { + return [ + [ + 'https://foo.bar/bla2', + "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nCALSCALE:GREGORIAN\r\nBEGIN:VEVENT\r\nUID:12345\r\nDTSTAMP:20160218T133704Z\r\nDTSTART;VALUE=DATE:19000101\r\nDTEND;VALUE=DATE:19000102\r\nRRULE:FREQ=YEARLY\r\nSUMMARY:12345's Birthday (1900)\r\nTRANSP:TRANSPARENT\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", + 'text/calendar;charset=utf8', + ], + [ + 'https://foo.bar/bla2', + '["vcalendar",[["prodid",{},"text","-//Example Corp.//Example Client//EN"],["version",{},"text","2.0"]],[["vtimezone",[["last-modified",{},"date-time","2004-01-10T03:28:45Z"],["tzid",{},"text","US/Eastern"]],[["daylight",[["dtstart",{},"date-time","2000-04-04T02:00:00"],["rrule",{},"recur",{"freq":"YEARLY","byday":"1SU","bymonth":4}],["tzname",{},"text","EDT"],["tzoffsetfrom",{},"utc-offset","-05:00"],["tzoffsetto",{},"utc-offset","-04:00"]],[]],["standard",[["dtstart",{},"date-time","2000-10-26T02:00:00"],["rrule",{},"recur",{"freq":"YEARLY","byday":"1SU","bymonth":10}],["tzname",{},"text","EST"],["tzoffsetfrom",{},"utc-offset","-04:00"],["tzoffsetto",{},"utc-offset","-05:00"]],[]]]],["vevent",[["dtstamp",{},"date-time","2006-02-06T00:11:21Z"],["dtstart",{"tzid":"US/Eastern"},"date-time","2006-01-02T14:00:00"],["duration",{},"duration","PT1H"],["recurrence-id",{"tzid":"US/Eastern"},"date-time","2006-01-04T12:00:00"],["summary",{},"text","Event #2"],["uid",{},"text","12345"]],[]]]]', + 'application/calendar+json', + ], + [ + 'https://foo.bar/bla2', + '<?xml version="1.0" encoding="utf-8" ?><icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0"><vcalendar><properties><prodid><text>-//Example Inc.//Example Client//EN</text></prodid><version><text>2.0</text></version></properties><components><vevent><properties><dtstamp><date-time>2006-02-06T00:11:21Z</date-time></dtstamp><dtstart><parameters><tzid><text>US/Eastern</text></tzid></parameters><date-time>2006-01-04T14:00:00</date-time></dtstart><duration><duration>PT1H</duration></duration><recurrence-id><parameters><tzid><text>US/Eastern</text></tzid></parameters><date-time>2006-01-04T12:00:00</date-time></recurrence-id><summary><text>Event #2 bis</text></summary><uid><text>12345</text></uid></properties></vevent></components></vcalendar></icalendar>', + 'application/calendar+xml', + ], + ]; + } +} diff --git a/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php b/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php index 2d57ad3b7d5..804af021d5a 100644 --- a/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php +++ b/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php @@ -1,41 +1,28 @@ <?php + +declare(strict_types=1); /** - * @copyright Copyright (c) 2018 Georg Ehrke - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Georg Ehrke <oc.list@georgehrke.com> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCA\DAV\Tests\unit\CalDAV\WebcalCaching; use OCA\DAV\CalDAV\WebcalCaching\Plugin; use OCP\IRequest; +use Sabre\DAV\Server; +use Sabre\DAV\Tree; +use Sabre\HTTP\Request; +use Sabre\HTTP\Response; class PluginTest extends \Test\TestCase { - public function testDisabled() { + public function testDisabled(): void { $request = $this->createMock(IRequest::class); - $request->expects($this->at(0)) + $request->expects($this->once()) ->method('isUserAgent') - ->with([]) + ->with(Plugin::ENABLE_FOR_CLIENTS) ->willReturn(false); - $request->expects($this->at(1)) + $request->expects($this->once()) ->method('getHeader') ->with('X-NC-CalDAV-Webcal-Caching') ->willReturn(''); @@ -45,20 +32,121 @@ class PluginTest extends \Test\TestCase { $this->assertEquals(false, $plugin->isCachingEnabledForThisRequest()); } - public function testEnabled() { + public function testEnabledUserAgent(): void { $request = $this->createMock(IRequest::class); - $request->expects($this->at(0)) + $request->expects($this->once()) ->method('isUserAgent') - ->with([]) - ->willReturn(false); + ->with(Plugin::ENABLE_FOR_CLIENTS) + ->willReturn(true); + $request->expects($this->once()) + ->method('getHeader') + ->with('X-NC-CalDAV-Webcal-Caching') + ->willReturn(''); + $request->expects($this->once()) + ->method('getMethod') + ->willReturn('REPORT'); + $request->expects($this->never()) + ->method('getParams'); + + $plugin = new Plugin($request); + + $this->assertEquals(true, $plugin->isCachingEnabledForThisRequest()); + } - $request->expects($this->at(1)) + public function testEnabledWebcalCachingHeader(): void { + $request = $this->createMock(IRequest::class); + $request->expects($this->once()) + ->method('isUserAgent') + ->with(Plugin::ENABLE_FOR_CLIENTS) + ->willReturn(false); + $request->expects($this->once()) ->method('getHeader') ->with('X-NC-CalDAV-Webcal-Caching') ->willReturn('On'); + $request->expects($this->once()) + ->method('getMethod') + ->willReturn('REPORT'); + $request->expects($this->never()) + ->method('getParams'); $plugin = new Plugin($request); $this->assertEquals(true, $plugin->isCachingEnabledForThisRequest()); } + + public function testEnabledExportRequest(): void { + $request = $this->createMock(IRequest::class); + $request->expects($this->once()) + ->method('isUserAgent') + ->with(Plugin::ENABLE_FOR_CLIENTS) + ->willReturn(false); + $request->expects($this->once()) + ->method('getHeader') + ->with('X-NC-CalDAV-Webcal-Caching') + ->willReturn(''); + $request->expects($this->once()) + ->method('getMethod') + ->willReturn('GET'); + $request->expects($this->once()) + ->method('getParams') + ->willReturn(['export' => '']); + + $plugin = new Plugin($request); + + $this->assertEquals(true, $plugin->isCachingEnabledForThisRequest()); + } + + public function testSkipNonCalendarRequest(): void { + $request = $this->createMock(IRequest::class); + $request->expects($this->once()) + ->method('isUserAgent') + ->with(Plugin::ENABLE_FOR_CLIENTS) + ->willReturn(false); + + $request->expects($this->once()) + ->method('getHeader') + ->with('X-NC-CalDAV-Webcal-Caching') + ->willReturn('On'); + + $sabreRequest = new Request('REPORT', '/remote.php/dav/principals/users/admin/'); + $sabreRequest->setBaseUrl('/remote.php/dav/'); + + $tree = $this->createMock(Tree::class); + $tree->expects($this->never()) + ->method('getNodeForPath'); + + $server = new Server($tree); + + $plugin = new Plugin($request); + $plugin->initialize($server); + + $plugin->beforeMethod($sabreRequest, new Response()); + } + + public function testProcessCalendarRequest(): void { + $request = $this->createMock(IRequest::class); + $request->expects($this->once()) + ->method('isUserAgent') + ->with(Plugin::ENABLE_FOR_CLIENTS) + ->willReturn(false); + + $request->expects($this->once()) + ->method('getHeader') + ->with('X-NC-CalDAV-Webcal-Caching') + ->willReturn('On'); + + $sabreRequest = new Request('REPORT', '/remote.php/dav/calendars/admin/personal/'); + $sabreRequest->setBaseUrl('/remote.php/dav/'); + + $tree = $this->createMock(Tree::class); + $tree->expects($this->once()) + ->method('getNodeForPath'); + + $server = new Server($tree); + + $plugin = new Plugin($request); + $plugin->initialize($server); + + $plugin->beforeMethod($sabreRequest, new Response()); + } } diff --git a/apps/dav/tests/unit/CalDAV/WebcalCaching/RefreshWebcalServiceTest.php b/apps/dav/tests/unit/CalDAV/WebcalCaching/RefreshWebcalServiceTest.php index 29a6170b1e7..d4f4b9e878f 100644 --- a/apps/dav/tests/unit/CalDAV/WebcalCaching/RefreshWebcalServiceTest.php +++ b/apps/dav/tests/unit/CalDAV/WebcalCaching/RefreshWebcalServiceTest.php @@ -1,42 +1,18 @@ <?php + +declare(strict_types=1); /** - * @copyright Copyright (c) 2020, Thomas Citharel <nextcloud@tcit.fr> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author eleith <online+github@eleith.com> - * @author Georg Ehrke <oc.list@georgehrke.com> - * @author Joas Schilling <coding@schilljs.com> - * @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/>. - * + * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ +namespace OCA\DAV\Tests\unit\CalDAV\WebcalCaching; -namespace OCA\DAV\Tests\unit\BackgroundJob; - -use GuzzleHttp\HandlerStack; use OCA\DAV\CalDAV\CalDavBackend; +use OCA\DAV\CalDAV\WebcalCaching\Connection; use OCA\DAV\CalDAV\WebcalCaching\RefreshWebcalService; -use OCP\Http\Client\IClient; -use OCP\Http\Client\IClientService; -use OCP\Http\Client\IResponse; -use OCP\Http\Client\LocalServerException; -use OCP\IConfig; -use OCP\ILogger; +use OCP\AppFramework\Utility\ITimeFactory; use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; use Sabre\DAV\Exception\BadRequest; use Sabre\VObject; use Sabre\VObject\Recur\NoInstancesException; @@ -44,121 +20,187 @@ use Sabre\VObject\Recur\NoInstancesException; use Test\TestCase; class RefreshWebcalServiceTest extends TestCase { - - /** @var CalDavBackend | MockObject */ - private $caldavBackend; - - /** @var IClientService | MockObject */ - private $clientService; - - /** @var IConfig | MockObject */ - private $config; - - /** @var ILogger | MockObject */ - private $logger; + private CalDavBackend&MockObject $caldavBackend; + private Connection&MockObject $connection; + private LoggerInterface&MockObject $logger; + private ITimeFactory&MockObject $time; protected function setUp(): void { parent::setUp(); $this->caldavBackend = $this->createMock(CalDavBackend::class); - $this->clientService = $this->createMock(IClientService::class); - $this->config = $this->createMock(IConfig::class); - $this->logger = $this->createMock(ILogger::class); + $this->connection = $this->createMock(Connection::class); + $this->logger = $this->createMock(LoggerInterface::class); + $this->time = $this->createMock(ITimeFactory::class); } - /** - * @param string $body - * @param string $contentType - * @param string $result - * - * @dataProvider runDataProvider - */ - public function testRun(string $body, string $contentType, string $result) { + #[\PHPUnit\Framework\Attributes\DataProvider('runDataProvider')] + public function testRun(string $body, string $contentType, string $result): void { $refreshWebcalService = $this->getMockBuilder(RefreshWebcalService::class) - ->setMethods(['getRandomCalendarObjectUri']) - ->setConstructorArgs([$this->caldavBackend, $this->clientService, $this->config, $this->logger]) + ->onlyMethods(['getRandomCalendarObjectUri']) + ->setConstructorArgs([$this->caldavBackend, $this->logger, $this->connection, $this->time]) ->getMock(); $refreshWebcalService ->method('getRandomCalendarObjectUri') ->willReturn('uri-1.ics'); - $this->caldavBackend->expects($this->once()) + $this->caldavBackend->expects(self::once()) ->method('getSubscriptionsForUser') ->with('principals/users/testuser') ->willReturn([ [ 'id' => '99', 'uri' => 'sub456', - '{http://apple.com/ns/ical/}refreshrate' => 'P1D', - '{http://calendarserver.org/ns/}subscribed-strip-todos' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-alarms' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-attachments' => '1', - 'source' => 'webcal://foo.bar/bla' + RefreshWebcalService::REFRESH_RATE => 'P1D', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla', + 'lastmodified' => 0, ], [ 'id' => '42', 'uri' => 'sub123', - '{http://apple.com/ns/ical/}refreshrate' => 'PT1H', - '{http://calendarserver.org/ns/}subscribed-strip-todos' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-alarms' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-attachments' => '1', - 'source' => 'webcal://foo.bar/bla2' + RefreshWebcalService::REFRESH_RATE => 'PT1H', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla2', + 'lastmodified' => 0, ], ]); - $client = $this->createMock(IClient::class); - $response = $this->createMock(IResponse::class); - $this->clientService->expects($this->once()) - ->method('newClient') - ->with() - ->willReturn($client); - - $this->config->expects($this->once()) - ->method('getAppValue') - ->with('dav', 'webcalAllowLocalAccess', 'no') - ->willReturn('no'); - - $client->expects($this->once()) - ->method('get') - ->with('https://foo.bar/bla2', $this->callback(function ($obj) { - return $obj['allow_redirects']['redirects'] === 10 && $obj['handler'] instanceof HandlerStack; - })) - ->willReturn($response); - - $response->expects($this->once()) - ->method('getBody') - ->with() - ->willReturn($body); - $response->expects($this->once()) - ->method('getHeader') - ->with('Content-Type') - ->willReturn($contentType); - - $this->caldavBackend->expects($this->once()) - ->method('purgeAllCachedEventsForSubscription') - ->with(42); - - $this->caldavBackend->expects($this->once()) + $this->connection->expects(self::once()) + ->method('queryWebcalFeed') + ->willReturn($result); + $this->caldavBackend->expects(self::once()) ->method('createCalendarObject') ->with(42, 'uri-1.ics', $result, 1); $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); } - - /** - * @param string $body - * @param string $contentType - * @param string $result - * - * @dataProvider runDataProvider - */ - public function testRunCreateCalendarNoException(string $body, string $contentType, string $result) { - $client = $this->createMock(IClient::class); - $response = $this->createMock(IResponse::class); + + #[\PHPUnit\Framework\Attributes\DataProvider('identicalDataProvider')] + public function testRunIdentical(string $uid, array $calendarObject, string $body, string $contentType, string $result): void { + $refreshWebcalService = $this->getMockBuilder(RefreshWebcalService::class) + ->onlyMethods(['getRandomCalendarObjectUri']) + ->setConstructorArgs([$this->caldavBackend, $this->logger, $this->connection, $this->time]) + ->getMock(); + + $refreshWebcalService + ->method('getRandomCalendarObjectUri') + ->willReturn('uri-1.ics'); + + $this->caldavBackend->expects(self::once()) + ->method('getSubscriptionsForUser') + ->with('principals/users/testuser') + ->willReturn([ + [ + 'id' => '99', + 'uri' => 'sub456', + RefreshWebcalService::REFRESH_RATE => 'P1D', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla', + 'lastmodified' => 0, + ], + [ + 'id' => '42', + 'uri' => 'sub123', + RefreshWebcalService::REFRESH_RATE => 'PT1H', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla2', + 'lastmodified' => 0, + ], + ]); + + $this->connection->expects(self::once()) + ->method('queryWebcalFeed') + ->willReturn($result); + + $this->caldavBackend->expects(self::once()) + ->method('getLimitedCalendarObjects') + ->willReturn($calendarObject); + + $denormalised = [ + 'etag' => 100, + 'size' => strlen($calendarObject[$uid]['calendardata']), + 'uid' => 'sub456' + ]; + + $this->caldavBackend->expects(self::once()) + ->method('getDenormalizedData') + ->willReturn($denormalised); + + $this->caldavBackend->expects(self::never()) + ->method('createCalendarObject'); + + $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub456'); + } + + public function testRunJustUpdated(): void { $refreshWebcalService = $this->getMockBuilder(RefreshWebcalService::class) - ->setMethods(['getRandomCalendarObjectUri', 'getSubscription', 'queryWebcalFeed']) - ->setConstructorArgs([$this->caldavBackend, $this->clientService, $this->config, $this->logger]) + ->onlyMethods(['getRandomCalendarObjectUri']) + ->setConstructorArgs([$this->caldavBackend, $this->logger, $this->connection, $this->time]) + ->getMock(); + + $refreshWebcalService + ->method('getRandomCalendarObjectUri') + ->willReturn('uri-1.ics'); + + $this->caldavBackend->expects(self::once()) + ->method('getSubscriptionsForUser') + ->with('principals/users/testuser') + ->willReturn([ + [ + 'id' => '99', + 'uri' => 'sub456', + RefreshWebcalService::REFRESH_RATE => 'P1D', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla', + 'lastmodified' => time(), + ], + [ + 'id' => '42', + 'uri' => 'sub123', + RefreshWebcalService::REFRESH_RATE => 'PT1H', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla2', + 'lastmodified' => time(), + ], + ]); + + $timeMock = $this->createMock(\DateTime::class); + $this->time->expects(self::once()) + ->method('getDateTime') + ->willReturn($timeMock); + $timeMock->expects(self::once()) + ->method('getTimestamp') + ->willReturn(2101724667); + $this->time->expects(self::once()) + ->method('getTime') + ->willReturn(time()); + $this->connection->expects(self::never()) + ->method('queryWebcalFeed'); + $this->caldavBackend->expects(self::never()) + ->method('createCalendarObject'); + + $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); + } + + #[\PHPUnit\Framework\Attributes\DataProvider('runDataProvider')] + public function testRunCreateCalendarNoException(string $body, string $contentType, string $result): void { + $refreshWebcalService = $this->getMockBuilder(RefreshWebcalService::class) + ->onlyMethods(['getRandomCalendarObjectUri', 'getSubscription',]) + ->setConstructorArgs([$this->caldavBackend, $this->logger, $this->connection, $this->time]) ->getMock(); $refreshWebcalService @@ -170,72 +212,39 @@ class RefreshWebcalServiceTest extends TestCase { ->willReturn([ 'id' => '42', 'uri' => 'sub123', - '{http://apple.com/ns/ical/}refreshrate' => 'PT1H', - '{http://calendarserver.org/ns/}subscribed-strip-todos' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-alarms' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-attachments' => '1', - 'source' => 'webcal://foo.bar/bla2' + RefreshWebcalService::REFRESH_RATE => 'PT1H', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla2', + 'lastmodified' => 0, ]); - $this->clientService->expects($this->once()) - ->method('newClient') - ->with() - ->willReturn($client); - - $this->config->expects($this->once()) - ->method('getAppValue') - ->with('dav', 'webcalAllowLocalAccess', 'no') - ->willReturn('no'); - - $client->expects($this->once()) - ->method('get') - ->with('https://foo.bar/bla2', $this->callback(function ($obj) { - return $obj['allow_redirects']['redirects'] === 10 && $obj['handler'] instanceof HandlerStack; - })) - ->willReturn($response); - - $response->expects($this->once()) - ->method('getBody') - ->with() - ->willReturn($body); - $response->expects($this->once()) - ->method('getHeader') - ->with('Content-Type') - ->willReturn($contentType); - - $this->caldavBackend->expects($this->once()) - ->method('purgeAllCachedEventsForSubscription') - ->with(42); - - $this->caldavBackend->expects($this->once()) + $this->connection->expects(self::once()) + ->method('queryWebcalFeed') + ->willReturn($result); + + $this->caldavBackend->expects(self::once()) ->method('createCalendarObject') ->with(42, 'uri-1.ics', $result, 1); - + $noInstanceException = new NoInstancesException("can't add calendar object"); - $this->caldavBackend->expects($this->once()) - ->method("createCalendarObject") + $this->caldavBackend->expects(self::once()) + ->method('createCalendarObject') ->willThrowException($noInstanceException); - - $this->logger->expects($this->once()) - ->method('logException') - ->with($noInstanceException); + + $this->logger->expects(self::once()) + ->method('warning') + ->with('Unable to create calendar object from subscription {subscriptionId}', ['exception' => $noInstanceException, 'subscriptionId' => '42', 'source' => 'webcal://foo.bar/bla2']); $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); } - /** - * @param string $body - * @param string $contentType - * @param string $result - * - * @dataProvider runDataProvider - */ - public function testRunCreateCalendarBadRequest(string $body, string $contentType, string $result) { - $client = $this->createMock(IClient::class); - $response = $this->createMock(IResponse::class); + #[\PHPUnit\Framework\Attributes\DataProvider('runDataProvider')] + public function testRunCreateCalendarBadRequest(string $body, string $contentType, string $result): void { $refreshWebcalService = $this->getMockBuilder(RefreshWebcalService::class) - ->setMethods(['getRandomCalendarObjectUri', 'getSubscription', 'queryWebcalFeed']) - ->setConstructorArgs([$this->caldavBackend, $this->clientService, $this->config, $this->logger]) + ->onlyMethods(['getRandomCalendarObjectUri', 'getSubscription']) + ->setConstructorArgs([$this->caldavBackend, $this->logger, $this->connection, $this->time]) ->getMock(); $refreshWebcalService @@ -247,63 +256,54 @@ class RefreshWebcalServiceTest extends TestCase { ->willReturn([ 'id' => '42', 'uri' => 'sub123', - '{http://apple.com/ns/ical/}refreshrate' => 'PT1H', - '{http://calendarserver.org/ns/}subscribed-strip-todos' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-alarms' => '1', - '{http://calendarserver.org/ns/}subscribed-strip-attachments' => '1', - 'source' => 'webcal://foo.bar/bla2' + RefreshWebcalService::REFRESH_RATE => 'PT1H', + RefreshWebcalService::STRIP_TODOS => '1', + RefreshWebcalService::STRIP_ALARMS => '1', + RefreshWebcalService::STRIP_ATTACHMENTS => '1', + 'source' => 'webcal://foo.bar/bla2', + 'lastmodified' => 0, ]); - $this->clientService->expects($this->once()) - ->method('newClient') - ->with() - ->willReturn($client); - - $this->config->expects($this->once()) - ->method('getAppValue') - ->with('dav', 'webcalAllowLocalAccess', 'no') - ->willReturn('no'); - - $client->expects($this->once()) - ->method('get') - ->with('https://foo.bar/bla2', $this->callback(function ($obj) { - return $obj['allow_redirects']['redirects'] === 10 && $obj['handler'] instanceof HandlerStack; - })) - ->willReturn($response); - - $response->expects($this->once()) - ->method('getBody') - ->with() - ->willReturn($body); - $response->expects($this->once()) - ->method('getHeader') - ->with('Content-Type') - ->willReturn($contentType); - - $this->caldavBackend->expects($this->once()) - ->method('purgeAllCachedEventsForSubscription') - ->with(42); - - $this->caldavBackend->expects($this->once()) + $this->connection->expects(self::once()) + ->method('queryWebcalFeed') + ->willReturn($result); + + $this->caldavBackend->expects(self::once()) ->method('createCalendarObject') ->with(42, 'uri-1.ics', $result, 1); - + $badRequestException = new BadRequest("can't add reach calendar url"); - $this->caldavBackend->expects($this->once()) - ->method("createCalendarObject") + $this->caldavBackend->expects(self::once()) + ->method('createCalendarObject') ->willThrowException($badRequestException); - - $this->logger->expects($this->once()) - ->method('logException') - ->with($badRequestException); + + $this->logger->expects(self::once()) + ->method('warning') + ->with('Unable to create calendar object from subscription {subscriptionId}', ['exception' => $badRequestException, 'subscriptionId' => '42', 'source' => 'webcal://foo.bar/bla2']); $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); } - /** - * @return array - */ - public function runDataProvider():array { + public static function identicalDataProvider(): array { + return [ + [ + '12345', + [ + '12345' => [ + 'id' => 42, + 'etag' => 100, + 'uri' => 'sub456', + 'calendardata' => "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nCALSCALE:GREGORIAN\r\nBEGIN:VEVENT\r\nUID:12345\r\nDTSTAMP:20160218T133704Z\r\nDTSTART;VALUE=DATE:19000101\r\nDTEND;VALUE=DATE:19000102\r\nRRULE:FREQ=YEARLY\r\nSUMMARY:12345's Birthday (1900)\r\nTRANSP:TRANSPARENT\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", + ], + ], + "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nCALSCALE:GREGORIAN\r\nBEGIN:VEVENT\r\nUID:12345\r\nDTSTAMP:20160218T133704Z\r\nDTSTART;VALUE=DATE:19000101\r\nDTEND;VALUE=DATE:19000102\r\nRRULE:FREQ=YEARLY\r\nSUMMARY:12345's Birthday (1900)\r\nTRANSP:TRANSPARENT\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", + 'text/calendar;charset=utf8', + "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nCALSCALE:GREGORIAN\r\nBEGIN:VEVENT\r\nUID:12345\r\nDTSTAMP:20180218T133704Z\r\nDTSTART;VALUE=DATE:19000101\r\nDTEND;VALUE=DATE:19000102\r\nRRULE:FREQ=YEARLY\r\nSUMMARY:12345's Birthday (1900)\r\nTRANSP:TRANSPARENT\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", + ], + ]; + } + + public static function runDataProvider(): array { return [ [ "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Sabre//Sabre VObject 4.1.1//EN\r\nCALSCALE:GREGORIAN\r\nBEGIN:VEVENT\r\nUID:12345\r\nDTSTAMP:20160218T133704Z\r\nDTSTART;VALUE=DATE:19000101\r\nDTEND;VALUE=DATE:19000102\r\nRRULE:FREQ=YEARLY\r\nSUMMARY:12345's Birthday (1900)\r\nTRANSP:TRANSPARENT\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n", @@ -322,109 +322,4 @@ class RefreshWebcalServiceTest extends TestCase { ] ]; } - - /** - * @dataProvider runLocalURLDataProvider - * - * @param string $source - */ - public function testRunLocalURL($source) { - $refreshWebcalService = new RefreshWebcalService( - $this->caldavBackend, - $this->clientService, - $this->config, - $this->logger - ); - - $this->caldavBackend->expects($this->once()) - ->method('getSubscriptionsForUser') - ->with('principals/users/testuser') - ->willReturn([ - [ - 'id' => 42, - 'uri' => 'sub123', - 'refreshreate' => 'P1H', - 'striptodos' => 1, - 'stripalarms' => 1, - 'stripattachments' => 1, - 'source' => $source - ], - ]); - - $client = $this->createMock(IClient::class); - $this->clientService->expects($this->once()) - ->method('newClient') - ->with() - ->willReturn($client); - - $this->config->expects($this->once()) - ->method('getAppValue') - ->with('dav', 'webcalAllowLocalAccess', 'no') - ->willReturn('no'); - - $client->expects($this->once()) - ->method('get') - ->willThrowException(new LocalServerException()); - - $this->logger->expects($this->once()) - ->method('logException') - ->with($this->isInstanceOf(LocalServerException::class), $this->anything()); - - $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); - } - - public function runLocalURLDataProvider():array { - return [ - ['localhost/foo.bar'], - ['localHost/foo.bar'], - ['random-host/foo.bar'], - ['[::1]/bla.blub'], - ['[::]/bla.blub'], - ['192.168.0.1'], - ['172.16.42.1'], - ['[fdf8:f53b:82e4::53]/secret.ics'], - ['[fe80::200:5aee:feaa:20a2]/secret.ics'], - ['[0:0:0:0:0:0:10.0.0.1]/secret.ics'], - ['[0:0:0:0:0:ffff:127.0.0.0]/secret.ics'], - ['10.0.0.1'], - ['another-host.local'], - ['service.localhost'], - ]; - } - - public function testInvalidUrl() { - $refreshWebcalService = new RefreshWebcalService($this->caldavBackend, - $this->clientService, $this->config, $this->logger); - - $this->caldavBackend->expects($this->once()) - ->method('getSubscriptionsForUser') - ->with('principals/users/testuser') - ->willReturn([ - [ - 'id' => 42, - 'uri' => 'sub123', - 'refreshreate' => 'P1H', - 'striptodos' => 1, - 'stripalarms' => 1, - 'stripattachments' => 1, - 'source' => '!@#$' - ], - ]); - - $client = $this->createMock(IClient::class); - $this->clientService->expects($this->once()) - ->method('newClient') - ->with() - ->willReturn($client); - - $this->config->expects($this->once()) - ->method('getAppValue') - ->with('dav', 'webcalAllowLocalAccess', 'no') - ->willReturn('no'); - - $client->expects($this->never()) - ->method('get'); - - $refreshWebcalService->refreshSubscription('principals/users/testuser', 'sub123'); - } } |