MC-11035: Create install script for MC-4239

- Modified install script to additionally migrate data from websites scope
- Modified unit tests with new scope migration in mind

Author: Mark Berube

app/code/Magento/AuthorizenetAcceptjs/Setup/Patch/Data/CopyCurrentConfig.php

@@ -10,12 +10,11 @@
 use Magento\Framework\App\Config\ConfigResource\ConfigInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Encryption\EncryptorInterface;
-use Magento\Framework\Setup\InstallDataInterface;
-use Magento\Framework\Setup\ModuleContextInterface;
 use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
-use Magento\Framework\Setup\Patch\PatchInterface;
 use Magento\Store\Model\ScopeInterface;
+use Magento\Store\Model\StoreManagerInterface;
+use Magento\Store\Api\Data\WebsiteInterface;
 
 /**
  * Copies the Authorize.net DirectPost configuration values to the new Accept.js module.
@@ -46,6 +45,11 @@ class CopyCurrentConfig implements DataPatchInterface
      */
     private $moduleDataSetup;
 
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
     /**
      * @var array
      */
@@ -76,26 +80,40 @@ class CopyCurrentConfig implements DataPatchInterface
      * @param ScopeConfigInterface $scopeConfig
      * @param ConfigInterface $resourceConfig
      * @param EncryptorInterface $encryptor
+     * @param StoreManagerInterface $storeManager
      */
     public function __construct(
         ModuleDataSetupInterface $moduleDataSetup,
         ScopeConfigInterface $scopeConfig,
         ConfigInterface  $resourceConfig,
-        EncryptorInterface $encryptor
+        EncryptorInterface $encryptor,
+        StoreManagerInterface $storeManager
     ) {
         $this->scopeConfig = $scopeConfig;
         $this->resourceConfig = $resourceConfig;
         $this->encryptor = $encryptor;
         $this->moduleDataSetup = $moduleDataSetup;
+        $this->storeManager = $storeManager;
     }
 
     /**
      * @inheritdoc
      */
-    public function apply()
+    public function apply(): void
     {
         $this->moduleDataSetup->startSetup();
+        $this->migrateDefaultValues();
+        $this->migrateWebsiteValues();
+        $this->moduleDataSetup->endSetup();
+    }
 
+    /**
+     * Migrate configuration values from DirectPost to Accept.js on default scope
+     *
+     * @return void
+     */
+    private function migrateDefaultValues(): void
+    {
         foreach ($this->configFieldsToMigrate as $field) {
             $configValue = $this->getOldConfigValue($field);
 
@@ -108,24 +126,62 @@ public function apply()
             $configValue = $this->getOldConfigValue($field);
 
             if (!empty($configValue)) {
-                $this->saveNewConfigValue($field, $configValue, true);
+                $this->saveNewConfigValue(
+                    $field,
+                    $configValue,
+                    ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
+                    0,
+                    true
+                );
             }
         }
+    }
 
-        $this->moduleDataSetup->endSetup();
+    /**
+     * Migrate configuration values from DirectPost to Accept.js on all website scopes
+     *
+     * @return void
+     */
+    private function migrateWebsiteValues(): void
+    {
+        foreach ($this->storeManager->getWebsites() as $website) {
+            $websiteID = (int) $website->getId();
+
+            foreach ($this->configFieldsToMigrate as $field) {
+                $configValue = $this->getOldConfigValue($field, ScopeInterface::SCOPE_WEBSITES, $websiteID);
+
+                if (!empty($configValue)) {
+                    $this->saveNewConfigValue($field, $configValue, ScopeInterface::SCOPE_WEBSITES, $websiteID);
+                }
+            }
+
+            foreach ($this->encryptedConfigFieldsToMigrate as $field) {
+                $configValue = $this->getOldConfigValue($field, ScopeInterface::SCOPE_WEBSITES, $websiteID);
+
+                if (!empty($configValue)) {
+                    $this->saveNewConfigValue($field, $configValue, ScopeInterface::SCOPE_WEBSITES, $websiteID, true);
+                }
+            }
+        }
     }
 
     /**
      * Get old configuration value from the DirectPost module's configuration on the store scope
      *
      * @param string $field
+     * @param string $scope
+     * @param int $scopeID
      * @return mixed
      */
-    private function getOldConfigValue(string $field)
-    {
+    private function getOldConfigValue(
+        string $field,
+        string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
+        int $scopeID = null
+    ) {
         return $this->scopeConfig->getValue(
             sprintf(self::PAYMENT_PATH_FORMAT, self::DIRECTPOST_PATH, $field),
-            ScopeInterface::SCOPE_STORE
+            $scope,
+            $scopeID
         );
     }
 
@@ -134,15 +190,25 @@ private function getOldConfigValue(string $field)
      *
      * @param string $field
      * @param mixed $value
+     * @param string $scope
+     * @param int $scopeID
      * @param bool $isEncrypted
+     * @return void
      */
-    private function saveNewConfigValue(string $field, $value, $isEncrypted = false): void
-    {
+    private function saveNewConfigValue(
+        string $field,
+        $value,
+        string $scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
+        int $scopeID = 0,
+        bool $isEncrypted = false
+    ): void {
         $value = $isEncrypted ? $this->encryptor->encrypt($value) : $value;
+
         $this->resourceConfig->saveConfig(
             sprintf(self::PAYMENT_PATH_FORMAT, self::ACCEPTJS_PATH, $field),
             $value,
-            ScopeInterface::SCOPE_STORE
+            $scope,
+            $scopeID
         );
     }
 

app/code/Magento/AuthorizenetAcceptjs/Test/Unit/Setup/Patch/Data/CopyCurrentConfigTest.php

@@ -15,6 +15,8 @@
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Setup\Module\DataSetup;
 use Magento\Setup\Model\ModuleContext;
+use Magento\Store\Model\StoreManagerInterface;
+use Magento\Store\Model\Website;
 use PHPUnit\Framework\TestCase;
 
 class CopyCurrentConfigTest extends TestCase
@@ -44,6 +46,16 @@ class CopyCurrentConfigTest extends TestCase
      */
     private $context;
 
+    /**
+     * @var \Magento\Store\Model\StoreManager
+     */
+    private $storeManager;
+
+    /**
+     * @var \Magento\Store\Model\Website
+     */
+    private $website;
+
     protected function setUp(): void
     {
         $this->scopeConfig = $this->createMock(Config::class);
@@ -60,22 +72,32 @@ protected function setUp(): void
             ->willReturn(null);
 
         $this->context = $this->createMock(ModuleContext::class);
+        $this->storeManager = $this->createMock(StoreManagerInterface::class);
+        $this->website = $this->createMock(Website::class);
     }
 
     public function testMigrateData(): void
     {
-        $this->scopeConfig->expects($this->exactly(13))
+        $this->scopeConfig->expects($this->exactly(26))
             ->method('getValue')
             ->willReturn('TestValue');
 
-        $this->resourceConfig->expects($this->exactly(13))
+        $this->resourceConfig->expects($this->exactly(26))
             ->method('saveConfig')
             ->willReturn(null);
 
-        $this->encryptor->expects($this->exactly(3))
+        $this->encryptor->expects($this->exactly(6))
             ->method('encrypt')
             ->willReturn('TestValue');
 
+        $this->website->expects($this->once())
+            ->method('getId')
+            ->willReturn(1);
+
+        $this->storeManager->expects($this->once())
+            ->method('getWebsites')
+            ->willReturn([$this->website]);
+
         $objectManager = new ObjectManager($this);
 
         $installer = $objectManager->getObject(
@@ -84,7 +106,8 @@ public function testMigrateData(): void
                 'moduleDataSetup' => $this->setup,
                 'scopeConfig' => $this->scopeConfig,
                 'resourceConfig' => $this->resourceConfig,
-                'encryptor' => $this->encryptor
+                'encryptor' => $this->encryptor,
+                'storeManager' => $this->storeManager
             ]
         );
 
@@ -104,6 +127,10 @@ public function testMigrateDataNullFields(): void
         $this->encryptor->expects($this->never())
             ->method('encrypt');
 
+        $this->storeManager->expects($this->once())
+            ->method('getWebsites')
+            ->willReturn([]);
+
         $objectManager = new ObjectManager($this);
 
         $installer = $objectManager->getObject(
@@ -112,7 +139,8 @@ public function testMigrateDataNullFields(): void
                 'moduleDataSetup' => $this->setup,
                 'scopeConfig' => $this->scopeConfig,
                 'resourceConfig' => $this->resourceConfig,
-                'encryptor' => $this->encryptor
+                'encryptor' => $this->encryptor,
+                'storeManager' => $this->storeManager
             ]
         );