CustomerPluginTest.php

Go to the documentation of this file.

<?php
namespace Magento\Newsletter\Test\Unit\Model\Plugin;

use Magento\Customer\Api\Data\CustomerInterface;
use Magento\Customer\Model\ResourceModel\CustomerRepository;
use Magento\Customer\Api\Data\CustomerExtensionInterface;
use Magento\Framework\Api\ExtensionAttributesFactory;
use Magento\Newsletter\Model\ResourceModel\Subscriber;

class CustomerPluginTest extends \PHPUnit\Framework\TestCase
{
    private $plugin;

    private $subscriberFactory;

    private $subscriber;

    private $objectManager;

    private $extensionFactoryMock;

    private $customerExtensionMock;

    private $subscriberResourceMock;

    private $customerMock;

    protected function setUp()
    {
        $this->subscriberFactory = $this->getMockBuilder(\Magento\Newsletter\Model\SubscriberFactory::class)
            ->disableOriginalConstructor()
            ->setMethods(['create'])
            ->getMock();
        $this->subscriber = $this->getMockBuilder(\Magento\Newsletter\Model\Subscriber::class)
            ->setMethods(
                [
                    'loadByEmail',
                    'getId',
                    'delete',
                    'updateSubscription',
                    'subscribeCustomerById',
                    'unsubscribeCustomerById',
                    'isSubscribed',
                ]
            )->disableOriginalConstructor()
            ->getMock();
        $this->extensionFactoryMock = $this->getMockBuilder(ExtensionAttributesFactory::class)
            ->disableOriginalConstructor()
            ->setMethods(['create'])
            ->getMock();
        $this->customerExtensionMock = $this->getMockBuilder(CustomerExtensionInterface::class)
            ->setMethods(['getIsSubscribed', 'setIsSubscribed'])
            ->disableOriginalConstructor()
            ->getMockForAbstractClass();
        $this->subscriberResourceMock = $this->getMockBuilder(Subscriber::class)
            ->disableOriginalConstructor()
            ->getMock();
        $this->customerMock = $this->getMockBuilder(CustomerInterface::class)
            ->setMethods(['getExtensionAttributes'])
            ->disableOriginalConstructor()
            ->getMockForAbstractClass();
        $this->subscriberFactory->expects($this->any())->method('create')->willReturn($this->subscriber);
        $this->objectManager = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);

        $this->plugin = $this->objectManager->getObject(
            \Magento\Newsletter\Model\Plugin\CustomerPlugin::class,
            [
                'subscriberFactory' => $this->subscriberFactory,
                'extensionFactory' => $this->extensionFactoryMock,
                'subscriberResource' => $this->subscriberResourceMock,
            ]
        );
    }

    public function testAfterSave($subscriptionOriginalValue, $subscriptionNewValue)
    {
        $customerId = 1;
        $result = $this->createMock(\Magento\Customer\Api\Data\CustomerInterface::class);
        $subject = $this->createMock(\Magento\Customer\Api\CustomerRepositoryInterface::class);

        $resultExtensionAttributes = $this->getMockBuilder(CustomerExtensionInterface::class)
            ->setMethods(['getIsSubscribed', 'setIsSubscribed'])
            ->getMockForAbstractClass();
        $result->expects($this->atLeastOnce())->method('getId')->willReturn($customerId);
        $result->expects($this->any())->method('getExtensionAttributes')->willReturn(null);
        $this->extensionFactoryMock->expects($this->any())
            ->method('create')
            ->willReturn($resultExtensionAttributes);
        $result->expects($this->once())
            ->method('setExtensionAttributes')
            ->with($resultExtensionAttributes)
            ->willReturnSelf();
        $this->customerMock->expects($this->once())
            ->method('getExtensionAttributes')
            ->willReturn($this->customerExtensionMock);
        $resultExtensionAttributes->expects($this->any())
            ->method('getIsSubscribed')
            ->willReturn($subscriptionOriginalValue);
        $this->customerExtensionMock->expects($this->any())
            ->method('getIsSubscribed')
            ->willReturn($subscriptionNewValue);

        if ($subscriptionOriginalValue !== $subscriptionNewValue) {
            if ($subscriptionNewValue) {
                $this->subscriber->expects($this->once())->method('subscribeCustomerById')->with($customerId);
            } else {
                $this->subscriber->expects($this->once())->method('unsubscribeCustomerById')->with($customerId);
            }
            $this->subscriber->expects($this->once())->method('isSubscribed')->willReturn($subscriptionNewValue);
            $resultExtensionAttributes->expects($this->once())->method('setIsSubscribed')->with($subscriptionNewValue);
        }

        $this->assertEquals($result, $this->plugin->afterSave($subject, $result, $this->customerMock));
    }

    public function afterSaveDataProvider()
    {
        return [
            [true, true],
            [false, false],
            [true, false],
            [false, true],
        ];
    }

    public function testAfterDelete()
    {
        $subject = $this->createMock(\Magento\Customer\Api\CustomerRepositoryInterface::class);
        $customer = $this->createMock(\Magento\Customer\Api\Data\CustomerInterface::class);
        $customer->expects($this->once())->method('getEmail')->willReturn('[email protected]');
        $this->subscriber->expects($this->once())->method('loadByEmail')->with('[email protected]')->willReturnSelf();
        $this->subscriber->expects($this->once())->method('getId')->willReturn(1);
        $this->subscriber->expects($this->once())->method('delete')->willReturnSelf();

        $this->assertEquals(true, $this->plugin->afterDelete($subject, true, $customer));
    }

    public function testAroundDeleteById()
    {
        $customerId = 1;
        $deleteCustomerById = function () {
            return true;
        };
        $subject = $this->createMock(\Magento\Customer\Api\CustomerRepositoryInterface::class);
        $customer = $this->createMock(\Magento\Customer\Api\Data\CustomerInterface::class);
        $subject->expects($this->once())->method('getById')->willReturn($customer);
        $customer->expects($this->once())->method('getEmail')->willReturn('[email protected]');
        $this->subscriber->expects($this->once())->method('loadByEmail')->with('[email protected]')->willReturnSelf();
        $this->subscriber->expects($this->once())->method('getId')->willReturn(1);
        $this->subscriber->expects($this->once())->method('delete')->willReturnSelf();

        $this->assertEquals(true, $this->plugin->aroundDeleteById($subject, $deleteCustomerById, $customerId));
    }

    public function testAfterGetByIdCreatesExtensionAttributesIfItIsNotSet(
        $subscriberStatusKey,
        $subscriberStatusValue,
        $isSubscribed
    ) {
        $subject = $this->createMock(\Magento\Customer\Api\CustomerRepositoryInterface::class);
        $subscriber = [$subscriberStatusKey => $subscriberStatusValue];

        $this->extensionFactoryMock->expects($this->any())
            ->method('create')
            ->willReturn($this->customerExtensionMock);
        $this->customerMock->expects($this->once())
            ->method('setExtensionAttributes')
            ->with($this->customerExtensionMock)
            ->willReturnSelf();
        $this->customerMock->expects($this->any())
            ->method('getId')
            ->willReturn(1);
        $this->subscriberResourceMock->expects($this->once())
            ->method('loadByCustomerData')
            ->with($this->customerMock)
            ->willReturn($subscriber);
        $this->customerExtensionMock->expects($this->once())->method('setIsSubscribed')->with($isSubscribed);

        $this->assertEquals(
            $this->customerMock,
            $this->plugin->afterGetById($subject, $this->customerMock)
        );
    }

    public function testAfterGetByIdSetsIsSubscribedFlagIfItIsNotSet()
    {
        $subject = $this->createMock(\Magento\Customer\Api\CustomerRepositoryInterface::class);
        $subscriber = ['subscriber_id' => 1, 'subscriber_status' => 1];

        $this->customerMock->expects($this->any())
            ->method('getExtensionAttributes')
            ->willReturn($this->customerExtensionMock);
        $this->customerExtensionMock->expects($this->any())
            ->method('getIsSubscribed')
            ->willReturn(null);
        $this->subscriberResourceMock->expects($this->once())
            ->method('loadByCustomerData')
            ->with($this->customerMock)
            ->willReturn($subscriber);
        $this->customerExtensionMock->expects($this->once())
            ->method('setIsSubscribed')
            ->willReturnSelf();

        $this->assertEquals(
            $this->customerMock,
            $this->plugin->afterGetById($subject, $this->customerMock)
        );
    }

    public function afterGetByIdDataProvider()
    {
        return [
            ['subscriber_status', 1, true],
            ['subscriber_status', 2, false],
            ['subscriber_status', 3, false],
            ['subscriber_status', 4, false],
            [null, null, false],
        ];
    }
}