From 061b4e99fb834efaf4a085e8944e99c16da1ac61 Mon Sep 17 00:00:00 2001 From: Hamza Mahjoubi Date: Mon, 9 Sep 2024 15:08:15 +0200 Subject: [PATCH] fix: provision api's status codes Signed-off-by: Hamza Mahjoubi --- .../lib/Controller/UsersController.php | 20 +++++++++---------- .../tests/Controller/UsersControllerTest.php | 8 ++++---- .../features/provisioning-v1.feature | 12 +++++------ 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/apps/provisioning_api/lib/Controller/UsersController.php b/apps/provisioning_api/lib/Controller/UsersController.php index dd5114a106ed6..e1c60f3eb677c 100644 --- a/apps/provisioning_api/lib/Controller/UsersController.php +++ b/apps/provisioning_api/lib/Controller/UsersController.php @@ -981,7 +981,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon } // Check if permitted to edit this field if (!in_array($key, $permittedFields)) { - throw new OCSException('', 103); + throw new OCSException('', 113); } // Process the edit switch ($key) { @@ -1036,7 +1036,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon } $targetUser->setPassword($value); } catch (HintException $e) { // password policy error - throw new OCSException($e->getMessage(), 103); + throw new OCSException($e->getMessage(), 107); } break; case self::USER_FIELD_LANGUAGE: @@ -1069,14 +1069,14 @@ public function editUser(string $userId, string $key, string $value): DataRespon } } if (!$success) { - throw new OCSException('', 102); + throw new OCSException('', 101); } break; case IAccountManager::PROPERTY_EMAIL: if (filter_var($value, FILTER_VALIDATE_EMAIL) || $value === '') { $targetUser->setEMailAddress($value); } else { - throw new OCSException('', 102); + throw new OCSException('', 101); } break; case IAccountManager::COLLECTION_EMAIL: @@ -1085,13 +1085,13 @@ public function editUser(string $userId, string $key, string $value): DataRespon $mailCollection = $userAccount->getPropertyCollection(IAccountManager::COLLECTION_EMAIL); if ($mailCollection->getPropertyByValue($value)) { - throw new OCSException('', 102); + throw new OCSException('', 101); } $mailCollection->addPropertyWithDefaults($value); $this->accountManager->updateAccount($userAccount); } else { - throw new OCSException('', 102); + throw new OCSException('', 101); } break; case IAccountManager::PROPERTY_PHONE: @@ -1113,7 +1113,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon $this->knownUserService->deleteByContactUserId($targetUser->getUID()); } } catch (InvalidArgumentException $e) { - throw new OCSException('Invalid ' . $e->getMessage(), 102); + throw new OCSException('Invalid ' . $e->getMessage(), 101); } } } catch (PropertyDoesNotExistException $e) { @@ -1122,7 +1122,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon try { $this->accountManager->updateAccount($userAccount); } catch (InvalidArgumentException $e) { - throw new OCSException('Invalid ' . $e->getMessage(), 102); + throw new OCSException('Invalid ' . $e->getMessage(), 101); } break; case IAccountManager::PROPERTY_PROFILE_ENABLED: @@ -1158,12 +1158,12 @@ public function editUser(string $userId, string $key, string $value): DataRespon $userProperty->setScope($value); $this->accountManager->updateAccount($userAccount); } catch (InvalidArgumentException $e) { - throw new OCSException('Invalid ' . $e->getMessage(), 102); + throw new OCSException('Invalid ' . $e->getMessage(), 101); } } break; default: - throw new OCSException('', 103); + throw new OCSException('', 113); } return new DataResponse(); } diff --git a/apps/provisioning_api/tests/Controller/UsersControllerTest.php b/apps/provisioning_api/tests/Controller/UsersControllerTest.php index a48461c0a27b5..66e54efb65064 100644 --- a/apps/provisioning_api/tests/Controller/UsersControllerTest.php +++ b/apps/provisioning_api/tests/Controller/UsersControllerTest.php @@ -1650,7 +1650,7 @@ public function testEditUserRegularUserSelfEditAddAdditionalEmailMainAddress(): ->with($userAccount); $this->expectException(OCSException::class); - $this->expectExceptionCode(102); + $this->expectExceptionCode(101); $this->api->editUser('UserToEdit', 'additional_mail', 'demo@nextcloud.com')->getData(); } @@ -1709,13 +1709,13 @@ public function testEditUserRegularUserSelfEditAddAdditionalEmailDuplicate(): vo ->with($userAccount); $this->expectException(OCSException::class); - $this->expectExceptionCode(102); + $this->expectExceptionCode(101); $this->api->editUser('UserToEdit', 'additional_mail', 'demo1@nextcloud.com')->getData(); } public function testEditUserRegularUserSelfEditChangeEmailInvalid() { $this->expectException(\OCP\AppFramework\OCS\OCSException::class); - $this->expectExceptionCode(102); + $this->expectExceptionCode(101); $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() @@ -1947,7 +1947,7 @@ public function testEditUserRegularUserSelfEditChangePassword() { public function testEditUserRegularUserSelfEditChangeQuota() { $this->expectException(\OCP\AppFramework\OCS\OCSException::class); - $this->expectExceptionCode(103); + $this->expectExceptionCode(113); $loggedInUser = $this->getMockBuilder(IUser::class) ->disableOriginalConstructor() diff --git a/build/integration/features/provisioning-v1.feature b/build/integration/features/provisioning-v1.feature index 0d1d5b1a3455e..be5473ea1e72e 100644 --- a/build/integration/features/provisioning-v1.feature +++ b/build/integration/features/provisioning-v1.feature @@ -208,7 +208,7 @@ Feature: provisioning And sending "PUT" to "/cloud/users/brand-new-user" with | key | additional_mail | | value | no-reply@nextcloud.com | - And the OCS status code should be "102" + And the OCS status code should be "101" And the HTTP status code should be "200" And sending "PUT" to "/cloud/users/brand-new-user" with | key | additional_mail | @@ -219,7 +219,7 @@ Feature: provisioning And sending "PUT" to "/cloud/users/brand-new-user" with | key | additional_mail | | value | no.reply2@nextcloud.com | - And the OCS status code should be "102" + And the OCS status code should be "101" And the HTTP status code should be "200" Then user "brand-new-user" has | id | brand-new-user | @@ -264,17 +264,17 @@ Feature: provisioning When sending "PUT" to "/cloud/users/brand-new-user" with | key | phoneScope | | value | invalid | - Then the OCS status code should be "102" + Then the OCS status code should be "101" And the HTTP status code should be "200" When sending "PUT" to "/cloud/users/brand-new-user" with | key | displaynameScope | | value | v2-private | - Then the OCS status code should be "102" + Then the OCS status code should be "101" And the HTTP status code should be "200" When sending "PUT" to "/cloud/users/brand-new-user" with | key | emailScope | | value | v2-private | - Then the OCS status code should be "102" + Then the OCS status code should be "101" And the HTTP status code should be "200" Scenario: Edit a user account multi-value property scopes with invalid or unsupported value @@ -320,7 +320,7 @@ Feature: provisioning When sending "PUT" to "/cloud/users/brand-new-user" with | key | phoneScope | | value | v2-private | - Then the OCS status code should be "103" + Then the OCS status code should be "113" And the HTTP status code should be "200" Scenario: Search by phone number