mirror of
https://github.com/nextcloud/server.git
synced 2024-12-29 16:38:28 +00:00
503 lines
12 KiB
PHP
503 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace Test\Collaboration\Collaborators;
|
|
|
|
use OC\Collaboration\Collaborators\GroupPlugin;
|
|
use OC\Collaboration\Collaborators\SearchResult;
|
|
use OCP\Collaboration\Collaborators\ISearchResult;
|
|
use OCP\IConfig;
|
|
use OCP\IGroup;
|
|
use OCP\IGroupManager;
|
|
use OCP\IUser;
|
|
use OCP\IUserSession;
|
|
use OCP\Share\IShare;
|
|
use Test\TestCase;
|
|
|
|
class GroupPluginTest extends TestCase {
|
|
/** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $config;
|
|
|
|
/** @var IGroupManager|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $groupManager;
|
|
|
|
/** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */
|
|
protected $session;
|
|
|
|
/** @var ISearchResult */
|
|
protected $searchResult;
|
|
|
|
/** @var GroupPlugin */
|
|
protected $plugin;
|
|
|
|
/** @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->groupManager = $this->createMock(IGroupManager::class);
|
|
|
|
$this->session = $this->createMock(IUserSession::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 GroupPlugin(
|
|
$this->config,
|
|
$this->groupManager,
|
|
$this->session
|
|
);
|
|
}
|
|
|
|
public function getUserMock($uid, $displayName) {
|
|
$user = $this->createMock(IUser::class);
|
|
|
|
$user->expects($this->any())
|
|
->method('getUID')
|
|
->willReturn($uid);
|
|
|
|
$user->expects($this->any())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
return $user;
|
|
}
|
|
|
|
/**
|
|
* @param string $gid
|
|
* @param null $displayName
|
|
* @param bool $hide
|
|
* @return IGroup|\PHPUnit\Framework\MockObject\MockObject
|
|
*/
|
|
protected function getGroupMock($gid, $displayName = null, $hide = false) {
|
|
$group = $this->createMock(IGroup::class);
|
|
|
|
$group->expects($this->any())
|
|
->method('getGID')
|
|
->willReturn($gid);
|
|
|
|
if (is_null($displayName)) {
|
|
// note: this is how the Group class behaves
|
|
$displayName = $gid;
|
|
}
|
|
|
|
$group->expects($this->any())
|
|
->method('getDisplayName')
|
|
->willReturn($displayName);
|
|
|
|
$group->method('hideFromCollaboration')
|
|
->willReturn($hide);
|
|
|
|
return $group;
|
|
}
|
|
|
|
public function dataGetGroups(): array {
|
|
return [
|
|
['test', false, true, false, [], [], [], [], true, false],
|
|
['test', false, false, false, [], [], [], [], true, false],
|
|
// group sharing disabled
|
|
['test', false, true, true, [], [], [], [], false, false],
|
|
// group without display name
|
|
[
|
|
'test', false, true, false,
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[],
|
|
[['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
true,
|
|
false,
|
|
],
|
|
// group with display name, search by id
|
|
[
|
|
'test', false, true, false,
|
|
[$this->getGroupMock('test1', 'Test One')],
|
|
[],
|
|
[],
|
|
[['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
true,
|
|
false,
|
|
],
|
|
// group with display name, search by display name
|
|
[
|
|
'one', false, true, false,
|
|
[$this->getGroupMock('test1', 'Test One')],
|
|
[],
|
|
[],
|
|
[['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
true,
|
|
false,
|
|
],
|
|
// group with display name, search by display name, exact expected
|
|
[
|
|
'Test One', false, true, false,
|
|
[$this->getGroupMock('test1', 'Test One')],
|
|
[],
|
|
[['label' => 'Test One', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', false, false, false,
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', false, true, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test', false, false, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', false, true, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[],
|
|
[
|
|
['label' => 'test0', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test0']],
|
|
['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']],
|
|
],
|
|
false,
|
|
null,
|
|
],
|
|
[
|
|
'test', false, false, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[],
|
|
[],
|
|
true,
|
|
null,
|
|
],
|
|
[
|
|
'test', false, true, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']],
|
|
],
|
|
[
|
|
['label' => 'test0', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test0']],
|
|
['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']],
|
|
],
|
|
false,
|
|
$this->getGroupMock('test'),
|
|
],
|
|
[
|
|
'test', false, false, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[
|
|
['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']],
|
|
],
|
|
[],
|
|
true,
|
|
$this->getGroupMock('test'),
|
|
],
|
|
['test', true, true, false, [], [], [], [], true, false],
|
|
['test', true, false, false, [], [], [], [], true, false],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test1'),
|
|
$this->getGroupMock('test2'),
|
|
],
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test1'),
|
|
$this->getGroupMock('test2'),
|
|
],
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test')],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test')],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test1')],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']]],
|
|
false,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']]],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[],
|
|
[
|
|
['label' => 'test0', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test0']],
|
|
['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']],
|
|
],
|
|
false,
|
|
null,
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[],
|
|
[],
|
|
true,
|
|
null,
|
|
],
|
|
[
|
|
'test', true, true, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[
|
|
['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']],
|
|
],
|
|
[
|
|
['label' => 'test0', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test0']],
|
|
['label' => 'test1', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test1']],
|
|
],
|
|
false,
|
|
$this->getGroupMock('test'),
|
|
],
|
|
[
|
|
'test', true, false, false,
|
|
[
|
|
$this->getGroupMock('test0'),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
|
|
[
|
|
['label' => 'test', 'value' => ['shareType' => IShare::TYPE_GROUP, 'shareWith' => 'test']],
|
|
],
|
|
[],
|
|
true,
|
|
$this->getGroupMock('test'),
|
|
],
|
|
[
|
|
'test', false, false, false,
|
|
[
|
|
$this->getGroupMock('test', null, true),
|
|
$this->getGroupMock('test1'),
|
|
],
|
|
[],
|
|
[],
|
|
[],
|
|
true,
|
|
false,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataGetGroups
|
|
*
|
|
* @param string $searchTerm
|
|
* @param bool $shareWithGroupOnly
|
|
* @param bool $shareeEnumeration
|
|
* @param bool $groupSharingDisabled
|
|
* @param array $groupResponse
|
|
* @param array $userGroupsResponse
|
|
* @param array $exactExpected
|
|
* @param array $expected
|
|
* @param bool $reachedEnd
|
|
* @param bool|IGroup $singleGroup
|
|
*/
|
|
public function testSearch(
|
|
string $searchTerm,
|
|
bool $shareWithGroupOnly,
|
|
bool $shareeEnumeration,
|
|
bool $groupSharingDisabled,
|
|
array $groupResponse,
|
|
array $userGroupsResponse,
|
|
array $exactExpected,
|
|
array $expected,
|
|
bool $reachedEnd,
|
|
$singleGroup,
|
|
): void {
|
|
$this->config->expects($this->any())
|
|
->method('getAppValue')
|
|
->willReturnCallback(
|
|
function ($appName, $key, $default) use ($shareWithGroupOnly, $shareeEnumeration, $groupSharingDisabled) {
|
|
if ($appName !== 'core') {
|
|
return $default;
|
|
}
|
|
switch ($key) {
|
|
case 'shareapi_only_share_with_group_members':
|
|
return $shareWithGroupOnly ? 'yes' : 'no';
|
|
case 'shareapi_allow_share_dialog_user_enumeration':
|
|
return $shareeEnumeration ? 'yes' : 'no';
|
|
case 'shareapi_allow_group_sharing':
|
|
return $groupSharingDisabled ? 'no' : 'yes';
|
|
default:
|
|
return $default;
|
|
}
|
|
}
|
|
);
|
|
|
|
$this->instantiatePlugin();
|
|
|
|
if (!$groupSharingDisabled) {
|
|
$this->groupManager->expects($this->once())
|
|
->method('search')
|
|
->with($searchTerm, $this->limit, $this->offset)
|
|
->willReturn($groupResponse);
|
|
}
|
|
|
|
if ($singleGroup !== false) {
|
|
$this->groupManager->expects($this->once())
|
|
->method('get')
|
|
->with($searchTerm)
|
|
->willReturn($singleGroup);
|
|
}
|
|
|
|
if ($shareWithGroupOnly) {
|
|
$this->session->expects($this->any())
|
|
->method('getUser')
|
|
->willReturn($this->user);
|
|
|
|
$numGetUserGroupsCalls = empty($groupResponse) ? 0 : 1;
|
|
$this->groupManager->expects($this->exactly($numGetUserGroupsCalls))
|
|
->method('getUserGroups')
|
|
->with($this->user)
|
|
->willReturn($userGroupsResponse);
|
|
}
|
|
|
|
$moreResults = $this->plugin->search($searchTerm, $this->limit, $this->offset, $this->searchResult);
|
|
$result = $this->searchResult->asArray();
|
|
|
|
if (!$groupSharingDisabled) {
|
|
$this->assertEquals($exactExpected, $result['exact']['groups']);
|
|
$this->assertEquals($expected, $result['groups']);
|
|
}
|
|
$this->assertSame($reachedEnd, $moreResults);
|
|
}
|
|
}
|