-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jonas Rittershofer <[email protected]>
- Loading branch information
Showing
2 changed files
with
913 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,390 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
/** | ||
* @copyright Copyright (c) 2021 Jonas Rittershofer <[email protected]> | ||
* | ||
* @author Jonas Rittershofer <[email protected]> | ||
* | ||
* @license AGPL-3.0-or-later | ||
* | ||
* 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\Forms\Tests\Unit\Controller; | ||
|
||
use OCA\Forms\Controller\ShareApiController; | ||
|
||
use OCA\Forms\Db\Form; | ||
use OCA\Forms\Db\FormMapper; | ||
use OCA\Forms\Db\Share; | ||
use OCA\Forms\Db\ShareMapper; | ||
use OCA\Forms\Service\FormsService; | ||
|
||
use OCP\AppFramework\Db\DoesNotExistException; | ||
use OCP\AppFramework\Http\DataResponse; | ||
use OCP\AppFramework\OCS\OCSBadRequestException; | ||
use OCP\AppFramework\OCS\OCSException; | ||
use OCP\AppFramework\OCS\OCSForbiddenException; | ||
use OCP\IGroup; | ||
use OCP\IGroupManager; | ||
use OCP\ILogger; | ||
use OCP\IRequest; | ||
use OCP\IUser; | ||
use OCP\IUserManager; | ||
use OCP\IUserSession; | ||
use OCP\Security\ISecureRandom; | ||
use OCP\Share\IShare; | ||
|
||
use PHPUnit\Framework\MockObject\MockObject; | ||
use Test\TestCase; | ||
|
||
class ShareApiControllerTest extends TestCase { | ||
|
||
/** @var ShareApiController */ | ||
private $shareApiController; | ||
|
||
/** @var FormMapper|MockObject */ | ||
private $formMapper; | ||
|
||
/** @var ShareMapper|MockObject */ | ||
private $shareMapper; | ||
|
||
/** @var FormsService|MockObject */ | ||
private $formsService; | ||
|
||
/** @var IGroupManager|MockObject */ | ||
private $groupManager; | ||
|
||
/** @var ILogger|MockObject */ | ||
private $logger; | ||
|
||
/** @var IRequest|MockObject */ | ||
private $request; | ||
|
||
/** @var IUserManager|MockObject */ | ||
private $userManager; | ||
|
||
/** @var ISecureRandom|MockObject */ | ||
private $secureRandom; | ||
|
||
public function setUp(): void { | ||
$this->formMapper = $this->createMock(FormMapper::class); | ||
$this->shareMapper = $this->createMock(ShareMapper::class); | ||
$this->formsService = $this->createMock(FormsService::class); | ||
$this->groupManager = $this->createMock(IGroupManager::class); | ||
$this->logger = $this->createMock(ILogger::class); | ||
$this->request = $this->createMock(IRequest::class); | ||
$this->userManager = $this->createMock(IUserManager::class); | ||
$userSession = $this->createMock(IUserSession::class); | ||
$this->secureRandom = $this->createMock(ISecureRandom::class); | ||
|
||
$user = $this->createMock(IUser::class); | ||
$user->expects($this->any()) | ||
->method('getUID') | ||
->willReturn('currentUser'); | ||
$userSession->expects($this->once()) | ||
->method('getUser') | ||
->willReturn($user); | ||
|
||
$this->shareApiController = new ShareApiController( | ||
'forms', | ||
$this->formMapper, | ||
$this->shareMapper, | ||
$this->formsService, | ||
$this->groupManager, | ||
$this->logger, | ||
$this->request, | ||
$this->userManager, | ||
$userSession, | ||
$this->secureRandom | ||
); | ||
} | ||
|
||
public function dataValidNewShare() { | ||
return [ | ||
'newUserShare' => [ | ||
'shareType' => IShare::TYPE_USER, | ||
'shareWith' => 'user1', | ||
'expected' => [ | ||
'id' => 13, | ||
'formId' => 5, | ||
'shareType' => 0, | ||
'shareWith' => 'user1', | ||
'displayName' => 'user1 DisplayName' | ||
] | ||
], | ||
'newGroupShare' => [ | ||
'shareType' => IShare::TYPE_GROUP, | ||
'shareWith' => 'group1', | ||
'expected' => [ | ||
'id' => 13, | ||
'formId' => 5, | ||
'shareType' => 1, | ||
'shareWith' => 'group1', | ||
'displayName' => 'group1 DisplayName' | ||
] | ||
], | ||
]; | ||
} | ||
/** | ||
* Test valid shares | ||
* @dataProvider dataValidNewShare | ||
* | ||
* @param int $shareType | ||
* @param string $shareWith | ||
* @param array $expected | ||
*/ | ||
public function testValidNewShare(int $shareType, string $shareWith, array $expected) { | ||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('currentUser'); | ||
|
||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->userManager->expects($this->any()) | ||
->method('get') | ||
->with($shareWith) | ||
->willReturn($this->createMock(IUser::class)); | ||
|
||
$this->groupManager->expects($this->any()) | ||
->method('get') | ||
->with($shareWith) | ||
->willReturn($this->createMock(IGroup::class)); | ||
|
||
$share = new Share(); | ||
$share->setformId('5'); | ||
$share->setShareType($shareType); | ||
$share->setShareWith($shareWith); | ||
$shareWithId = clone $share; | ||
$shareWithId->setId(13); | ||
$this->shareMapper->expects($this->once()) | ||
->method('insert') | ||
->with($share) | ||
->willReturn($shareWithId); | ||
|
||
$this->formsService->expects($this->once()) | ||
->method('getShareDisplayName') | ||
->with($shareWithId->read()) | ||
->willReturn($shareWith . ' DisplayName'); | ||
|
||
// Share Form '5' to 'user1' of share-type 'user=0' | ||
$expectedResponse = new DataResponse($expected); | ||
$this->assertEquals($expectedResponse, $this->shareApiController->newShare(5, $shareType, $shareWith)); | ||
} | ||
|
||
public function dataNewLinkShare() { | ||
return [ | ||
'newLinkShare' => [ | ||
'shareType' => IShare::TYPE_LINK, | ||
'shareWith' => '', | ||
'expected' => [ | ||
'id' => 13, | ||
'formId' => 5, | ||
'shareType' => 3, | ||
'shareWith' => 'abcdefgh', | ||
'displayName' => '' | ||
]], | ||
]; | ||
} | ||
/** | ||
* Test valid Link shares | ||
* @dataProvider dataNewLinkShare | ||
* | ||
* @param int $shareType | ||
* @param string $shareWith | ||
* @param array $expected | ||
*/ | ||
public function testNewLinkShare(int $shareType, string $shareWith, array $expected) { | ||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('currentUser'); | ||
|
||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->secureRandom->expects($this->any()) | ||
->method('generate') | ||
->willReturn('abcdefgh'); | ||
|
||
$share = new Share(); | ||
$share->setformId('5'); | ||
$share->setShareType($shareType); | ||
if ($shareWith === '') { | ||
$share->setShareWith('abcdefgh'); | ||
} else { | ||
$share->setShareWith($shareWith); | ||
} | ||
$shareWithId = clone $share; | ||
$shareWithId->setId(13); | ||
$this->shareMapper->expects($this->once()) | ||
->method('insert') | ||
->with($share) | ||
->willReturn($shareWithId); | ||
|
||
$this->formsService->expects($this->once()) | ||
->method('getShareDisplayName') | ||
->with($shareWithId->read()) | ||
->willReturn(''); | ||
|
||
$this->shareMapper->expects($this->once()) | ||
->method('findPublicShareByHash') | ||
->will($this->throwException(new DoesNotExistException('Not found.'))); | ||
|
||
// Share the form. | ||
$expectedResponse = new DataResponse($expected); | ||
$this->assertEquals($expectedResponse, $this->shareApiController->newShare(5, $shareType, $shareWith)); | ||
} | ||
|
||
/** | ||
* Test a random link hash, that is already existing. | ||
*/ | ||
public function testExistingLinkHash() { | ||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('currentUser'); | ||
|
||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->secureRandom->expects($this->any()) | ||
->method('generate') | ||
->willReturn('abcdefgh'); | ||
|
||
$this->shareMapper->expects($this->once()) | ||
->method('findPublicShareByHash') | ||
->with('abcdefgh') | ||
->willReturn(new Share()); | ||
|
||
$this->shareMapper->expects($this->never()) | ||
->method('insert'); | ||
|
||
$this->expectException(OCSException::class); | ||
$this->shareApiController->newShare(5, IShare::TYPE_LINK, ''); | ||
} | ||
|
||
/** | ||
* Test an unused (but existing) Share-Type | ||
*/ | ||
public function testBadShareType() { | ||
$this->expectException(OCSBadRequestException::class); | ||
|
||
// Share Form '5' to 'user1' of share-type 'deck_user=13' | ||
$this->shareApiController->newShare(5, 13, 'user1'); | ||
} | ||
|
||
/** | ||
* Sharing a non-existing form. | ||
*/ | ||
public function testShareUnknownForm() { | ||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->will($this->throwException(new DoesNotExistException('Form not found'))); | ||
; | ||
|
||
$this->expectException(OCSBadRequestException::class); | ||
$this->shareApiController->newShare(5, 0, 'user1'); | ||
} | ||
|
||
/** | ||
* Share form of other owner | ||
*/ | ||
public function testShareForeignForm() { | ||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('someOtherUser'); | ||
|
||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->expectException(OCSForbiddenException::class); | ||
$this->shareApiController->newShare(5, 0, 'user1'); | ||
} | ||
|
||
/** | ||
* Delete a share. | ||
*/ | ||
public function testDeleteShare() { | ||
$share = new Share(); | ||
$share->setId(8); | ||
$share->setFormId(5); | ||
$this->shareMapper->expects($this->once()) | ||
->method('findById') | ||
->with('8') | ||
->willReturn($share); | ||
|
||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('currentUser'); | ||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->shareMapper->expects($this->once()) | ||
->method('deleteById') | ||
->with('8'); | ||
|
||
$response = new DataResponse(8); | ||
$this->assertEquals($response, $this->shareApiController->deleteShare(8)); | ||
} | ||
|
||
/** | ||
* Delete Non-existing share. | ||
*/ | ||
public function testDeleteUnknownShare() { | ||
$this->shareMapper->expects($this->once()) | ||
->method('findById') | ||
->with('8') | ||
->will($this->throwException(new DoesNotExistException('Share not found'))); | ||
; | ||
|
||
$this->expectException(OCSBadRequestException::class); | ||
$this->shareApiController->deleteShare(8); | ||
} | ||
|
||
/** | ||
* Delete share from form of other owner. | ||
*/ | ||
public function testDeleteForeignShare() { | ||
$share = new Share(); | ||
$share->setId(8); | ||
$share->setFormId(5); | ||
$this->shareMapper->expects($this->once()) | ||
->method('findById') | ||
->with('8') | ||
->willReturn($share); | ||
|
||
$form = new Form(); | ||
$form->setId('5'); | ||
$form->setOwnerId('someOtherUser'); | ||
$this->formMapper->expects($this->once()) | ||
->method('findById') | ||
->with('5') | ||
->willReturn($form); | ||
|
||
$this->expectException(OCSForbiddenException::class); | ||
$this->shareApiController->deleteShare(8); | ||
} | ||
} |
Oops, something went wrong.