CABPI-27::Implement Admin Users export from Adobe to Commerce - Rename Files from SaveImsUserAndRole to SaveImsUser

Author: rimple-saini

app/code/Magento/AdminAdobeIms/Api/SaveImsUserAndRoleInterface.php

@@ -18,7 +18,7 @@
 use Magento\AdobeImsApi\Api\OrganizationMembershipInterface;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\AuthenticationException;
-use Magento\AdminAdobeIms\Api\SaveImsUserAndRoleInterface;
+use Magento\AdminAdobeIms\Api\SaveImsUserInterface;
 
 /**
  * Adobe IMS Auth Model for getting Admin Token
@@ -65,9 +65,9 @@ class AdobeImsAdminTokenUserService
     private RequestInterface $request;
 
     /**
-     * @var SaveImsUserAndRoleInterface
+     * @var SaveImsUserInterface
      */
-    private SaveImsUserAndRoleInterface $saveImsUserAndRole;
+    private SaveImsUserInterface $saveImsUser;
 
     /**
      * @param ImsConfig $adminImsConfig
@@ -77,7 +77,7 @@ class AdobeImsAdminTokenUserService
      * @param RequestInterface $request
      * @param GetTokenInterface $token
      * @param GetProfileInterface $profile
-     * @param SaveImsUserAndRoleInterface $saveImsUserAndRole
+     * @param SaveImsUserInterface $saveImsUser
      */
     public function __construct(
         ImsConfig $adminImsConfig,
@@ -87,7 +87,7 @@ public function __construct(
         RequestInterface $request,
         GetTokenInterface $token,
         GetProfileInterface $profile,
-        SaveImsUserAndRoleInterface $saveImsUserAndRole
+        SaveImsUserInterface $saveImsUser
     ) {
         $this->adminImsConfig = $adminImsConfig;
         $this->organizationMembership = $organizationMembership;
@@ -96,7 +96,7 @@ public function __construct(
         $this->request = $request;
         $this->token = $token;
         $this->profile = $profile;
-        $this->saveImsUserAndRole = $saveImsUserAndRole;
+        $this->saveImsUser = $saveImsUser;
     }
 
     /**
@@ -131,7 +131,7 @@ public function processLoginRequest(bool $isReauthorize = false): void
                 if ($isReauthorize) {
                     $this->adminReauthProcessService->execute($tokenResponse);
                 } else {
-                    $this->saveImsUserAndRole->save($profile);
+                    $this->saveImsUser->save($profile);
                     $this->adminLoginProcessService->execute($tokenResponse, $profile);
                 }
             } catch (AdobeImsAuthorizationException $e) {

app/code/Magento/AdminAdobeIms/Api/SaveImsUserInterface.php

@@ -7,7 +7,7 @@
 
 namespace Magento\AdminAdobeIms\Model;
 
-use Magento\AdminAdobeIms\Api\SaveImsUserAndRoleInterface;
+use Magento\AdminAdobeIms\Api\SaveImsUserInterface;
 use Magento\User\Model\User;
 use Magento\User\Model\ResourceModel\User\CollectionFactory as UserCollectionFactory;
 use Magento\Authorization\Model\ResourceModel\Role\CollectionFactory as RoleCollectionFactory;
@@ -17,10 +17,10 @@
 use Magento\Framework\Exception\CouldNotSaveException;
 
 /**
- * Class SaveImsUserAndRole
+ * Class SaveImsUser
  * Save Adobe IMS User with Default Role i.e "Adobe Ims" & No Permissions
  */
-class SaveImsUserAndRole implements SaveImsUserAndRoleInterface
+class SaveImsUser implements SaveImsUserInterface
 {
     private const ADMIN_IMS_ROLE = 'Adobe Ims';
 

app/code/Magento/AdminAdobeIms/Model/Authorization/AdobeImsAdminTokenUserService.php

@@ -20,7 +20,7 @@
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\TestCase;
 use Magento\AdminAdobeIms\Service\AdminReauthProcessService;
-use Magento\AdminAdobeIms\Api\SaveImsUserAndRoleInterface;
+use Magento\AdminAdobeIms\Api\SaveImsUserInterface;
 
 /**
  * Tests Magento\AdminAdobeIms\Model\Authorization\AdobeImsAdminTokenUserService
@@ -75,9 +75,9 @@ class AdobeImsAdminTokenUserServiceTest extends TestCase
     private $adminReauthProcessService;
 
     /**
-     * @var SaveImsUserAndRoleInterface
+     * @var SaveImsUserInterface
      */
-    private $saveImsUserAndRole;
+    private $saveImsUser;
 
     protected function setUp(): void
     {
@@ -90,7 +90,7 @@ protected function setUp(): void
         $this->adminLoginProcessService = $this->createMock(AdminLoginProcessService::class);
         $this->requestInterfaceMock = $this->createMock(RequestInterface::class);
         $this->adminReauthProcessService = $this->createMock(AdminReauthProcessService::class);
-        $this->saveImsUserAndRole = $this->createMock(SaveImsUserAndRoleInterface::class);
+        $this->saveImsUser = $this->createMock(SaveImsUserInterface::class);
 
         $this->adminImsConfigMock->expects($this->any())
             ->method('enabled')
@@ -106,7 +106,7 @@ protected function setUp(): void
                 'request' => $this->requestInterfaceMock,
                 'token' => $this->token,
                 'profile' => $this->profile,
-                'saveImsUserAndRole' => $this->saveImsUserAndRole
+                'saveImsUser' => $this->saveImsUser
             ]
         );
     }
@@ -146,7 +146,7 @@ public function testProcessLoginRequest(string $code, array $responseData)
             ->method('checkOrganizationMembership')
             ->with($responseData['access_token']);
 
-        $this->saveImsUserAndRole->expects($this->once())
+        $this->saveImsUser->expects($this->once())
             ->method('save')
             ->with($responseData);
 

app/code/Magento/AdminAdobeIms/Model/SaveImsUserAndRole.php renamed to app/code/Magento/AdminAdobeIms/Model/SaveImsUser.php

@@ -11,7 +11,7 @@
     <preference for="Magento\AdminAdobeIms\Api\Data\ImsWebapiInterface" type="Magento\AdminAdobeIms\Model\ImsWebapi"/>
     <preference for="Magento\AdobeImsApi\Api\GetAccessTokenInterface" type="Magento\AdminAdobeIms\Model\GetAccessTokenProxy"/>
     <preference for="Magento\AdobeImsApi\Api\UserAuthorizedInterface" type="Magento\AdminAdobeIms\Model\UserAuthorizedProxy"/>
-    <preference for="Magento\AdminAdobeIms\Api\SaveImsUserAndRoleInterface" type="Magento\AdminAdobeIms\Model\SaveImsUserAndRole"/>
+    <preference for="Magento\AdminAdobeIms\Api\SaveImsUserInterface" type="Magento\AdminAdobeIms\Model\SaveImsUser"/>
 
     <type name="Magento\Framework\Console\CommandListInterface">
         <arguments>

app/code/Magento/AdminAdobeIms/Test/Unit/Model/Authorization/AdobeImsAdminTokenUserServiceTest.php

@@ -20,15 +20,15 @@
 use Magento\User\Model\User as AdminUser;
 use Magento\Authorization\Model\Role;
 use Magento\Backend\Model\Auth\Session;
-use Magento\AdminAdobeIms\Model\SaveImsUserAndRole;
+use Magento\AdminAdobeIms\Model\SaveImsUser;
 use Magento\Framework\Exception\CouldNotSaveException;
 
 /**
- * Test class for adding Admin User with default "Adobe Ims" Role & Auto Login to Magento Dashboard
+ * Test class for adding Admin IMS User with default "Adobe Ims" Role
  *
  * @magentoDbIsolation disabled
  */
-class SaveImsUserAndRoleTest extends TestCase
+class SaveImsUserTest extends TestCase
 {
     private const ADMIN_IMS_ROLE = 'Adobe Ims';
 
@@ -63,9 +63,9 @@ class SaveImsUserAndRoleTest extends TestCase
     private $authSession;
 
     /**
-     * @var SaveImsUserAndRole
+     * @var SaveImsUser
      */
-    private $saveImsUserAndRole;
+    private $saveImsUser;
 
     /**
      * @return void
@@ -79,8 +79,8 @@ protected function setUp(): void
         $this->roleCollectionFactory    = $this->objectManager->create(RoleCollectionFactory::class);
         $this->logger                   = $this->createMock(AdminAdobeImsLogger::class);
         $this->authSession              = $this->objectManager->create(Session::class);
-        $this->saveImsUserAndRole       = $this->objectManager->create(
-            SaveImsUserAndRole::class,
+        $this->saveImsUser              = $this->objectManager->create(
+            SaveImsUser::class,
             [
                 'user'                  => $this->user,
                 'userCollectionFactory' => $this->userCollectionFactory,
@@ -114,7 +114,7 @@ public function testImportImsUserToAdobeCommerce(): void
             'email'                 => 'imsuser1@admin.com',
         ];
 
-        $this->saveImsUserAndRole->save($profile);
+        $this->saveImsUser->save($profile);
 
         $savedUserId = $this->user->getUserId();
         //Check whether Adobe Ims User is saved
@@ -142,14 +142,14 @@ public function testImportImsUserToAdobeCommerce(): void
         AppArea(Area::AREA_ADMINHTML),
         DataFixture(RoleFixture::class, ['role_name' => self::ADMIN_IMS_ROLE]),
     ]
-    public function testExceptionWhenSaveImsUserAndRoleFails(): void
+    public function testExceptionWhenSaveImsUserFails(): void
     {
         $profile = [
             'email' => 'imsuser2@admin.com',
         ];
         $this->expectException(CouldNotSaveException::class);
         $this->expectExceptionMessage('Could not save ims user.');
 
-        $this->saveImsUserAndRole->save($profile);
+        $this->saveImsUser->save($profile);
     }
 }