diff options
Diffstat (limited to 'apps/provisioning_api/tests')
7 files changed, 2818 insertions, 1460 deletions
diff --git a/apps/provisioning_api/tests/CapabilitiesTest.php b/apps/provisioning_api/tests/CapabilitiesTest.php new file mode 100644 index 00000000000..86d2bb8c4fa --- /dev/null +++ b/apps/provisioning_api/tests/CapabilitiesTest.php @@ -0,0 +1,77 @@ +<?php + +declare(strict_types=1); +/** + * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OCA\Provisioning_API\Tests; + +use OCA\FederatedFileSharing\FederatedShareProvider; +use OCA\Provisioning_API\Capabilities; +use OCP\App\IAppManager; +use PHPUnit\Framework\MockObject\MockObject; +use Test\TestCase; + +/** + * Capabilities test for provisioning API. + * + * Note: group DB needed because of usage of overwriteService() + * + * @package OCA\Provisioning_API\Tests + * @group DB + */ +class CapabilitiesTest extends TestCase { + + protected IAppManager&MockObject $appManager; + protected Capabilities $capabilities; + + public function setUp(): void { + parent::setUp(); + $this->appManager = $this->createMock(IAppManager::class); + $this->capabilities = new Capabilities($this->appManager); + + $this->appManager->expects($this->once()) + ->method('getAppVersion') + ->with('provisioning_api') + ->willReturn('1.12'); + } + + public static function getCapabilitiesProvider(): array { + return [ + [true, false, false, true, false], + [true, true, false, true, false], + [true, true, true, true, true], + [false, false, false, false, false], + [false, true, false, false, false], + [false, true, true, false, true], + ]; + } + + #[\PHPUnit\Framework\Attributes\DataProvider('getCapabilitiesProvider')] + public function testGetCapabilities(bool $federationAppEnabled, bool $federatedFileSharingAppEnabled, bool $lookupServerEnabled, bool $expectedFederatedScopeEnabled, bool $expectedPublishedScopeEnabled): void { + $this->appManager->expects($this->any()) + ->method('isEnabledForUser') + ->willReturnMap([ + ['federation', null, $federationAppEnabled], + ['federatedfilesharing', null, $federatedFileSharingAppEnabled], + ]); + + $federatedShareProvider = $this->createMock(FederatedShareProvider::class); + $this->overwriteService(FederatedShareProvider::class, $federatedShareProvider); + + $federatedShareProvider->expects($this->any()) + ->method('isLookupServerUploadEnabled') + ->willReturn($lookupServerEnabled); + + $expected = [ + 'provisioning_api' => [ + 'version' => '1.12', + 'AccountPropertyScopesVersion' => 2, + 'AccountPropertyScopesFederatedEnabled' => $expectedFederatedScopeEnabled, + 'AccountPropertyScopesPublishedEnabled' => $expectedPublishedScopeEnabled, + ], + ]; + $this->assertSame($expected, $this->capabilities->getCapabilities()); + } +} diff --git a/apps/provisioning_api/tests/Controller/AppConfigControllerTest.php b/apps/provisioning_api/tests/Controller/AppConfigControllerTest.php index 7f24ef5bcb3..1b09838cbc3 100644 --- a/apps/provisioning_api/tests/Controller/AppConfigControllerTest.php +++ b/apps/provisioning_api/tests/Controller/AppConfigControllerTest.php @@ -1,36 +1,30 @@ <?php + +declare(strict_types=1); /** - * @copyright Copyright (c) 2016 Joas Schilling <coding@schilljs.com> - * - * @author Joas Schilling <coding@schilljs.com> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ - namespace OCA\Provisioning_API\Tests\Controller; - +use OC\AppConfig; use OCA\Provisioning_API\Controller\AppConfigController; +use OCP\App\IAppManager; use OCP\AppFramework\Http; use OCP\AppFramework\Http\DataResponse; +use OCP\Exceptions\AppConfigUnknownKeyException; use OCP\IAppConfig; -use OCP\IConfig; +use OCP\IGroupManager; +use OCP\IL10N; use OCP\IRequest; +use OCP\IUser; +use OCP\IUserSession; +use OCP\Server; +use OCP\Settings\IManager; +use PHPUnit\Framework\MockObject\MockObject; use Test\TestCase; +use function json_decode; +use function json_encode; /** * Class AppConfigControllerTest @@ -38,23 +32,27 @@ use Test\TestCase; * @package OCA\Provisioning_API\Tests */ class AppConfigControllerTest extends TestCase { - - /** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */ - private $config; - /** @var IAppConfig|\PHPUnit_Framework_MockObject_MockObject */ - private $appConfig; - - protected function setUp() { + private IAppConfig&MockObject $appConfig; + private IUserSession&MockObject $userSession; + private IL10N&MockObject $l10n; + private IManager&MockObject $settingManager; + private IGroupManager&MockObject $groupManager; + private IAppManager $appManager; + + protected function setUp(): void { parent::setUp(); - $this->config = $this->createMock(IConfig::class); - $this->appConfig = $this->createMock(IAppConfig::class); - + $this->appConfig = $this->createMock(AppConfig::class); + $this->userSession = $this->createMock(IUserSession::class); + $this->l10n = $this->createMock(IL10N::class); + $this->settingManager = $this->createMock(IManager::class); + $this->groupManager = $this->createMock(IGroupManager::class); + $this->appManager = Server::get(IAppManager::class); } /** * @param string[] $methods - * @return AppConfigController|\PHPUnit_Framework_MockObject_MockObject + * @return AppConfigController|MockObject */ protected function getInstance(array $methods = []) { $request = $this->createMock(IRequest::class); @@ -63,23 +61,31 @@ class AppConfigControllerTest extends TestCase { return new AppConfigController( 'provisioning_api', $request, - $this->config, - $this->appConfig + $this->appConfig, + $this->userSession, + $this->l10n, + $this->groupManager, + $this->settingManager, + $this->appManager, ); } else { return $this->getMockBuilder(AppConfigController::class) ->setConstructorArgs([ 'provisioning_api', $request, - $this->config, $this->appConfig, + $this->userSession, + $this->l10n, + $this->groupManager, + $this->settingManager, + $this->appManager, ]) - ->setMethods($methods) + ->onlyMethods($methods) ->getMock(); } } - public function testGetApps() { + public function testGetApps(): void { $this->appConfig->expects($this->once()) ->method('getApps') ->willReturn(['apps']); @@ -90,22 +96,15 @@ class AppConfigControllerTest extends TestCase { $this->assertEquals(['data' => ['apps']], $result->getData()); } - public function dataGetKeys() { + public static function dataGetKeys(): array { return [ ['app1 ', null, new \InvalidArgumentException('error'), Http::STATUS_FORBIDDEN], ['app2', ['keys'], null, Http::STATUS_OK], ]; } - /** - * @dataProvider dataGetKeys - * @param string $app - * @param array|null $keys - * @param \Exception|null $throws - * @param int $status - */ - public function testGetKeys($app, $keys, $throws, $status) { - + #[\PHPUnit\Framework\Attributes\DataProvider('dataGetKeys')] + public function testGetKeys(string $app, ?array $keys, ?\Throwable $throws, int $status): void { $api = $this->getInstance(['verifyAppId']); if ($throws instanceof \Exception) { $api->expects($this->once()) @@ -113,15 +112,15 @@ class AppConfigControllerTest extends TestCase { ->with($app) ->willThrowException($throws); - $this->config->expects($this->never()) - ->method('getAppKeys'); + $this->appConfig->expects($this->never()) + ->method('getKeys'); } else { $api->expects($this->once()) ->method('verifyAppId') ->with($app); - $this->config->expects($this->once()) - ->method('getAppKeys') + $this->appConfig->expects($this->once()) + ->method('getKeys') ->with($app) ->willReturn($keys); } @@ -136,40 +135,28 @@ class AppConfigControllerTest extends TestCase { } } - public function dataGetValue() { + public static function dataGetValue(): array { return [ - ['app1 ', null, null, null, new \InvalidArgumentException('error'), Http::STATUS_FORBIDDEN], + ['app1', 'key', 'default', null, new \InvalidArgumentException('error'), Http::STATUS_FORBIDDEN], ['app2', 'key', 'default', 'return', null, Http::STATUS_OK], ]; } - /** - * @dataProvider dataGetValue - * @param string $app - * @param string|null $key - * @param string|null $default - * @param string|null $return - * @param \Exception|null $throws - * @param int $status - */ - public function testGetValue($app, $key, $default, $return, $throws, $status) { - + #[\PHPUnit\Framework\Attributes\DataProvider('dataGetValue')] + public function testGetValue(string $app, string $key, string $default, ?string $return, ?\Throwable $throws, int $status): void { $api = $this->getInstance(['verifyAppId']); if ($throws instanceof \Exception) { $api->expects($this->once()) ->method('verifyAppId') ->with($app) ->willThrowException($throws); - - $this->config->expects($this->never()) - ->method('getAppValue'); } else { $api->expects($this->once()) ->method('verifyAppId') ->with($app); - $this->config->expects($this->once()) - ->method('getAppValue') + $this->appConfig->expects($this->once()) + ->method('getValueMixed') ->with($app, $key, $default) ->willReturn($return); } @@ -184,25 +171,35 @@ class AppConfigControllerTest extends TestCase { } } - public function dataSetValue() { + public static function dataSetValue(): array { return [ - ['app1 ', null, null, new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN], - ['app2', 'key', null, null, new \InvalidArgumentException('error2'), Http::STATUS_FORBIDDEN], + ['app1', 'key', 'default', new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN], + ['app2', 'key', 'default', null, new \InvalidArgumentException('error2'), Http::STATUS_FORBIDDEN], ['app2', 'key', 'default', null, null, Http::STATUS_OK], + ['app2', 'key', '1', null, null, Http::STATUS_OK, IAppConfig::VALUE_BOOL], + ['app2', 'key', '42', null, null, Http::STATUS_OK, IAppConfig::VALUE_INT], + ['app2', 'key', '4.2', null, null, Http::STATUS_OK, IAppConfig::VALUE_FLOAT], + ['app2', 'key', '42', null, null, Http::STATUS_OK, IAppConfig::VALUE_STRING], + ['app2', 'key', 'secret', null, null, Http::STATUS_OK, IAppConfig::VALUE_STRING | IAppConfig::VALUE_SENSITIVE], + ['app2', 'key', json_encode([4, 2]), null, null, Http::STATUS_OK, IAppConfig::VALUE_ARRAY], + ['app2', 'key', json_encode([4, 2]), null, null, Http::STATUS_OK, new AppConfigUnknownKeyException()], ]; } - /** - * @dataProvider dataSetValue - * @param string $app - * @param string|null $key - * @param string|null $value - * @param \Exception|null $appThrows - * @param \Exception|null $keyThrows - * @param int $status - */ - public function testSetValue($app, $key, $value, $appThrows, $keyThrows, $status) { - + #[\PHPUnit\Framework\Attributes\DataProvider('dataSetValue')] + public function testSetValue(string $app, string $key, string $value, ?\Throwable $appThrows, ?\Throwable $keyThrows, int $status, int|\Throwable $type = IAppConfig::VALUE_MIXED): void { + $adminUser = $this->createMock(IUser::class); + $adminUser->expects($this->once()) + ->method('getUid') + ->willReturn('admin'); + + $this->userSession->expects($this->once()) + ->method('getUser') + ->willReturn($adminUser); + $this->groupManager->expects($this->once()) + ->method('isAdmin') + ->with('admin') + ->willReturn(true); $api = $this->getInstance(['verifyAppId', 'verifyConfigKey']); if ($appThrows instanceof \Exception) { $api->expects($this->once()) @@ -212,9 +209,9 @@ class AppConfigControllerTest extends TestCase { $api->expects($this->never()) ->method('verifyConfigKey'); - $this->config->expects($this->never()) - ->method('setAppValue'); - } else if ($keyThrows instanceof \Exception) { + $this->appConfig->expects($this->never()) + ->method('setValueMixed'); + } elseif ($keyThrows instanceof \Exception) { $api->expects($this->once()) ->method('verifyAppId') ->with($app); @@ -223,8 +220,8 @@ class AppConfigControllerTest extends TestCase { ->with($app, $key) ->willThrowException($keyThrows); - $this->config->expects($this->never()) - ->method('setAppValue'); + $this->appConfig->expects($this->never()) + ->method('setValueMixed'); } else { $api->expects($this->once()) ->method('verifyAppId') @@ -233,9 +230,38 @@ class AppConfigControllerTest extends TestCase { ->method('verifyConfigKey') ->with($app, $key); - $this->config->expects($this->once()) - ->method('setAppValue') - ->with($app, $key, $value); + if ($type instanceof \Throwable) { + $this->appConfig->expects($this->once()) + ->method('getDetails') + ->with($app, $key) + ->willThrowException($type); + } else { + $this->appConfig->expects($this->once()) + ->method('getDetails') + ->with($app, $key) + ->willReturn([ + 'app' => $app, + 'key' => $key, + 'value' => '', // 🤷 + 'type' => $type, + 'lazy' => false, + 'typeString' => (string)$type, // this is not accurate, but acceptable + 'sensitive' => ($type & IAppConfig::VALUE_SENSITIVE) !== 0, + ]); + } + + $configValueSetter = match ($type) { + IAppConfig::VALUE_BOOL => 'setValueBool', + IAppConfig::VALUE_FLOAT => 'setValueFloat', + IAppConfig::VALUE_INT => 'setValueInt', + IAppConfig::VALUE_STRING => 'setValueString', + IAppConfig::VALUE_ARRAY => 'setValueArray', + default => 'setValueMixed', + }; + + $this->appConfig->expects($this->once()) + ->method($configValueSetter) + ->with($app, $key, $configValueSetter === 'setValueArray' ? json_decode($value, true) : $value); } $result = $api->setValue($app, $key, $value); @@ -243,31 +269,23 @@ class AppConfigControllerTest extends TestCase { $this->assertSame($status, $result->getStatus()); if ($appThrows instanceof \Exception) { $this->assertEquals(['data' => ['message' => $appThrows->getMessage()]], $result->getData()); - } else if ($keyThrows instanceof \Exception) { + } elseif ($keyThrows instanceof \Exception) { $this->assertEquals(['data' => ['message' => $keyThrows->getMessage()]], $result->getData()); } else { $this->assertEquals([], $result->getData()); } } - public function dataDeleteValue() { + public static function dataDeleteValue(): array { return [ - ['app1 ', null, new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN], + ['app1', 'key', new \InvalidArgumentException('error1'), null, Http::STATUS_FORBIDDEN], ['app2', 'key', null, new \InvalidArgumentException('error2'), Http::STATUS_FORBIDDEN], ['app2', 'key', null, null, Http::STATUS_OK], ]; } - /** - * @dataProvider dataDeleteValue - * @param string $app - * @param string|null $key - * @param \Exception|null $appThrows - * @param \Exception|null $keyThrows - * @param int $status - */ - public function testDeleteValue($app, $key, $appThrows, $keyThrows, $status) { - + #[\PHPUnit\Framework\Attributes\DataProvider('dataDeleteValue')] + public function testDeleteValue(string $app, string $key, ?\Throwable $appThrows, ?\Throwable $keyThrows, int $status): void { $api = $this->getInstance(['verifyAppId', 'verifyConfigKey']); if ($appThrows instanceof \Exception) { $api->expects($this->once()) @@ -277,9 +295,9 @@ class AppConfigControllerTest extends TestCase { $api->expects($this->never()) ->method('verifyConfigKey'); - $this->config->expects($this->never()) - ->method('deleteAppValue'); - } else if ($keyThrows instanceof \Exception) { + $this->appConfig->expects($this->never()) + ->method('deleteKey'); + } elseif ($keyThrows instanceof \Exception) { $api->expects($this->once()) ->method('verifyAppId') ->with($app); @@ -288,8 +306,8 @@ class AppConfigControllerTest extends TestCase { ->with($app, $key) ->willThrowException($keyThrows); - $this->config->expects($this->never()) - ->method('deleteAppValue'); + $this->appConfig->expects($this->never()) + ->method('deleteKey'); } else { $api->expects($this->once()) ->method('verifyAppId') @@ -298,8 +316,8 @@ class AppConfigControllerTest extends TestCase { ->method('verifyConfigKey') ->with($app, $key); - $this->config->expects($this->once()) - ->method('deleteAppValue') + $this->appConfig->expects($this->once()) + ->method('deleteKey') ->with($app, $key); } @@ -308,20 +326,20 @@ class AppConfigControllerTest extends TestCase { $this->assertSame($status, $result->getStatus()); if ($appThrows instanceof \Exception) { $this->assertEquals(['data' => ['message' => $appThrows->getMessage()]], $result->getData()); - } else if ($keyThrows instanceof \Exception) { + } elseif ($keyThrows instanceof \Exception) { $this->assertEquals(['data' => ['message' => $keyThrows->getMessage()]], $result->getData()); } else { $this->assertEquals([], $result->getData()); } } - public function testVerifyAppId() { + public function testVerifyAppId(): void { $api = $this->getInstance(); $this->invokePrivate($api, 'verifyAppId', ['activity']); - $this->assertTrue(true); + $this->addToAssertionCount(1); } - public function dataVerifyAppIdThrows() { + public static function dataVerifyAppIdThrows(): array { return [ ['activity..'], ['activity/'], @@ -330,55 +348,49 @@ class AppConfigControllerTest extends TestCase { ]; } - /** - * @dataProvider dataVerifyAppIdThrows - * @expectedException \InvalidArgumentException - * @param string $app - */ - public function testVerifyAppIdThrows($app) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataVerifyAppIdThrows')] + public function testVerifyAppIdThrows(string $app): void { + $this->expectException(\InvalidArgumentException::class); + $api = $this->getInstance(); $this->invokePrivate($api, 'verifyAppId', [$app]); } - public function dataVerifyConfigKey() { + public static function dataVerifyConfigKey(): array { return [ - ['activity', 'abc'], - ['dav', 'public_route'], - ['files', 'remote_route'], + ['activity', 'abc', ''], + ['dav', 'public_route', ''], + ['files', 'remote_route', ''], + ['core', 'encryption_enabled', 'yes'], ]; } - /** - * @dataProvider dataVerifyConfigKey - * @param string $app - * @param string $key - */ - public function testVerifyConfigKey($app, $key) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataVerifyConfigKey')] + public function testVerifyConfigKey(string $app, string $key, string $value): void { $api = $this->getInstance(); - $this->invokePrivate($api, 'verifyConfigKey', [$app, $key]); - $this->assertTrue(true); + $this->invokePrivate($api, 'verifyConfigKey', [$app, $key, $value]); + $this->addToAssertionCount(1); } - public function dataVerifyConfigKeyThrows() { + public static function dataVerifyConfigKeyThrows(): array { return [ - ['activity', 'installed_version'], - ['calendar', 'enabled'], - ['contacts', 'types'], - ['core', 'public_files'], - ['core', 'public_dav'], - ['core', 'remote_files'], - ['core', 'remote_dav'], + ['activity', 'installed_version', ''], + ['calendar', 'enabled', ''], + ['contacts', 'types', ''], + ['core', 'encryption_enabled', 'no'], + ['core', 'encryption_enabled', ''], + ['core', 'public_files', ''], + ['core', 'public_dav', ''], + ['core', 'remote_files', ''], + ['core', 'remote_dav', ''], ]; } - /** - * @dataProvider dataVerifyConfigKeyThrows - * @expectedException \InvalidArgumentException - * @param string $app - * @param string $key - */ - public function testVerifyConfigKeyThrows($app, $key) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataVerifyConfigKeyThrows')] + public function testVerifyConfigKeyThrows(string $app, string $key, string $value): void { + $this->expectException(\InvalidArgumentException::class); + $api = $this->getInstance(); - $this->invokePrivate($api, 'verifyConfigKey', [$app, $key]); + $this->invokePrivate($api, 'verifyConfigKey', [$app, $key, $value]); } } diff --git a/apps/provisioning_api/tests/Controller/AppsControllerTest.php b/apps/provisioning_api/tests/Controller/AppsControllerTest.php index 7bd20e4233f..f95daeae7d3 100644 --- a/apps/provisioning_api/tests/Controller/AppsControllerTest.php +++ b/apps/provisioning_api/tests/Controller/AppsControllerTest.php @@ -1,37 +1,23 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Joas Schilling <coding@schilljs.com> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * @author Tom Needham <tom@owncloud.com> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Provisioning_API\Tests\Controller; - +use OC\Installer; use OCA\Provisioning_API\Controller\AppsController; +use OCA\Provisioning_API\Tests\TestCase; use OCP\App\IAppManager; +use OCP\AppFramework\OCS\OCSException; +use OCP\IAppConfig; +use OCP\IGroupManager; use OCP\IRequest; use OCP\IUserSession; +use OCP\Server; +use PHPUnit\Framework\MockObject\MockObject; /** * Class AppsTest @@ -40,47 +26,52 @@ use OCP\IUserSession; * * @package OCA\Provisioning_API\Tests */ -class AppsControllerTest extends \OCA\Provisioning_API\Tests\TestCase { - /** @var IAppManager */ - private $appManager; - /** @var AppsController */ - private $api; - /** @var IUserSession */ - private $userSession; - - protected function setUp() { +class AppsControllerTest extends TestCase { + private IAppManager $appManager; + private IAppConfig&MockObject $appConfig; + private Installer&MockObject $installer; + private AppsController $api; + private IUserSession $userSession; + + protected function setUp(): void { parent::setUp(); - $this->appManager = \OC::$server->getAppManager(); - $this->groupManager = \OC::$server->getGroupManager(); - $this->userSession = \OC::$server->getUserSession(); + $this->appManager = Server::get(IAppManager::class); + $this->groupManager = Server::get(IGroupManager::class); + $this->userSession = Server::get(IUserSession::class); + $this->appConfig = $this->createMock(IAppConfig::class); + $this->installer = $this->createMock(Installer::class); - $request = $this->getMockBuilder(IRequest::class) - ->disableOriginalConstructor() - ->getMock(); + $request = $this->createMock(IRequest::class); $this->api = new AppsController( 'provisioning_api', $request, - $this->appManager + $this->appManager, + $this->installer, + $this->appConfig, ); } - public function testGetAppInfo() { + protected function tearDown(): void { + $this->userSession->setUser(null); + } + + public function testGetAppInfo(): void { $result = $this->api->getAppInfo('provisioning_api'); - $expected = \OC_App::getAppInfo('provisioning_api'); + $expected = $this->appManager->getAppInfo('provisioning_api'); $this->assertEquals($expected, $result->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 998 - */ - public function testGetAppInfoOnBadAppID() { + + public function testGetAppInfoOnBadAppID(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $this->api->getAppInfo('not_provisioning_api'); } - public function testGetApps() { + public function testGetApps(): void { $user = $this->generateUsers(); $this->groupManager->get('admin')->addUser($user); $this->userSession->setUser($user); @@ -91,29 +82,29 @@ class AppsControllerTest extends \OCA\Provisioning_API\Tests\TestCase { $this->assertEquals(count((new \OC_App())->listAllApps()), count($data['apps'])); } - public function testGetAppsEnabled() { + public function testGetAppsEnabled(): void { $result = $this->api->getApps('enabled'); $data = $result->getData(); $this->assertEquals(count(\OC_App::getEnabledApps()), count($data['apps'])); } - public function testGetAppsDisabled() { + public function testGetAppsDisabled(): void { $result = $this->api->getApps('disabled'); $data = $result->getData(); $apps = (new \OC_App)->listAllApps(); - $list = array(); - foreach($apps as $app) { + $list = []; + foreach ($apps as $app) { $list[] = $app['id']; } $disabled = array_diff($list, \OC_App::getEnabledApps()); $this->assertEquals(count($disabled), count($data['apps'])); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testGetAppsInvalidFilter() { + + public function testGetAppsInvalidFilter(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $this->api->getApps('foo'); } } diff --git a/apps/provisioning_api/tests/Controller/GroupsControllerTest.php b/apps/provisioning_api/tests/Controller/GroupsControllerTest.php index cd3dae79336..85e5d733b1f 100644 --- a/apps/provisioning_api/tests/Controller/GroupsControllerTest.php +++ b/apps/provisioning_api/tests/Controller/GroupsControllerTest.php @@ -1,102 +1,118 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Joas Schilling <coding@schilljs.com> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Tom Needham <tom@owncloud.com> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Provisioning_API\Tests\Controller; +use OC\Group\Manager; +use OC\User\NoUserException; use OCA\Provisioning_API\Controller\GroupsController; -use OCP\IGroupManager; -use OCP\ILogger; +use OCP\Accounts\IAccountManager; +use OCP\AppFramework\OCS\OCSException; +use OCP\Files\IRootFolder; +use OCP\Group\ISubAdmin; +use OCP\IConfig; +use OCP\IGroup; use OCP\IRequest; use OCP\IUser; +use OCP\IUserManager; use OCP\IUserSession; +use OCP\L10N\IFactory; +use OCP\UserInterface; +use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; class GroupsControllerTest extends \Test\TestCase { - /** @var IGroupManager|\PHPUnit_Framework_MockObject_MockObject */ - protected $groupManager; - /** @var IUserSession|\PHPUnit_Framework_MockObject_MockObject */ - protected $userSession; - /** @var \OC\SubAdmin|\PHPUnit_Framework_MockObject_MockObject */ - protected $subAdminManager; + protected IRequest&MockObject $request; + protected IUserManager&MockObject $userManager; + protected IConfig&MockObject $config; + protected Manager&MockObject $groupManager; + protected IUserSession&MockObject $userSession; + protected IAccountManager&MockObject $accountManager; + protected ISubAdmin&MockObject $subAdminManager; + protected IFactory&MockObject $l10nFactory; + protected LoggerInterface&MockObject $logger; + protected GroupsController&MockObject $api; - /** @var GroupsController */ - protected $api; + private IRootFolder $rootFolder; - protected function setUp() { + + protected function setUp(): void { parent::setUp(); - $this->subAdminManager = $this->getMockBuilder('OC\SubAdmin') - ->disableOriginalConstructor() - ->getMock(); + $this->request = $this->createMock(IRequest::class); + $this->userManager = $this->createMock(IUserManager::class); + $this->config = $this->createMock(IConfig::class); + $this->groupManager = $this->createMock(Manager::class); + $this->userSession = $this->createMock(IUserSession::class); + $this->accountManager = $this->createMock(IAccountManager::class); + $this->subAdminManager = $this->createMock(ISubAdmin::class); + $this->l10nFactory = $this->createMock(IFactory::class); + $this->logger = $this->createMock(LoggerInterface::class); + $this->rootFolder = $this->createMock(IRootFolder::class); - $this->groupManager = $this->getMockBuilder('OC\Group\Manager') - ->disableOriginalConstructor() - ->getMock(); $this->groupManager ->method('getSubAdmin') ->willReturn($this->subAdminManager); - $this->userSession = $this->getMockBuilder(IUserSession::class) - ->disableOriginalConstructor() - ->getMock(); - $request = $this->getMockBuilder(IRequest::class) - ->disableOriginalConstructor() + $this->api = $this->getMockBuilder(GroupsController::class) + ->setConstructorArgs([ + 'provisioning_api', + $this->request, + $this->userManager, + $this->config, + $this->groupManager, + $this->userSession, + $this->accountManager, + $this->subAdminManager, + $this->l10nFactory, + $this->rootFolder, + $this->logger + ]) + ->onlyMethods(['fillStorageInfo']) ->getMock(); - - $logger = $this->createMock(ILogger::class); - - $this->api = new GroupsController( - 'provisioning_api', - $request, - $this->groupManager, - $this->userSession, - $logger - ); } - /** - * @param string $gid - * @return \OCP\IGroup|\PHPUnit_Framework_MockObject_MockObject - */ - private function createGroup($gid) { - $group = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); + private function createGroup(string $gid): IGroup&MockObject { + $group = $this->createMock(IGroup::class); $group ->method('getGID') ->willReturn($gid); + $group + ->method('getDisplayName') + ->willReturn($gid . '-name'); + $group + ->method('count') + ->willReturn(123); + $group + ->method('countDisabled') + ->willReturn(11); + $group + ->method('canAddUser') + ->willReturn(true); + $group + ->method('canRemoveUser') + ->willReturn(true); + return $group; } /** * @param string $uid - * @return \OCP\IUser|\PHPUnit_Framework_MockObject_MockObject + * @return IUser&MockObject */ private function createUser($uid) { $user = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $user ->method('getUID') ->willReturn($uid); + $backendMock = $this->createMock(UserInterface::class); + $user + ->method('getBackend') + ->willReturn($backendMock); return $user; } @@ -127,32 +143,48 @@ class GroupsControllerTest extends \Test\TestCase { $this->subAdminManager ->method('isSubAdminOfGroup') - ->will($this->returnCallback(function($_user, $_group) use ($user, $group) { + ->willReturnCallback(function ($_user, $_group) use ($user, $group) { if ($_user === $user && $_group === $group) { return true; } return false; - })); + }); } - public function dataGetGroups() { + public static function dataGetGroups(): array { return [ - [null, null, null], - ['foo', null, null], - [null, 1, null], - [null, null, 2], + [null, 0, 0], + ['foo', 0, 0], + [null, 1, 0], + [null, 0, 2], ['foo', 1, 2], ]; } + #[\PHPUnit\Framework\Attributes\DataProvider('dataGetGroups')] + public function testGetGroups(?string $search, int $limit, int $offset): void { + $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->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 testGetGroups($search, $limit, $offset) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataGetGroups')] + public function testGetGroupsDetails($search, $limit, $offset): void { $groups = [$this->createGroup('group1'), $this->createGroup('group2')]; $search = $search === null ? '' : $search; @@ -163,11 +195,28 @@ class GroupsControllerTest extends \Test\TestCase { ->with($search, $limit, $offset) ->willReturn($groups); - $result = $this->api->getGroups($search, $limit, $offset); - $this->assertEquals(['groups' => ['group1', 'group2']], $result->getData()); + $result = $this->api->getGroupsDetails($search, $limit, $offset); + $this->assertEquals(['groups' => [ + [ + 'id' => 'group1', + 'displayname' => 'group1-name', + 'usercount' => 123, + 'disabled' => 11, + 'canAdd' => true, + 'canRemove' => true + ], + [ + 'id' => 'group2', + 'displayname' => 'group2-name', + 'usercount' => 123, + 'disabled' => 11, + 'canAdd' => true, + 'canRemove' => true + ] + ]], $result->getData()); } - public function testGetGroupAsSubadmin() { + public function testGetGroupAsSubadmin(): void { $group = $this->createGroup('group'); $this->asSubAdminOfGroup($group); @@ -191,11 +240,11 @@ class GroupsControllerTest extends \Test\TestCase { $this->assertEquals(['users' => ['user1', 'user2']], $result->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testGetGroupAsIrrelevantSubadmin() { + + public function testGetGroupAsIrrelevantSubadmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(403); + $group = $this->createGroup('group'); $otherGroup = $this->createGroup('otherGroup'); $this->asSubAdminOfGroup($otherGroup); @@ -212,7 +261,7 @@ class GroupsControllerTest extends \Test\TestCase { $this->api->getGroup('group'); } - public function testGetGroupAsAdmin() { + public function testGetGroupAsAdmin(): void { $group = $this->createGroup('group'); $this->asAdmin(); @@ -236,27 +285,27 @@ class GroupsControllerTest extends \Test\TestCase { $this->assertEquals(['users' => ['user1', 'user2']], $result->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 998 - * @expectedExceptionMessage The requested group could not be found - */ - public function testGetGroupNonExisting() { + + public function testGetGroupNonExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('The requested group could not be found'); + $this->expectExceptionCode(404); + $this->asUser(); $this->api->getGroup($this->getUniqueID()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Group does not exist - */ - public function testGetSubAdminsOfGroupsNotExists() { + + public function testGetSubAdminsOfGroupsNotExists(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Group does not exist'); + $this->expectExceptionCode(101); + $this->api->getSubAdminsOfGroup('NonExistingGroup'); } - public function testGetSubAdminsOfGroup() { + public function testGetSubAdminsOfGroup(): void { $group = $this->createGroup('GroupWithSubAdmins'); $this->groupManager ->method('get') @@ -276,7 +325,7 @@ class GroupsControllerTest extends \Test\TestCase { $this->assertEquals(['SubAdmin1', 'SubAdmin2'], $result->getData()); } - public function testGetSubAdminsOfGroupEmptyList() { + public function testGetSubAdminsOfGroupEmptyList(): void { $group = $this->createGroup('GroupWithOutSubAdmins'); $this->groupManager ->method('get') @@ -294,20 +343,20 @@ class GroupsControllerTest extends \Test\TestCase { $this->assertEquals([], $result->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Invalid group name - */ - public function testAddGroupEmptyGroup() { + + public function testAddGroupEmptyGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Invalid group name'); + $this->expectExceptionCode(101); + $this->api->addGroup(''); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testAddGroupExistingGroup() { + + public function testAddGroupExistingGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(102); + $this->groupManager ->method('groupExists') ->with('ExistingGroup') @@ -316,47 +365,51 @@ class GroupsControllerTest extends \Test\TestCase { $this->api->addGroup('ExistingGroup'); } - public function testAddGroup() { + public function testAddGroup(): void { $this->groupManager ->method('groupExists') ->with('NewGroup') ->willReturn(false); + $group = $this->createGroup('NewGroup'); $this->groupManager ->expects($this->once()) ->method('createGroup') - ->with('NewGroup'); + ->with('NewGroup') + ->willReturn($group); $this->api->addGroup('NewGroup'); } - public function testAddGroupWithSpecialChar() { + public function testAddGroupWithSpecialChar(): void { $this->groupManager ->method('groupExists') ->with('Iñtërnâtiônà lizætiøn') ->willReturn(false); + $group = $this->createGroup('Iñtërnâtiônà lizætiøn'); $this->groupManager ->expects($this->once()) ->method('createGroup') - ->with('Iñtërnâtiônà lizætiøn'); + ->with('Iñtërnâtiônà lizætiøn') + ->willReturn($group); $this->api->addGroup('Iñtërnâtiônà lizætiøn'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testDeleteGroupNonExisting() { + + public function testDeleteGroupNonExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $this->api->deleteGroup('NonExistingGroup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testDeleteAdminGroup() { + + public function testDeleteAdminGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(102); + $this->groupManager ->method('groupExists') ->with('admin') @@ -365,7 +418,7 @@ class GroupsControllerTest extends \Test\TestCase { $this->api->deleteGroup('admin'); } - public function testDeleteGroup() { + public function testDeleteGroup(): void { $this->groupManager ->method('groupExists') ->with('ExistingGroup') @@ -383,4 +436,113 @@ class GroupsControllerTest extends \Test\TestCase { $this->api->deleteGroup('ExistingGroup'); } + + public function testDeleteGroupEncoding(): void { + $this->groupManager + ->method('groupExists') + ->with('ExistingGroup A/B') + ->willReturn('true'); + + $group = $this->createGroup('ExistingGroup'); + $this->groupManager + ->method('get') + ->with('ExistingGroup A/B') + ->willReturn($group); + $group + ->expects($this->once()) + ->method('delete') + ->willReturn(true); + + $this->api->deleteGroup(urlencode('ExistingGroup A/B')); + } + + public function testGetGroupUsersDetails(): void { + $gid = 'ncg1'; + + $this->asAdmin(); + + $users = [ + 'ncu1' => $this->createUser('ncu1'), # regular + 'ncu2' => $this->createUser('ncu2'), # the zombie + ]; + $users['ncu2']->expects($this->atLeastOnce()) + ->method('getHome') + ->willThrowException(new NoUserException()); + + $this->userManager->expects($this->any()) + ->method('get') + ->willReturnCallback(function (string $uid) use ($users) { + return $users[$uid] ?? null; + }); + + $group = $this->createGroup($gid); + $group->expects($this->once()) + ->method('searchUsers') + ->with('', null, 0) + ->willReturn(array_values($users)); + + $this->groupManager + ->method('get') + ->with($gid) + ->willReturn($group); + $this->groupManager->expects($this->any()) + ->method('getUserGroups') + ->willReturn([$group]); + + /** @var MockObject */ + $this->subAdminManager->expects($this->any()) + ->method('isSubAdminOfGroup') + ->willReturn(false); + $this->subAdminManager->expects($this->any()) + ->method('getSubAdminsGroups') + ->willReturn([]); + + + $this->api->getGroupUsersDetails($gid); + } + + public function testGetGroupUsersDetailsEncoded(): void { + $gid = 'Department A/B C/D'; + + $this->asAdmin(); + + $users = [ + 'ncu1' => $this->createUser('ncu1'), # regular + 'ncu2' => $this->createUser('ncu2'), # the zombie + ]; + $users['ncu2']->expects($this->atLeastOnce()) + ->method('getHome') + ->willThrowException(new NoUserException()); + + $this->userManager->expects($this->any()) + ->method('get') + ->willReturnCallback(function (string $uid) use ($users) { + return $users[$uid] ?? null; + }); + + $group = $this->createGroup($gid); + $group->expects($this->once()) + ->method('searchUsers') + ->with('', null, 0) + ->willReturn(array_values($users)); + + $this->groupManager + ->method('get') + ->with($gid) + ->willReturn($group); + $this->groupManager->expects($this->any()) + ->method('getUserGroups') + ->willReturn([$group]); + + /** @var MockObject */ + $this->subAdminManager->expects($this->any()) + ->method('isSubAdminOfGroup') + ->willReturn(false); + $this->subAdminManager->expects($this->any()) + ->method('getSubAdminsGroups') + ->willReturn([]); + + + $this->api->getGroupUsersDetails(urlencode($gid)); + } } diff --git a/apps/provisioning_api/tests/Controller/UsersControllerTest.php b/apps/provisioning_api/tests/Controller/UsersControllerTest.php index ef47583e9df..0c0a0ae3d74 100644 --- a/apps/provisioning_api/tests/Controller/UsersControllerTest.php +++ b/apps/provisioning_api/tests/Controller/UsersControllerTest.php @@ -1,99 +1,97 @@ <?php + + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Bjoern Schiessle <bjoern@schiessle.org> - * @author Christoph Wurst <christoph@owncloud.com> - * @author Joas Schilling <coding@schilljs.com> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author michag86 <micha_g@arcor.de> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * @author Tom Needham <tom@owncloud.com> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Provisioning_API\Tests\Controller; use Exception; -use OC\Accounts\AccountManager; +use OC\Authentication\Token\RemoteWipe; use OC\Group\Manager; -use OCP\App\IAppManager; -use OCP\AppFramework\OCS\OCSException; -use OCP\Mail\IEMailTemplate; -use OC\Settings\Mailer\NewUserMailHelper; +use OC\KnownUser\KnownUserService; +use OC\PhoneNumberUtil; use OC\SubAdmin; use OCA\Provisioning_API\Controller\UsersController; +use OCA\Settings\Mailer\NewUserMailHelper; +use OCP\Accounts\IAccount; +use OCP\Accounts\IAccountManager; +use OCP\Accounts\IAccountProperty; +use OCP\Accounts\IAccountPropertyCollection; +use OCP\App\IAppManager; use OCP\AppFramework\Http\DataResponse; -use OCP\Defaults; +use OCP\AppFramework\OCS\OCSException; +use OCP\EventDispatcher\IEventDispatcher; +use OCP\Files\IRootFolder; +use OCP\Group\ISubAdmin; use OCP\IConfig; use OCP\IGroup; -use OCP\ILogger; use OCP\IL10N; +use OCP\IPhoneNumberUtil; use OCP\IRequest; use OCP\IURLGenerator; use OCP\IUser; use OCP\IUserManager; use OCP\IUserSession; use OCP\L10N\IFactory; -use OCP\Mail\IMailer; -use PHPUnit_Framework_MockObject_MockObject; +use OCP\Mail\IEMailTemplate; +use OCP\Security\Events\GenerateSecurePasswordEvent; +use OCP\Security\ISecureRandom; +use OCP\User\Backend\ISetDisplayNameBackend; +use OCP\UserInterface; +use PHPUnit\Framework\MockObject\MockObject; +use Psr\Log\LoggerInterface; +use RuntimeException; use Test\TestCase; class UsersControllerTest extends TestCase { - - /** @var IUserManager|PHPUnit_Framework_MockObject_MockObject */ - protected $userManager; - /** @var IConfig|PHPUnit_Framework_MockObject_MockObject */ - protected $config; - /** @var IAppManager|PHPUnit_Framework_MockObject_MockObject */ - protected $appManager; - /** @var Manager|PHPUnit_Framework_MockObject_MockObject */ - protected $groupManager; - /** @var IUserSession|PHPUnit_Framework_MockObject_MockObject */ - protected $userSession; - /** @var ILogger|PHPUnit_Framework_MockObject_MockObject */ - protected $logger; - /** @var UsersController|PHPUnit_Framework_MockObject_MockObject */ - protected $api; - /** @var AccountManager|PHPUnit_Framework_MockObject_MockObject */ - protected $accountManager; - /** @var IRequest|PHPUnit_Framework_MockObject_MockObject */ - protected $request; - /** @var IFactory|PHPUnit_Framework_MockObject_MockObject */ - private $l10nFactory; - /** @var NewUserMailHelper|PHPUnit_Framework_MockObject_MockObject */ - private $newUserMailHelper; - - protected function setUp() { + protected IUserManager&MockObject $userManager; + protected IConfig&MockObject $config; + protected Manager&MockObject $groupManager; + protected IUserSession&MockObject $userSession; + protected LoggerInterface&MockObject $logger; + protected UsersController&MockObject $api; + protected IAccountManager&MockObject $accountManager; + protected ISubAdmin&MockObject $subAdminManager; + protected IURLGenerator&MockObject $urlGenerator; + protected IRequest&MockObject $request; + private IFactory&MockObject $l10nFactory; + private NewUserMailHelper&MockObject $newUserMailHelper; + private ISecureRandom&MockObject $secureRandom; + private RemoteWipe&MockObject $remoteWipe; + private KnownUserService&MockObject $knownUserService; + private IEventDispatcher&MockObject $eventDispatcher; + private IRootFolder $rootFolder; + private IPhoneNumberUtil $phoneNumberUtil; + private IAppManager $appManager; + + protected function setUp(): void { parent::setUp(); $this->userManager = $this->createMock(IUserManager::class); $this->config = $this->createMock(IConfig::class); - $this->appManager = $this->createMock(IAppManager::class); $this->groupManager = $this->createMock(Manager::class); $this->userSession = $this->createMock(IUserSession::class); - $this->logger = $this->createMock(ILogger::class); + $this->logger = $this->createMock(LoggerInterface::class); $this->request = $this->createMock(IRequest::class); - $this->accountManager = $this->createMock(AccountManager::class); + $this->accountManager = $this->createMock(IAccountManager::class); + $this->subAdminManager = $this->createMock(ISubAdmin::class); + $this->urlGenerator = $this->createMock(IURLGenerator::class); $this->l10nFactory = $this->createMock(IFactory::class); $this->newUserMailHelper = $this->createMock(NewUserMailHelper::class); + $this->secureRandom = $this->createMock(ISecureRandom::class); + $this->remoteWipe = $this->createMock(RemoteWipe::class); + $this->knownUserService = $this->createMock(KnownUserService::class); + $this->eventDispatcher = $this->createMock(IEventDispatcher::class); + $this->phoneNumberUtil = new PhoneNumberUtil(); + $this->appManager = $this->createMock(IAppManager::class); + $this->rootFolder = $this->createMock(IRootFolder::class); + + $l10n = $this->createMock(IL10N::class); + $l10n->method('t')->willReturnCallback(fn (string $txt, array $replacement = []) => sprintf($txt, ...$replacement)); + $this->l10nFactory->method('get')->with('provisioning_api')->willReturn($l10n); $this->api = $this->getMockBuilder(UsersController::class) ->setConstructorArgs([ @@ -101,41 +99,50 @@ class UsersControllerTest extends TestCase { $this->request, $this->userManager, $this->config, - $this->appManager, $this->groupManager, $this->userSession, $this->accountManager, - $this->logger, + $this->subAdminManager, $this->l10nFactory, - $this->newUserMailHelper + $this->rootFolder, + $this->urlGenerator, + $this->logger, + $this->newUserMailHelper, + $this->secureRandom, + $this->remoteWipe, + $this->knownUserService, + $this->eventDispatcher, + $this->phoneNumberUtil, + $this->appManager, ]) - ->setMethods(['fillStorageInfo']) + ->onlyMethods(['fillStorageInfo']) ->getMock(); } - public function testGetUsersAsAdmin() { + public function testGetUsersAsAdmin(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->userManager ->expects($this->once()) ->method('search') - ->with('MyCustomSearch', null, null) - ->will($this->returnValue(['Admin' => [], 'Foo' => [], 'Bar' => []])); + ->with('MyCustomSearch') + ->willReturn(['Admin' => [], 'Foo' => [], 'Bar' => []]); - $expected = ['users' => [ + $expected = [ + 'users' => [ 'Admin', 'Foo', 'Bar', @@ -144,56 +151,55 @@ class UsersControllerTest extends TestCase { $this->assertEquals($expected, $this->api->getUsers('MyCustomSearch')->getData()); } - public function testGetUsersAsSubAdmin() { + public function testGetUsersAsSubAdmin(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') - ->will($this->returnValue(false)); + ->willReturn(false); $firstGroup = $this->getMockBuilder('OCP\IGroup') ->disableOriginalConstructor() ->getMock(); $firstGroup ->expects($this->once()) ->method('getGID') - ->will($this->returnValue('FirstGroup')); + ->willReturn('FirstGroup'); $secondGroup = $this->getMockBuilder('OCP\IGroup') ->disableOriginalConstructor() ->getMock(); $secondGroup ->expects($this->once()) ->method('getGID') - ->will($this->returnValue('SecondGroup')); + ->willReturn('SecondGroup'); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isSubAdmin') ->with($loggedInUser) - ->will($this->returnValue(true)); + ->willReturn(true); $subAdminManager ->expects($this->once()) ->method('getSubAdminsGroups') ->with($loggedInUser) - ->will($this->returnValue([$firstGroup, $secondGroup])); + ->willReturn([$firstGroup, $secondGroup]); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) - ->method('displayNamesInGroup') - ->will($this->onConsecutiveCalls(['AnotherUserInTheFirstGroup' => []], ['UserInTheSecondGroup' => []])); + ->method('displayNamesInGroup')->willReturnOnConsecutiveCalls(['AnotherUserInTheFirstGroup' => []], ['UserInTheSecondGroup' => []]); $expected = [ 'users' => [ @@ -204,16 +210,141 @@ class UsersControllerTest extends TestCase { $this->assertEquals($expected, $this->api->getUsers('MyCustomSearch')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testAddUserAlreadyExisting() { + private function createUserMock(string $uid, bool $enabled): MockObject&IUser { + $mockUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $mockUser + ->method('getUID') + ->willReturn($uid); + $mockUser + ->method('isEnabled') + ->willReturn($enabled); + return $mockUser; + } + + public function testGetDisabledUsersAsAdmin(): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->once()) + ->method('getUID') + ->willReturn('admin'); + $this->userSession + ->expects($this->atLeastOnce()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->willReturn(true); + $this->userManager + ->expects($this->once()) + ->method('getDisabledUsers') + ->with(3, 0, 'MyCustomSearch') + ->willReturn([ + $this->createUserMock('admin', false), + $this->createUserMock('foo', false), + $this->createUserMock('bar', false), + ]); + + $expected = [ + 'users' => [ + 'admin' => ['id' => 'admin'], + 'foo' => ['id' => 'foo'], + 'bar' => ['id' => 'bar'], + ], + ]; + $this->assertEquals($expected, $this->api->getDisabledUsersDetails('MyCustomSearch', 3)->getData()); + } + + public function testGetDisabledUsersAsSubAdmin(): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->once()) + ->method('getUID') + ->willReturn('subadmin'); + $this->userSession + ->expects($this->atLeastOnce()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->willReturn(false); + $firstGroup = $this->getMockBuilder('OCP\IGroup') + ->disableOriginalConstructor() + ->getMock(); + $secondGroup = $this->getMockBuilder('OCP\IGroup') + ->disableOriginalConstructor() + ->getMock(); + $subAdminManager = $this->getMockBuilder('OC\SubAdmin') + ->disableOriginalConstructor()->getMock(); + $subAdminManager + ->expects($this->once()) + ->method('isSubAdmin') + ->with($loggedInUser) + ->willReturn(true); + $subAdminManager + ->expects($this->once()) + ->method('getSubAdminsGroups') + ->with($loggedInUser) + ->willReturn([$firstGroup, $secondGroup]); + $this->groupManager + ->expects($this->once()) + ->method('getSubAdmin') + ->willReturn($subAdminManager); + $this->groupManager + ->expects($this->never()) + ->method('displayNamesInGroup'); + + $firstGroup + ->expects($this->once()) + ->method('searchUsers') + ->with('MyCustomSearch') + ->willReturn([ + $this->createUserMock('user1', false), + $this->createUserMock('bob', true), + $this->createUserMock('user2', false), + $this->createUserMock('alice', true), + ]); + + $secondGroup + ->expects($this->once()) + ->method('searchUsers') + ->with('MyCustomSearch') + ->willReturn([ + $this->createUserMock('user2', false), + $this->createUserMock('joe', true), + $this->createUserMock('user3', false), + $this->createUserMock('jim', true), + $this->createUserMock('john', true), + ]); + + + $expected = [ + 'users' => [ + 'user1' => ['id' => 'user1'], + 'user2' => ['id' => 'user2'], + 'user3' => ['id' => 'user3'], + ], + ]; + $this->assertEquals($expected, $this->api->getDisabledUsersDetails('MyCustomSearch', 3)->getData()); + } + + + public function testAddUserAlreadyExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(102); + $this->userManager ->expects($this->once()) ->method('userExists') ->with('AlreadyExistingUser') - ->will($this->returnValue(true)); + ->willReturn(true); $this->logger ->expects($this->once()) ->method('error') @@ -222,28 +353,28 @@ class UsersControllerTest extends TestCase { ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('adminUser') ->willReturn(true); - $this->api->addUser('AlreadyExistingUser', null, null); + $this->api->addUser('AlreadyExistingUser', 'password', '', '', []); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 104 - * @expectedExceptionMessage group NonExistingGroup does not exist - */ - public function testAddUserNonExistingGroup() { + + public function testAddUserNonExistingGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Group NonExistingGroup does not exist'); + $this->expectExceptionCode(104); + $this->userManager ->expects($this->once()) ->method('userExists') @@ -253,13 +384,13 @@ class UsersControllerTest extends TestCase { ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -271,15 +402,15 @@ class UsersControllerTest extends TestCase { ->with('NonExistingGroup') ->willReturn(false); - $this->api->addUser('NewUser', 'pass', ['NonExistingGroup']); + $this->api->addUser('NewUser', 'pass', '', '', ['NonExistingGroup']); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 104 - * @expectedExceptionMessage group NonExistingGroup does not exist - */ - public function testAddUserExistingGroupNonExistingGroup() { + + public function testAddUserExistingGroupNonExistingGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Group NonExistingGroup does not exist'); + $this->expectExceptionCode(104); + $this->userManager ->expects($this->once()) ->method('userExists') @@ -289,13 +420,13 @@ class UsersControllerTest extends TestCase { ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -304,28 +435,25 @@ class UsersControllerTest extends TestCase { $this->groupManager ->expects($this->exactly(2)) ->method('groupExists') - ->withConsecutive( - ['ExistingGroup'], - ['NonExistingGroup'] - ) - ->will($this->returnValueMap([ + ->willReturnMap([ ['ExistingGroup', true], ['NonExistingGroup', false] - ])); + ]); - $this->api->addUser('NewUser', 'pass', ['ExistingGroup', 'NonExistingGroup']); + $this->api->addUser('NewUser', 'pass', '', '', ['ExistingGroup', 'NonExistingGroup']); } - public function testAddUserSuccessful() { + public function testAddUserSuccessful(): void { $this->userManager ->expects($this->once()) ->method('userExists') ->with('NewUser') - ->will($this->returnValue(false)); + ->willReturn(false); $this->userManager ->expects($this->once()) ->method('createUser') - ->with('NewUser', 'PasswordOfTheNewUser'); + ->with('NewUser', 'PasswordOfTheNewUser') + ->willReturn($this->createMock(IUser::class)); $this->logger ->expects($this->once()) ->method('info') @@ -334,39 +462,343 @@ class UsersControllerTest extends TestCase { ->disableOriginalConstructor() ->getMock(); $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + + $this->assertTrue(key_exists( + 'id', + $this->api->addUser('NewUser', 'PasswordOfTheNewUser')->getData() + )); + } + + public function testAddUserSuccessfulWithDisplayName(): void { + /** + * @var UserController + */ + $api = $this->getMockBuilder(UsersController::class) + ->setConstructorArgs([ + 'provisioning_api', + $this->request, + $this->userManager, + $this->config, + $this->groupManager, + $this->userSession, + $this->accountManager, + $this->subAdminManager, + $this->l10nFactory, + $this->rootFolder, + $this->urlGenerator, + $this->logger, + $this->newUserMailHelper, + $this->secureRandom, + $this->remoteWipe, + $this->knownUserService, + $this->eventDispatcher, + $this->phoneNumberUtil, + $this->appManager, + ]) + ->onlyMethods(['editUser']) + ->getMock(); + + $this->userManager + ->expects($this->once()) + ->method('userExists') + ->with('NewUser') + ->willReturn(false); + $this->userManager + ->expects($this->once()) + ->method('createUser') + ->with('NewUser', 'PasswordOfTheNewUser') + ->willReturn($this->createMock(IUser::class)); + $this->logger + ->expects($this->once()) + ->method('info') + ->with('Successful addUser call with userid: NewUser', ['app' => 'ocs_api']); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession + ->expects($this->any()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + $api + ->expects($this->once()) + ->method('editUser') + ->with('NewUser', 'display', 'DisplayNameOfTheNewUser'); + + $this->assertTrue(key_exists( + 'id', + $api->addUser('NewUser', 'PasswordOfTheNewUser', 'DisplayNameOfTheNewUser')->getData() + )); + } + + public function testAddUserSuccessfulGenerateUserID(): void { + $this->config + ->expects($this->any()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'newUser.generateUserID') { + return 'yes'; + } + return null; + }); + $this->userManager + ->expects($this->any()) + ->method('userExists') + ->with($this->anything()) + ->willReturn(false); + $this->userManager + ->expects($this->once()) + ->method('createUser') + ->with($this->anything(), 'PasswordOfTheNewUser') + ->willReturn($this->createMock(IUser::class)); + $this->logger + ->expects($this->once()) + ->method('info') + ->with($this->stringStartsWith('Successful addUser call with userid: '), ['app' => 'ocs_api']); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + $this->secureRandom->expects($this->any()) + ->method('generate') + ->with(10) + ->willReturnCallback(function () { + return (string)rand(100000000, 999999999); + }); + + $this->assertTrue(key_exists( + 'id', + $this->api->addUser('', 'PasswordOfTheNewUser')->getData() + )); + } + + public function testAddUserSuccessfulGeneratePassword(): void { + $this->userManager + ->expects($this->once()) + ->method('userExists') + ->with('NewUser') + ->willReturn(false); + $newUser = $this->createMock(IUser::class); + $newUser->expects($this->once()) + ->method('setSystemEMailAddress'); + $this->userManager + ->expects($this->once()) + ->method('createUser') + ->willReturn($newUser); + $this->logger + ->expects($this->once()) + ->method('info') + ->with('Successful addUser call with userid: NewUser', ['app' => 'ocs_api']); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('adminUser') ->willReturn(true); + $this->eventDispatcher + ->expects($this->once()) + ->method('dispatchTyped') + ->with(new GenerateSecurePasswordEvent()); - $this->assertEquals([], $this->api->addUser('NewUser', 'PasswordOfTheNewUser')->getData()); + $this->assertTrue(key_exists( + 'id', + $this->api->addUser('NewUser', '', '', 'foo@bar')->getData() + )); } - public function testAddUserExistingGroup() { + public function testAddUserSuccessfulLowercaseEmail(): void { $this->userManager ->expects($this->once()) ->method('userExists') ->with('NewUser') ->willReturn(false); + $newUser = $this->createMock(IUser::class); + $newUser->expects($this->once()) + ->method('setSystemEMailAddress') + ->with('foo@bar.com'); + $this->userManager + ->expects($this->once()) + ->method('createUser') + ->willReturn($newUser); + $this->logger + ->expects($this->once()) + ->method('info') + ->with('Successful addUser call with userid: NewUser', ['app' => 'ocs_api']); $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + $this->eventDispatcher + ->expects($this->once()) + ->method('dispatchTyped') + ->with(new GenerateSecurePasswordEvent()); + + $this->assertTrue(key_exists( + 'id', + $this->api->addUser('NewUser', '', '', 'fOo@BaR.CoM')->getData() + )); + } + + + public function testAddUserFailedToGenerateUserID(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Could not create non-existing user ID'); + $this->expectExceptionCode(111); + + $this->config + ->expects($this->any()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'newUser.generateUserID') { + return 'yes'; + } + return null; + }); + $this->userManager + ->expects($this->any()) + ->method('userExists') + ->with($this->anything()) + ->willReturn(true); + $this->userManager + ->expects($this->never()) + ->method('createUser'); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + + $this->api->addUser('', 'PasswordOfTheNewUser')->getData(); + } + + + public function testAddUserEmailRequired(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Required email address was not provided'); + $this->expectExceptionCode(110); + + $this->config + ->expects($this->any()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'newUser.requireEmail') { + return 'yes'; + } + return null; + }); + $this->userManager + ->expects($this->once()) + ->method('userExists') + ->with('NewUser') + ->willReturn(false); + $this->userManager + ->expects($this->never()) + ->method('createUser'); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->groupManager + ->expects($this->once()) + ->method('isAdmin') + ->with('adminUser') + ->willReturn(true); + + $this->assertTrue(key_exists( + 'id', + $this->api->addUser('NewUser', 'PasswordOfTheNewUser')->getData() + )); + } + + public function testAddUserExistingGroup(): void { + $this->userManager + ->expects($this->once()) + ->method('userExists') + ->with('NewUser') + ->willReturn(false); + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('adminUser'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -397,48 +829,60 @@ class UsersControllerTest extends TestCase { ->method('get') ->with('ExistingGroup') ->willReturn($group); + + $calls = [ + ['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']], + ['Added userid NewUser to group ExistingGroup', ['app' => 'ocs_api']], + ]; $this->logger ->expects($this->exactly(2)) ->method('info') - ->withConsecutive( - ['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']], - ['Added userid NewUser to group ExistingGroup', ['app' => 'ocs_api']] - ); + ->willReturnCallback(function () use (&$calls): void { + $expected = array_shift($calls); + $this->assertEquals($expected, func_get_args()); + }); - $this->assertEquals([], $this->api->addUser('NewUser', 'PasswordOfTheNewUser', ['ExistingGroup'])->getData()); + $this->assertArrayHasKey('id', $this->api->addUser('NewUser', 'PasswordOfTheNewUser', '', '', ['ExistingGroup'])->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Bad request - */ - public function testAddUserUnsuccessful() { + + public function testAddUserUnsuccessful(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Bad request'); + $this->expectExceptionCode(101); + + $exception = new Exception('User backend not found.'); $this->userManager ->expects($this->once()) ->method('userExists') ->with('NewUser') - ->will($this->returnValue(false)); + ->willReturn(false); $this->userManager ->expects($this->once()) ->method('createUser') ->with('NewUser', 'PasswordOfTheNewUser') - ->will($this->throwException(new Exception('User backend not found.'))); + ->willThrowException($exception); $this->logger ->expects($this->once()) ->method('error') - ->with('Failed addUser attempt with exception: User backend not found.', ['app' => 'ocs_api']); + ->with( + 'Failed addUser attempt with exception.', + [ + 'app' => 'ocs_api', + 'exception' => $exception + ] + ); $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('adminUser')); + ->willReturn('adminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -448,23 +892,23 @@ class UsersControllerTest extends TestCase { $this->api->addUser('NewUser', 'PasswordOfTheNewUser'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 106 - * @expectedExceptionMessage no group specified (required for subadmins) - */ - public function testAddUserAsSubAdminNoGroup() { + + public function testAddUserAsSubAdminNoGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('No group specified (required for sub-admins)'); + $this->expectExceptionCode(106); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('regularUser')); + ->willReturn('regularUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -478,26 +922,26 @@ class UsersControllerTest extends TestCase { ->with() ->willReturn($subAdminManager); - $this->api->addUser('NewUser', 'PasswordOfTheNewUser', null); + $this->api->addUser('NewUser', 'PasswordOfTheNewUser', '', '', []); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 105 - * @expectedExceptionMessage insufficient privileges for group ExistingGroup - */ - public function testAddUserAsSubAdminValidGroupNotSubAdmin() { + + public function testAddUserAsSubAdminValidGroupNotSubAdmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Insufficient privileges for group ExistingGroup'); + $this->expectExceptionCode(105); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('regularUser')); + ->willReturn('regularUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -527,10 +971,10 @@ class UsersControllerTest extends TestCase { ->with('ExistingGroup') ->willReturn(true); - $this->api->addUser('NewUser', 'PasswordOfTheNewUser', ['ExistingGroup'])->getData(); + $this->api->addUser('NewUser', 'PasswordOfTheNewUser', '', '', ['ExistingGroup'])->getData(); } - public function testAddUserAsSubAdminExistingGroups() { + public function testAddUserAsSubAdminExistingGroups(): void { $this->userManager ->expects($this->once()) ->method('userExists') @@ -540,13 +984,13 @@ class UsersControllerTest extends TestCase { ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('subAdminUser')); + ->willReturn('subAdminUser'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') @@ -555,11 +999,10 @@ class UsersControllerTest extends TestCase { $this->groupManager ->expects($this->exactly(2)) ->method('groupExists') - ->withConsecutive( - ['ExistingGroup1'], - ['ExistingGroup2'] - ) - ->willReturn(true); + ->willReturnMap([ + ['ExistingGroup1', true], + ['ExistingGroup2', true] + ]); $user = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); @@ -585,24 +1028,23 @@ class UsersControllerTest extends TestCase { $this->groupManager ->expects($this->exactly(4)) ->method('get') - ->withConsecutive( - ['ExistingGroup1'], - ['ExistingGroup2'], - ['ExistingGroup1'], - ['ExistingGroup2'] - ) - ->will($this->returnValueMap([ + ->willReturnMap([ ['ExistingGroup1', $existingGroup1], ['ExistingGroup2', $existingGroup2] - ])); + ]); + + $calls = [ + ['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']], + ['Added userid NewUser to group ExistingGroup1', ['app' => 'ocs_api']], + ['Added userid NewUser to group ExistingGroup2', ['app' => 'ocs_api']], + ]; $this->logger ->expects($this->exactly(3)) ->method('info') - ->withConsecutive( - ['Successful addUser call with userid: NewUser', ['app' => 'ocs_api']], - ['Added userid NewUser to group ExistingGroup1', ['app' => 'ocs_api']], - ['Added userid NewUser to group ExistingGroup2', ['app' => 'ocs_api']] - ); + ->willReturnCallback(function () use (&$calls): void { + $expected = array_shift($calls); + $this->assertEquals($expected, func_get_args()); + }); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $this->groupManager @@ -612,160 +1054,219 @@ class UsersControllerTest extends TestCase { $subAdminManager ->expects($this->exactly(2)) ->method('isSubAdminOfGroup') - ->withConsecutive( - [$loggedInUser, $existingGroup1], - [$loggedInUser, $existingGroup2] - ) - ->willReturn(true); + ->willReturnMap([ + [$loggedInUser, $existingGroup1, true], + [$loggedInUser, $existingGroup2, true], + ]); - $this->assertEquals([], $this->api->addUser('NewUser', 'PasswordOfTheNewUser', ['ExistingGroup1', 'ExistingGroup2'])->getData()); + $this->assertArrayHasKey('id', $this->api->addUser('NewUser', 'PasswordOfTheNewUser', '', '', ['ExistingGroup1', 'ExistingGroup2'])->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 998 - * @expectedExceptionMessage The requested user could not be found - */ - public function testGetUserTargetDoesNotExist() { + + public function testGetUserTargetDoesNotExist(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('User does not exist'); + $this->expectExceptionCode(404); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession - ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->getUser('UserToGet'); } - public function testGetUserDataAsAdmin() { - $group = $this->getMockBuilder(IGroup::class) + public function testGetUserDataAsAdmin(): void { + $group0 = $this->createMock(IGroup::class); + $group1 = $this->createMock(IGroup::class); + $group2 = $this->createMock(IGroup::class); + $group3 = $this->createMock(IGroup::class); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); - $loggedInUser = $this->getMockBuilder(IUser::class) + $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $targetUser->expects($this->once()) - ->method('getEMailAddress') - ->willReturn('demo@owncloud.org'); + ->method('getSystemEMailAddress') + ->willReturn('demo@nextcloud.com'); $this->userSession - ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager - ->expects($this->once()) ->method('get') - ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->with('UID') + ->willReturn($targetUser); $this->groupManager - ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->any()) ->method('getUserGroups') - ->willReturn([$group, $group, $group]); - $group->expects($this->at(0)) - ->method('getDisplayName') + ->willReturn([$group0, $group1, $group2]); + $this->groupManager + ->expects($this->once()) + ->method('getSubAdmin') + ->willReturn($subAdminManager); + $subAdminManager + ->expects($this->once()) + ->method('getSubAdminsGroups') + ->willReturn([$group3]); + $group0->expects($this->once()) + ->method('getGID') ->willReturn('group0'); - $group->expects($this->at(1)) - ->method('getDisplayName') + $group1->expects($this->once()) + ->method('getGID') ->willReturn('group1'); - $group->expects($this->at(2)) - ->method('getDisplayName') + $group2->expects($this->once()) + ->method('getGID') ->willReturn('group2'); - $this->accountManager->expects($this->any())->method('getUser') - ->with($targetUser) - ->willReturn( - [ - AccountManager::PROPERTY_ADDRESS => ['value' => 'address'], - AccountManager::PROPERTY_PHONE => ['value' => 'phone'], - AccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], - AccountManager::PROPERTY_WEBSITE => ['value' => 'website'], - ] - ); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('UID', 'core', 'enabled', 'true') - ->will($this->returnValue('true')); + $group3->expects($this->once()) + ->method('getGID') + ->willReturn('group3'); + + $this->mockAccount($targetUser, [ + IAccountManager::PROPERTY_ADDRESS => ['value' => 'address'], + IAccountManager::PROPERTY_PHONE => ['value' => 'phone'], + IAccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], + IAccountManager::PROPERTY_BLUESKY => ['value' => 'bluesky'], + IAccountManager::PROPERTY_FEDIVERSE => ['value' => 'fediverse'], + IAccountManager::PROPERTY_WEBSITE => ['value' => 'website'], + IAccountManager::PROPERTY_ORGANISATION => ['value' => 'organisation'], + IAccountManager::PROPERTY_ROLE => ['value' => 'role'], + IAccountManager::PROPERTY_HEADLINE => ['value' => 'headline'], + IAccountManager::PROPERTY_BIOGRAPHY => ['value' => 'biography'], + IAccountManager::PROPERTY_PROFILE_ENABLED => ['value' => '1'], + IAccountManager::PROPERTY_PRONOUNS => ['value' => 'they/them'], + ]); $this->config - ->expects($this->at(1)) ->method('getUserValue') - ->with('UID', 'core', 'lang') - ->will($this->returnValue('de')); + ->willReturnMap([ + ['UID', 'core', 'enabled', 'true', 'true'], + ]); $this->api ->expects($this->once()) ->method('fillStorageInfo') - ->with('UID') - ->will($this->returnValue(['DummyValue'])); + ->with($targetUser) + ->willReturn(['DummyValue']); + + $backend = $this->createMock(UserInterface::class); + $backend->expects($this->any()) + ->method('implementsActions') + ->willReturn(true); + $targetUser ->expects($this->once()) ->method('getDisplayName') - ->will($this->returnValue('Demo User')); + ->willReturn('Demo User'); + $targetUser + ->expects($this->once()) + ->method('getHome') + ->willReturn('/var/www/newtcloud/data/UID'); + $targetUser + ->expects($this->exactly(2)) + ->method('getLastLogin') + ->willReturn(1521191471); + $targetUser + ->expects($this->once()) + ->method('getFirstLogin') + ->willReturn(1511191471); + $targetUser + ->expects($this->once()) + ->method('getBackendClassName') + ->willReturn('Database'); + $targetUser + ->expects($this->once()) + ->method('getBackend') + ->willReturn($backend); $targetUser - ->expects($this->exactly(4)) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $this->l10nFactory + ->expects($this->once()) + ->method('getUserLanguage') + ->with($targetUser) + ->willReturn('de'); $expected = [ 'id' => 'UID', - 'enabled' => 'true', + 'enabled' => true, + 'storageLocation' => '/var/www/newtcloud/data/UID', + 'firstLoginTimestamp' => 1511191471, + 'lastLoginTimestamp' => 1521191471, + 'lastLogin' => 1521191471000, + 'backend' => 'Database', + 'subadmin' => ['group3'], 'quota' => ['DummyValue'], - 'email' => 'demo@owncloud.org', + 'email' => 'demo@nextcloud.com', 'displayname' => 'Demo User', + 'display-name' => 'Demo User', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', 'twitter' => 'twitter', + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', 'groups' => ['group0', 'group1', 'group2'], 'language' => 'de', + 'locale' => null, + 'backendCapabilities' => [ + 'setDisplayName' => true, + 'setPassword' => true, + ], + 'additional_mail' => [], + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'notify_email' => null, + 'manager' => '', + 'pronouns' => 'they/them', ]; - $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UserToGet'])); + $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID'])); } - public function testGetUserDataAsSubAdminAndUserIsAccessible() { + public function testGetUserDataAsSubAdminAndUserIsAccessible(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $targetUser - ->expects($this->once()) - ->method('getEMailAddress') - ->willReturn('demo@owncloud.org'); - $this->userSession ->expects($this->once()) + ->method('getSystemEMailAddress') + ->willReturn('demo@nextcloud.com'); + $this->userSession ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager - ->expects($this->once()) ->method('get') - ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->with('UID') + ->willReturn($targetUser); $this->groupManager - ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->any()) ->method('getUserGroups') @@ -777,91 +1278,146 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); - $this->groupManager + ->willReturn(true); + $subAdminManager ->expects($this->once()) + ->method('getSubAdminsGroups') + ->willReturn([]); + $this->groupManager + ->expects($this->exactly(2)) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('UID', 'core', 'enabled', 'true') - ->will($this->returnValue('true')); + ->willReturn($subAdminManager); $this->config - ->expects($this->at(1)) ->method('getUserValue') - ->with('UID', 'core', 'lang') - ->will($this->returnValue('da')); + ->willReturnMap([ + ['UID', 'core', 'enabled', 'true', 'true'], + ]); $this->api ->expects($this->once()) ->method('fillStorageInfo') - ->with('UID') - ->will($this->returnValue(['DummyValue'])); + ->with($targetUser) + ->willReturn(['DummyValue']); + + $backend = $this->createMock(UserInterface::class); + $backend->expects($this->any()) + ->method('implementsActions') + ->willReturn(true); + $targetUser ->expects($this->once()) ->method('getDisplayName') - ->will($this->returnValue('Demo User')); + ->willReturn('Demo User'); + $targetUser + ->expects($this->never()) + ->method('getHome'); + $targetUser + ->expects($this->exactly(2)) + ->method('getLastLogin') + ->willReturn(1521191471); + $targetUser + ->expects($this->once()) + ->method('getFirstLogin') + ->willReturn(1511191471); + $targetUser + ->expects($this->once()) + ->method('getBackendClassName') + ->willReturn('Database'); + $targetUser + ->expects($this->once()) + ->method('getBackend') + ->willReturn($backend); $targetUser - ->expects($this->exactly(4)) ->method('getUID') - ->will($this->returnValue('UID')); - $this->accountManager->expects($this->any())->method('getUser') + ->willReturn('UID'); + + $this->mockAccount($targetUser, [ + IAccountManager::PROPERTY_ADDRESS => ['value' => 'address'], + IAccountManager::PROPERTY_PHONE => ['value' => 'phone'], + IAccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], + IAccountManager::PROPERTY_BLUESKY => ['value' => 'bluesky'], + IAccountManager::PROPERTY_FEDIVERSE => ['value' => 'fediverse'], + IAccountManager::PROPERTY_WEBSITE => ['value' => 'website'], + IAccountManager::PROPERTY_ORGANISATION => ['value' => 'organisation'], + IAccountManager::PROPERTY_ROLE => ['value' => 'role'], + IAccountManager::PROPERTY_HEADLINE => ['value' => 'headline'], + IAccountManager::PROPERTY_BIOGRAPHY => ['value' => 'biography'], + IAccountManager::PROPERTY_PROFILE_ENABLED => ['value' => '1'], + IAccountManager::PROPERTY_PRONOUNS => ['value' => 'they/them'], + ]); + + $this->l10nFactory + ->expects($this->once()) + ->method('getUserLanguage') ->with($targetUser) - ->willReturn( - [ - AccountManager::PROPERTY_ADDRESS => ['value' => 'address'], - AccountManager::PROPERTY_PHONE => ['value' => 'phone'], - AccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], - AccountManager::PROPERTY_WEBSITE => ['value' => 'website'], - ] - ); + ->willReturn('da'); $expected = [ 'id' => 'UID', - 'enabled' => 'true', + 'enabled' => true, + 'firstLoginTimestamp' => 1511191471, + 'lastLoginTimestamp' => 1521191471, + 'lastLogin' => 1521191471000, + 'backend' => 'Database', + 'subadmin' => [], 'quota' => ['DummyValue'], - 'email' => 'demo@owncloud.org', + 'email' => 'demo@nextcloud.com', 'displayname' => 'Demo User', + 'display-name' => 'Demo User', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', 'twitter' => 'twitter', + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', 'groups' => [], 'language' => 'da', + 'locale' => null, + 'backendCapabilities' => [ + 'setDisplayName' => true, + 'setPassword' => true, + ], + 'additional_mail' => [], + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'notify_email' => null, + 'manager' => '', + 'pronouns' => 'they/them', ]; - $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UserToGet'])); + $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID'])); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testGetUserDataAsSubAdminAndUserIsNotAccessible() { + + public function testGetUserDataAsSubAdminAndUserIsNotAccessible(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(4)) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession - ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -869,40 +1425,36 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); - $this->invokePrivate($this->api, 'getUserData', ['UserToGet']); + $this->invokePrivate($this->api, 'getUser', ['UserToGet']); } - public function testGetUserDataAsSubAdminSelfLookup() { + public function testGetUserDataAsSubAdminSelfLookup(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession - ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager - ->expects($this->once()) ->method('get') - ->with('subadmin') - ->will($this->returnValue($targetUser)); + ->with('UID') + ->willReturn($targetUser); $this->groupManager - ->expects($this->once()) ->method('isAdmin') ->with('UID') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -910,11 +1462,15 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); - $this->groupManager + ->willReturn(false); + $subAdminManager ->expects($this->once()) + ->method('getSubAdminsGroups') + ->willReturn([]); + $this->groupManager + ->expects($this->exactly(2)) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) ->method('getUserGroups') @@ -922,168 +1478,600 @@ class UsersControllerTest extends TestCase { $this->api ->expects($this->once()) ->method('fillStorageInfo') - ->with('UID') - ->will($this->returnValue(['DummyValue'])); + ->with($targetUser) + ->willReturn(['DummyValue']); + + $backend = $this->createMock(UserInterface::class); + $backend->expects($this->atLeastOnce()) + ->method('implementsActions') + ->willReturn(false); + $targetUser ->expects($this->once()) ->method('getDisplayName') - ->will($this->returnValue('Subadmin User')); + ->willReturn('Subadmin User'); $targetUser ->expects($this->once()) - ->method('getEMailAddress') - ->will($this->returnValue('subadmin@owncloud.org')); + ->method('getSystemEMailAddress') + ->willReturn('subadmin@nextcloud.com'); $targetUser - ->expects($this->exactly(4)) ->method('getUID') - ->will($this->returnValue('UID')); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('UID', 'core', 'lang') - ->will($this->returnValue('ru')); - $this->accountManager->expects($this->any())->method('getUser') + ->willReturn('UID'); + $targetUser + ->expects($this->never()) + ->method('getHome'); + $targetUser + ->expects($this->exactly(2)) + ->method('getLastLogin') + ->willReturn(1521191471); + $targetUser + ->expects($this->once()) + ->method('getFirstLogin') + ->willReturn(1511191471); + $targetUser + ->expects($this->once()) + ->method('getBackendClassName') + ->willReturn('Database'); + $targetUser + ->expects($this->once()) + ->method('getBackend') + ->willReturn($backend); + $this->mockAccount($targetUser, [ + IAccountManager::PROPERTY_ADDRESS => ['value' => 'address'], + IAccountManager::PROPERTY_PHONE => ['value' => 'phone'], + IAccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], + IAccountManager::PROPERTY_BLUESKY => ['value' => 'bluesky'], + IAccountManager::PROPERTY_FEDIVERSE => ['value' => 'fediverse'], + IAccountManager::PROPERTY_WEBSITE => ['value' => 'website'], + IAccountManager::PROPERTY_ORGANISATION => ['value' => 'organisation'], + IAccountManager::PROPERTY_ROLE => ['value' => 'role'], + IAccountManager::PROPERTY_HEADLINE => ['value' => 'headline'], + IAccountManager::PROPERTY_BIOGRAPHY => ['value' => 'biography'], + IAccountManager::PROPERTY_PROFILE_ENABLED => ['value' => '1'], + IAccountManager::PROPERTY_PRONOUNS => ['value' => 'they/them'], + ]); + + $this->l10nFactory + ->expects($this->once()) + ->method('getUserLanguage') ->with($targetUser) - ->willReturn( - [ - AccountManager::PROPERTY_ADDRESS => ['value' => 'address'], - AccountManager::PROPERTY_PHONE => ['value' => 'phone'], - AccountManager::PROPERTY_TWITTER => ['value' => 'twitter'], - AccountManager::PROPERTY_WEBSITE => ['value' => 'website'], - ] - ); + ->willReturn('ru'); $expected = [ 'id' => 'UID', + 'firstLoginTimestamp' => 1511191471, + 'lastLoginTimestamp' => 1521191471, + 'lastLogin' => 1521191471000, + 'backend' => 'Database', + 'subadmin' => [], 'quota' => ['DummyValue'], - 'email' => 'subadmin@owncloud.org', + 'email' => 'subadmin@nextcloud.com', 'displayname' => 'Subadmin User', + 'display-name' => 'Subadmin User', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', 'twitter' => 'twitter', + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', 'groups' => [], 'language' => 'ru', + 'locale' => null, + 'backendCapabilities' => [ + 'setDisplayName' => false, + 'setPassword' => false, + ], + 'additional_mail' => [], + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'notify_email' => null, + 'manager' => '', + 'pronouns' => 'they/them', + ]; + $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID'])); + } + + public static function dataSearchByPhoneNumbers(): array { + return [ + 'Invalid country' => ['Not a country code', ['12345' => ['NaN']], 400, null, null, []], + 'No number to search' => ['DE', ['12345' => ['NaN']], 200, null, null, []], + 'Valid number but no match' => ['DE', ['12345' => ['0711 / 25 24 28-90']], 200, ['+4971125242890'], [], []], + 'Invalid number' => ['FR', ['12345' => ['0711 / 25 24 28-90']], 200, null, null, []], + 'Invalid and valid number' => ['DE', ['12345' => ['NaN', '0711 / 25 24 28-90']], 200, ['+4971125242890'], [], []], + 'Valid and invalid number' => ['DE', ['12345' => ['0711 / 25 24 28-90', 'NaN']], 200, ['+4971125242890'], [], []], + 'Valid number and a match' => ['DE', ['12345' => ['0711 / 25 24 28-90']], 200, ['+4971125242890'], ['+4971125242890' => 'admin'], ['12345' => 'admin@localhost']], + 'Same number twice, later hits' => ['DE', ['12345' => ['0711 / 25 24 28-90'], '23456' => ['0711 / 25 24 28-90']], 200, ['+4971125242890'], ['+4971125242890' => 'admin'], ['23456' => 'admin@localhost']], ]; - $this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['subadmin'])); } - public function testEditUserRegularUserSelfEditChangeDisplayName() { + #[\PHPUnit\Framework\Attributes\DataProvider('dataSearchByPhoneNumbers')] + public function testSearchByPhoneNumbers(string $location, array $search, int $status, ?array $searchUsers, ?array $userMatches, array $expected): void { + $knownTo = 'knownTo'; + $user = $this->createMock(IUser::class); + $user->method('getUID') + ->willReturn($knownTo); + $this->userSession->method('getUser') + ->willReturn($user); + + if ($searchUsers === null) { + $this->accountManager->expects($this->never()) + ->method('searchUsers'); + } else { + $this->accountManager->expects($this->once()) + ->method('searchUsers') + ->with(IAccountManager::PROPERTY_PHONE, $searchUsers) + ->willReturn($userMatches); + + $this->knownUserService->expects($this->once()) + ->method('deleteKnownTo') + ->with($knownTo); + + $this->knownUserService->expects($this->exactly(count($expected))) + ->method('storeIsKnownToUser') + ->with($knownTo, $this->anything()); + } + + $this->urlGenerator->method('getAbsoluteURL') + ->with('/') + ->willReturn('https://localhost/'); + + $response = $this->api->searchByPhoneNumbers($location, $search); + + self::assertEquals($status, $response->getStatus()); + self::assertEquals($expected, $response->getData()); + } + + public function testEditUserRegularUserSelfEditChangeDisplayName(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); + $targetUser + ->expects($this->once()) + ->method('getBackend') + ->willReturn($this->createMock(ISetDisplayNameBackend::class)); $targetUser ->expects($this->once()) ->method('setDisplayName') - ->with('NewDisplayName'); + ->with('NewDisplayName') + ->willReturn(true); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->assertEquals([], $this->api->editUser('UserToEdit', 'display', 'NewDisplayName')->getData()); } - public function testEditUserRegularUserSelfEditChangeEmailValid() { + public function testEditUserRegularUserSelfEditChangeEmailValid(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $targetUser ->expects($this->once()) - ->method('setEMailAddress') - ->with('demo@owncloud.org'); + ->method('setSystemEMailAddress') + ->with('demo@nextcloud.com'); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); - $this->assertEquals([], $this->api->editUser('UserToEdit', 'email', 'demo@owncloud.org')->getData()); + $this->config->method('getSystemValue')->willReturnCallback(fn (string $key, mixed $default) => $default); + + $this->assertEquals([], $this->api->editUser('UserToEdit', 'email', 'demo@nextcloud.com')->getData()); } + public function testEditUserRegularUserSelfEditAddAdditionalEmailValid(): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + $targetUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->userManager + ->expects($this->once()) + ->method('get') + ->with('UserToEdit') + ->willReturn($targetUser); + $targetUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + + $userAccount = $this->createMock(IAccount::class); - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testEditUserRegularUserSelfEditChangeEmailInvalid() { + $this->accountManager + ->expects($this->once()) + ->method('getAccount') + ->with($targetUser) + ->willReturn($userAccount); + $this->accountManager + ->expects($this->once()) + ->method('updateAccount') + ->with($userAccount); + + $this->assertEquals([], $this->api->editUser('UserToEdit', 'additional_mail', 'demo1@nextcloud.com')->getData()); + } + + public function testEditUserRegularUserSelfEditAddAdditionalEmailMainAddress(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + $targetUser + ->expects($this->any()) + ->method('getSystemEMailAddress') + ->willReturn('demo@nextcloud.com'); + + $userAccount = $this->createMock(IAccount::class); + + $this->accountManager + ->expects($this->never()) + ->method('getAccount') + ->with($targetUser) + ->willReturn($userAccount); + $this->accountManager + ->expects($this->never()) + ->method('updateAccount') + ->with($userAccount); + + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $this->api->editUser('UserToEdit', 'additional_mail', 'demo@nextcloud.com')->getData(); + } + + public function testEditUserRegularUserSelfEditAddAdditionalEmailDuplicate(): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + $targetUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->userManager + ->expects($this->once()) + ->method('get') + ->with('UserToEdit') + ->willReturn($targetUser); + $targetUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + + $property = $this->createMock(IAccountProperty::class); + $property->method('getValue') + ->willReturn('demo1@nextcloud.com'); + $collection = $this->createMock(IAccountPropertyCollection::class); + $collection->method('getPropertyByValue') + ->with('demo1@nextcloud.com') + ->willReturn($property); + + $userAccount = $this->createMock(IAccount::class); + $userAccount->method('getPropertyCollection') + ->with(IAccountManager::COLLECTION_EMAIL) + ->willReturn($collection); + + $this->accountManager + ->expects($this->once()) + ->method('getAccount') + ->with($targetUser) + ->willReturn($userAccount); + $this->accountManager + ->expects($this->never()) + ->method('updateAccount') + ->with($userAccount); + + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $this->api->editUser('UserToEdit', 'additional_mail', 'demo1@nextcloud.com')->getData(); + } + + public function testEditUserRegularUserSelfEditChangeEmailInvalid(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + $targetUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->userManager + ->expects($this->once()) + ->method('get') + ->with('UserToEdit') + ->willReturn($targetUser); + $targetUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + + $this->config->method('getSystemValue')->willReturnCallback(fn (string $key, mixed $default) => $default); $this->api->editUser('UserToEdit', 'email', 'demo.org'); } - public function testEditUserRegularUserSelfEditChangePassword() { + public static function selfEditChangePropertyProvider(): array { + return [ + [IAccountManager::PROPERTY_TWITTER, '@oldtwitter', '@newtwitter'], + [IAccountManager::PROPERTY_BLUESKY, 'old.bluesky', 'new.bluesky'], + [IAccountManager::PROPERTY_FEDIVERSE, '@oldFediverse@floss.social', '@newFediverse@floss.social'], + [IAccountManager::PROPERTY_PHONE, '1234', '12345'], + [IAccountManager::PROPERTY_ADDRESS, 'Something street 2', 'Another street 3'], + [IAccountManager::PROPERTY_WEBSITE, 'https://examplesite1', 'https://examplesite2'], + [IAccountManager::PROPERTY_ORGANISATION, 'Organisation A', 'Organisation B'], + [IAccountManager::PROPERTY_ROLE, 'Human', 'Alien'], + [IAccountManager::PROPERTY_HEADLINE, 'Hi', 'Hello'], + [IAccountManager::PROPERTY_BIOGRAPHY, 'A biography', 'Another biography'], + [IAccountManager::PROPERTY_PROFILE_ENABLED, '1', '0'], + [IAccountManager::PROPERTY_PRONOUNS, 'they/them', 'he/him'], + ]; + } + + #[\PHPUnit\Framework\Attributes\DataProvider('selfEditChangePropertyProvider')] + public function testEditUserRegularUserSelfEditChangeProperty($propertyName, $oldValue, $newValue): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->userManager + ->expects($this->once()) + ->method('get') + ->with('UserToEdit') + ->willReturn($loggedInUser); + + $backend = $this->createMock(UserInterface::class); + $loggedInUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + + $propertyMock = $this->createMock(IAccountProperty::class); + $propertyMock->expects($this->any()) + ->method('getName') + ->willReturn($propertyName); + $propertyMock->expects($this->any()) + ->method('getValue') + ->willReturn($oldValue); + $propertyMock->expects($this->once()) + ->method('setValue') + ->with($newValue) + ->willReturnSelf(); + $propertyMock->expects($this->any()) + ->method('getScope') + ->willReturn(IAccountManager::SCOPE_LOCAL); + + $accountMock = $this->createMock(IAccount::class); + $accountMock->expects($this->any()) + ->method('getProperty') + ->with($propertyName) + ->willReturn($propertyMock); + + $this->accountManager->expects($this->atLeastOnce()) + ->method('getAccount') + ->with($loggedInUser) + ->willReturn($accountMock); + $this->accountManager->expects($this->once()) + ->method('updateAccount') + ->with($accountMock); + + $this->assertEquals([], $this->api->editUser('UserToEdit', $propertyName, $newValue)->getData()); + } + + public function selfEditChangePropertyScopeProvider() { + return [ + [IAccountManager::PROPERTY_AVATAR, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_DISPLAYNAME, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_EMAIL, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_TWITTER, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_BLUESKY, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_FEDIVERSE, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_PHONE, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_ADDRESS, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_WEBSITE, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_ORGANISATION, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_ROLE, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_HEADLINE, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_BIOGRAPHY, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_PROFILE_ENABLED, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + [IAccountManager::PROPERTY_PRONOUNS, IAccountManager::SCOPE_LOCAL, IAccountManager::SCOPE_FEDERATED], + ]; + } + + #[\PHPUnit\Framework\Attributes\DataProvider('selfEditChangePropertyProvider')] + public function testEditUserRegularUserSelfEditChangePropertyScope($propertyName, $oldScope, $newScope): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + $this->userSession + ->expects($this->once()) + ->method('getUser') + ->willReturn($loggedInUser); + $this->userManager + ->expects($this->once()) + ->method('get') + ->with('UserToEdit') + ->willReturn($loggedInUser); + + $backend = $this->createMock(UserInterface::class); + $loggedInUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); + + $propertyMock = $this->createMock(IAccountProperty::class); + $propertyMock->expects($this->any()) + ->method('getName') + ->willReturn($propertyName); + $propertyMock->expects($this->any()) + ->method('getValue') + ->willReturn('somevalue'); + $propertyMock->expects($this->any()) + ->method('getScope') + ->willReturn($oldScope); + $propertyMock->expects($this->atLeastOnce()) + ->method('setScope') + ->with($newScope) + ->willReturnSelf(); + + $accountMock = $this->createMock(IAccount::class); + $accountMock->expects($this->any()) + ->method('getProperty') + ->with($propertyName) + ->willReturn($propertyMock); + + $this->accountManager->expects($this->atLeastOnce()) + ->method('getAccount') + ->with($loggedInUser) + ->willReturn($accountMock); + $this->accountManager->expects($this->once()) + ->method('updateAccount') + ->with($accountMock); + + $this->assertEquals([], $this->api->editUser('UserToEdit', $propertyName . 'Scope', $newScope)->getData()); + } + + public function testEditUserRegularUserSelfEditChangePassword(): void { + $loggedInUser = $this->getMockBuilder(IUser::class) + ->disableOriginalConstructor() + ->getMock(); + $loggedInUser + ->expects($this->any()) + ->method('getUID') + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); + $targetUser + ->expects($this->once()) + ->method('canChangePassword') + ->willReturn(true); $targetUser ->expects($this->once()) ->method('setPassword') @@ -1091,50 +2079,71 @@ class UsersControllerTest extends TestCase { $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'password', 'NewPassword')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testEditUserRegularUserSelfEditChangeQuota() { + + public function testEditUserRegularUserSelfEditChangeQuota(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(113); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->api->editUser('UserToEdit', 'quota', 'NewQuota'); } - public function testEditUserAdminUserSelfEditChangeValidQuota() { + public function testEditUserAdminUserSelfEditChangeValidQuota(): void { + $this->config + ->expects($this->once()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'max_quota') { + return '-1'; + } + return null; + }); $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser->expects($this->once()) ->method('setQuota') @@ -1142,66 +2151,87 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('isAdmin') ->with('UID') - ->will($this->returnValue(true)); + ->willReturn(true); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'quota', '3042824')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - * @expectedExceptionMessage Invalid quota value ABC - */ - public function testEditUserAdminUserSelfEditChangeInvalidQuota() { + + public function testEditUserAdminUserSelfEditChangeInvalidQuota(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Invalid quota value: ABC'); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('isAdmin') ->with('UID') - ->will($this->returnValue(true)); + ->willReturn(true); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->api->editUser('UserToEdit', 'quota', 'ABC'); } - public function testEditUserAdminUserEditChangeValidQuota() { + public function testEditUserAdminUserEditChangeValidQuota(): void { + $this->config + ->expects($this->once()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'max_quota') { + return '-1'; + } + return null; + }); $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser->expects($this->once()) ->method('setQuota') @@ -1209,34 +2239,39 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'quota', '3042824')->getData()); } - public function testEditUserSelfEditChangeLanguage() { - + public function testEditUserSelfEditChangeLanguage(): void { $this->l10nFactory->expects($this->once()) ->method('findAvailableLanguages') ->willReturn(['en', 'de', 'sv']); @@ -1251,7 +2286,7 @@ class UsersControllerTest extends TestCase { $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); $targetUser = $this->createMock(IUser::class); $this->config->expects($this->once()) ->method('setUserValue') @@ -1259,37 +2294,42 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->atLeastOnce()) ->method('isAdmin') ->with('UserToEdit') - ->will($this->returnValue(false)); + ->willReturn(false); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'language', 'de')->getData()); } - public function dataEditUserSelfEditChangeLanguageButForced() { + public static function dataEditUserSelfEditChangeLanguageButForced(): array { return [ ['de'], [true], ]; } - /** - * @dataProvider dataEditUserSelfEditChangeLanguageButForced - * @expectedException \OCP\AppFramework\OCS\OCSException - */ - public function testEditUserSelfEditChangeLanguageButForced($forced) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataEditUserSelfEditChangeLanguageButForced')] + public function testEditUserSelfEditChangeLanguageButForced($forced): void { + $this->expectException(OCSException::class); + $this->config->expects($this->any()) ->method('getSystemValue') ->willReturnMap([ @@ -1301,34 +2341,39 @@ class UsersControllerTest extends TestCase { $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); $targetUser = $this->createMock(IUser::class); $this->config->expects($this->never()) ->method('setUserValue'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->atLeastOnce()) ->method('isAdmin') ->with('UserToEdit') - ->will($this->returnValue(false)); + ->willReturn(false); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'language', 'de')->getData()); } - public function testEditUserAdminEditChangeLanguage() { - + public function testEditUserAdminEditChangeLanguage(): void { $this->l10nFactory->expects($this->once()) ->method('findAvailableLanguages') ->willReturn(['en', 'de', 'sv']); @@ -1337,7 +2382,7 @@ class UsersControllerTest extends TestCase { $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->createMock(IUser::class); $this->config->expects($this->once()) ->method('setUserValue') @@ -1345,35 +2390,40 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $subAdminManager = $this->createMock(SubAdmin::class); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'language', 'de')->getData()); } - /** - * @dataProvider dataEditUserSelfEditChangeLanguageButForced - * @expectedException \OCP\AppFramework\OCS\OCSException - */ - public function testEditUserAdminEditChangeLanguageInvalidLanguage() { + #[\PHPUnit\Framework\Attributes\DataProvider('dataEditUserSelfEditChangeLanguageButForced')] + public function testEditUserAdminEditChangeLanguageInvalidLanguage(): void { + $this->expectException(OCSException::class); + $this->l10nFactory->expects($this->once()) ->method('findAvailableLanguages') @@ -1383,43 +2433,58 @@ class UsersControllerTest extends TestCase { $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->createMock(IUser::class); $this->config->expects($this->never()) ->method('setUserValue'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $subAdminManager = $this->createMock(SubAdmin::class); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'language', 'ru')->getData()); } - public function testEditUserSubadminUserAccessible() { + public function testEditUserSubadminUserAccessible(): void { + $this->config + ->expects($this->once()) + ->method('getAppValue') + ->willReturnCallback(function ($appid, $key, $default) { + if ($key === 'max_quota') { + return '-1'; + } + return null; + }); $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser->expects($this->once()) ->method('setQuota') @@ -1427,12 +2492,12 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -1440,39 +2505,45 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); + + $backend = $this->createMock(UserInterface::class); + $targetUser + ->expects($this->any()) + ->method('getBackend') + ->willReturn($backend); $this->assertEquals([], $this->api->editUser('UserToEdit', 'quota', '3042824')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testEditUserSubadminUserInaccessible() { + + public function testEditUserSubadminUserInaccessible(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToEdit') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -1480,467 +2551,467 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->api->editUser('UserToEdit', 'quota', 'value'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testDeleteUserNotExistingUser() { + + public function testDeleteUserNotExistingUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UserToEdit')); + ->willReturn('UserToEdit'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->deleteUser('UserToDelete'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testDeleteUserSelf() { + + public function testDeleteUserSelf(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->api->deleteUser('UserToDelete'); } - public function testDeleteSuccessfulUserAsAdmin() { + public function testDeleteSuccessfulUserAsAdmin(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $targetUser ->expects($this->once()) ->method('delete') - ->will($this->returnValue(true)); + ->willReturn(true); $this->assertEquals([], $this->api->deleteUser('UserToDelete')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testDeleteUnsuccessfulUserAsAdmin() { + + public function testDeleteUnsuccessfulUserAsAdmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $targetUser ->expects($this->once()) ->method('delete') - ->will($this->returnValue(false)); + ->willReturn(false); $this->api->deleteUser('UserToDelete'); } - public function testDeleteSuccessfulUserAsSubadmin() { + public function testDeleteSuccessfulUserAsSubadmin(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->once()) ->method('delete') - ->will($this->returnValue(true)); + ->willReturn(true); $this->assertEquals([], $this->api->deleteUser('UserToDelete')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testDeleteUnsuccessfulUserAsSubadmin() { + + public function testDeleteUnsuccessfulUserAsSubadmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->once()) ->method('delete') - ->will($this->returnValue(false)); + ->willReturn(false); $this->api->deleteUser('UserToDelete'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testDeleteUserAsSubAdminAndUserIsNotAccessible() { + + public function testDeleteUserAsSubAdminAndUserIsNotAccessible(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UID')); + ->willReturn('UID'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToDelete') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->api->deleteUser('UserToDelete'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 998 - */ - public function testGetUsersGroupsTargetUserNotExisting() { + + public function testGetUsersGroupsTargetUserNotExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->api->getUsersGroups('UserToLookup'); } - public function testGetUsersGroupsSelfTargetted() { + public function testGetUsersGroupsSelfTargetted(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('UserToLookup')); + ->willReturn('UserToLookup'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UserToLookup')); + ->willReturn('UserToLookup'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToLookup') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('getUserGroupIds') ->with($targetUser) - ->will($this->returnValue(['DummyValue'])); + ->willReturn(['DummyValue']); $this->assertEquals(['groups' => ['DummyValue']], $this->api->getUsersGroups('UserToLookup')->getData()); } - public function testGetUsersGroupsForAdminUser() { + public function testGetUsersGroupsForAdminUser(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UserToLookup')); + ->willReturn('UserToLookup'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToLookup') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('getUserGroupIds') ->with($targetUser) - ->will($this->returnValue(['DummyValue'])); + ->willReturn(['DummyValue']); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->assertEquals(['groups' => ['DummyValue']], $this->api->getUsersGroups('UserToLookup')->getData()); } - public function testGetUsersGroupsForSubAdminUserAndUserIsAccessible() { + public function testGetUsersGroupsForSubAdminUserAndUserIsAccessible(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UserToLookup')); + ->willReturn('UserToLookup'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToLookup') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $group1 = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $group1 ->expects($this->any()) ->method('getGID') - ->will($this->returnValue('Group1')); + ->willReturn('Group1'); $group2 = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $group2 ->expects($this->any()) ->method('getGID') - ->will($this->returnValue('Group2')); + ->willReturn('Group2'); $subAdminManager ->expects($this->once()) ->method('getSubAdminsGroups') ->with($loggedInUser) - ->will($this->returnValue([$group1, $group2])); + ->willReturn([$group1, $group2]); $this->groupManager ->expects($this->any()) ->method('getUserGroupIds') ->with($targetUser) - ->will($this->returnValue(['Group1'])); + ->willReturn(['Group1']); $this->assertEquals(['groups' => ['Group1']], $this->api->getUsersGroups('UserToLookup')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testGetUsersGroupsForSubAdminUserAndUserIsInaccessible() { + + public function testGetUsersGroupsForSubAdminUserAndUserIsInaccessible(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('UserToLookup')); + ->willReturn('UserToLookup'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToLookup') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) ->method('getUserGroupIds') ->with($targetUser) - ->will($this->returnValue(['Group1'])); + ->willReturn(['Group1']); $this->api->getUsersGroups('UserToLookup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testAddToGroupWithTargetGroupNotExisting() { + + public function testAddToGroupWithTargetGroupNotExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(102); + $this->groupManager->expects($this->once()) ->method('get') ->with('GroupToAddTo') @@ -1949,19 +3020,19 @@ class UsersControllerTest extends TestCase { $this->api->addToGroup('TargetUser', 'GroupToAddTo'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testAddToGroupWithNoGroupSpecified() { + + public function testAddToGroupWithNoGroupSpecified(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $this->api->addToGroup('TargetUser'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - */ - public function testAddToGroupWithTargetUserNotExisting() { + + public function testAddToGroupWithTargetUserNotExisting(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(103); + $targetGroup = $this->createMock(IGroup::class); $this->groupManager->expects($this->once()) ->method('get') @@ -1971,14 +3042,14 @@ class UsersControllerTest extends TestCase { $this->api->addToGroup('TargetUser', 'GroupToAddTo'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 104 - */ - public function testAddToGroupNoSubadmin() { + + public function testAddToGroupNoSubadmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(104); + $targetUser = $this->createMock(IUser::class); $loggedInUser = $this->createMock(IUser::class); - $loggedInUser->expects($this->once()) + $loggedInUser->expects($this->exactly(2)) ->method('getUID') ->willReturn('subadmin'); @@ -2019,10 +3090,10 @@ class UsersControllerTest extends TestCase { $this->api->addToGroup('TargetUser', 'GroupToAddTo'); } - public function testAddToGroupSuccessAsSubadmin() { + public function testAddToGroupSuccessAsSubadmin(): void { $targetUser = $this->createMock(IUser::class); $loggedInUser = $this->createMock(IUser::class); - $loggedInUser->expects($this->once()) + $loggedInUser->expects($this->exactly(2)) ->method('getUID') ->willReturn('subadmin'); @@ -2063,10 +3134,10 @@ class UsersControllerTest extends TestCase { $this->assertEquals(new DataResponse(), $this->api->addToGroup('TargetUser', 'GroupToAddTo')); } - public function testAddToGroupSuccessAsAdmin() { + public function testAddToGroupSuccessAsAdmin(): void { $targetUser = $this->createMock(IUser::class); $loggedInUser = $this->createMock(IUser::class); - $loggedInUser->expects($this->once()) + $loggedInUser->expects($this->exactly(2)) ->method('getUID') ->willReturn('admin'); @@ -2105,277 +3176,277 @@ class UsersControllerTest extends TestCase { $this->assertEquals(new DataResponse(), $this->api->addToGroup('TargetUser', 'GroupToAddTo')); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testRemoveFromGroupWithNoTargetGroup() { + + public function testRemoveFromGroupWithNoTargetGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); - $this->api->removeFromGroup('TargetUser', null); + $this->api->removeFromGroup('TargetUser', ''); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - */ - public function testRemoveFromGroupWithEmptyTargetGroup() { + + public function testRemoveFromGroupWithEmptyTargetGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->api->removeFromGroup('TargetUser', ''); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - */ - public function testRemoveFromGroupWithNotExistingTargetGroup() { + + public function testRemoveFromGroupWithNotExistingTargetGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(102); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('TargetGroup') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->removeFromGroup('TargetUser', 'TargetGroup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - */ - public function testRemoveFromGroupWithNotExistingTargetUser() { + + public function testRemoveFromGroupWithNotExistingTargetUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(103); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('TargetGroup') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('TargetUser') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->removeFromGroup('TargetUser', 'TargetGroup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 104 - */ - public function testRemoveFromGroupWithoutPermission() { + + public function testRemoveFromGroupWithoutPermission(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(104); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->once()) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('unauthorizedUser')); + ->willReturn('unauthorizedUser'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('TargetGroup') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('TargetUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('unauthorizedUser') - ->will($this->returnValue(false)); + ->willReturn(false); $this->api->removeFromGroup('TargetUser', 'TargetGroup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 105 - * @expectedExceptionMessage Cannot remove yourself from the admin group - */ - public function testRemoveFromGroupAsAdminFromAdmin() { + + public function testRemoveFromGroupAsAdminFromAdmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Cannot remove yourself from the admin group'); + $this->expectExceptionCode(105); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $targetGroup ->expects($this->once()) ->method('getGID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('admin') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('Admin') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->api->removeFromGroup('Admin', 'admin'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 105 - * @expectedExceptionMessage Cannot remove yourself from this group as you are a SubAdmin - */ - public function testRemoveFromGroupAsSubAdminFromSubAdmin() { + + public function testRemoveFromGroupAsSubAdminFromSubAdmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Cannot remove yourself from this group as you are a sub-admin'); + $this->expectExceptionCode(105); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser ->expects($this->once()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $targetGroup ->expects($this->any()) ->method('getGID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('subadmin') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('SubAdmin') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) - ->method('isSubAdminofGroup') + ->method('isSubAdminOfGroup') ->with($loggedInUser, $targetGroup) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $this->api->removeFromGroup('SubAdmin', 'subadmin'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 105 - * @expectedExceptionMessage Cannot remove user from this group as this is the only remaining group you are a SubAdmin of - */ - public function testRemoveFromGroupAsSubAdminFromLastSubAdminGroup() { + + public function testRemoveFromGroupAsSubAdminFromLastSubAdminGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Not viable to remove user from the last group you are sub-admin of'); + $this->expectExceptionCode(105); + $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $targetGroup ->expects($this->any()) ->method('getGID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('subadmin') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('AnotherUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) - ->method('isSubAdminofGroup') + ->method('isSubAdminOfGroup') ->with($loggedInUser, $targetGroup) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $subAdminManager ->expects($this->once()) ->method('getSubAdminsGroups') ->with($loggedInUser) - ->will($this->returnValue([$targetGroup])); + ->willReturn([$targetGroup]); $this->groupManager ->expects($this->any()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getUserGroupIds') @@ -2385,39 +3456,39 @@ class UsersControllerTest extends TestCase { $this->api->removeFromGroup('AnotherUser', 'subadmin'); } - public function testRemoveFromGroupSuccessful() { + public function testRemoveFromGroupSuccessful(): void { $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser ->expects($this->any()) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('admin') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->userManager ->expects($this->once()) ->method('get') ->with('AnotherUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->groupManager ->expects($this->any()) ->method('isAdmin') ->with('admin') - ->will($this->returnValue(true)); + ->willReturn(true); $targetGroup ->expects($this->once()) ->method('removeUser') @@ -2426,379 +3497,274 @@ class UsersControllerTest extends TestCase { $this->assertEquals([], $this->api->removeFromGroup('AnotherUser', 'admin')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage User does not exist - */ - public function testAddSubAdminWithNotExistingTargetUser() { + + public function testAddSubAdminWithNotExistingTargetUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('User does not exist'); + $this->expectExceptionCode(101); + $this->userManager ->expects($this->once()) ->method('get') ->with('NotExistingUser') - ->will($this->returnValue(null)); + ->willReturn(null); - $this->api->addSubAdmin('NotExistingUser', null); + $this->api->addSubAdmin('NotExistingUser', ''); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - * @expectedExceptionMessage Group does not exist - */ - public function testAddSubAdminWithNotExistingTargetGroup() { + + public function testAddSubAdminWithNotExistingTargetGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Group does not exist'); + $this->expectExceptionCode(102); + $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('NotExistingGroup') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->addSubAdmin('ExistingUser', 'NotExistingGroup'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - * @expectedExceptionMessage Cannot create subadmins for admin group - */ - public function testAddSubAdminToAdminGroup() { + + public function testAddSubAdminToAdminGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Cannot create sub-admins for admin group'); + $this->expectExceptionCode(103); + $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $targetGroup ->expects($this->once()) ->method('getGID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('ADmiN') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $this->api->addSubAdmin('ExistingUser', 'ADmiN'); } - public function testAddSubAdminTwice() { + public function testAddSubAdminTwice(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('TargetGroup') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isSubAdminOfGroup') ->with($targetUser, $targetGroup) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->assertEquals([], $this->api->addSubAdmin('ExistingUser', 'TargetGroup')->getData()); } - public function testAddSubAdminSuccessful() { + public function testAddSubAdminSuccessful(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('TargetGroup') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isSubAdminOfGroup') ->with($targetUser, $targetGroup) - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager ->expects($this->once()) ->method('createSubAdmin') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(true)); + ->with($targetUser, $targetGroup); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->assertEquals([], $this->api->addSubAdmin('ExistingUser', 'TargetGroup')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - * @expectedExceptionMessage Unknown error occurred - */ - public function testAddSubAdminUnsuccessful() { - $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); - $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); - $this->userManager - ->expects($this->once()) - ->method('get') - ->with('ExistingUser') - ->will($this->returnValue($targetUser)); - $this->groupManager - ->expects($this->once()) - ->method('get') - ->with('TargetGroup') - ->will($this->returnValue($targetGroup)); - $subAdminManager = $this->getMockBuilder('OC\SubAdmin') - ->disableOriginalConstructor()->getMock(); - $subAdminManager - ->expects($this->once()) - ->method('isSubAdminOfGroup') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(false)); - $subAdminManager - ->expects($this->once()) - ->method('createSubAdmin') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(false)); - $this->groupManager - ->expects($this->once()) - ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); - $this->api->addSubAdmin('ExistingUser', 'TargetGroup'); - } + public function testRemoveSubAdminNotExistingTargetUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('User does not exist'); + $this->expectExceptionCode(101); - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage User does not exist - */ - public function testRemoveSubAdminNotExistingTargetUser() { $this->userManager ->expects($this->once()) ->method('get') ->with('NotExistingUser') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->removeSubAdmin('NotExistingUser', 'GroupToDeleteFrom'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Group does not exist - */ - public function testRemoveSubAdminNotExistingTargetGroup() { + + public function testRemoveSubAdminNotExistingTargetGroup(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Group does not exist'); + $this->expectExceptionCode(101); + $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('GroupToDeleteFrom') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->removeSubAdmin('ExistingUser', 'GroupToDeleteFrom'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - * @expectedExceptionMessage User is not a subadmin of this group - */ - public function testRemoveSubAdminFromNotASubadmin() { + + public function testRemoveSubAdminFromNotASubadmin(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('User is not a sub-admin of this group'); + $this->expectExceptionCode(102); + $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('GroupToDeleteFrom') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isSubAdminOfGroup') ->with($targetUser, $targetGroup) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->api->removeSubAdmin('ExistingUser', 'GroupToDeleteFrom'); } - public function testRemoveSubAdminSuccessful() { + public function testRemoveSubAdminSuccessful(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $this->userManager ->expects($this->once()) ->method('get') ->with('ExistingUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('get') ->with('GroupToDeleteFrom') - ->will($this->returnValue($targetGroup)); + ->willReturn($targetGroup); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('isSubAdminOfGroup') ->with($targetUser, $targetGroup) - ->will($this->returnValue(true)); + ->willReturn(true); $subAdminManager ->expects($this->once()) ->method('deleteSubAdmin') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(true)); + ->with($targetUser, $targetGroup); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->assertEquals([], $this->api->removeSubAdmin('ExistingUser', 'GroupToDeleteFrom')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 103 - * @expectedExceptionMessage Unknown error occurred - */ - public function testRemoveSubAdminUnsuccessful() { - $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); - $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); - $this->userManager - ->expects($this->once()) - ->method('get') - ->with('ExistingUser') - ->will($this->returnValue($targetUser)); - $this->groupManager - ->expects($this->once()) - ->method('get') - ->with('GroupToDeleteFrom') - ->will($this->returnValue($targetGroup)); - $subAdminManager = $this->getMockBuilder('OC\SubAdmin') - ->disableOriginalConstructor()->getMock(); - $subAdminManager - ->expects($this->once()) - ->method('isSubAdminOfGroup') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(true)); - $subAdminManager - ->expects($this->once()) - ->method('deleteSubAdmin') - ->with($targetUser, $targetGroup) - ->will($this->returnValue(false)); - $this->groupManager - ->expects($this->once()) - ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); - $this->api->removeSubAdmin('ExistingUser', 'GroupToDeleteFrom'); - } + public function testGetUserSubAdminGroupsNotExistingTargetUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('User does not exist'); + $this->expectExceptionCode(404); - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage User does not exist - */ - public function testGetUserSubAdminGroupsNotExistingTargetUser() { $this->userManager ->expects($this->once()) ->method('get') ->with('RequestedUser') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->getUserSubAdminGroups('RequestedUser'); } - public function testGetUserSubAdminGroupsWithGroups() { + public function testGetUserSubAdminGroupsWithGroups(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetGroup = $this->getMockBuilder('\OCP\IGroup')->disableOriginalConstructor()->getMock(); $targetGroup ->expects($this->once()) ->method('getGID') - ->will($this->returnValue('TargetGroup')); + ->willReturn('TargetGroup'); $this->userManager ->expects($this->once()) ->method('get') ->with('RequestedUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor()->getMock(); $subAdminManager ->expects($this->once()) ->method('getSubAdminsGroups') ->with($targetUser) - ->will($this->returnValue([$targetGroup])); + ->willReturn([$targetGroup]); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->assertEquals(['TargetGroup'], $this->api->getUserSubAdminGroups('RequestedUser')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - * @expectedExceptionMessage Unknown error occurred - */ - public function testGetUserSubAdminGroupsWithoutGroups() { - $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); - $this->userManager - ->expects($this->once()) - ->method('get') - ->with('RequestedUser') - ->will($this->returnValue($targetUser)); - $subAdminManager = $this->getMockBuilder('OC\SubAdmin') - ->disableOriginalConstructor()->getMock(); - $subAdminManager - ->expects($this->once()) - ->method('getSubAdminsGroups') - ->with($targetUser) - ->will($this->returnValue([])); - $this->groupManager - ->expects($this->once()) - ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); - - $this->api->getUserSubAdminGroups('RequestedUser'); - } - - public function testEnableUser() { + public function testEnableUser(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser->expects($this->once()) ->method('setEnabled') @@ -2807,25 +3773,25 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('get') ->with('RequestedUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->assertEquals([], $this->api->enableUser('RequestedUser')->getData()); } - public function testDisableUser() { + public function testDisableUser(): void { $targetUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $targetUser->expects($this->once()) ->method('setEnabled') @@ -2834,61 +3800,78 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('get') ->with('RequestedUser') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $loggedInUser = $this->getMockBuilder(IUser::class)->disableOriginalConstructor()->getMock(); $loggedInUser - ->expects($this->exactly(2)) + ->expects($this->exactly(3)) ->method('getUID') - ->will($this->returnValue('admin')); + ->willReturn('admin'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') - ->will($this->returnValue(true)); + ->willReturn(true); $this->assertEquals([], $this->api->disableUser('RequestedUser')->getData()); } - public function testGetCurrentUserLoggedIn() { + public function testGetCurrentUserLoggedIn(): void { $user = $this->createMock(IUser::class); $user->expects($this->once())->method('getUID')->willReturn('UID'); $this->userSession->expects($this->once())->method('getUser') ->willReturn($user); - /** @var UsersController | PHPUnit_Framework_MockObject_MockObject $api */ - $api = $this->getMockBuilder('OCA\Provisioning_API\Controller\UsersController') + /** @var UsersController | MockObject $api */ + $api = $this->getMockBuilder(UsersController::class) ->setConstructorArgs([ 'provisioning_api', $this->request, $this->userManager, $this->config, - $this->appManager, $this->groupManager, $this->userSession, $this->accountManager, - $this->logger, + $this->subAdminManager, $this->l10nFactory, - $this->newUserMailHelper + $this->rootFolder, + $this->urlGenerator, + $this->logger, + $this->newUserMailHelper, + $this->secureRandom, + $this->remoteWipe, + $this->knownUserService, + $this->eventDispatcher, + $this->phoneNumberUtil, + $this->appManager, ]) - ->setMethods(['getUserData']) + ->onlyMethods(['getUserData']) ->getMock(); - $api->expects($this->once())->method('getUserData')->with('UID') + $api->expects($this->once())->method('getUserData')->with('UID', true) ->willReturn( [ 'id' => 'UID', 'enabled' => 'true', 'quota' => ['DummyValue'], - 'email' => 'demo@owncloud.org', + 'email' => 'demo@nextcloud.com', 'displayname' => 'Demo User', + 'display-name' => 'Demo User', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', - 'twitter' => 'twitter' + 'twitter' => 'twitter', + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'pronouns' => 'they/them', ] ); @@ -2896,21 +3879,30 @@ class UsersControllerTest extends TestCase { 'id' => 'UID', 'enabled' => 'true', 'quota' => ['DummyValue'], - 'email' => 'demo@owncloud.org', + 'email' => 'demo@nextcloud.com', + 'displayname' => 'Demo User', + 'display-name' => 'Demo User', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', 'twitter' => 'twitter', - 'display-name' => 'Demo User' + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'pronouns' => 'they/them', ]; $this->assertSame($expected, $api->getCurrentUser()->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - */ - public function testGetCurrentUserNotLoggedIn() { + + public function testGetCurrentUserNotLoggedIn(): void { + $this->expectException(OCSException::class); + $this->userSession->expects($this->once())->method('getUser') ->willReturn(null); @@ -2918,88 +3910,117 @@ class UsersControllerTest extends TestCase { $this->api->getCurrentUser(); } + public function testGetUser(): void { + $loggedInUser = $this->createMock(IUser::class); + $loggedInUser + ->method('getUID') + ->willReturn('currentuser'); + $this->userSession + ->method('getUser') + ->willReturn($loggedInUser); - public function testGetUser() { - /** @var UsersController | PHPUnit_Framework_MockObject_MockObject $api */ - $api = $this->getMockBuilder('OCA\Provisioning_API\Controller\UsersController') + /** @var UsersController | MockObject $api */ + $api = $this->getMockBuilder(UsersController::class) ->setConstructorArgs([ 'provisioning_api', $this->request, $this->userManager, $this->config, - $this->appManager, $this->groupManager, $this->userSession, $this->accountManager, - $this->logger, + $this->subAdminManager, $this->l10nFactory, - $this->newUserMailHelper + $this->rootFolder, + $this->urlGenerator, + $this->logger, + $this->newUserMailHelper, + $this->secureRandom, + $this->remoteWipe, + $this->knownUserService, + $this->eventDispatcher, + $this->phoneNumberUtil, + $this->appManager, ]) - ->setMethods(['getUserData']) + ->onlyMethods(['getUserData']) ->getMock(); $expected = [ 'id' => 'UID', 'enabled' => 'true', 'quota' => ['DummyValue'], - 'email' => 'demo@owncloud.org', + 'email' => 'demo@nextcloud.com', 'phone' => 'phone', 'address' => 'address', 'website' => 'website', 'twitter' => 'twitter', - 'displayname' => 'Demo User' + 'bluesky' => 'bluesky', + 'fediverse' => 'fediverse', + 'displayname' => 'Demo User', + 'display-name' => 'Demo User', + 'organisation' => 'organisation', + 'role' => 'role', + 'headline' => 'headline', + 'biography' => 'biography', + 'profile_enabled' => '1', + 'pronouns' => 'they/them', ]; - $api->expects($this->once())->method('getUserData') - ->with('uid') - ->willReturn($expected); + $api->expects($this->exactly(2)) + ->method('getUserData') + ->willReturnMap([ + ['uid', false, $expected], + ['currentuser', true, $expected], + ]); $this->assertSame($expected, $api->getUser('uid')->getData()); + + $this->assertSame($expected, $api->getUser('currentuser')->getData()); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 998 - */ - public function testResendWelcomeMessageWithNotExistingTargetUser() { + + public function testResendWelcomeMessageWithNotExistingTargetUser(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $this->userManager ->expects($this->once()) ->method('get') ->with('NotExistingUser') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->resendWelcomeMessage('NotExistingUser'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 997 - */ - public function testResendWelcomeMessageAsSubAdminAndUserIsNotAccessible() { + + public function testResendWelcomeMessageAsSubAdminAndUserIsNotAccessible(): void { + $this->expectException(OCSException::class); + $this->expectExceptionCode(998); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $loggedInUser - ->expects($this->exactly(1)) + ->expects($this->exactly(2)) ->method('getUID') - ->will($this->returnValue('subadmin')); + ->willReturn('subadmin'); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $this->groupManager ->expects($this->once()) ->method('isAdmin') ->with('subadmin') - ->will($this->returnValue(false)); + ->willReturn(false); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3007,21 +4028,21 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(false)); + ->willReturn(false); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $this->api->resendWelcomeMessage('UserToGet'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Email address not available - */ - public function testResendWelcomeMessageNoEmail() { + + public function testResendWelcomeMessageNoEmail(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Email address not available'); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); @@ -3031,12 +4052,12 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3044,25 +4065,29 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('logged-user-id'); $targetUser ->expects($this->once()) ->method('getEmailAddress') - ->will($this->returnValue('')); + ->willReturn(''); $this->api->resendWelcomeMessage('UserToGet'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 101 - * @expectedExceptionMessage Email address not available - */ - public function testResendWelcomeMessageNullEmail() { + + public function testResendWelcomeMessageNullEmail(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Email address not available'); + $this->expectExceptionCode(101); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); @@ -3072,12 +4097,12 @@ class UsersControllerTest extends TestCase { $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3085,38 +4110,45 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('logged-user-id'); $targetUser ->expects($this->once()) ->method('getEmailAddress') - ->will($this->returnValue(null)); + ->willReturn(null); $this->api->resendWelcomeMessage('UserToGet'); } - public function testResendWelcomeMessageSuccess() { + public function testResendWelcomeMessageSuccess(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); + $loggedInUser + ->method('getUID') + ->willReturn('logged-user-id'); $targetUser ->method('getUID') ->willReturn('user-id'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3124,69 +4156,50 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->once()) ->method('getEmailAddress') - ->will($this->returnValue('abc@example.org')); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('user-id', 'core', 'lang') - ->willReturn('es'); - $l10n = $this->getMockBuilder(IL10N::class) - ->disableOriginalConstructor() - ->getMock(); - $this->l10nFactory - ->expects($this->at(0)) - ->method('languageExists') - ->with('settings', 'es') - ->willReturn(true); - $this->l10nFactory - ->expects($this->at(1)) - ->method('get') - ->with('settings', 'es') - ->willReturn($l10n); + ->willReturn('abc@example.org'); $emailTemplate = $this->createMock(IEMailTemplate::class); $this->newUserMailHelper - ->expects($this->at(0)) - ->method('setL10N') - ->willReturn($l10n); - $this->newUserMailHelper - ->expects($this->at(1)) + ->expects($this->once()) ->method('generateTemplate') ->willReturn($emailTemplate); $this->newUserMailHelper - ->expects($this->at(2)) + ->expects($this->once()) ->method('sendMail') ->with($targetUser, $emailTemplate); $this->api->resendWelcomeMessage('UserToGet'); } - public function testResendWelcomeMessageSuccessWithFallbackLanguage() { + public function testResendWelcomeMessageSuccessWithFallbackLanguage(): void { $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); + $loggedInUser + ->method('getUID') + ->willReturn('logged-user-id'); $targetUser ->method('getUID') ->willReturn('user-id'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3194,74 +4207,56 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->once()) ->method('getEmailAddress') - ->will($this->returnValue('abc@example.org')); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('user-id', 'core', 'lang') - ->willReturn('es'); - $l10n = $this->getMockBuilder(IL10N::class) - ->disableOriginalConstructor() - ->getMock(); - $this->l10nFactory - ->expects($this->at(0)) - ->method('languageExists') - ->with('settings', 'es') - ->willReturn(false); - $this->l10nFactory - ->expects($this->at(1)) - ->method('get') - ->with('settings', 'en') - ->willReturn($l10n); + ->willReturn('abc@example.org'); $emailTemplate = $this->createMock(IEMailTemplate::class); $this->newUserMailHelper - ->expects($this->at(0)) - ->method('setL10N') - ->willReturn($l10n); - $this->newUserMailHelper - ->expects($this->at(1)) + ->expects($this->once()) ->method('generateTemplate') ->willReturn($emailTemplate); $this->newUserMailHelper - ->expects($this->at(2)) + ->expects($this->once()) ->method('sendMail') ->with($targetUser, $emailTemplate); $this->api->resendWelcomeMessage('UserToGet'); } - /** - * @expectedException \OCP\AppFramework\OCS\OCSException - * @expectedExceptionCode 102 - * @expectedExceptionMessage Sending email failed - */ - public function testResendWelcomeMessageFailed() { + + public function testResendWelcomeMessageFailed(): void { + $this->expectException(OCSException::class); + $this->expectExceptionMessage('Sending email failed'); + $this->expectExceptionCode(102); + $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); $targetUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() ->getMock(); + $loggedInUser + ->expects($this->exactly(2)) + ->method('getUID') + ->willReturn('logged-user-id'); $targetUser ->method('getUID') ->willReturn('user-id'); $this->userSession ->expects($this->once()) ->method('getUser') - ->will($this->returnValue($loggedInUser)); + ->willReturn($loggedInUser); $this->userManager ->expects($this->once()) ->method('get') ->with('UserToGet') - ->will($this->returnValue($targetUser)); + ->willReturn($targetUser); $subAdminManager = $this->getMockBuilder('OC\SubAdmin') ->disableOriginalConstructor() ->getMock(); @@ -3269,48 +4264,200 @@ class UsersControllerTest extends TestCase { ->expects($this->once()) ->method('isUserAccessible') ->with($loggedInUser, $targetUser) - ->will($this->returnValue(true)); + ->willReturn(true); $this->groupManager ->expects($this->once()) ->method('getSubAdmin') - ->will($this->returnValue($subAdminManager)); + ->willReturn($subAdminManager); $targetUser ->expects($this->once()) ->method('getEmailAddress') - ->will($this->returnValue('abc@example.org')); - $this->config - ->expects($this->at(0)) - ->method('getUserValue') - ->with('user-id', 'core', 'lang') - ->willReturn('es'); - $l10n = $this->getMockBuilder(IL10N::class) - ->disableOriginalConstructor() - ->getMock(); - $this->l10nFactory - ->expects($this->at(0)) - ->method('languageExists') - ->with('settings', 'es') - ->willReturn(true); - $this->l10nFactory - ->expects($this->at(1)) - ->method('get') - ->with('settings', 'es') - ->willReturn($l10n); + ->willReturn('abc@example.org'); $emailTemplate = $this->createMock(IEMailTemplate::class); $this->newUserMailHelper - ->expects($this->at(0)) - ->method('setL10N') - ->willReturn($l10n); - $this->newUserMailHelper - ->expects($this->at(1)) + ->expects($this->once()) ->method('generateTemplate') ->willReturn($emailTemplate); $this->newUserMailHelper - ->expects($this->at(2)) + ->expects($this->once()) ->method('sendMail') ->with($targetUser, $emailTemplate) ->willThrowException(new \Exception()); $this->api->resendWelcomeMessage('UserToGet'); } + + + public static function dataGetEditableFields(): array { + return [ + [false, true, ISetDisplayNameBackend::class, [ + IAccountManager::PROPERTY_EMAIL, + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [true, false, ISetDisplayNameBackend::class, [ + IAccountManager::PROPERTY_DISPLAYNAME, + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [true, true, ISetDisplayNameBackend::class, [ + IAccountManager::PROPERTY_DISPLAYNAME, + IAccountManager::PROPERTY_EMAIL, + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [false, false, ISetDisplayNameBackend::class, [ + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [false, true, UserInterface::class, [ + IAccountManager::PROPERTY_EMAIL, + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [true, false, UserInterface::class, [ + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [true, true, UserInterface::class, [ + IAccountManager::PROPERTY_EMAIL, + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + [false, false, UserInterface::class, [ + IAccountManager::COLLECTION_EMAIL, + IAccountManager::PROPERTY_PHONE, + IAccountManager::PROPERTY_ADDRESS, + IAccountManager::PROPERTY_WEBSITE, + IAccountManager::PROPERTY_TWITTER, + IAccountManager::PROPERTY_BLUESKY, + IAccountManager::PROPERTY_FEDIVERSE, + IAccountManager::PROPERTY_ORGANISATION, + IAccountManager::PROPERTY_ROLE, + IAccountManager::PROPERTY_HEADLINE, + IAccountManager::PROPERTY_BIOGRAPHY, + IAccountManager::PROPERTY_PROFILE_ENABLED, + IAccountManager::PROPERTY_PRONOUNS, + ]], + ]; + } + + #[\PHPUnit\Framework\Attributes\DataProvider('dataGetEditableFields')] + public function testGetEditableFields(bool $allowedToChangeDisplayName, bool $allowedToChangeEmail, string $userBackend, array $expected): void { + $this->config->method('getSystemValue')->willReturnCallback(fn (string $key, mixed $default) => match ($key) { + 'allow_user_to_change_display_name' => $allowedToChangeDisplayName, + 'allow_user_to_change_email' => $allowedToChangeEmail, + default => throw new RuntimeException('Unexpected system config key: ' . $key), + }); + + $user = $this->createMock(IUser::class); + $this->userSession->method('getUser') + ->willReturn($user); + + $backend = $this->createMock($userBackend); + + $user->method('getUID') + ->willReturn('userId'); + $user->method('getBackend') + ->willReturn($backend); + + $expectedResp = new DataResponse($expected); + $this->assertEquals($expectedResp, $this->api->getEditableFields('userId')); + } + + private function mockAccount($targetUser, $accountProperties) { + $mockedProperties = []; + + foreach ($accountProperties as $propertyName => $data) { + $mockedProperty = $this->createMock(IAccountProperty::class); + $mockedProperty->method('getValue')->willReturn($data['value'] ?? ''); + $mockedProperty->method('getScope')->willReturn($data['scope'] ?? ''); + $mockedProperties[] = [$propertyName, $mockedProperty]; + } + + $account = $this->createMock(IAccount::class); + $account->method('getProperty') + ->willReturnMap($mockedProperties); + + $this->accountManager->expects($this->any())->method('getAccount') + ->with($targetUser) + ->willReturn($account); + } } diff --git a/apps/provisioning_api/tests/Middleware/ProvisioningApiMiddlewareTest.php b/apps/provisioning_api/tests/Middleware/ProvisioningApiMiddlewareTest.php index 2d8b79842f2..c027e518a3d 100644 --- a/apps/provisioning_api/tests/Middleware/ProvisioningApiMiddlewareTest.php +++ b/apps/provisioning_api/tests/Middleware/ProvisioningApiMiddlewareTest.php @@ -1,66 +1,51 @@ <?php + /** - * @copyright 2016, Roeland Jago Douma <roeland@famdouma.nl> - * - * @author Roeland Jago Douma <roeland@famdouma.nl> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ namespace OCA\Provisioning_API\Tests\Middleware; use OCA\Provisioning_API\Middleware\Exceptions\NotSubAdminException; use OCA\Provisioning_API\Middleware\ProvisioningApiMiddleware; use OCP\AppFramework\Controller; +use OCP\AppFramework\Http; use OCP\AppFramework\OCS\OCSException; use OCP\AppFramework\Utility\IControllerMethodReflector; use Test\TestCase; class ProvisioningApiMiddlewareTest extends TestCase { - /** @var IControllerMethodReflector|\PHPUnit_Framework_MockObject_MockObject */ + /** @var IControllerMethodReflector|\PHPUnit\Framework\MockObject\MockObject */ private $reflector; - public function setUp() { + protected function setUp(): void { parent::setUp(); $this->reflector = $this->createMock(IControllerMethodReflector::class); } - public function dataAnnotation() { + public static function dataAnnotation(): array { return [ - [false, false, false, false], - [false, false, true, false], - [false, true, true, false], - [ true, false, false, true], - [ true, false, true, false], - [ true, true, false, false], - [ true, true, true, false], + [false, false, false, false, false], + [false, false, true, false, false], + [false, true, true, false, false], + [true, false, false, false, true], + [true, false, true, false, false], + [true, true, false, false, false], + [true, true, true, false, false], + [false, false, false, true, false], + [false, false, true, true, false], + [false, true, true, true, false], + [true, false, false, true, false], + [true, false, true, true, false], + [true, true, false, true, false], + [true, true, true, true, false], ]; } - /** - * @dataProvider dataAnnotation - * - * @param bool $subadminRequired - * @param bool $isAdmin - * @param bool $isSubAdmin - * @param bool $shouldThrowException - */ - public function testBeforeController($subadminRequired, $isAdmin, $isSubAdmin, $shouldThrowException) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataAnnotation')] + public function testBeforeController(bool $subadminRequired, bool $isAdmin, bool $isSubAdmin, bool $hasSettingAuthorizationAnnotation, bool $shouldThrowException): void { $middleware = new ProvisioningApiMiddleware( $this->reflector, $isAdmin, @@ -68,8 +53,15 @@ class ProvisioningApiMiddlewareTest extends TestCase { ); $this->reflector->method('hasAnnotation') - ->with('NoSubAdminRequired') - ->willReturn(!$subadminRequired); + ->willReturnCallback(function ($annotation) use ($subadminRequired, $hasSettingAuthorizationAnnotation) { + if ($annotation === 'NoSubAdminRequired') { + return !$subadminRequired; + } + if ($annotation === 'AuthorizedAdminSetting') { + return $hasSettingAuthorizationAnnotation; + } + return false; + }); try { $middleware->beforeController( @@ -82,20 +74,15 @@ class ProvisioningApiMiddlewareTest extends TestCase { } } - public function dataAfterException() { + public static function dataAfterException(): array { return [ [new NotSubAdminException(), false], [new \Exception('test', 42), true], ]; } - /** - * @dataProvider dataAfterException - * - * @param \Exception $e - * @param bool $forwared - */ - public function testAfterException(\Exception $exception, $forwared) { + #[\PHPUnit\Framework\Attributes\DataProvider('dataAfterException')] + public function testAfterException(\Exception $exception, bool $forwared): void { $middleware = new ProvisioningApiMiddleware( $this->reflector, false, @@ -112,11 +99,10 @@ class ProvisioningApiMiddlewareTest extends TestCase { } catch (OCSException $e) { $this->assertFalse($forwared); $this->assertSame($exception->getMessage(), $e->getMessage()); - $this->assertSame(\OCP\API::RESPOND_UNAUTHORISED, $e->getCode()); + $this->assertSame(Http::STATUS_FORBIDDEN, $e->getCode()); } catch (\Exception $e) { $this->assertTrue($forwared); $this->assertSame($exception, $e); } - } } diff --git a/apps/provisioning_api/tests/TestCase.php b/apps/provisioning_api/tests/TestCase.php index 1ff2c82a3be..30e7f3a4ecf 100644 --- a/apps/provisioning_api/tests/TestCase.php +++ b/apps/provisioning_api/tests/TestCase.php @@ -1,38 +1,21 @@ <?php + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Joas Schilling <coding@schilljs.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * - * @license AGPL-3.0 - * - * This code is free software: you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License, version 3, - * as published by the Free Software Foundation. - * - * 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, version 3, - * along with this program. If not, see <http://www.gnu.org/licenses/> - * + * SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\Provisioning_API\Tests; +use OCP\IGroupManager; use OCP\IUser; use OCP\IUserManager; -use OCP\IGroupManager; +use OCP\Server; abstract class TestCase extends \Test\TestCase { /** @var IUser[] */ - protected $users = array(); + protected $users = []; /** @var IUserManager */ protected $userManager; @@ -40,11 +23,11 @@ abstract class TestCase extends \Test\TestCase { /** @var IGroupManager */ protected $groupManager; - protected function setUp() { + protected function setUp(): void { parent::setUp(); - $this->userManager = \OC::$server->getUserManager(); - $this->groupManager = \OC::$server->getGroupManager(); + $this->userManager = Server::get(IUserManager::class); + $this->groupManager = Server::get(IGroupManager::class); $this->groupManager->createGroup('admin'); } @@ -54,7 +37,7 @@ abstract class TestCase extends \Test\TestCase { * @return IUser[]|IUser */ protected function generateUsers($num = 1) { - $users = array(); + $users = []; for ($i = 0; $i < $num; $i++) { $user = $this->userManager->createUser($this->getUniqueID(), 'password'); $this->users[] = $user; @@ -63,8 +46,8 @@ abstract class TestCase extends \Test\TestCase { return count($users) == 1 ? reset($users) : $users; } - protected function tearDown() { - foreach($this->users as $user) { + protected function tearDown(): void { + foreach ($this->users as $user) { $user->delete(); } |