CABPI-396: Change public methods that are used only inside the class to private

slopukhov · slopukhov · commit 5c0650ae8cdf · 2022-05-06T12:42:29.000-05:00
diff --git a/app/code/Magento/AdminAdobeIms/Model/UserAuthorizedSession.php b/app/code/Magento/AdminAdobeIms/Model/UserAuthorizedSession.php
@@ -24,18 +24,18 @@ class UserAuthorizedSession implements UserAuthorizedInterface
     /**
      * @var ImsConnection
      */
-    private ImsConnection $imsConnection;
+    private ImsConnection $adminImsConnection;
 
     /**
      * @param Auth $auth
-     * @param ImsConnection $imsConnection
+     * @param ImsConnection $adminImsConnection
      */
     public function __construct(
         Auth $auth,
-        ImsConnection $imsConnection
+        ImsConnection $adminImsConnection
     ) {
         $this->auth = $auth;
-        $this->imsConnection = $imsConnection;
+        $this->adminImsConnection = $adminImsConnection;
     }
 
     /**
@@ -50,7 +50,7 @@ public function execute(int $adminUserId = null): bool
         }
 
         try {
-            return $this->imsConnection->validateToken($token);
+            return $this->adminImsConnection->validateToken($token);
         } catch (AuthorizationException $e) {
             return false;
         }
diff --git a/app/code/Magento/AdminAdobeIms/Test/Unit/Command/AdminAdobeImsEnableCommandTest.php b/app/code/Magento/AdminAdobeIms/Test/Unit/Command/AdminAdobeImsEnableCommandTest.php
@@ -37,12 +37,12 @@ class AdminAdobeImsEnableCommandTest extends TestCase
     /**
      * @var ImsConfig
      */
-    private $imsConfigMock;
+    private $adminImsConfigMock;
 
     /**
      * @var ImsConnection
      */
-    private $imsConnectionMock;
+    private $adminImsConnectionMock;
 
     /**
      * @var ImsCommandOptionService
@@ -73,8 +73,8 @@ protected function setUp(): void
     {
         $objectManagerHelper = new ObjectManagerHelper($this);
 
-        $this->imsConfigMock = $this->createMock(ImsConfig::class);
-        $this->imsConnectionMock = $this->createMock(ImsConnection::class);
+        $this->adminImsConfigMock = $this->createMock(ImsConfig::class);
+        $this->adminImsConnectionMock = $this->createMock(ImsConnection::class);
         $this->imsCommandOptionService = $this->createMock(ImsCommandOptionService::class);
         $this->typeListInterface = $this->createMock(TypeListInterface::class);
         $this->updateTokensService = $this->createMock(UpdateTokensService::class);
@@ -86,8 +86,8 @@ protected function setUp(): void
         $this->enableCommand = $objectManagerHelper->getObject(
             AdminAdobeImsEnableCommand::class,
             [
-                'imsConfig' => $this->imsConfigMock,
-                'imsConnection' => $this->imsConnectionMock,
+                'adminImsConfig' => $this->adminImsConfigMock,
+                'adminImsConnection' => $this->adminImsConnectionMock,
                 'imsCommandOptionService' => $this->imsCommandOptionService,
                 'cacheTypeList' => $this->typeListInterface,
                 'updateTokenService' => $this->updateTokensService
@@ -127,10 +127,10 @@ public function testAdminAdobeImsModuleEnableWillClearCacheWhenSuccessful(
         $this->imsCommandOptionService->method('getClientSecret')->willReturn('clientSecret');
         $this->imsCommandOptionService->method('isTwoFactorAuthEnabled')->willReturn($isTwoFactorAuthEnabled);
 
-        $this->imsConnectionMock->method('testAuth')
+        $this->adminImsConnectionMock->method('testAuth')
             ->willReturn($testAuthMode);
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($enableMethodCallExpection)
             ->method('enableModule');
 
diff --git a/app/code/Magento/AdminAdobeIms/Test/Unit/Model/ImsConnectionTest.php b/app/code/Magento/AdminAdobeIms/Test/Unit/Model/ImsConnectionTest.php
@@ -36,26 +36,26 @@ class ImsConnectionTest extends TestCase
     /**
      * @var ImsConnection
      */
-    private $imsConnection;
+    private $adminImsConnection;
 
     protected function setUp(): void
     {
         $objectManagerHelper = new ObjectManagerHelper($this);
 
-        $imsConfigMock = $this->createMock(ImsConfig::class);
-        $imsConfigMock
+        $adminImsConfigMock = $this->createMock(ImsConfig::class);
+        $adminImsConfigMock
             ->method('getAuthUrl')
             ->willReturn(self::AUTH_URL);
 
         $this->curlFactory = $this->createMock(CurlFactory::class);
 
         $json = $this->createMock(Json::class);
 
-        $this->imsConnection = $objectManagerHelper->getObject(
+        $this->adminImsConnection = $objectManagerHelper->getObject(
             ImsConnection::class,
             [
                 'curlFactory' => $this->curlFactory,
-                'imsConfig' => $imsConfigMock,
+                'adminImsConfig' => $adminImsConfigMock,
                 'json' => $json,
             ]
         );
@@ -74,7 +74,7 @@ public function testAuthThrowsExceptionWhenResponseCodeIs200(): void
 
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Could not get a valid response from Adobe IMS Service.');
-        $this->imsConnection->auth();
+        $this->adminImsConnection->auth();
     }
 
     public function testAuthThrowsExceptionWhenResponseContainsError(): void
@@ -90,6 +90,6 @@ public function testAuthThrowsExceptionWhenResponseContainsError(): void
 
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Could not connect to Adobe IMS Service: invalid_scope.');
-        $this->imsConnection->auth();
+        $this->adminImsConnection->auth();
     }
 }
diff --git a/app/code/Magento/AdminAdobeIms/Test/Unit/Plugin/AdminForgotPasswordPluginTest.php b/app/code/Magento/AdminAdobeIms/Test/Unit/Plugin/AdminForgotPasswordPluginTest.php
@@ -32,7 +32,7 @@ class AdminForgotPasswordPluginTest extends TestCase
     /**
      * @var ImsConfig|MockObject
      */
-    private $imsConfigMock;
+    private $adminImsConfigMock;
 
     /**
      * @var MessageManagerInterface|MockObject
@@ -47,14 +47,14 @@ protected function setUp(): void
         $objectManagerHelper = new ObjectManagerHelper($this);
 
         $this->redirectFactory = $this->createMock(RedirectFactory::class);
-        $this->imsConfigMock = $this->createMock(ImsConfig::class);
+        $this->adminImsConfigMock = $this->createMock(ImsConfig::class);
         $this->messageManagerMock = $this->createMock(MessageManagerInterface::class);
 
         $this->plugin = $objectManagerHelper->getObject(
             AdminForgotPasswordPlugin::class,
             [
                 'redirectFactory' => $this->redirectFactory,
-                'imsConfig' => $this->imsConfigMock,
+                'adminImsConfig' => $this->adminImsConfigMock,
                 'messageManager' => $this->messageManagerMock,
             ]
         );
@@ -72,7 +72,7 @@ public function testPluginRedirectsToLoginPageWhenModuleIsEnabled(): void
         $redirect->method('setPath')
             ->willReturnSelf();
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(true);
@@ -104,7 +104,7 @@ public function testPluginProceedsWhenModuleIsDisabled(): void
         $subject = $this->createMock(Forgotpassword::class);
         $redirect = $this->createMock(Redirect::class);
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(false);
diff --git a/app/code/Magento/AdminAdobeIms/Test/Unit/Plugin/ReplaceVerifyIdentityWithImsPluginTest.php b/app/code/Magento/AdminAdobeIms/Test/Unit/Plugin/ReplaceVerifyIdentityWithImsPluginTest.php
@@ -40,12 +40,12 @@ class ReplaceVerifyIdentityWithImsPluginTest extends TestCase
     /**
      * @var ImsConfig|MockObject
      */
-    private $imsConfigMock;
+    private $adminImsConfigMock;
 
     /**
      * @var ImsConnection|MockObject
      */
-    private $imsConnectionMock;
+    private $adminImsConnectionMock;
 
     /**
      * @return void
@@ -63,14 +63,14 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->imsConfigMock = $this->createMock(ImsConfig::class);
-        $this->imsConnectionMock = $this->createMock(ImsConnection::class);
+        $this->adminImsConfigMock = $this->createMock(ImsConfig::class);
+        $this->adminImsConnectionMock = $this->createMock(ImsConnection::class);
 
         $this->plugin = $objectManagerHelper->getObject(
             ReplaceVerifyIdentityWithImsPlugin::class,
             [
-                'imsConfig' => $this->imsConfigMock,
-                'imsConnection' => $this->imsConnectionMock,
+                'adminImsConfig' => $this->adminImsConfigMock,
+                'adminImsConnection' => $this->adminImsConnectionMock,
                 'auth' => $this->authMock,
             ]
         );
@@ -89,7 +89,7 @@ public function testAroundVerifyIdentityCallsProceedWhenModuleIsDisabled(): void
         $this->authMock->expects($this->never())
             ->method('getAuthStorage');
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(false);
@@ -102,7 +102,7 @@ public function testAroundVerifyIdentityCallsProceedWhenModuleIsDisabled(): void
             return $expectedResult;
         };
 
-        $this->imsConnectionMock
+        $this->adminImsConnectionMock
             ->expects($this->never())
             ->method('validateToken');
 
@@ -133,14 +133,14 @@ public function testAroundVerifyIdentityVerifiesAccessTokenWhenModuleIsEnabled()
         ->method('getAuthStorage')
         ->willReturn($this->storageMock);
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(true);
 
         $subject = $this->createMock(User::class);
 
-        $this->imsConnectionMock
+        $this->adminImsConnectionMock
             ->expects($this->once())
             ->method('validateToken')
             ->willReturn(true);
@@ -178,14 +178,14 @@ public function testAroundVerifyIdentityThrowsExceptionOnInvalidToken(): void
             ->method('getAuthStorage')
             ->willReturn($this->storageMock);
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(true);
 
         $subject = $this->createMock(User::class);
 
-        $this->imsConnectionMock
+        $this->adminImsConnectionMock
             ->expects($this->once())
             ->method('validateToken')
             ->willReturn(false);
@@ -227,14 +227,14 @@ public function testAroundVerifyIdentityThrowsExceptionOnEmptyToken(): void
             ->method('getAuthStorage')
             ->willReturn($this->storageMock);
 
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->expects($this->once())
             ->method('enabled')
             ->willReturn(true);
 
         $subject = $this->createMock(User::class);
 
-        $this->imsConnectionMock
+        $this->adminImsConnectionMock
             ->expects($this->never())
             ->method('validateToken');
 
diff --git a/app/code/Magento/AdminAdobeIms/Test/Unit/Service/ImsOrganizationServiceTest.php b/app/code/Magento/AdminAdobeIms/Test/Unit/Service/ImsOrganizationServiceTest.php
@@ -27,18 +27,18 @@ class ImsOrganizationServiceTest extends TestCase
     /**
      * @var ImsConfig
      */
-    private $imsConfigMock;
+    private $adminImsConfigMock;
 
     protected function setUp(): void
     {
         $objectManagerHelper = new ObjectManagerHelper($this);
 
-        $this->imsConfigMock = $this->createMock(ImsConfig::class);
+        $this->adminImsConfigMock = $this->createMock(ImsConfig::class);
 
         $this->imsOrganizationService = $objectManagerHelper->getObject(
             ImsOrganizationService::class,
             [
-                'imsConfig' => $this->imsConfigMock
+                'adminImsConfig' => $this->adminImsConfigMock
             ]
         );
     }
@@ -52,7 +52,7 @@ public function testCheckOrganizationAllocationWithEmptyProfileRolesThrowsExcept
 
     public function testCheckOrganizationAllocationReturnsTrueWhenProfileAssignedToOrg()
     {
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->method('getOrganizationId')
             ->willReturn(self::VALID_ORGANIZATION_ID);
 
@@ -68,7 +68,7 @@ public function testCheckOrganizationAllocationReturnsTrueWhenProfileAssignedToO
 
     public function testCheckOrganizationAllocationThrowsExceptionWhenProfileNotAssignedToOrg()
     {
-        $this->imsConfigMock
+        $this->adminImsConfigMock
             ->method('getOrganizationId')
             ->willReturn(self::INVALID_ORGANIZATION_ID);
 

Original file line number	Diff line number	Diff line change
`@@ -27,18 +27,18 @@ class ImsOrganizationServiceTest extends TestCase`
`27`	`27`	`/**`
`28`	`28`	`* @var ImsConfig`
`29`	`29`	`*/`
`30`		`- private $imsConfigMock;`
	`30`	`+ private $adminImsConfigMock;`
`31`	`31`
`32`	`32`	`protected function setUp(): void`
`33`	`33`	`{`
`34`	`34`	`$objectManagerHelper = new ObjectManagerHelper($this);`
`35`	`35`
`36`		`- $this->imsConfigMock = $this->createMock(ImsConfig::class);`
	`36`	`+ $this->adminImsConfigMock = $this->createMock(ImsConfig::class);`
`37`	`37`
`38`	`38`	`$this->imsOrganizationService = $objectManagerHelper->getObject(`
`39`	`39`	`ImsOrganizationService::class,`
`40`	`40`	`[`
`41`		`- 'imsConfig' => $this->imsConfigMock`
	`41`	`+ 'adminImsConfig' => $this->adminImsConfigMock`
`42`	`42`	`]`
`43`	`43`	`);`
`44`	`44`	`}`
`@@ -52,7 +52,7 @@ public function testCheckOrganizationAllocationWithEmptyProfileRolesThrowsExcept`
`52`	`52`
`53`	`53`	`public function testCheckOrganizationAllocationReturnsTrueWhenProfileAssignedToOrg()`
`54`	`54`	`{`
`55`		`- $this->imsConfigMock`
	`55`	`+ $this->adminImsConfigMock`
`56`	`56`	`->method('getOrganizationId')`
`57`	`57`	`->willReturn(self::VALID_ORGANIZATION_ID);`
`58`	`58`
`@@ -68,7 +68,7 @@ public function testCheckOrganizationAllocationReturnsTrueWhenProfileAssignedToO`
`68`	`68`
`69`	`69`	`public function testCheckOrganizationAllocationThrowsExceptionWhenProfileNotAssignedToOrg()`
`70`	`70`	`{`
`71`		`- $this->imsConfigMock`
	`71`	`+ $this->adminImsConfigMock`
`72`	`72`	`->method('getOrganizationId')`
`73`	`73`	`->willReturn(self::INVALID_ORGANIZATION_ID);`
`74`	`74`