-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Test coverage for PR #27589 (E-mail templates) #27606
Merged
magento-engcom-team
merged 6 commits into
magento:2.4-develop
from
lbajsarowicz:test-coverage/27589-email-integration-tests
Apr 18, 2020
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1ac923d
Use the same greeting as in other Magento Customer emails
ptylek 16cb18d
magento/magento2#27589 Cover with Integration Tests the template chan…
lbajsarowicz f882122
magento/magento2#27589 Expect exactly one greeting in the Template
lbajsarowicz 82224a6
magento/magento2#27589 Fix Static Tests
lbajsarowicz cd895a5
Merge branch '2.4-develop' into test-coverage/27589-email-integration…
slavvka d4b8083
Merge remote-tracking branch 'origin/2.4-develop' into test-coverage/…
lbajsarowicz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
204 changes: 204 additions & 0 deletions
204
dev/tests/integration/testsuite/Magento/Customer/Controller/Account/EmailTemplateTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,204 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\Customer\Controller\Account; | ||
|
||
use Magento\Customer\Model\Session; | ||
use Magento\Framework\App\Request\Http as HttpRequest; | ||
use Magento\Framework\Data\Form\FormKey; | ||
use Magento\Framework\Mail\EmailMessage; | ||
use Magento\Framework\Message\MessageInterface; | ||
use Magento\TestFramework\Mail\Template\TransportBuilderMock; | ||
use Magento\TestFramework\TestCase\AbstractController; | ||
|
||
/** | ||
* Set of tests to verify e-mail templates delivered to Customers | ||
* | ||
* @magentoAppArea frontend | ||
*/ | ||
class EmailTemplateTest extends AbstractController | ||
{ | ||
private const FIXTURE_CUSTOMER_EMAIL = 'customer@example.com'; | ||
private const FIXTURE_CUSTOMER_FIRSTNAME = 'John'; | ||
private const FIXTURE_CUSTOMER_LASTNAME = 'Smith'; | ||
private const FIXTURE_CUSTOMER_ID = 1; | ||
private const FIXTURE_CUSTOMER_PASSWORD = 'password'; | ||
private const EXPECTED_GREETING = self::FIXTURE_CUSTOMER_FIRSTNAME . ' ' . self::FIXTURE_CUSTOMER_LASTNAME . ','; | ||
|
||
/** | ||
* @var TransportBuilderMock | ||
*/ | ||
private $transportBuilderMock; | ||
|
||
/** | ||
* @var Session | ||
*/ | ||
private $session; | ||
|
||
/** | ||
* @var FormKey | ||
*/ | ||
private $formKey; | ||
|
||
protected function setUp() | ||
{ | ||
parent::setUp(); | ||
$this->transportBuilderMock = $this->_objectManager->get(TransportBuilderMock::class); | ||
$this->session = $this->_objectManager->get(Session::class); | ||
$this->formKey = $this->_objectManager->get(FormKey::class); | ||
} | ||
|
||
/** | ||
* @magentoDataFixture Magento/Customer/_files/customer.php | ||
* @magentoConfigFixture current_store customer/captcha/enable 0 | ||
*/ | ||
public function testForgotPasswordEmailTemplateGreeting() | ||
{ | ||
$this->getRequest()->setMethod(HttpRequest::METHOD_POST) | ||
->setPostValue(['email' => self::FIXTURE_CUSTOMER_EMAIL]); | ||
$this->dispatch('customer/account/forgotPasswordPost'); | ||
|
||
$this->assertSameGreeting(self::EXPECTED_GREETING, $this->transportBuilderMock->getSentMessage()); | ||
} | ||
|
||
/** | ||
* Covers Magento_Customer::view/frontend/email/change_email.html | ||
* | ||
* @magentoDataFixture Magento/Customer/_files/customer.php | ||
* @magentoConfigFixture current_store customer/captcha/enable 0 | ||
*/ | ||
public function testCustomerEmailChangeNotificationTemplateGreeting() | ||
{ | ||
$this->loginByCustomerId(self::FIXTURE_CUSTOMER_ID); | ||
|
||
$this->sendAccountEditRequest([ | ||
'email' => 'new.email@example.com', | ||
'change_email' => 1, | ||
]); | ||
|
||
$this->assertRedirect($this->stringContains('customer/account/')); | ||
$this->assertSessionMessages( | ||
$this->equalTo(['You saved the account information.']), | ||
MessageInterface::TYPE_SUCCESS | ||
); | ||
|
||
$this->assertSameGreeting(self::EXPECTED_GREETING, $this->transportBuilderMock->getSentMessage()); | ||
} | ||
|
||
/** | ||
* Covers Magento_Customer::view/frontend/email/change_email_and_password.html | ||
* | ||
* @magentoDataFixture Magento/Customer/_files/customer.php | ||
* @magentoConfigFixture current_store customer/captcha/enable 0 | ||
*/ | ||
public function testCustomerEmailAndPasswordChangeNotificationTemplateGreeting() | ||
{ | ||
$this->loginByCustomerId(self::FIXTURE_CUSTOMER_ID); | ||
|
||
$this->sendAccountEditRequest([ | ||
'email' => 'new.email@example.com', | ||
'change_email' => 1, | ||
'change_password' => 1, | ||
'password' => 'new-Password1', | ||
'password_confirmation' => 'new-Password1', | ||
]); | ||
|
||
$this->assertRedirect($this->stringContains('customer/account/')); | ||
$this->assertSessionMessages( | ||
$this->equalTo(['You saved the account information.']), | ||
MessageInterface::TYPE_SUCCESS | ||
); | ||
|
||
$this->assertSameGreeting(self::EXPECTED_GREETING, $this->transportBuilderMock->getSentMessage()); | ||
} | ||
|
||
/** | ||
* Covers Magento_Customer::view/frontend/email/change_password.html | ||
* | ||
* @magentoDataFixture Magento/Customer/_files/customer.php | ||
* @magentoConfigFixture current_store customer/captcha/enable 0 | ||
*/ | ||
public function testCustomerPasswordChangeNotificationTemplateGreeting() | ||
{ | ||
$this->loginByCustomerId(self::FIXTURE_CUSTOMER_ID); | ||
|
||
$this->sendAccountEditRequest([ | ||
'change_password' => 1, | ||
'password' => 'new-Password1', | ||
'password_confirmation' => 'new-Password1', | ||
]); | ||
|
||
$this->assertRedirect($this->stringContains('customer/account/')); | ||
$this->assertSessionMessages( | ||
$this->equalTo(['You saved the account information.']), | ||
MessageInterface::TYPE_SUCCESS | ||
); | ||
|
||
$this->assertSameGreeting(self::EXPECTED_GREETING, $this->transportBuilderMock->getSentMessage()); | ||
} | ||
|
||
/** | ||
* Wraps Customer Edit POST request | ||
* | ||
* @param array $customData | ||
*/ | ||
private function sendAccountEditRequest(array $customData): void | ||
{ | ||
$basicData = [ | ||
'form_key' => $this->formKey->getFormKey(), | ||
'firstname' => self::FIXTURE_CUSTOMER_FIRSTNAME, | ||
'lastname' => self::FIXTURE_CUSTOMER_LASTNAME, | ||
'current_password' => self::FIXTURE_CUSTOMER_PASSWORD | ||
]; | ||
|
||
$this->getRequest()->setMethod(HttpRequest::METHOD_POST) | ||
->setPostValue(array_merge($basicData, $customData)); | ||
|
||
$this->dispatch('customer/account/editPost'); | ||
} | ||
|
||
/** | ||
* Verifies if `<p class="greeting"/>` text contents equals the expected one. | ||
* | ||
* @param string $expectedGreeting | ||
* @param EmailMessage $message | ||
*/ | ||
private function assertSameGreeting(string $expectedGreeting, EmailMessage $message) | ||
{ | ||
$messageContent = $this->getMessageRawContent($message); | ||
$emailDom = new \DOMDocument(); | ||
$emailDom->loadHTML($messageContent); | ||
|
||
$emailXpath = new \DOMXPath($emailDom); | ||
$greeting = $emailXpath->query('//p[@class="greeting"]'); | ||
|
||
$this->assertSame(1, $greeting->length); | ||
$this->assertSame($expectedGreeting, $greeting->item(0)->textContent); | ||
} | ||
|
||
/** | ||
* Returns raw content of provided message | ||
* | ||
* @param EmailMessage $message | ||
* @return string | ||
*/ | ||
private function getMessageRawContent(EmailMessage $message): string | ||
{ | ||
$emailParts = $message->getBody()->getParts(); | ||
return current($emailParts)->getRawContent(); | ||
} | ||
|
||
/** | ||
* Performs Customer log in | ||
* | ||
* @param int $customerId | ||
*/ | ||
private function loginByCustomerId(int $customerId): void | ||
{ | ||
$this->session->loginById($customerId); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can introduce new "assert class" and put in
https://github.com/magento/magento2/tree/2.4-develop/dev/tests/integration/framework/Magento/TestFramework
Assert
namespace.We achieve 2 goals:
Thanks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to create separate ticket for that point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please link this and a new ticket.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#27607