Merge pull request #8865 from nextcloud/ocs-groups-displayname

Return groups displayname in provisioning api

3 files changed, 59 insertions, 0 deletions

diff --git a/apps/provisioning_api/appinfo/routes.php b/apps/provisioning_api/appinfo/routes.php
index 791267a97a1..c2bbd8025ee 100644
--- a/apps/provisioning_api/appinfo/routes.php
+++ b/apps/provisioning_api/appinfo/routes.php
@@ -34,6 +34,7 @@ return [
 
 		// Groups
 		['root' => '/cloud', 'name' => 'Groups#getGroups', 'url' => '/groups', 'verb' => 'GET'],
+		['root' => '/cloud', 'name' => 'Groups#getGroupsDetails', 'url' => '/groups/details', 'verb' => 'GET'],
 		['root' => '/cloud', 'name' => 'Groups#getGroup', 'url' => '/groups/{groupId}', 'verb' => 'GET'],
 		['root' => '/cloud', 'name' => 'Groups#addGroup', 'url' => '/groups', 'verb' => 'POST'],
 		['root' => '/cloud', 'name' => 'Groups#deleteGroup', 'url' => '/groups/{groupId}', 'verb' => 'DELETE'],
diff --git a/apps/provisioning_api/lib/Controller/GroupsController.php b/apps/provisioning_api/lib/Controller/GroupsController.php
index 8aed50bf049..d6f2d9f3391 100644
--- a/apps/provisioning_api/lib/Controller/GroupsController.php
+++ b/apps/provisioning_api/lib/Controller/GroupsController.php
@@ -97,6 +97,33 @@ class GroupsController extends OCSController {
 	}
 
 	/**
+	 * returns a list of groups details with ids and displaynames
+	 *
+	 * @NoAdminRequired
+	 *
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return DataResponse
+	 */
+	public function getGroupsDetails(string $search = '', $limit = null, $offset = null): DataResponse {
+		if ($limit !== null) {
+			$limit = (int)$limit;
+		}
+		if ($offset !== null) {
+			$offset = (int)$offset;
+		}
+
+		$groups = $this->groupManager->search($search, $limit, $offset);
+		$groups = array_map(function($group) {
+			/** @var IGroup $group */
+			return ['id' => $group->getGID(), 'displayname' => $group->getDisplayName()];
+		}, $groups);
+
+		return new DataResponse(['groups' => $groups]);
+	}
+
+	/**
 	 * returns an array of users in the group specified
 	 *
 	 * @NoAdminRequired
diff --git a/apps/provisioning_api/tests/Controller/GroupsControllerTest.php b/apps/provisioning_api/tests/Controller/GroupsControllerTest.php
index cd3dae79336..352264c7afb 100644
--- a/apps/provisioning_api/tests/Controller/GroupsControllerTest.php
+++ b/apps/provisioning_api/tests/Controller/GroupsControllerTest.php
@@ -85,6 +85,10 @@ class GroupsControllerTest extends \Test\TestCase {
 		$group
 			->method('getGID')
 			->willReturn($gid);
+		$group
+			->method('getDisplayName')
+			->willReturn($gid.'-name');
+
 		return $group;
 	}
 
@@ -165,6 +169,33 @@ class GroupsControllerTest extends \Test\TestCase {
 
 		$result = $this->api->getGroups($search, $limit, $offset);
 		$this->assertEquals(['groups' => ['group1', 'group2']], $result->getData());
+
+	}
+
+	/**
+	 * @dataProvider dataGetGroups
+	 *
+	 * @param string|null $search
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 */
+	public function testGetGroupsDetails($search, $limit, $offset) {
+		$groups = [$this->createGroup('group1'), $this->createGroup('group2')];
+
+		$search = $search === null ? '' : $search;
+
+		$this->groupManager
+			->expects($this->once())
+			->method('search')
+			->with($search, $limit, $offset)
+			->willReturn($groups);
+
+		$result = $this->api->getGroupsDetails($search, $limit, $offset);
+		$this->assertEquals(['groups' => [
+			Array('id' => 'group1', 'displayname' => 'group1-name'), 
+			Array('id' => 'group2', 'displayname' => 'group2-name')
+		]], $result->getData());
+
 	}
 
 	public function testGetGroupAsSubadmin() {