diff options
Diffstat (limited to 'apps/comments/tests/Unit/Controller/NotificationsTest.php')
-rw-r--r-- | apps/comments/tests/Unit/Controller/NotificationsTest.php | 199 |
1 files changed, 123 insertions, 76 deletions
diff --git a/apps/comments/tests/Unit/Controller/NotificationsTest.php b/apps/comments/tests/Unit/Controller/NotificationsTest.php index eb29947342b..04490ca63e8 100644 --- a/apps/comments/tests/Unit/Controller/NotificationsTest.php +++ b/apps/comments/tests/Unit/Controller/NotificationsTest.php @@ -1,33 +1,22 @@ <?php + +declare(strict_types=1); + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Morris Jobke <hey@morrisjobke.de> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Comments\Tests\Unit\Controller; -use OCA\Comments\Controller\Notifications; +use OCA\Comments\Controller\NotificationsController; +use OCP\AppFramework\Http\NotFoundResponse; +use OCP\AppFramework\Http\RedirectResponse; use OCP\Comments\IComment; use OCP\Comments\ICommentsManager; use OCP\Comments\NotFoundException; use OCP\Files\Folder; +use OCP\Files\IRootFolder; use OCP\Files\Node; use OCP\IRequest; use OCP\IURLGenerator; @@ -35,91 +24,134 @@ use OCP\IUser; use OCP\IUserSession; use OCP\Notification\IManager; use OCP\Notification\INotification; +use PHPUnit\Framework\MockObject\MockObject; use Test\TestCase; class NotificationsTest extends TestCase { - /** @var \OCA\Comments\Controller\Notifications */ - protected $notificationsController; - - /** @var \OCP\Comments\ICommentsManager|\PHPUnit_Framework_MockObject_MockObject */ - protected $commentsManager; - - /** @var \OCP\Files\Folder|\PHPUnit_Framework_MockObject_MockObject */ - protected $folder; - - /** @var \OCP\IUserSession|\PHPUnit_Framework_MockObject_MockObject */ - protected $session; - - /** @var \OCP\Notification\IManager|\PHPUnit_Framework_MockObject_MockObject */ - protected $notificationManager; - - protected function setUp() { + protected ICommentsManager&MockObject $commentsManager; + protected IRootFolder&MockObject $rootFolder; + protected IUserSession&MockObject $session; + protected IManager&MockObject $notificationManager; + protected IURLGenerator&MockObject $urlGenerator; + protected NotificationsController $notificationsController; + + protected function setUp(): void { parent::setUp(); - $this->commentsManager = $this->getMockBuilder(ICommentsManager::class)->getMock(); - $this->folder = $this->getMockBuilder(Folder::class)->getMock(); - $this->session = $this->getMockBuilder(IUserSession::class)->getMock(); - $this->notificationManager = $this->getMockBuilder(IManager::class)->getMock(); + $this->commentsManager = $this->createMock(ICommentsManager::class); + $this->rootFolder = $this->createMock(IRootFolder::class); + $this->session = $this->createMock(IUserSession::class); + $this->notificationManager = $this->createMock(IManager::class); + $this->urlGenerator = $this->createMock(IURLGenerator::class); - $this->notificationsController = new Notifications( + $this->notificationsController = new NotificationsController( 'comments', - $this->getMockBuilder(IRequest::class)->getMock(), + $this->createMock(IRequest::class), $this->commentsManager, - $this->folder, - $this->getMockBuilder(IURLGenerator::class)->getMock(), + $this->rootFolder, + $this->urlGenerator, $this->notificationManager, $this->session ); } - - public function testViewSuccess() { - $comment = $this->getMockBuilder(IComment::class)->getMock(); + + public function testViewGuestRedirect(): void { + $this->commentsManager->expects($this->never()) + ->method('get'); + + $this->rootFolder->expects($this->never()) + ->method('getUserFolder'); + + $this->session->expects($this->once()) + ->method('getUser') + ->willReturn(null); + + $this->notificationManager->expects($this->never()) + ->method('createNotification'); + $this->notificationManager->expects($this->never()) + ->method('markProcessed'); + + $this->urlGenerator->expects($this->exactly(2)) + ->method('linkToRoute') + ->willReturnMap([ + ['comments.Notifications.view', ['id' => '42'], 'link-to-comment'], + ['core.login.showLoginForm', ['redirect_url' => 'link-to-comment'], 'link-to-login'], + ]); + + /** @var RedirectResponse $response */ + $response = $this->notificationsController->view('42'); + $this->assertInstanceOf(RedirectResponse::class, $response); + $this->assertSame('link-to-login', $response->getRedirectURL()); + } + + public function testViewSuccess(): void { + $comment = $this->createMock(IComment::class); $comment->expects($this->any()) ->method('getObjectType') - ->will($this->returnValue('files')); + ->willReturn('files'); + $comment->expects($this->any()) + ->method('getId') + ->willReturn('1234'); $this->commentsManager->expects($this->any()) ->method('get') ->with('42') - ->will($this->returnValue($comment)); + ->willReturn($comment); + + $file = $this->createMock(Node::class); + $folder = $this->createMock(Folder::class); + $user = $this->createMock(IUser::class); - $file = $this->getMockBuilder(Node::class)->getMock(); + $this->rootFolder->expects($this->once()) + ->method('getUserFolder') + ->willReturn($folder); - $this->folder->expects($this->once()) + $folder->expects($this->once()) ->method('getById') - ->will($this->returnValue([$file])); + ->willReturn([$file]); $this->session->expects($this->once()) ->method('getUser') - ->will($this->returnValue($this->getMockBuilder(IUser::class)->getMock())); + ->willReturn($user); - $notification = $this->getMockBuilder(INotification::class)->getMock(); + $user->expects($this->any()) + ->method('getUID') + ->willReturn('user'); + + $notification = $this->createMock(INotification::class); $notification->expects($this->any()) ->method($this->anything()) - ->will($this->returnValue($notification)); + ->willReturn($notification); $this->notificationManager->expects($this->once()) ->method('createNotification') - ->will($this->returnValue($notification)); + ->willReturn($notification); $this->notificationManager->expects($this->once()) ->method('markProcessed') ->with($notification); $response = $this->notificationsController->view('42'); - $this->assertInstanceOf('\OCP\AppFramework\Http\RedirectResponse', $response); + $this->assertInstanceOf(RedirectResponse::class, $response); } - public function testViewInvalidComment() { + public function testViewInvalidComment(): void { $this->commentsManager->expects($this->any()) ->method('get') ->with('42') - ->will($this->throwException(new NotFoundException())); + ->willThrowException(new NotFoundException()); - $this->folder->expects($this->never()) - ->method('getById'); + $this->rootFolder->expects($this->never()) + ->method('getUserFolder'); - $this->session->expects($this->never()) - ->method('getUser'); + $user = $this->createMock(IUser::class); + + $this->session->expects($this->once()) + ->method('getUser') + ->willReturn($user); + + $user->expects($this->any()) + ->method('getUID') + ->willReturn('user'); $this->notificationManager->expects($this->never()) ->method('createNotification'); @@ -127,41 +159,56 @@ class NotificationsTest extends TestCase { ->method('markProcessed'); $response = $this->notificationsController->view('42'); - $this->assertInstanceOf('\OCP\AppFramework\Http\NotFoundResponse', $response); + $this->assertInstanceOf(NotFoundResponse::class, $response); } - public function testViewNoFile() { - $comment = $this->getMockBuilder(IComment::class)->getMock(); + public function testViewNoFile(): void { + $comment = $this->createMock(IComment::class); $comment->expects($this->any()) ->method('getObjectType') - ->will($this->returnValue('files')); + ->willReturn('files'); + $comment->expects($this->any()) + ->method('getId') + ->willReturn('1234'); $this->commentsManager->expects($this->any()) ->method('get') ->with('42') - ->will($this->returnValue($comment)); + ->willReturn($comment); - $this->folder->expects($this->once()) + $folder = $this->createMock(Folder::class); + + $this->rootFolder->expects($this->once()) + ->method('getUserFolder') + ->willReturn($folder); + + $folder->expects($this->once()) ->method('getById') - ->will($this->returnValue([])); + ->willReturn([]); + + $user = $this->createMock(IUser::class); $this->session->expects($this->once()) ->method('getUser') - ->will($this->returnValue($this->getMockBuilder(IUser::class)->getMock())); + ->willReturn($user); + + $user->expects($this->any()) + ->method('getUID') + ->willReturn('user'); - $notification = $this->getMockBuilder(INotification::class)->getMock(); + $notification = $this->createMock(INotification::class); $notification->expects($this->any()) ->method($this->anything()) - ->will($this->returnValue($notification)); + ->willReturn($notification); $this->notificationManager->expects($this->once()) ->method('createNotification') - ->will($this->returnValue($notification)); + ->willReturn($notification); $this->notificationManager->expects($this->once()) ->method('markProcessed') ->with($notification); $response = $this->notificationsController->view('42'); - $this->assertInstanceOf('\OCP\AppFramework\Http\NotFoundResponse', $response); + $this->assertInstanceOf(NotFoundResponse::class, $response); } } |