Fixes unstable email integration tests

[hostep]

Description (*)

This is re-adding the fixes added in #25296

Following changes made the email integration tests unstable again:

• MC-31752 reverted some changes done by Fixes unstable email integration tests, by decoding the raw contents … #25296 for no good reason
• MC-19918 reverted some changes done by Fixes unstable email integration tests, by decoding the raw contents … #25296 for no good reason

Related Pull Requests

Should fix integration tests which now fail in #27888

Fixed Issues (if relevant)

• None

Manual testing scenarios (*)

See #25296

Questions or comments

Can we do something to avoid Magento core devs for re-introducing this incorrect way of testing email content?

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @hostep. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.4-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[lbajsarowicz]

I've addressed that in: #27606

magento2/dev/tests/integration/testsuite/Magento/Customer/Controller/Account/EmailTemplateTest.php

Lines 170 to 181 in d4b8083

	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);
	}

Using DOM structure instead of assertContains (which is deprecated, btw).

There's also ticket to introduce DOM assertions:
#27607

[hostep]

Aha, thanks for the info @lbajsarowicz!

Let me try to update this PR to use the same DOM assertions then.
That will then also settle ticket #27607 I assume?

[hostep]

@lbajsarowicz: updated PR (rebased on latest 2.4-develop branch, amended commit and force pushed)

Before we fix all the occurrences (I count about 16 more classes using the getRawContent method), here are a couple of questions first:

• Can you explain the deprecation of the assertContains method a bit, I can't seem to find information about that, what should it be replaced with?
• I've written a generic assertEmailContains method, which can probably be re-used in all classes. Is that one ok? Where can we put this method so we don't need to copy it in all the test files?

Thanks!

[lbajsarowicz]

@hostep assertContains won't work with string anymore

https://phpunit.readthedocs.io/en/9.0/assertions.html

It's replacement is assertStringContainsString

[hostep]

I came by that article indeed, and tested assertStringContainsString, but assertStringContainsString doesn't exists yet in PHPUnit 6.5 which Magento is using ...
I've seen you working on PHPUnit 8 compatibility, but that's not finished yet I think?

[lbajsarowicz]

Could you change this to assertStringContainsString? We will add your change once the PHPUnit 8 is finally introduced (team of people are working on this right now)

[hostep]

Hmm, I'd rather solve this as fast as possible, because the unstable email integration tests cause failures in this very good PR: #27888

If you want me to revert back to my old changes or keep this half-finished work and merge that first. And later handle a better way of handling it, that's also fine by me.

[lbajsarowicz]

Yeah, so choose the MVP, and later on we'll do it the right way : )

[hostep]

Ok, I've reverted to my initial changes.

I've pushed my other changes to a different branch, just in case if somebody wants to get some inspiration from them: hostep/magento2@c163118...first-part-to-fix-issue-27607 when trying to fix #27607

[magento-engcom-team]

Hi @ihor-sviziev, thank you for the review.
ENGCOM-7467 has been created to process this Pull Request

[engcom-Alfa]

✔️ QA Passed

[m2-assistant]

Hi @hostep, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.