split off getGroups unit tests

Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>

1 files changed, 491 insertions, 0 deletions

diff --git a/tests/lib/Collaboration/Collaborators/GroupPluginTest.php b/tests/lib/Collaboration/Collaborators/GroupPluginTest.php
new file mode 100644
index 00000000000..9849bdb874a
--- /dev/null
+++ b/tests/lib/Collaboration/Collaborators/GroupPluginTest.php
@@ -0,0 +1,491 @@
+<?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\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;
+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;
+
+	public function setUp() {
+		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
+	 * @return IGroup|\PHPUnit_Framework_MockObject_MockObject
+	 */
+	protected function getGroupMock($gid, $displayName = null) {
+		$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);
+
+		return $group;
+	}
+
+	public function dataGetGroups() {
+		return [
+			['test', false, true, [], [], [], [], true, false],
+			['test', false, false, [], [], [], [], true, false],
+			// group without display name
+			[
+				'test', false, true,
+				[$this->getGroupMock('test1')],
+				[],
+				[],
+				[['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				true,
+				false,
+			],
+			// group with display name, search by id
+			[
+				'test', false, true,
+				[$this->getGroupMock('test1', 'Test One')],
+				[],
+				[],
+				[['label' => 'Test One', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				true,
+				false,
+			],
+			// group with display name, search by display name
+			[
+				'one', false, true,
+				[$this->getGroupMock('test1', 'Test One')],
+				[],
+				[],
+				[['label' => 'Test One', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				true,
+				false,
+			],
+			// group with display name, search by display name, exact expected
+			[
+				'Test One', false, true,
+				[$this->getGroupMock('test1', 'Test One')],
+				[],
+				[['label' => 'Test One', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', false, false,
+				[$this->getGroupMock('test1')],
+				[],
+				[],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', false, true,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				false,
+				false,
+			],
+			[
+				'test', false, false,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', false, true,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[],
+				[
+					['label' => 'test0', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test0']],
+					['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']],
+				],
+				false,
+				null,
+			],
+			[
+				'test', false, false,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[],
+				[],
+				true,
+				null,
+			],
+			[
+				'test', false, true,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[
+					['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']],
+				],
+				[
+					['label' => 'test0', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test0']],
+					['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']],
+				],
+				false,
+				$this->getGroupMock('test'),
+			],
+			[
+				'test', false, false,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[],
+				[
+					['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']],
+				],
+				[],
+				true,
+				$this->getGroupMock('test'),
+			],
+			['test', true, true, [], [], [], [], true, false],
+			['test', true, false, [], [], [], [], true, false],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test1'),
+					$this->getGroupMock('test2'),
+				],
+				[$this->getGroupMock('test1')],
+				[],
+				[['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				false,
+				false,
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test1'),
+					$this->getGroupMock('test2'),
+				],
+				[$this->getGroupMock('test1')],
+				[],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test')],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[],
+				false,
+				false,
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test')],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test1')],
+				[],
+				[['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				false,
+				false,
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test1')],
+				[],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']]],
+				false,
+				false,
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']]],
+				[],
+				true,
+				false,
+			],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[],
+				[
+					['label' => 'test0', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test0']],
+					['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']],
+				],
+				false,
+				null,
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[],
+				[],
+				true,
+				null,
+			],
+			[
+				'test', true, true,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[
+					['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']],
+				],
+				[
+					['label' => 'test0', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test0']],
+					['label' => 'test1', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test1']],
+				],
+				false,
+				$this->getGroupMock('test'),
+			],
+			[
+				'test', true, false,
+				[
+					$this->getGroupMock('test0'),
+					$this->getGroupMock('test1'),
+				],
+				[$this->getGroupMock('test'), $this->getGroupMock('test0'), $this->getGroupMock('test1')],
+				[
+					['label' => 'test', 'value' => ['shareType' => Share::SHARE_TYPE_GROUP, 'shareWith' => 'test']],
+				],
+				[],
+				true,
+				$this->getGroupMock('test'),
+			],
+		];
+	}
+
+	/**
+	 * @dataProvider dataGetGroups
+	 *
+	 * @param string $searchTerm
+	 * @param bool $shareWithGroupOnly
+	 * @param bool $shareeEnumeration
+	 * @param array $groupResponse
+	 * @param array $userGroupsResponse
+	 * @param array $exactExpected
+	 * @param array $expected
+	 * @param bool $reachedEnd
+	 * @param bool|IGroup $singleGroup
+	 */
+	public function testSearch(
+		$searchTerm,
+		$shareWithGroupOnly,
+		$shareeEnumeration,
+		array $groupResponse,
+		array $userGroupsResponse,
+		array $exactExpected,
+		array $expected,
+		$reachedEnd,
+		$singleGroup
+	) {
+		$this->config->expects($this->any())
+			->method('getAppValue')
+			->willReturnCallback(
+				function($appName, $key, $default)
+				use ($shareWithGroupOnly, $shareeEnumeration)
+				{
+					if ($appName === 'core' && $key === 'shareapi_only_share_with_group_members') {
+						return $shareWithGroupOnly ? 'yes' : 'no';
+					} else if ($appName === 'core' && $key === 'shareapi_allow_share_dialog_user_enumeration') {
+						return $shareeEnumeration ? 'yes' : 'no';
+					}
+					return $default;
+				}
+			);
+
+		$this->instantiatePlugin();
+
+		$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();
+
+		$this->assertEquals($exactExpected, $result['exact']['groups']);
+		$this->assertEquals($expected, $result['groups']);
+		$this->assertSame($reachedEnd, $moreResults);
+	}
+}