mirror of
https://github.com/nextcloud/server.git
synced 2026-02-03 20:41:22 -05:00
caff1023ea
To continue this formatting madness, here's a tiny patch that adds unified formatting for control structures like if and loops as well as classes, their methods and anonymous functions. This basically forces the constructs to start on the same line. This is not exactly what PSR2 wants, but I think we can have a few exceptions with "our" style. The starting of braces on the same line is pracrically standard for our code. This also removes and empty lines from method/function bodies at the beginning and end. Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
619 lines
16 KiB
PHP
619 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
*
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
|
*
|
|
* @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\Comments\Tests\Unit\Notification;
|
|
|
|
use OCA\Comments\Notification\Notifier;
|
|
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\IL10N;
|
|
use OCP\IURLGenerator;
|
|
use OCP\IUser;
|
|
use OCP\IUserManager;
|
|
use OCP\L10N\IFactory;
|
|
use OCP\Notification\INotification;
|
|
use Test\TestCase;
|
|
|
|
class NotifierTest extends TestCase {
|
|
|
|
/** @var Notifier */
|
|
protected $notifier;
|
|
/** @var IFactory|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $l10nFactory;
|
|
/** @var IL10N|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $l;
|
|
/** @var IRootFolder|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $folder;
|
|
/** @var ICommentsManager|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $commentsManager;
|
|
/** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $url;
|
|
/** @var IUserManager|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $userManager;
|
|
/** @var INotification|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $notification;
|
|
/** @var IComment|\PHPUnit_Framework_MockObject_MockObject */
|
|
protected $comment;
|
|
/** @var string */
|
|
protected $lc = 'tlh_KX';
|
|
|
|
protected function setUp(): void {
|
|
parent::setUp();
|
|
|
|
$this->l10nFactory = $this->createMock(IFactory::class);
|
|
$this->folder = $this->createMock(IRootFolder::class);
|
|
$this->commentsManager = $this->createMock(ICommentsManager::class);
|
|
$this->url = $this->createMock(IURLGenerator::class);
|
|
$this->userManager = $this->createMock(IUserManager::class);
|
|
|
|
$this->notifier = new Notifier(
|
|
$this->l10nFactory,
|
|
$this->folder,
|
|
$this->commentsManager,
|
|
$this->url,
|
|
$this->userManager
|
|
);
|
|
|
|
$this->l = $this->createMock(IL10N::class);
|
|
$this->l->expects($this->any())
|
|
->method('t')
|
|
->willReturnCallback(function ($text, $parameters = []) {
|
|
return vsprintf($text, $parameters);
|
|
});
|
|
|
|
$this->notification = $this->createMock(INotification::class);
|
|
$this->comment = $this->createMock(IComment::class);
|
|
}
|
|
|
|
public function testPrepareSuccess() {
|
|
$fileName = 'Gre\'thor.odp';
|
|
$displayName = 'Huraga';
|
|
$message = '@Huraga mentioned you in a comment on “Gre\'thor.odp”';
|
|
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
|
|
$user = $this->createMock(IUser::class);
|
|
$user->expects($this->once())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $you */
|
|
$you = $this->createMock(IUser::class);
|
|
|
|
/** @var Node|\PHPUnit_Framework_MockObject_MockObject $node */
|
|
$node = $this->createMock(Node::class);
|
|
$node
|
|
->expects($this->atLeastOnce())
|
|
->method('getName')
|
|
->willReturn($fileName);
|
|
$node
|
|
->expects($this->atLeastOnce())
|
|
->method('getPath')
|
|
->willReturn('/you/files/' . $fileName);
|
|
|
|
$userFolder = $this->createMock(Folder::class);
|
|
$this->folder->expects($this->once())
|
|
->method('getUserFolder')
|
|
->with('you')
|
|
->willReturn($userFolder);
|
|
$userFolder->expects($this->once())
|
|
->method('getById')
|
|
->with('678')
|
|
->willReturn([$node]);
|
|
|
|
$this->notification->expects($this->exactly(2))
|
|
->method('getUser')
|
|
->willReturn('you');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubject')
|
|
->willReturn('mention');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubjectParameters')
|
|
->willReturn(['files', '678']);
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setParsedSubject')
|
|
->with($message)
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setRichSubject')
|
|
->with('{user} mentioned you in a comment on “{file}”', $this->anything())
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setRichMessage')
|
|
->with('Hi {mention-user1}!', ['mention-user1' => ['type' => 'user', 'id' => 'you', 'name' => 'Your name']])
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setParsedMessage')
|
|
->with('Hi @Your name!')
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setIcon')
|
|
->with('absolute-image-path')
|
|
->willReturnSelf();
|
|
|
|
$this->url->expects($this->once())
|
|
->method('imagePath')
|
|
->with('core', 'actions/comment.svg')
|
|
->willReturn('image-path');
|
|
$this->url->expects($this->once())
|
|
->method('getAbsoluteURL')
|
|
->with('image-path')
|
|
->willReturn('absolute-image-path');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->l);
|
|
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorId')
|
|
->willReturn('huraga');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorType')
|
|
->willReturn('users');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getMessage')
|
|
->willReturn('Hi @you!');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getMentions')
|
|
->willReturn([['type' => 'user', 'id' => 'you']]);
|
|
$this->comment->expects($this->atLeastOnce())
|
|
->method('getId')
|
|
->willReturn('1234');
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->comment);
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('resolveDisplayName')
|
|
->with('user', 'you')
|
|
->willReturn('Your name');
|
|
|
|
$this->userManager
|
|
->expects($this->exactly(2))
|
|
->method('get')
|
|
->willReturnMap([
|
|
['huraga', $user],
|
|
['you', $you],
|
|
]);
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
public function testPrepareSuccessDeletedUser() {
|
|
$fileName = 'Gre\'thor.odp';
|
|
$message = 'You were mentioned on “Gre\'thor.odp”, in a comment by a user that has since been deleted';
|
|
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $you */
|
|
$you = $this->createMock(IUser::class);
|
|
|
|
/** @var Node|\PHPUnit_Framework_MockObject_MockObject $node */
|
|
$node = $this->createMock(Node::class);
|
|
$node
|
|
->expects($this->atLeastOnce())
|
|
->method('getName')
|
|
->willReturn($fileName);
|
|
$node
|
|
->expects($this->atLeastOnce())
|
|
->method('getPath')
|
|
->willReturn('/you/files/' . $fileName);
|
|
|
|
$userFolder = $this->createMock(Folder::class);
|
|
$this->folder->expects($this->once())
|
|
->method('getUserFolder')
|
|
->with('you')
|
|
->willReturn($userFolder);
|
|
$userFolder->expects($this->once())
|
|
->method('getById')
|
|
->with('678')
|
|
->willReturn([$node]);
|
|
|
|
$this->notification->expects($this->exactly(2))
|
|
->method('getUser')
|
|
->willReturn('you');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubject')
|
|
->willReturn('mention');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubjectParameters')
|
|
->willReturn(['files', '678']);
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setParsedSubject')
|
|
->with($message)
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setRichSubject')
|
|
->with('You were mentioned on “{file}”, in a comment by a user that has since been deleted', $this->anything())
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setRichMessage')
|
|
->with('Hi {mention-user1}!', ['mention-user1' => ['type' => 'user', 'id' => 'you', 'name' => 'Your name']])
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setParsedMessage')
|
|
->with('Hi @Your name!')
|
|
->willReturnSelf();
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('setIcon')
|
|
->with('absolute-image-path')
|
|
->willReturnSelf();
|
|
|
|
$this->url->expects($this->once())
|
|
->method('imagePath')
|
|
->with('core', 'actions/comment.svg')
|
|
->willReturn('image-path');
|
|
$this->url->expects($this->once())
|
|
->method('getAbsoluteURL')
|
|
->with('image-path')
|
|
->willReturn('absolute-image-path');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->l);
|
|
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorId')
|
|
->willReturn('huraga');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorType')
|
|
->willReturn(ICommentsManager::DELETED_USER);
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getMessage')
|
|
->willReturn('Hi @you!');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getMentions')
|
|
->willReturn([['type' => 'user', 'id' => 'you']]);
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->comment);
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('resolveDisplayName')
|
|
->with('user', 'you')
|
|
->willReturn('Your name');
|
|
|
|
$this->userManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->with('you')
|
|
->willReturn($you);
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
|
|
public function testPrepareDifferentApp() {
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
|
|
$this->folder
|
|
->expects($this->never())
|
|
->method('getById');
|
|
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('constructions');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('getSubject');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('getSubjectParameters');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('setParsedSubject');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->never())
|
|
->method('get');
|
|
|
|
$this->commentsManager
|
|
->expects($this->never())
|
|
->method('get');
|
|
|
|
$this->userManager
|
|
->expects($this->never())
|
|
->method('get');
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
|
|
public function testPrepareNotFound() {
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
|
|
$this->folder
|
|
->expects($this->never())
|
|
->method('getById');
|
|
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('getSubject');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('getSubjectParameters');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('setParsedSubject');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->never())
|
|
->method('get');
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willThrowException(new NotFoundException());
|
|
|
|
$this->userManager
|
|
->expects($this->never())
|
|
->method('get');
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
|
|
public function testPrepareDifferentSubject() {
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
|
|
$displayName = 'Huraga';
|
|
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
|
|
$user = $this->createMock(IUser::class);
|
|
$user->expects($this->once())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
$this->folder
|
|
->expects($this->never())
|
|
->method('getById');
|
|
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubject')
|
|
->willReturn('unlike');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('getSubjectParameters');
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('setParsedSubject');
|
|
|
|
$this->l
|
|
->expects($this->never())
|
|
->method('t');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->l);
|
|
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorId')
|
|
->willReturn('huraga');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorType')
|
|
->willReturn('users');
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->comment);
|
|
|
|
$this->userManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->with('huraga')
|
|
->willReturn($user);
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
|
|
public function testPrepareNotFiles() {
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
|
|
$displayName = 'Huraga';
|
|
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
|
|
$user = $this->createMock(IUser::class);
|
|
$user->expects($this->once())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
$this->folder
|
|
->expects($this->never())
|
|
->method('getById');
|
|
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubject')
|
|
->willReturn('mention');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubjectParameters')
|
|
->willReturn(['ships', '678']);
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('setParsedSubject');
|
|
|
|
$this->l
|
|
->expects($this->never())
|
|
->method('t');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->l);
|
|
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorId')
|
|
->willReturn('huraga');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorType')
|
|
->willReturn('users');
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->comment);
|
|
|
|
$this->userManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->with('huraga')
|
|
->willReturn($user);
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
|
|
|
|
public function testPrepareUnresolvableFileID() {
|
|
$this->expectException(\OCP\Notification\AlreadyProcessedException::class);
|
|
|
|
$displayName = 'Huraga';
|
|
|
|
/** @var IUser|\PHPUnit_Framework_MockObject_MockObject $user */
|
|
$user = $this->createMock(IUser::class);
|
|
$user->expects($this->once())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
$userFolder = $this->createMock(Folder::class);
|
|
$this->folder->expects($this->once())
|
|
->method('getUserFolder')
|
|
->with('you')
|
|
->willReturn($userFolder);
|
|
$userFolder->expects($this->once())
|
|
->method('getById')
|
|
->with('678')
|
|
->willReturn([]);
|
|
|
|
$this->notification->expects($this->once())
|
|
->method('getUser')
|
|
->willReturn('you');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getApp')
|
|
->willReturn('comments');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubject')
|
|
->willReturn('mention');
|
|
$this->notification
|
|
->expects($this->once())
|
|
->method('getSubjectParameters')
|
|
->willReturn(['files', '678']);
|
|
$this->notification
|
|
->expects($this->never())
|
|
->method('setParsedSubject');
|
|
|
|
$this->l
|
|
->expects($this->never())
|
|
->method('t');
|
|
|
|
$this->l10nFactory
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->l);
|
|
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorId')
|
|
->willReturn('huraga');
|
|
$this->comment
|
|
->expects($this->any())
|
|
->method('getActorType')
|
|
->willReturn('users');
|
|
|
|
$this->commentsManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->willReturn($this->comment);
|
|
|
|
$this->userManager
|
|
->expects($this->once())
|
|
->method('get')
|
|
->with('huraga')
|
|
->willReturn($user);
|
|
|
|
$this->notifier->prepare($this->notification, $this->lc);
|
|
}
|
|
}
|