MC-42486: Region ID and Country ID values and not properly converted in Email templates

- Added unit testing for email modules

Author: devarul

app/code/Magento/Email/Test/Unit/Model/AbstractTemplateTest.php

@@ -253,7 +253,6 @@ public function testGetProcessedTemplate($variables, $templateType, $storeId, $e
             ->method('filter')
             ->with($preparedTemplateText)
             ->willReturn($expectedResult);
-
         $this->assertEquals($expectedResult, $model->getProcessedTemplate($variables));
     }
 
@@ -339,6 +338,8 @@ public function getProcessedTemplateProvider()
                     'store_phone' => null,
                     'store_hours' => null,
                     'store_email' => null,
+                    'store_country' => null,
+                    'store_region' => null
                 ],
                 'expectedResult' => 'expected result',
             ],
@@ -359,6 +360,8 @@ public function getProcessedTemplateProvider()
                     'store_hours' => null,
                     'store_email' => null,
                     'template_styles' => null,
+                    'store_country' => null,
+                    'store_region' => null
                 ],
                 'expectedResult' => 'expected result',
             ],

app/code/Magento/Email/Test/Unit/Model/TemplateTest.php

@@ -24,6 +24,8 @@
 use Magento\Framework\Registry;
 use Magento\Framework\Serialize\Serializer\Json;
 use Magento\Framework\Url;
+use Magento\Directory\Api\CountryInformationAcquirerInterface;
+use Magento\Directory\Model\RegionFactory;
 use Magento\Framework\View\Asset\Repository;
 use Magento\Framework\View\DesignInterface;
 use Magento\Setup\Module\I18n\Locale;
@@ -98,6 +100,16 @@ class TemplateTest extends TestCase
      */
     private $urlModel;
 
+    /**
+     * @var CountryInformationAcqirerInterface|MockObject
+     */
+    private $countryInformationAcquirerInterface;
+
+    /**
+     * @var RegionFactory|MockObject
+     */
+    private $regionFactory;
+
     /**
      * @var Config|MockObject
      */
@@ -163,6 +175,15 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
+        $this->countryInformationAcquirerInterface = $this->getMockBuilder(CountryInformationAcquirerInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->regionFactory = $this->getMockBuilder(RegionFactory::class)
+            ->setMethods(['create'])
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->filterFactory = $this->getMockBuilder(FilterFactory::class)
             ->setMethods(['create'])
             ->disableOriginalConstructor()
@@ -196,6 +217,8 @@ protected function getModelMock(array $mockedMethods = [])
                     $this->templateFactory,
                     $this->filterManager,
                     $this->urlModel,
+                    $this->countryInformationAcquirerInterface,
+                    $this->regionFactory,
                     $this->filterFactory,
                     [],
                     $this->serializerMock
@@ -774,6 +797,8 @@ public function testGetType($templateType, $expectedResult)
                     $this->createMock(TemplateFactory::class),
                     $this->createMock(FilterManager::class),
                     $this->createMock(Url::class),
+                    $this->createMock(CountryInformationAcquirerInterface::class),
+                    $this->createMock(RegionFactory::class),
                     $this->createMock(FilterFactory::class),
                     [],
                     $this->createMock(Json::class)

app/code/Magento/Email/composer.json

@@ -15,7 +15,8 @@
         "magento/module-require-js": "*",
         "magento/module-media-storage": "*",
         "magento/module-variable": "*",
-        "magento/module-ui": "*"
+        "magento/module-ui": "*",
+        "magento/module-directory": "*"
     },
     "suggest": {
         "magento/module-theme": "*"

app/code/Magento/Newsletter/Model/Template.php

@@ -81,6 +81,8 @@ class Template extends \Magento\Email\Model\AbstractTemplate
      * @param \Magento\Framework\Filter\FilterManager $filterManager
      * @param \Magento\Framework\Url|\Magento\Framework\UrlInterface $urlModel
      * @param \Magento\Framework\App\RequestInterface $request
+     * @param \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface
+     * @param \Magento\Directory\Model\RegionFactory $regionFactory
      * @param \Magento\Newsletter\Model\Template\FilterFactory $filterFactory ,
      * @param array $data
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
@@ -98,6 +100,8 @@ public function __construct(
         \Magento\Email\Model\TemplateFactory $templateFactory,
         \Magento\Framework\Filter\FilterManager $filterManager,
         \Magento\Framework\UrlInterface $urlModel,
+        \Magento\Directory\Api\CountryInformationAcquirerInterface $countryInformationAcquirerInterface,
+        \Magento\Directory\Model\RegionFactory $regionFactory,
         \Magento\Framework\App\RequestInterface $request,
         \Magento\Newsletter\Model\Template\FilterFactory $filterFactory,
         array $data = []
@@ -115,6 +119,8 @@ public function __construct(
             $templateFactory,
             $filterManager,
             $urlModel,
+            $countryInformationAcquirerInterface,
+            $regionFactory,
             $data
         );
         $this->_storeManager = $storeManager;

app/code/Magento/Newsletter/Test/Unit/Model/TemplateTest.php

@@ -7,6 +7,7 @@
 
 namespace Magento\Newsletter\Test\Unit\Model;
 
+use Magento\Directory\Model\RegionFactory;
 use Magento\Email\Model\Template\Config;
 use Magento\Email\Model\TemplateFactory;
 use Magento\Framework\App\Area;
@@ -19,6 +20,7 @@
 use Magento\Framework\Model\Context;
 use Magento\Framework\Registry;
 use Magento\Framework\Url;
+use Magento\Directory\Api\CountryInformationAcquirerInterface;
 use Magento\Framework\View\Asset\Repository;
 use Magento\Framework\View\DesignInterface;
 use Magento\Newsletter\Model\Subscriber;
@@ -103,6 +105,16 @@ class TemplateTest extends TestCase
      */
     private $urlModelMock;
 
+    /**
+     * @var CountryInformationAcqirerInterface|MockObject
+     */
+    private $countryInformationAcquirerInterface;
+
+    /**
+     * @var RegionFactory|MockObject
+     */
+    private $regionFactory;
+
     /**
      * @var RequestInterface|MockObject
      */
@@ -180,6 +192,15 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
+        $this->countryInformationAcquirerInterface = $this->getMockBuilder(CountryInformationAcquirerInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->regionFactory = $this->getMockBuilder(RegionFactory::class)
+            ->setMethods(['create'])
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->requestMock = $this->getMockBuilder(RequestInterface::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
@@ -213,6 +234,8 @@ protected function getModelMock(array $mockedMethods = [])
                     $this->templateFactoryMock,
                     $this->filterManagerMock,
                     $this->urlModelMock,
+                    $this->countryInformationAcquirerInterface,
+                    $this->regionFactory,
                     $this->requestMock,
                     $this->filterFactoryMock,
                 ]
@@ -387,6 +410,8 @@ public function getProcessedTemplateDataProvider()
                     'store_phone' => null,
                     'store_hours' => null,
                     'store_email' => null,
+                    'store_country' => null,
+                    'store_region' => null
                 ],
                 'expectedResult' => 'expected result',
             ],
@@ -407,6 +432,8 @@ public function getProcessedTemplateDataProvider()
                     'store_hours' => null,
                     'store_email' => null,
                     'template_styles' => null,
+                    'store_country' => null,
+                    'store_region' => null
                 ],
                 'expectedResult' => 'expected result',
             ],