ENGCOM-6001: 2.3.3 Fix multiple copy to email recipients #24855

Author: VladimirZaets

app/code/Magento/Sales/Model/Order/Email/SenderBuilder.php

@@ -85,8 +85,8 @@ public function sendCopyTo()
         $copyTo = $this->identityContainer->getEmailCopyTo();
 
         if (!empty($copyTo)) {
-            $this->configureEmailTemplate();
             foreach ($copyTo as $email) {
+                $this->configureEmailTemplate();
                 $this->transportBuilder->addTo($email);
                 $transport = $this->transportBuilder->getTransport();
                 $transport->sendMessage();

app/code/Magento/Sales/Test/Unit/Model/Order/Email/SenderBuilderTest.php

@@ -37,11 +37,6 @@ class SenderBuilderTest extends \PHPUnit\Framework\TestCase
 
     protected function setUp()
     {
-        $templateId = 'test_template_id';
-        $templateOptions = ['option1', 'option2'];
-        $templateVars = ['var1', 'var2'];
-        $emailIdentity = 'email_identity_test';
-        $emailCopyTo = ['example@mail.com'];
 
         $this->templateContainerMock = $this->createPartialMock(
             \Magento\Sales\Model\Order\Email\Container\Template::class,
@@ -83,36 +78,6 @@ protected function setUp()
             ]
         );
 
-        $this->templateContainerMock->expects($this->once())
-            ->method('getTemplateId')
-            ->will($this->returnValue($templateId));
-        $this->transportBuilder->expects($this->once())
-            ->method('setTemplateIdentifier')
-            ->with($this->equalTo($templateId));
-        $this->templateContainerMock->expects($this->once())
-            ->method('getTemplateOptions')
-            ->will($this->returnValue($templateOptions));
-        $this->transportBuilder->expects($this->once())
-            ->method('setTemplateOptions')
-            ->with($this->equalTo($templateOptions));
-        $this->templateContainerMock->expects($this->once())
-            ->method('getTemplateVars')
-            ->will($this->returnValue($templateVars));
-        $this->transportBuilder->expects($this->once())
-            ->method('setTemplateVars')
-            ->with($this->equalTo($templateVars));
-
-        $this->identityContainerMock->expects($this->once())
-            ->method('getEmailIdentity')
-            ->will($this->returnValue($emailIdentity));
-        $this->transportBuilder->expects($this->once())
-            ->method('setFromByScope')
-            ->with($this->equalTo($emailIdentity), 1);
-
-        $this->identityContainerMock->expects($this->once())
-            ->method('getEmailCopyTo')
-            ->will($this->returnValue($emailCopyTo));
-
         $this->senderBuilder = new SenderBuilder(
             $this->templateContainerMock,
             $this->identityContainerMock,
@@ -122,6 +87,7 @@ protected function setUp()
 
     public function testSend()
     {
+        $this->setExpectedCount(1);
         $customerName = 'test_name';
         $customerEmail = 'test_email';
         $identity = 'email_identity_test';
@@ -142,20 +108,20 @@ public function testSend()
         $this->identityContainerMock->expects($this->once())
             ->method('getCustomerName')
             ->will($this->returnValue($customerName));
-        $this->identityContainerMock->expects($this->once())
+        $this->identityContainerMock->expects($this->exactly(1))
             ->method('getStore')
             ->willReturn($this->storeMock);
         $this->storeMock->expects($this->once())
             ->method('getId')
             ->willReturn(1);
-        $this->transportBuilder->expects($this->once())
+        $this->transportBuilder->expects($this->exactly(1))
             ->method('setFromByScope')
             ->with($identity, 1);
-        $this->transportBuilder->expects($this->once())
+        $this->transportBuilder->expects($this->exactly(1))
             ->method('addTo')
             ->with($this->equalTo($customerEmail), $this->equalTo($customerName));
 
-        $this->transportBuilder->expects($this->once())
+        $this->transportBuilder->expects($this->exactly(1))
             ->method('getTransport')
             ->will($this->returnValue($transportMock));
 
@@ -164,6 +130,7 @@ public function testSend()
 
     public function testSendCopyTo()
     {
+        $this->setExpectedCount(2);
         $identity = 'email_identity_test';
         $transportMock = $this->createMock(
             \Magento\Sales\Test\Unit\Model\Order\Email\Stub\TransportInterfaceMock::class
@@ -172,22 +139,66 @@ public function testSendCopyTo()
             ->method('getCustomerEmail');
         $this->identityContainerMock->expects($this->never())
             ->method('getCustomerName');
-        $this->transportBuilder->expects($this->once())
-            ->method('addTo')
-            ->with($this->equalTo('example@mail.com'));
-        $this->transportBuilder->expects($this->once())
+        $this->transportBuilder->expects($this->exactly(2))
+            ->method('addTo');
+        $this->transportBuilder->expects($this->exactly(2))
             ->method('setFromByScope')
             ->with($identity, 1);
-        $this->identityContainerMock->expects($this->once())
+        $this->identityContainerMock->expects($this->exactly(2))
             ->method('getStore')
             ->willReturn($this->storeMock);
-        $this->storeMock->expects($this->once())
+        $this->storeMock->expects($this->exactly(2))
             ->method('getId')
             ->willReturn(1);
-        $this->transportBuilder->expects($this->once())
+        $this->transportBuilder->expects($this->exactly(2))
             ->method('getTransport')
             ->will($this->returnValue($transportMock));
 
         $this->senderBuilder->sendCopyTo();
     }
+
+    /**
+     * Sets expected count invocation.
+     *
+     * @param int $count
+     */
+    private function setExpectedCount(int $count = 1)
+    {
+
+        $templateId = 'test_template_id';
+        $templateOptions = ['option1', 'option2'];
+        $templateVars = ['var1', 'var2'];
+        $emailIdentity = 'email_identity_test';
+        $emailCopyTo = ['example@mail.com', 'example2@mail.com'];
+
+        $this->templateContainerMock->expects($this->exactly($count))
+            ->method('getTemplateId')
+            ->will($this->returnValue($templateId));
+        $this->transportBuilder->expects($this->exactly($count))
+            ->method('setTemplateIdentifier')
+            ->with($this->equalTo($templateId));
+        $this->templateContainerMock->expects($this->exactly($count))
+            ->method('getTemplateOptions')
+            ->will($this->returnValue($templateOptions));
+        $this->transportBuilder->expects($this->exactly($count))
+            ->method('setTemplateOptions')
+            ->with($this->equalTo($templateOptions));
+        $this->templateContainerMock->expects($this->exactly($count))
+            ->method('getTemplateVars')
+            ->will($this->returnValue($templateVars));
+        $this->transportBuilder->expects($this->exactly($count))
+            ->method('setTemplateVars')
+            ->with($this->equalTo($templateVars));
+
+        $this->identityContainerMock->expects($this->exactly($count))
+            ->method('getEmailIdentity')
+            ->will($this->returnValue($emailIdentity));
+        $this->transportBuilder->expects($this->exactly($count))
+            ->method('setFromByScope')
+            ->with($this->equalTo($emailIdentity), 1);
+
+        $this->identityContainerMock->expects($this->once())
+            ->method('getEmailCopyTo')
+            ->will($this->returnValue($emailCopyTo));
+    }
 }