Add Tests for files UserConfig service #50050
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,202 @@ | ||||||||
| <?php | ||||||||
|
|
||||||||
| /** | ||||||||
| * SPDX-FileCopyrightText: 2024 STRATO AG | ||||||||
| * SPDX-License-Identifier: AGPL-3.0-only | ||||||||
| */ | ||||||||
|
|
||||||||
| namespace OCA\Files\Tests\Service; | ||||||||
|
|
||||||||
| use OCA\Files\AppInfo\Application; | ||||||||
| use OCA\Files\Service\UserConfig; | ||||||||
| use OCP\IConfig; | ||||||||
| use OCP\IUser; | ||||||||
| use OCP\IUserSession; | ||||||||
|
|
||||||||
| /** | ||||||||
| * Class UserConfigTest | ||||||||
| * | ||||||||
| * @group DB | ||||||||
| * | ||||||||
| * @package OCA\Files | ||||||||
| */ | ||||||||
| class UserConfigTest extends \Test\TestCase { | ||||||||
| /** | ||||||||
| * @var string | ||||||||
| */ | ||||||||
| private $userUID; | ||||||||
|
|
||||||||
| private $userMock; | ||||||||
|
|
||||||||
| /** @var IConfig|\PHPUnit\Framework\MockObject\MockObject */ | ||||||||
| private $configMock; | ||||||||
|
|
||||||||
| /** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */ | ||||||||
| private $userSessionMock; | ||||||||
|
|
||||||||
| /** | ||||||||
| * @var UserConfig|\PHPUnit\Framework\MockObject\MockObject | ||||||||
| */ | ||||||||
| private $userConfigService; | ||||||||
|
|
||||||||
| protected function setUp(): void { | ||||||||
| parent::setUp(); | ||||||||
| $this->configMock = $this->createMock(IConfig::class); | ||||||||
|
|
||||||||
| $this->userUID = static::getUniqueID('user_id-'); | ||||||||
| \OC::$server->getUserManager()->createUser($this->userUID, 'test'); | ||||||||
| \OC_User::setUserId($this->userUID); | ||||||||
| \OC_Util::setupFS($this->userUID); | ||||||||
| $this->userMock = $this->getUserMock($this->userUID); | ||||||||
|
Comment on lines
+46
to
+50
There was a problem hiding this comment. Is all this needed? 🤔 Looks ugly and calls obsolete methods. |
||||||||
|
|
||||||||
| $this->userSessionMock = $this->createMock(IUserSession::class); | ||||||||
| $this->userSessionMock->expects($this->any()) | ||||||||
| ->method('getUser') | ||||||||
| ->withAnyParameters() | ||||||||
| ->willReturn($this->userMock); | ||||||||
|
|
||||||||
| $this->userConfigService = $this->getUserConfigService(['addActivity']); | ||||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * @param array $methods | ||||||||
| * @return UserConfig|\PHPUnit\Framework\MockObject\MockObject | ||||||||
| */ | ||||||||
| protected function getUserConfigService(array $methods = []) { | ||||||||
| return $this->getMockBuilder(UserConfig::class) | ||||||||
| ->setConstructorArgs([ | ||||||||
| $this->configMock, | ||||||||
| $this->userSessionMock, | ||||||||
| ]) | ||||||||
| ->setMethods($methods) | ||||||||
| ->getMock(); | ||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * @param string $uid | ||||||||
| * @return IUser|MockObject | ||||||||
| */ | ||||||||
| protected function getUserMock($uid) { | ||||||||
| $user = $this->createMock(IUser::class); | ||||||||
| $user->expects($this->any()) | ||||||||
| ->method('getUID') | ||||||||
| ->willReturn($uid); | ||||||||
| return $user; | ||||||||
| } | ||||||||
| protected function tearDown(): void { | ||||||||
| \OC_User::setUserId(''); | ||||||||
| $user = \OC::$server->getUserManager()->get($this->userUID); | ||||||||
| if ($user !== null) { | ||||||||
| $user->delete(); | ||||||||
| } | ||||||||
| } | ||||||||
| public function testThrowsExceptionWhenNoUserLoggedInForSetConfig(): void { | ||||||||
| $this->userSessionMock = $this->createMock(IUserSession::class); | ||||||||
| $this->userSessionMock->expects($this->any()) | ||||||||
| ->method('getUser') | ||||||||
| ->withAnyParameters() | ||||||||
| ->willReturn(null); | ||||||||
|
|
||||||||
| $this->expectException(\Exception::class); | ||||||||
| $this->expectExceptionMessage('No user logged in'); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $userConfig->setConfig('crop_image_previews', true); | ||||||||
|
Comment on lines
+103
to
+104
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. And same for the other ones |
||||||||
| } | ||||||||
|
|
||||||||
| public function testThrowsInvalidArgumentExceptionForUnknownConfigKey(): void { | ||||||||
| $this->expectException(\InvalidArgumentException::class); | ||||||||
| $this->expectExceptionMessage('Unknown config key'); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $userConfig->setConfig('unknown_key', true); | ||||||||
| } | ||||||||
|
|
||||||||
| public function testThrowsInvalidArgumentExceptionForInvalidConfigValue(): void { | ||||||||
| $this->expectException(\InvalidArgumentException::class); | ||||||||
| $this->expectExceptionMessage('Invalid config value'); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $userConfig->setConfig('crop_image_previews', 'foo'); | ||||||||
| } | ||||||||
|
|
||||||||
| public static function validBoolConfigValues(): array { | ||||||||
| return [ | ||||||||
| ['true', '1'], | ||||||||
| ['false', '0'], | ||||||||
| ['1', '1'], | ||||||||
| ['0', '0'], | ||||||||
| ['yes', '1'], | ||||||||
| ['no', '0'], | ||||||||
| [true, '1'], | ||||||||
| [false, '0'], | ||||||||
| ]; | ||||||||
| } | ||||||||
|
|
||||||||
| /** | ||||||||
| * @dataProvider validBoolConfigValues | ||||||||
| */ | ||||||||
| public function testSetsConfigWithBooleanValuesSuccessfully($boolValue, $expectedValue): void { | ||||||||
| $this->configMock->expects($this->once()) | ||||||||
| ->method('setUserValue') | ||||||||
| ->with($this->userUID, Application::APP_ID, 'crop_image_previews', $expectedValue); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $userConfig->setConfig('crop_image_previews', $boolValue); | ||||||||
| } | ||||||||
|
|
||||||||
| public function testGetsConfigsWithDefaultValuesSuccessfully(): void { | ||||||||
| $this->userSessionMock->method('getUser')->willReturn($this->userMock); | ||||||||
| $this->configMock->method('getUserValue') | ||||||||
| ->willReturnCallback(function ($userId, $appId, $key, $default) { | ||||||||
| return $default; | ||||||||
| }); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $configs = $userConfig->getConfigs(); | ||||||||
| $this->assertEquals([ | ||||||||
| 'crop_image_previews' => true, | ||||||||
| 'show_hidden' => false, | ||||||||
| 'sort_favorites_first' => true, | ||||||||
| 'sort_folders_first' => true, | ||||||||
| 'grid_view' => false, | ||||||||
| 'folder_tree' => true, | ||||||||
| ], $configs); | ||||||||
| } | ||||||||
|
|
||||||||
| private function getDefaultConfigValue(string $key) { | ||||||||
| foreach (UserConfig::ALLOWED_CONFIGS as $config) { | ||||||||
| if ($config['key'] === $key) { | ||||||||
| return $config['default']; | ||||||||
| } | ||||||||
| } | ||||||||
| return ''; | ||||||||
| } | ||||||||
|
|
||||||||
| public function testGetsConfigsOverrideWithUserValuesSuccessfully(): void { | ||||||||
| $this->userSessionMock->method('getUser')->willReturn($this->userMock); | ||||||||
| $this->configMock->method('getUserValue') | ||||||||
| ->willReturnCallback(function ($userId, $appId, $key, $default) { | ||||||||
|
|
||||||||
| // Override the default values | ||||||||
| if ($key === 'crop_image_previews') { | ||||||||
| return !$this->getDefaultConfigValue($key); | ||||||||
| } elseif ($key === 'show_hidden') { | ||||||||
| return !$this->getDefaultConfigValue($key); | ||||||||
| } | ||||||||
|
|
||||||||
| return $default; | ||||||||
| }); | ||||||||
|
|
||||||||
| $userConfig = new UserConfig($this->configMock, $this->userSessionMock); | ||||||||
| $configs = $userConfig->getConfigs(); | ||||||||
| $this->assertEquals([ | ||||||||
| 'crop_image_previews' => false, | ||||||||
| 'show_hidden' => true, | ||||||||
| 'sort_favorites_first' => true, | ||||||||
| 'sort_folders_first' => true, | ||||||||
| 'grid_view' => false, | ||||||||
| 'folder_tree' => true, | ||||||||
| ], $configs); | ||||||||
| } | ||||||||
| } | ||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.