This commit is contained in:
2026-09-15 10:26:34 +08:00
commit ecf36afa56
10493 changed files with 1404888 additions and 0 deletions
@@ -0,0 +1,300 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model\Plugin;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\Mail\Template\TransportBuilderMock;
/**
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* phpcs:disable Magento2.Security.Superglobal
* @magentoAppIsolation enabled
*/
class PluginTest extends \PHPUnit\Framework\TestCase
{
/**
* Customer Account Service
*
* @var \Magento\Customer\Api\AccountManagementInterface
*/
protected $accountManagement;
/**
* @var \Magento\Customer\Api\CustomerRepositoryInterface
*/
protected $customerRepository;
/**
* @var TransportBuilderMock
*/
protected $transportBuilderMock;
protected function setUp(): void
{
$this->accountManagement = Bootstrap::getObjectManager()->get(
\Magento\Customer\Api\AccountManagementInterface::class
);
$this->customerRepository = Bootstrap::getObjectManager()->get(
\Magento\Customer\Api\CustomerRepositoryInterface::class
);
$this->transportBuilderMock = Bootstrap::getObjectManager()->get(
TransportBuilderMock::class
);
}
protected function tearDown(): void
{
/** @var \Magento\Customer\Model\CustomerRegistry $customerRegistry */
$customerRegistry = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
->get(\Magento\Customer\Model\CustomerRegistry::class);
//Cleanup customer from registry
$customerRegistry->remove(1);
}
/**
* @magentoAppArea adminhtml
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testCustomerCreated()
{
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail('customer_two@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->assertEquals(0, (int)$subscriber->getCustomerId());
/** @var \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory */
$customerFactory = $objectManager->get(\Magento\Customer\Api\Data\CustomerInterfaceFactory::class);
$customerDataObject = $customerFactory->create()
->setFirstname('Firstname')
->setLastname('Lastname')
->setEmail('customer_two@example.com');
$createdCustomer = $this->customerRepository->save(
$customerDataObject,
$this->accountManagement->getPasswordHash('password')
);
$subscriber->loadByEmail('customer_two@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->assertEquals((int)$createdCustomer->getId(), (int)$subscriber->getCustomerId());
}
/**
* @magentoAppArea adminhtml
* @magentoDbIsolation enabled
*/
public function testCustomerCreatedNotSubscribed()
{
$this->verifySubscriptionNotExist('customer@example.com');
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory */
$customerFactory = $objectManager->get(\Magento\Customer\Api\Data\CustomerInterfaceFactory::class);
$customerDataObject = $customerFactory->create()
->setFirstname('Firstname')
->setLastname('Lastname')
->setEmail('customer@example.com');
$this->accountManagement->createAccount($customerDataObject);
$this->verifySubscriptionNotExist('customer@example.com');
}
/**
* @magentoAppArea adminhtml
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testCustomerUpdatedEmail()
{
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail('customer@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->assertEquals(1, (int)$subscriber->getCustomerId());
$customer = $this->customerRepository->getById(1);
$customer->setEmail('new@example.com');
$this->customerRepository->save($customer);
$subscriber->loadByEmail('new@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->assertEquals(1, (int)$subscriber->getCustomerId());
}
/**
* @magentoAppArea adminhtml
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testCustomerDeletedByIdAdminArea()
{
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail('customer@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->customerRepository->deleteById(1);
$this->verifySubscriptionNotExist('customer@example.com');
}
/**
* @magentoAppArea adminhtml
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testCustomerDeletedAdminArea()
{
$customer = $this->customerRepository->getById(1);
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail('customer@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->customerRepository->delete($customer);
$this->verifySubscriptionNotExist('customer@example.com');
}
/**
* Verify a subscription doesn't exist for a given email address
*
* @param string $email
* @return \Magento\Newsletter\Model\Subscriber
*/
private function verifySubscriptionNotExist($email)
{
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail($email);
$this->assertFalse($subscriber->isSubscribed());
$this->assertEquals(0, (int)$subscriber->getId());
return $subscriber;
}
/**
* @magentoAppArea adminhtml
* @magentoDbIsolation enabled
*/
public function testCustomerWithZeroStoreIdIsSubscribed()
{
$objectManager = Bootstrap::getObjectManager();
$currentStore = $objectManager->get(
\Magento\Store\Model\StoreManagerInterface::class
)->getStore()->getId();
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber->setStoreId($currentStore)
->setCustomerId(0)
->setSubscriberEmail('customer@example.com')
->setSubscriberStatus(\Magento\Newsletter\Model\Subscriber::STATUS_SUBSCRIBED)
->save();
/** @var \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory */
$customerFactory = $objectManager->get(\Magento\Customer\Api\Data\CustomerInterfaceFactory::class);
$customerDataObject = $customerFactory->create()
->setFirstname('Firstname')
->setLastname('Lastname')
->setStoreId(0)
->setEmail('customer@example.com');
/** @var \Magento\Customer\Api\Data\CustomerInterface $customer */
$customer = $this->accountManagement->createAccount($customerDataObject);
$this->customerRepository->save($customer);
$subscriber->loadByEmail('customer@example.com');
$this->assertEquals($customer->getId(), (int)$subscriber->getCustomerId());
$this->assertEquals($currentStore, (int)$subscriber->getStoreId());
}
/**
* Test get list customer, which have more then 2 subscribes in newsletter_subscriber.
*
* @magentoAppArea frontend
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testCustomerWithTwoNewsLetterSubscriptions()
{
/** @var \Magento\Framework\Api\SearchCriteriaBuilder $searchBuilder */
$searchBuilder = Bootstrap::getObjectManager()->create(\Magento\Framework\Api\SearchCriteriaBuilder::class);
$searchCriteria = $searchBuilder->addFilter('entity_id', 1)->create();
$items = $this->customerRepository->getList($searchCriteria)->getItems();
/** @var \Magento\Customer\Api\Data\CustomerInterface $customer */
$customer = $items[0];
$extensionAttributes = $customer->getExtensionAttributes();
$this->assertTrue($extensionAttributes->getIsSubscribed());
}
/**
* @magentoAppArea adminhtml
* @magentoDbIsolation enabled
* @magentoConfigFixture current_store newsletter/general/active 1
* @magentoDataFixture Magento/Customer/_files/customer_welcome_email_template.php
*
* @return void
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function testCreateAccountWithNewsLetterSubscription(): void
{
$objectManager = Bootstrap::getObjectManager();
/** @var \Magento\Customer\Api\Data\CustomerInterfaceFactory $customerFactory */
$customerFactory = $objectManager->get(\Magento\Customer\Api\Data\CustomerInterfaceFactory::class);
$customerDataObject = $customerFactory->create()
->setFirstname('John')
->setLastname('Doe')
->setEmail('customer@example.com');
$extensionAttributes = $customerDataObject->getExtensionAttributes();
$extensionAttributes->setIsSubscribed(true);
$customerDataObject->setExtensionAttributes($extensionAttributes);
$this->accountManagement->createAccount($customerDataObject, '123123qW');
$message = $this->transportBuilderMock->getSentMessage();
$this->assertNotNull($message);
$this->assertEquals('Welcome to Main Website Store', $message->getSubject());
$this->assertStringContainsString(
'John',
$message->getBody()->getParts()[0]->getRawContent()
);
$this->assertStringContainsString(
'customer@example.com',
$message->getBody()->getParts()[0]->getRawContent()
);
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = $objectManager->create(\Magento\Newsletter\Model\Subscriber::class);
$subscriber->loadByEmail('customer@example.com');
$this->assertTrue($subscriber->isSubscribed());
$this->transportBuilderMock->setTemplateIdentifier(
'newsletter_subscription_confirm_email_template'
)->setTemplateVars([
'subscriber_data' => [
'confirmation_link' => $subscriber->getConfirmationLink(),
],
])->setTemplateOptions([
'area' => \Magento\Framework\App\Area::AREA_FRONTEND,
'store' => \Magento\Store\Model\Store::DEFAULT_STORE_ID
])
->addTo('customer@example.com')
->getTransport();
$message = $this->transportBuilderMock->getSentMessage();
$this->assertNotNull($message);
$this->assertStringContainsString(
$subscriber->getConfirmationLink(),
$message->getBody()->getParts()[0]->getRawContent()
);
$this->assertEquals('Newsletter subscription confirmation', $message->getSubject());
}
}
@@ -0,0 +1,105 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model;
use Magento\Store\Model\ScopeInterface;
class QueueTest extends \PHPUnit\Framework\TestCase
{
/**
* @magentoDataFixture Magento/Newsletter/_files/queue.php
* @magentoAppIsolation enabled
*/
public function testSendPerSubscriber()
{
/** @var $objectManager \Magento\TestFramework\ObjectManager */
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
/** @var \Magento\Framework\App\Config\MutableScopeConfigInterface $mutableConfig */
$mutableConfig = $objectManager->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class);
$mutableConfig->setValue('general/locale/code', 'de_DE', ScopeInterface::SCOPE_STORE, 'fixturestore');
$objectManager->get(
\Magento\Framework\App\State::class
)->setAreaCode(\Magento\Framework\App\Area::AREA_FRONTEND);
$area = $objectManager->get(\Magento\Framework\App\AreaList::class)
->getArea(\Magento\Framework\App\Area::AREA_FRONTEND);
$area->load();
/** @var $filter \Magento\Newsletter\Model\Template\Filter */
$filter = $objectManager->get(\Magento\Newsletter\Model\Template\Filter::class);
$transport = $this->getMockBuilder(\Magento\Framework\Mail\TransportInterface::class)
->setMethods(['sendMessage'])
->getMockForAbstractClass();
$transport->expects($this->exactly(2))->method('sendMessage')->willReturnSelf();
$builder = $this->createPartialMock(
\Magento\Newsletter\Model\Queue\TransportBuilder::class,
['getTransport', 'setFrom', 'addTo']
);
$builder->expects($this->exactly(2))->method('getTransport')->willReturn($transport);
$builder->expects($this->exactly(2))->method('setFrom')->willReturnSelf();
$builder->expects($this->exactly(2))->method('addTo')->willReturnSelf();
/** @var $queue \Magento\Newsletter\Model\Queue */
$queue = $objectManager->create(
\Magento\Newsletter\Model\Queue::class,
['filter' => $filter, 'transportBuilder' => $builder]
);
$queue->load('Subject', 'newsletter_subject');
// fixture
$queue->sendPerSubscriber();
}
/**
* @magentoDataFixture Magento/Newsletter/_files/queue.php
* @magentoAppIsolation enabled
*/
public function testSendPerSubscriberProblem()
{
// md5 used here only for random string generation for test purposes. No cryptographic use.
// phpcs:ignore Magento2.Security.InsecureFunction
$errorMsg = md5(microtime());
\Magento\TestFramework\Helper\Bootstrap::getInstance()
->loadArea(\Magento\Framework\App\Area::AREA_FRONTEND);
$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$transport = $this->getMockBuilder(\Magento\Framework\Mail\TransportInterface::class)
->setMethods(['sendMessage'])
->getMockForAbstractClass();
$transport->expects($this->any())
->method('sendMessage')
->willThrowException(new \Magento\Framework\Exception\MailException(__($errorMsg)));
$builder = $this->createPartialMock(
\Magento\Newsletter\Model\Queue\TransportBuilder::class,
['getTransport', 'setFrom', 'addTo', 'setTemplateOptions', 'setTemplateVars']
);
$builder->expects($this->any())->method('getTransport')->willReturn($transport);
$builder->expects($this->any())->method('setTemplateOptions')->willReturnSelf();
$builder->expects($this->any())->method('setTemplateVars')->willReturnSelf();
$builder->expects($this->any())->method('setFrom')->willReturnSelf();
$builder->expects($this->any())->method('addTo')->willReturnSelf();
/** @var $queue \Magento\Newsletter\Model\Queue */
$queue = $objectManager->create(\Magento\Newsletter\Model\Queue::class, ['transportBuilder' => $builder]);
$queue->load('Subject', 'newsletter_subject');
// fixture
$problem = $objectManager->create(\Magento\Newsletter\Model\Problem::class);
$problem->load($queue->getId(), 'queue_id');
$this->assertEmpty($problem->getId());
$queue->sendPerSubscriber();
$problem->load($queue->getId(), 'queue_id');
$this->assertNotEmpty($problem->getId());
$this->assertEquals($errorMsg, $problem->getProblemErrorText());
}
}
@@ -0,0 +1,50 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model\ResourceModel\Problem;
use Magento\TestFramework\Helper\Bootstrap;
class CollectionTest extends \PHPUnit\Framework\TestCase
{
/**
* @var \Magento\Newsletter\Model\ResourceModel\Problem\Collection
*/
protected $_collection;
protected function setUp(): void
{
$this->_collection = Bootstrap::getObjectManager()
->create(\Magento\Newsletter\Model\ResourceModel\Problem\Collection::class);
}
/**
* @magentoDataFixture Magento/Newsletter/_files/problems.php
*/
public function testAddCustomersData()
{
/** @var \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository */
$customerRepository = Bootstrap::getObjectManager()
->create(\Magento\Customer\Api\CustomerRepositoryInterface::class);
$customer = $customerRepository->getById(1);
/** @var \Magento\Newsletter\Model\Subscriber $subscriber */
$subscriber = Bootstrap::getObjectManager()
->create(\Magento\Newsletter\Model\Subscriber::class)->loadByEmail($customer->getEmail());
/** @var \Magento\Newsletter\Model\Problem $problem */
$problem = Bootstrap::getObjectManager()
->create(\Magento\Newsletter\Model\Problem::class)->addSubscriberData($subscriber);
$item = $this->_collection->addSubscriberInfo()->load()->getFirstItem();
$this->assertEquals($problem->getProblemErrorCode(), $item->getErrorCode());
$this->assertEquals($problem->getProblemErrorText(), $item->getErrorText());
$this->assertEquals($problem->getSubscriberId(), $item->getSubscriberId());
$this->assertEquals($customer->getEmail(), $item->getSubscriberEmail());
$this->assertEquals($customer->getFirstname(), $item->getCustomerFirstName());
$this->assertEquals($customer->getLastname(), $item->getCustomerLastName());
$this->assertStringContainsString($customer->getFirstname(), $item->getCustomerName());
}
}
@@ -0,0 +1,42 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Newsletter\Model\ResourceModel\Queue;
use Magento\Newsletter\Model\Subscriber;
use Magento\TestFramework\Helper\Bootstrap;
use PHPUnit\Framework\TestCase;
/**
* Customer filter fields Collection test class
*/
class CollectionTest extends TestCase
{
/**
* @magentoDataFixture Magento/Customer/_files/customer_sample.php
* @magentoDataFixture Magento/Newsletter/_files/newsletter_sample.php
* @magentoDataFixture Magento/Newsletter/_files/queue.php
*/
public function testLoadWithCustomerFilter()
{
$objectManager = Bootstrap::getObjectManager();
/** @var CollectionFactory $collectionFactory */
$collectionFactory = $objectManager->get(CollectionFactory::class);
$collection = $collectionFactory->create()->addCustomerFilter(1);
$item = $collection->getFirstItem();
/** @var Subscriber $subscriber */
$subscriber = $objectManager->get(Subscriber::class);
$subscriber->loadByCustomer(1, 1);
self::assertEquals(
$subscriber->getId(),
$item->getSubscriberId(),
'Wrong subscriber id loaded in collection.'
);
}
}
@@ -0,0 +1,44 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model\ResourceModel\Subscriber;
class CollectionTest extends \PHPUnit\Framework\TestCase
{
/**
* @var \Magento\Newsletter\Model\ResourceModel\Subscriber\Collection
*/
protected $_collectionModel;
protected function setUp(): void
{
$this->_collectionModel = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
->create(\Magento\Newsletter\Model\ResourceModel\Subscriber\Collection::class);
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testShowCustomerInfo()
{
$this->_collectionModel->showCustomerInfo()->load();
/** @var \Magento\Newsletter\Model\Subscriber[] $subscribers */
$subscribers = $this->_collectionModel->getItems();
$this->assertCount(3, $subscribers);
while ($subscribers) {
$subscriber = array_shift($subscribers);
if ($subscriber->getCustomerId()) {
$this->assertEquals('John', $subscriber->getFirstname(), $subscriber->getSubscriberEmail());
$this->assertEquals('Smith', $subscriber->getLastname(), $subscriber->getSubscriberEmail());
} else {
$this->assertNull($subscriber->getFirstname(), $subscriber->getSubscriberEmail());
$this->assertNull($subscriber->getLastname(), $subscriber->getSubscriberEmail());
}
}
}
}
@@ -0,0 +1,54 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model\ResourceModel;
use Magento\TestFramework\Helper\Bootstrap;
class SubscriberTest extends \PHPUnit\Framework\TestCase
{
/**
* @var \Magento\Newsletter\Model\ResourceModel\Subscriber
*/
protected $_resourceModel;
protected function setUp(): void
{
$this->_resourceModel = Bootstrap::getObjectManager()
->create(\Magento\Newsletter\Model\ResourceModel\Subscriber::class);
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*/
public function testLoadByCustomerDataWithCustomerId()
{
/** @var \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository */
$customerRepository = Bootstrap::getObjectManager()
->create(\Magento\Customer\Api\CustomerRepositoryInterface::class);
$customerData = $customerRepository->getById(1);
$result = $this->_resourceModel->loadByCustomerData($customerData);
$this->assertEquals(1, $result['customer_id']);
$this->assertEquals('customer@example.com', $result['subscriber_email']);
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
* @magentoDataFixture Magento/Customer/_files/two_customers.php
*/
public function testLoadByCustomerDataWithoutCustomerId()
{
/** @var \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository */
$customerRepository = Bootstrap::getObjectManager()
->create(\Magento\Customer\Api\CustomerRepositoryInterface::class);
$customerData = $customerRepository->getById(2);
$result = $this->_resourceModel->loadByCustomerData($customerData);
$this->assertEquals(0, $result['customer_id']);
$this->assertEquals('customer_two@example.com', $result['subscriber_email']);
}
}
@@ -0,0 +1,288 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Newsletter\Model;
use Magento\Customer\Api\CustomerRepositoryInterface;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Exception\NoSuchEntityException;
use Magento\Framework\Mail\EmailMessage;
use Magento\Newsletter\Model\ResourceModel\Subscriber\CollectionFactory;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\Mail\Template\TransportBuilderMock;
use PHPUnit\Framework\TestCase;
/**
* Class checks subscription behavior.
*
* @see \Magento\Newsletter\Model\Subscriber
*/
class SubscriberTest extends TestCase
{
private const CONFIRMATION_SUBSCRIBE = 'You have been successfully subscribed to our newsletter.';
private const CONFIRMATION_UNSUBSCRIBE = 'You have been unsubscribed from the newsletter.';
/**
* @var SubscriberFactory
*/
private $subscriberFactory;
/**
* @var TransportBuilderMock
*/
private $transportBuilder;
/**
* @var CustomerRepositoryInterface
*/
private $customerRepository;
/**
* @var QueueFactory
*/
private $queueFactory;
/**
* @var CollectionFactory
*/
private $subscriberCollectionFactory;
/**
* @inheritdoc
*/
protected function setUp(): void
{
$objectManager = Bootstrap::getObjectManager();
$this->subscriberFactory = $objectManager->get(SubscriberFactory::class);
$this->transportBuilder = $objectManager->get(TransportBuilderMock::class);
$this->customerRepository = $objectManager->get(CustomerRepositoryInterface::class);
$this->queueFactory = $objectManager->get(QueueFactory::class);
$this->subscriberCollectionFactory = $objectManager->get(CollectionFactory::class);
}
/**
* @magentoConfigFixture current_store newsletter/subscription/confirm 1
*
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*
* @return void
*/
public function testEmailConfirmation(): void
{
$subscriber = $this->subscriberFactory->create();
$subscriber->subscribe('customer_confirm@example.com');
// confirmationCode 'ysayquyajua23iq29gxwu2eax2qb6gvy' is taken from fixture
$this->assertStringContainsString(
'/newsletter/subscriber/confirm/id/' . $subscriber->getSubscriberId()
. '/code/ysayquyajua23iq29gxwu2eax2qb6gvy',
$this->transportBuilder->getSentMessage()->getBody()->getParts()[0]->getRawContent()
);
$this->assertEquals(Subscriber::STATUS_NOT_ACTIVE, $subscriber->getSubscriberStatus());
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*
* @return void
*/
public function testLoadByCustomerId(): void
{
$subscriber = $this->subscriberFactory->create();
$this->assertSame($subscriber, $subscriber->loadByCustomerId(1));
$this->assertEquals('customer@example.com', $subscriber->getSubscriberEmail());
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*
* @magentoAppArea frontend
*
* @return void
*/
public function testUnsubscribeSubscribe(): void
{
$subscriber = $this->subscriberFactory->create();
$this->assertSame($subscriber, $subscriber->loadByCustomerId(1));
$this->assertEquals($subscriber, $subscriber->unsubscribe());
$this->assertConfirmationParagraphExists(
self::CONFIRMATION_UNSUBSCRIBE,
$this->transportBuilder->getSentMessage()
);
$this->assertEquals(Subscriber::STATUS_UNSUBSCRIBED, $subscriber->getSubscriberStatus());
// Subscribe and verify
$this->assertEquals(Subscriber::STATUS_SUBSCRIBED, $subscriber->subscribe('customer@example.com'));
$this->assertEquals(Subscriber::STATUS_SUBSCRIBED, $subscriber->getSubscriberStatus());
$this->assertConfirmationParagraphExists(
self::CONFIRMATION_SUBSCRIBE,
$this->transportBuilder->getSentMessage()
);
}
/**
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*
* @magentoAppArea frontend
*
* @return void
*/
public function testUnsubscribeSubscribeByCustomerId(): void
{
$subscriber = $this->subscriberFactory->create();
// Unsubscribe and verify
$this->assertSame($subscriber, $subscriber->unsubscribeCustomerById(1));
$this->assertEquals(Subscriber::STATUS_UNSUBSCRIBED, $subscriber->getSubscriberStatus());
$this->assertConfirmationParagraphExists(
self::CONFIRMATION_UNSUBSCRIBE,
$this->transportBuilder->getSentMessage()
);
// Subscribe and verify
$this->assertSame($subscriber, $subscriber->subscribeCustomerById(1));
$this->assertEquals(Subscriber::STATUS_SUBSCRIBED, $subscriber->getSubscriberStatus());
$this->assertConfirmationParagraphExists(
self::CONFIRMATION_SUBSCRIBE,
$this->transportBuilder->getSentMessage()
);
}
/**
* Test subscribe and verify customer subscription status
*
* @magentoDataFixture Magento/Customer/_files/customer_sample.php
*
* @return void
*/
public function testSubscribeAndVerifyCustomerSubscriptionStatus(): void
{
$customer = $this->customerRepository->getById(1);
$subscriptionBefore = $customer->getExtensionAttributes()
->getIsSubscribed();
$subscriber = $this->subscriberFactory->create();
$subscriber->subscribeCustomerById($customer->getId());
$customer = $this->customerRepository->getById(1);
$this->assertFalse($subscriptionBefore);
$this->assertTrue($customer->getExtensionAttributes()->getIsSubscribed());
}
/**
* @magentoConfigFixture current_store newsletter/subscription/confirm 1
*
* @magentoDataFixture Magento/Newsletter/_files/subscribers.php
*
* @return void
*/
public function testConfirm(): void
{
$subscriber = $this->subscriberFactory->create();
$customerEmail = 'customer_confirm@example.com';
$subscriber->subscribe($customerEmail);
$subscriber->loadByEmail($customerEmail);
$subscriber->confirm($subscriber->getSubscriberConfirmCode());
$this->assertConfirmationParagraphExists(
self::CONFIRMATION_SUBSCRIBE,
$this->transportBuilder->getSentMessage()
);
}
/**
* Unsubscribe and check queue
*
* @magentoDataFixture Magento/Newsletter/_files/queue.php
*
* @return void
*/
public function testUnsubscribeCustomer(): void
{
$firstSubscriber = $this->subscriberFactory->create()
->load('customer@example.com', 'subscriber_email');
$secondSubscriber = $this->subscriberFactory->create()
->load('customer_two@example.com', 'subscriber_email');
$queue = $this->queueFactory->create()
->load('CustomerSupport', 'newsletter_sender_name');
$queue->addSubscribersToQueue([$firstSubscriber->getId(), $secondSubscriber->getId()]);
$secondSubscriber->unsubscribe();
$collection = $this->subscriberCollectionFactory->create()
->useQueue($queue);
$this->assertCount(1, $collection);
$this->assertEquals(
'customer@example.com',
$collection->getFirstItem()->getData('subscriber_email')
);
}
/**
* @magentoDataFixture Magento/Customer/_files/customer_confirmation_config_enable.php
* @magentoDataFixture Magento/Newsletter/_files/newsletter_unconfirmed_customer.php
*
* @return void
* @throws LocalizedException
* @throws NoSuchEntityException
*/
public function testSubscribeUnconfirmedCustomerWithSubscription(): void
{
$customer = $this->customerRepository->get('unconfirmedcustomer@example.com');
$subscriber = $this->subscriberFactory->create();
$subscriber->subscribeCustomerById($customer->getId());
$this->assertEquals(Subscriber::STATUS_SUBSCRIBED, $subscriber->getStatus());
}
/**
* @magentoDataFixture Magento/Customer/_files/customer_confirmation_config_enable.php
* @magentoDataFixture Magento/Customer/_files/unconfirmed_customer.php
*
* @return void
* @throws LocalizedException
* @throws NoSuchEntityException
*/
public function testSubscribeUnconfirmedCustomerWithoutSubscription(): void
{
$customer = $this->customerRepository->get('unconfirmedcustomer@example.com');
$subscriber = $this->subscriberFactory->create();
$subscriber->subscribeCustomerById($customer->getId());
$this->assertEquals(Subscriber::STATUS_UNCONFIRMED, $subscriber->getStatus());
}
/**
* Verifies if Paragraph with specified message is in e-mail
*
* @param string $expectedMessage
* @param EmailMessage $message
*/
private function assertConfirmationParagraphExists(string $expectedMessage, EmailMessage $message): void
{
$messageContent = $this->getMessageRawContent($message);
$emailDom = new \DOMDocument();
$emailDom->loadHTML($messageContent);
$emailXpath = new \DOMXPath($emailDom);
$greeting = $emailXpath->query("//p[contains(text(), '$expectedMessage')]");
$this->assertSame(1, $greeting->length, "Cannot find the confirmation paragraph in e-mail contents");
}
/**
* 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();
}
}
@@ -0,0 +1,216 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Newsletter\Model;
use Magento\Framework\App\TemplateTypesInterface;
use Magento\Framework\View\DesignInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\TestFramework\Helper\Bootstrap;
/**
* @magentoDataFixture Magento/Store/_files/core_fixturestore.php
*/
class TemplateTest extends \PHPUnit\Framework\TestCase
{
/**
* @var \Magento\Newsletter\Model\Template
*/
protected $_model = null;
protected function setUp(): void
{
$this->_model = Bootstrap::getObjectManager()->create(
\Magento\Newsletter\Model\Template::class
);
}
/**
* This test expects next themes for areas:
* current_store design/theme/full_name Magento/luma
* fixturestore_store design/theme/full_name Magento/blank
*
* @magentoAppIsolation enabled
* @magentoAppArea adminhtml
* @dataProvider getProcessedTemplateFrontendDataProvider
*/
public function testGetProcessedTemplateFrontend($store, $design)
{
$this->_model->setTemplateText('{{view url="Magento_Theme::favicon.ico"}}');
if ($store != 'default') {
Bootstrap::getObjectManager()->get(
\Magento\Framework\App\Config\MutableScopeConfigInterface::class
)->setValue(
\Magento\Theme\Model\View\Design::XML_PATH_THEME_ID,
$design,
'store',
$store
);
}
$this->_model->emulateDesign($store, 'frontend');
$processedTemplate = Bootstrap::getObjectManager()->get(
\Magento\Framework\App\State::class
)->emulateAreaCode(
'frontend',
[$this->_model, 'getProcessedTemplate']
);
$expectedTemplateText = "frontend/{$design}/en_US/Magento_Theme/favicon.ico";
$this->assertStringEndsWith($expectedTemplateText, $processedTemplate);
$this->_model->revertDesign();
}
/**
* @return array
*/
public function getProcessedTemplateFrontendDataProvider()
{
return [
'frontend' => ['default', 'Magento/luma'],
'frontend store' => ['fixturestore', 'Magento/blank']
];
}
/**
* This test expects next themes for areas:
* adminhtml/design/theme/full_name Magento/backend
*
* @magentoAppIsolation enabled
* @dataProvider getProcessedTemplateAreaDataProvider
*/
public function testGetProcessedTemplateArea($area, $design)
{
$this->_model->setTemplateText('{{view url="Magento_Theme::favicon.ico"}}');
$this->_model->emulateDesign('default', $area);
$processedTemplate = Bootstrap::getObjectManager()->get(
\Magento\Framework\App\State::class
)->emulateAreaCode(
$area,
[$this->_model, 'getProcessedTemplate']
);
$expectedTemplateText = "{$area}/{$design}/en_US/Magento_Theme/favicon.ico";
$this->assertStringEndsWith($expectedTemplateText, $processedTemplate);
}
/**
* @return array
*/
public function getProcessedTemplateAreaDataProvider()
{
$designTheme = Bootstrap::getObjectManager()
->get(DesignInterface::class)
->getConfigurationDesignTheme('adminhtml');
return [
'backend' => ['adminhtml', $designTheme]
];
}
/**
* @magentoConfigFixture current_store system/smtp/disable 0
* @magentoAppIsolation enabled
* @dataProvider isValidToSendDataProvider
*/
public function testIsValidToSend($senderEmail, $senderName, $subject, $isValid)
{
$this->_model->setTemplateSenderEmail(
$senderEmail
)->setTemplateSenderName(
$senderName
)->setTemplateSubject(
$subject
);
$this->assertSame($isValid, $this->_model->isValidForSend());
}
/**
* @return array
*/
public function isValidToSendDataProvider()
{
return [
['john.doe@example.com', 'john.doe', 'Test Subject', true],
['john.doe@example.com', 'john.doe', '', false],
['john.doe@example.com', '', 'Test Subject', false],
['john.doe@example.com', '', '', false],
['', 'john.doe', 'Test Subject', false],
['', '', 'Test Subject', false],
['', 'john.doe', '', false],
['', '', '', false]
];
}
/**
* @magentoAppIsolation enabled
* @magentoDbIsolation enabled
*/
public function testLegacyTemplateFromDbLoadsInStrictMode()
{
$objectManager = Bootstrap::getObjectManager();
$this->_model->setTemplateType(TemplateTypesInterface::TYPE_HTML);
$templateText = '{{var store.isSaveAllowed()}} - {{template config_path="foobar"}}';
$this->_model->setTemplateText($templateText);
$this->_model->setTemplateId('abc');
$template = $objectManager->create(\Magento\Email\Model\Template::class);
$templateData = [
'template_code' => 'some_unique_code',
'template_type' => TemplateTypesInterface::TYPE_HTML,
'template_text' => '{{var this.template_code}}'
. ' - {{var store.isSaveAllowed()}} - {{var this.getTemplateCode()}}',
];
$template->setData($templateData);
$template->save();
// Store the ID of the newly created template in the system config so that this template will be loaded
$objectManager->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class)
->setValue('foobar', $template->getId(), ScopeInterface::SCOPE_STORE, 'default');
$this->_model->emulateDesign('default', 'frontend');
$processedTemplate = Bootstrap::getObjectManager()->get(
\Magento\Framework\App\State::class
)->emulateAreaCode(
'frontend',
[$this->_model, 'getProcessedTemplate']
);
self::assertEquals(' - some_unique_code - - some_unique_code', $processedTemplate);
}
/**
* @magentoAppIsolation enabled
* @magentoDbIsolation enabled
*/
public function testTemplateFromDbLoadsInStrictMode()
{
$objectManager = Bootstrap::getObjectManager();
$this->_model->setTemplateType(TemplateTypesInterface::TYPE_HTML);
$templateText = '{{var store.isSaveAllowed()}} - {{template config_path="foobar"}}';
$this->_model->setTemplateText($templateText);
$this->_model->setTemplateId('abc');
$template = $objectManager->create(\Magento\Email\Model\Template::class);
$templateData = [
'template_code' => 'some_unique_code',
'template_type' => TemplateTypesInterface::TYPE_HTML,
'template_text' => '{{var this.template_code}}'
. ' - {{var store.isSaveAllowed()}} - {{var this.getTemplateCode()}}',
];
$template->setData($templateData);
$template->save();
// Store the ID of the newly created template in the system config so that this template will be loaded
$objectManager->get(\Magento\Framework\App\Config\MutableScopeConfigInterface::class)
->setValue('foobar', $template->getId(), ScopeInterface::SCOPE_STORE, 'default');
$this->_model->emulateDesign('default', 'frontend');
$processedTemplate = Bootstrap::getObjectManager()->get(
\Magento\Framework\App\State::class
)->emulateAreaCode(
'frontend',
[$this->_model, 'getProcessedTemplate']
);
self::assertEquals(' - some_unique_code - - some_unique_code', $processedTemplate);
}
}