660 lines
17 KiB
PHP
660 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
*
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
|
*
|
|
* @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 Test\Collaboration\Collaborators;
|
|
|
|
use OC\Collaboration\Collaborators\SearchResult;
|
|
use OC\Collaboration\Collaborators\UserPlugin;
|
|
use OCP\Collaboration\Collaborators\ISearchResult;
|
|
use OCP\IConfig;
|
|
use OCP\IGroup;
|
|
use OCP\IGroupManager;
|
|
use OCP\IUser;
|
|
use OCP\IUserManager;
|
|
use OCP\IUserSession;
|
|
use OCP\Share\IShare;
|
|
use OCP\UserStatus\IManager as IUserStatusManager;
|
|
use Test\TestCase;
|
|
|
|
class UserPluginTest extends TestCase {
|
|
/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $config;
|
|
|
|
/** @var IUserManager|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $userManager;
|
|
|
|
/** @var IGroupManager|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $groupManager;
|
|
|
|
/** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $session;
|
|
|
|
/** @var IUserStatusManager|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $userStatusManager;
|
|
|
|
/** @var UserPlugin */
|
|
protected $plugin;
|
|
|
|
/** @var ISearchResult */
|
|
protected $searchResult;
|
|
|
|
/** @var int */
|
|
protected $limit = 2;
|
|
|
|
/** @var int */
|
|
protected $offset = 0;
|
|
|
|
/** @var IUser|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $user;
|
|
|
|
protected function setUp(): void {
|
|
parent::setUp();
|
|
|
|
$this->config = $this->createMock(IConfig::class);
|
|
|
|
$this->userManager = $this->createMock(IUserManager::class);
|
|
|
|
$this->groupManager = $this->createMock(IGroupManager::class);
|
|
|
|
$this->session = $this->createMock(IUserSession::class);
|
|
|
|
$this->userStatusManager = $this->createMock(IUserStatusManager::class);
|
|
|
|
$this->searchResult = new SearchResult();
|
|
|
|
$this->user = $this->getUserMock('admin', 'Administrator');
|
|
}
|
|
|
|
public function instantiatePlugin() {
|
|
// cannot be done within setUp, because dependent mocks needs to be set
|
|
// up with configuration etc. first
|
|
$this->plugin = new UserPlugin(
|
|
$this->config,
|
|
$this->userManager,
|
|
$this->groupManager,
|
|
$this->session,
|
|
$this->userStatusManager
|
|
);
|
|
}
|
|
|
|
public function mockConfig($shareWithGroupOnly, $shareeEnumeration, $shareeEnumerationLimitToGroup) {
|
|
$this->config->expects($this->any())
|
|
->method('getAppValue')
|
|
->willReturnCallback(
|
|
function ($appName, $key, $default) use ($shareWithGroupOnly, $shareeEnumeration, $shareeEnumerationLimitToGroup) {
|
|
if ($appName === 'core' && $key === 'shareapi_only_share_with_group_members') {
|
|
return $shareWithGroupOnly ? 'yes' : 'no';
|
|
} elseif ($appName === 'core' && $key === 'shareapi_allow_share_dialog_user_enumeration') {
|
|
return $shareeEnumeration ? 'yes' : 'no';
|
|
} elseif ($appName === 'core' && $key === 'shareapi_restrict_user_enumeration_to_group') {
|
|
return $shareeEnumerationLimitToGroup ? 'yes' : 'no';
|
|
}
|
|
return $default;
|
|
}
|
|
);
|
|
}
|
|
|
|
public function getUserMock($uid, $displayName, $enabled = true, $groups = []) {
|
|
$user = $this->createMock(IUser::class);
|
|
|
|
$user->expects($this->any())
|
|
->method('getUID')
|
|
->willReturn($uid);
|
|
|
|
$user->expects($this->any())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
$user->expects($this->any())
|
|
->method('isEnabled')
|
|
->willReturn($enabled);
|
|
|
|
return $user;
|
|
}
|
|
|
|
public function getGroupMock($gid) {
|
|
$group = $this->createMock(IGroup::class);
|
|
|
|
$group->expects($this->any())
|
|
->method('getGID')
|
|
->willReturn($gid);
|
|
|
|
return $group;
|
|
}
|
|
|
|
public function dataGetUsers() {
|
|
return [
|
|
['test', false, true, [], [], [], [], true, false],
|
|
['test', false, false, [], [], [], [], true, false],
|
|
['test', true, true, [], [], [], [], true, false],
|
|
['test', true, false, [], [], [], [], true, false],
|
|
[
|
|
'test', false, true, [], [],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test', false, false, [], [],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test', true, true, [], [],
|
|
[], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test', true, false, [], [],
|
|
[], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test', true, true, ['test-group'], [['test-group', 'test', 2, 0, []]],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test', true, false, ['test-group'], [['test-group', 'test', 2, 0, []]],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
], [], true, $this->getUserMock('test', 'Test'),
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
true,
|
|
[],
|
|
[
|
|
$this->getUserMock('test1', 'Test One'),
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test1'], 'status' => [], 'shareWithDisplayNameUnique' => 'test1'],
|
|
],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
false,
|
|
[],
|
|
[
|
|
$this->getUserMock('test1', 'Test One'),
|
|
],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
true,
|
|
[],
|
|
[
|
|
$this->getUserMock('test1', 'Test One'),
|
|
$this->getUserMock('test2', 'Test Two'),
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test1'], 'status' => [], 'shareWithDisplayNameUnique' => 'test1'],
|
|
['label' => 'Test Two', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test2'], 'status' => [], 'shareWithDisplayNameUnique' => 'test2'],
|
|
],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
false,
|
|
[],
|
|
[
|
|
$this->getUserMock('test1', 'Test One'),
|
|
$this->getUserMock('test2', 'Test Two'),
|
|
],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
true,
|
|
[],
|
|
[
|
|
$this->getUserMock('test0', 'Test'),
|
|
$this->getUserMock('test1', 'Test One'),
|
|
$this->getUserMock('test2', 'Test Two'),
|
|
],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test0'], 'status' => [], 'shareWithDisplayNameUnique' => 'test0'],
|
|
],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test1'], 'status' => [], 'shareWithDisplayNameUnique' => 'test1'],
|
|
['label' => 'Test Two', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test2'], 'status' => [], 'shareWithDisplayNameUnique' => 'test2'],
|
|
],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
false,
|
|
false,
|
|
[],
|
|
[
|
|
$this->getUserMock('test0', 'Test'),
|
|
$this->getUserMock('test1', 'Test One'),
|
|
$this->getUserMock('test2', 'Test Two'),
|
|
],
|
|
[
|
|
['label' => 'Test', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test0'], 'status' => [], 'shareWithDisplayNameUnique' => 'test0'],
|
|
],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
true,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, ['test1' => 'Test One']],
|
|
['xyz', 'test', 2, 0, []],
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test1'], 'status' => [], 'shareWithDisplayNameUnique' => 'test1'],
|
|
],
|
|
true,
|
|
false,
|
|
[['test1', $this->getUserMock('test1', 'Test One')]],
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
false,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, ['test1' => 'Test One']],
|
|
['xyz', 'test', 2, 0, []],
|
|
],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
[['test1', $this->getUserMock('test1', 'Test One')]],
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
true,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, [
|
|
'test1' => 'Test One',
|
|
'test2' => 'Test Two',
|
|
]],
|
|
['xyz', 'test', 2, 0, [
|
|
'test1' => 'Test One',
|
|
'test2' => 'Test Two',
|
|
]],
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test1'], 'status' => [], 'shareWithDisplayNameUnique' => 'test1'],
|
|
['label' => 'Test Two', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test2'], 'status' => [], 'shareWithDisplayNameUnique' => 'test2'],
|
|
],
|
|
true,
|
|
false,
|
|
[
|
|
['test1', $this->getUserMock('test1', 'Test One')],
|
|
['test2', $this->getUserMock('test2', 'Test Two')],
|
|
],
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
false,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, [
|
|
'test1' => 'Test One',
|
|
'test2' => 'Test Two',
|
|
]],
|
|
['xyz', 'test', 2, 0, [
|
|
'test1' => 'Test One',
|
|
'test2' => 'Test Two',
|
|
]],
|
|
],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
[
|
|
['test1', $this->getUserMock('test1', 'Test One')],
|
|
['test2', $this->getUserMock('test2', 'Test Two')],
|
|
],
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
true,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, [
|
|
'test' => 'Test One',
|
|
]],
|
|
['xyz', 'test', 2, 0, [
|
|
'test2' => 'Test Two',
|
|
]],
|
|
],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
],
|
|
[
|
|
['label' => 'Test Two', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test2'], 'status' => [], 'shareWithDisplayNameUnique' => 'test2'],
|
|
],
|
|
false,
|
|
false,
|
|
[
|
|
['test', $this->getUserMock('test', 'Test One')],
|
|
['test2', $this->getUserMock('test2', 'Test Two')],
|
|
],
|
|
],
|
|
[
|
|
'test',
|
|
true,
|
|
false,
|
|
['abc', 'xyz'],
|
|
[
|
|
['abc', 'test', 2, 0, [
|
|
'test' => 'Test One',
|
|
]],
|
|
['xyz', 'test', 2, 0, [
|
|
'test2' => 'Test Two',
|
|
]],
|
|
],
|
|
[
|
|
['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_USER, 'shareWith' => 'test'], 'status' => [], 'shareWithDisplayNameUnique' => 'test'],
|
|
],
|
|
[],
|
|
true,
|
|
false,
|
|
[
|
|
['test', $this->getUserMock('test', 'Test One')],
|
|
['test2', $this->getUserMock('test2', 'Test Two')],
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataGetUsers
|
|
*
|
|
* @param string $searchTerm
|
|
* @param bool $shareWithGroupOnly
|
|
* @param bool $shareeEnumeration
|
|
* @param array $groupResponse
|
|
* @param array $userResponse
|
|
* @param array $exactExpected
|
|
* @param array $expected
|
|
* @param bool $reachedEnd
|
|
* @param bool|IUser $singleUser
|
|
* @param array $users
|
|
*/
|
|
public function testSearch(
|
|
$searchTerm,
|
|
$shareWithGroupOnly,
|
|
$shareeEnumeration,
|
|
array $groupResponse,
|
|
array $userResponse,
|
|
array $exactExpected,
|
|
array $expected,
|
|
$reachedEnd,
|
|
$singleUser,
|
|
array $users = []
|
|
) {
|
|
$this->mockConfig($shareWithGroupOnly, $shareeEnumeration, false);
|
|
$this->instantiatePlugin();
|
|
|
|
$this->session->expects($this->any())
|
|
->method('getUser')
|
|
->willReturn($this->user);
|
|
|
|
if (!$shareWithGroupOnly) {
|
|
$this->userManager->expects($this->once())
|
|
->method('searchDisplayName')
|
|
->with($searchTerm, $this->limit, $this->offset)
|
|
->willReturn($userResponse);
|
|
} else {
|
|
$this->groupManager->method('getUserGroupIds')
|
|
->with($this->user)
|
|
->willReturn($groupResponse);
|
|
|
|
if ($singleUser !== false) {
|
|
$this->groupManager->method('getUserGroupIds')
|
|
->with($singleUser)
|
|
->willReturn($groupResponse);
|
|
}
|
|
|
|
$this->groupManager->method('displayNamesInGroup')
|
|
->willReturnMap($userResponse);
|
|
}
|
|
|
|
if ($singleUser !== false) {
|
|
$users[] = [$searchTerm, $singleUser];
|
|
}
|
|
|
|
if (!empty($users)) {
|
|
$this->userManager->expects($this->atLeastOnce())
|
|
->method('get')
|
|
->willReturnMap($users);
|
|
}
|
|
|
|
$moreResults = $this->plugin->search($searchTerm, $this->limit, $this->offset, $this->searchResult);
|
|
$result = $this->searchResult->asArray();
|
|
|
|
$this->assertEquals($exactExpected, $result['exact']['users']);
|
|
$this->assertEquals($expected, $result['users']);
|
|
$this->assertSame($reachedEnd, $moreResults);
|
|
}
|
|
|
|
public function takeOutCurrentUserProvider() {
|
|
$inputUsers = [
|
|
'alice' => 'Alice',
|
|
'bob' => 'Bob',
|
|
'carol' => 'Carol',
|
|
];
|
|
return [
|
|
[
|
|
$inputUsers,
|
|
['alice', 'carol'],
|
|
'bob',
|
|
],
|
|
[
|
|
$inputUsers,
|
|
['alice', 'bob', 'carol'],
|
|
'dave',
|
|
],
|
|
[
|
|
$inputUsers,
|
|
['alice', 'bob', 'carol'],
|
|
null,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider takeOutCurrentUserProvider
|
|
* @param array $users
|
|
* @param array $expectedUIDs
|
|
* @param $currentUserId
|
|
*/
|
|
public function testTakeOutCurrentUser(array $users, array $expectedUIDs, $currentUserId) {
|
|
$this->instantiatePlugin();
|
|
|
|
$this->session->expects($this->once())
|
|
->method('getUser')
|
|
->willReturnCallback(function () use ($currentUserId) {
|
|
if ($currentUserId !== null) {
|
|
return $this->getUserMock($currentUserId, $currentUserId);
|
|
}
|
|
return null;
|
|
});
|
|
|
|
$this->plugin->takeOutCurrentUser($users);
|
|
$this->assertSame($expectedUIDs, array_keys($users));
|
|
}
|
|
|
|
public function dataSearchEnumeration() {
|
|
return [
|
|
[
|
|
'test',
|
|
['groupA'],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA']],
|
|
['uid' => 'test2', 'groups' => ['groupB']],
|
|
],
|
|
['exact' => [], 'wide' => ['test1']],
|
|
],
|
|
[
|
|
'test1',
|
|
['groupA'],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA']],
|
|
['uid' => 'test2', 'groups' => ['groupB']],
|
|
],
|
|
['exact' => ['test1'], 'wide' => []],
|
|
],
|
|
[
|
|
'test',
|
|
['groupA'],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA']],
|
|
['uid' => 'test2', 'groups' => ['groupB', 'groupA']],
|
|
],
|
|
['exact' => [], 'wide' => ['test1', 'test2']],
|
|
],
|
|
[
|
|
'test',
|
|
['groupA'],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA', 'groupC']],
|
|
['uid' => 'test2', 'groups' => ['groupB', 'groupA']],
|
|
],
|
|
['exact' => [], 'wide' => ['test1', 'test2']],
|
|
],
|
|
[
|
|
'test',
|
|
['groupC', 'groupB'],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA', 'groupC']],
|
|
['uid' => 'test2', 'groups' => ['groupB', 'groupA']],
|
|
],
|
|
['exact' => [], 'wide' => ['test1', 'test2']],
|
|
],
|
|
[
|
|
'test',
|
|
[],
|
|
[
|
|
['uid' => 'test1', 'groups' => ['groupA']],
|
|
['uid' => 'test2', 'groups' => ['groupB', 'groupA']],
|
|
],
|
|
['exact' => [], 'wide' => []],
|
|
],
|
|
[
|
|
'test',
|
|
['groupC', 'groupB'],
|
|
[
|
|
['uid' => 'test1', 'groups' => []],
|
|
['uid' => 'test2', 'groups' => []],
|
|
],
|
|
['exact' => [], 'wide' => []],
|
|
],
|
|
[
|
|
'test',
|
|
['groupC', 'groupB'],
|
|
[
|
|
['uid' => 'test1', 'groups' => []],
|
|
['uid' => 'test2', 'groups' => []],
|
|
],
|
|
['exact' => [], 'wide' => []],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataSearchEnumeration
|
|
*/
|
|
public function testSearchEnumerationLimit($search, $userGroups, $matchingUsers, $result) {
|
|
$this->mockConfig(false, true, true);
|
|
|
|
$userResults = array_map(function ($user) {
|
|
return $this->getUserMock($user['uid'], $user['uid']);
|
|
}, $matchingUsers);
|
|
|
|
$mappedResultExact = array_map(function ($user) {
|
|
return ['label' => $user, 'value' => ['shareType' => 0, 'shareWith' => $user], 'status' => [], 'shareWithDisplayNameUnique' => $user];
|
|
}, $result['exact']);
|
|
$mappedResultWide = array_map(function ($user) {
|
|
return ['label' => $user, 'value' => ['shareType' => 0, 'shareWith' => $user], 'status' => [], 'shareWithDisplayNameUnique' => $user];
|
|
}, $result['wide']);
|
|
|
|
$this->userManager->expects($this->once())
|
|
->method('searchDisplayName')
|
|
->willReturn($userResults);
|
|
$this->session->expects($this->any())
|
|
->method('getUser')
|
|
->willReturn($this->getUserMock('test', 'foo'));
|
|
// current user
|
|
$this->groupManager->expects($this->at(0))
|
|
->method('getUserGroupIds')
|
|
->willReturn($userGroups);
|
|
$this->groupManager->expects($this->any())
|
|
->method('getUserGroupIds')
|
|
->willReturnCallback(function ($user) use ($matchingUsers) {
|
|
$neededObject = array_filter(
|
|
$matchingUsers,
|
|
function ($e) use ($user) {
|
|
return $user->getUID() === $e['uid'];
|
|
}
|
|
);
|
|
if (count($neededObject) > 0) {
|
|
return array_shift($neededObject)['groups'];
|
|
}
|
|
return [];
|
|
});
|
|
|
|
$this->instantiatePlugin();
|
|
$this->plugin->search($search, $this->limit, $this->offset, $this->searchResult);
|
|
$result = $this->searchResult->asArray();
|
|
|
|
$this->assertEquals($mappedResultExact, $result['exact']['users']);
|
|
$this->assertEquals($mappedResultWide, $result['users']);
|
|
}
|
|
}
|