ExportContactCommandTest::testExecuteContactExportDisabled() - Code Metrics - Inspection of "add the ability to partially enable/disable export" - commerceleague/magento2-module-activecampaign - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( c92bdf...416677 )

by Andreas
created 2019-07-15 14:32 UTC
testExecuteContactExportDisabled() A

↳ Parent: ExportContactCommandTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	14
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	9
nc	1
nop	0
dl	0
loc	14
rs	9.9666
c	0
b	0
f	0
<?php
declare(strict_types=1);
/**
 */

namespace Test\Unit\Console\Command;

use CommerceLeague\ActiveCampaign\Console\Command\ExportContactCommand;
use CommerceLeague\ActiveCampaign\Helper\Config as ConfigHelper;
use CommerceLeague\ActiveCampaign\MessageQueue\Topics;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Customer\Collection as CustomerCollection;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Customer\CollectionFactory as CustomerCollectionFactory;
filter:
    dependency_paths: ["lib/*"]
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Subscriber\Collection as SubscriberCollection;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Subscriber\CollectionFactory as SubscriberCollectionFactory;
filter:
    dependency_paths: ["lib/*"]
use CommerceLeague\ActiveCampaign\Test\Unit\Console\Command\TestOutput;
use Magento\Framework\Console\Cli;
use Magento\Framework\MessageQueue\PublisherInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Exception\RuntimeException;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Helper\ProgressBarFactory;
filter:
    dependency_paths: ["lib/*"]
use Symfony\Component\Console\Tester\CommandTester;

class ExportContactCommandTest extends TestCase
{
    /**
     * @var MockObject|ConfigHelper
     */
    protected $configHelper;

    /**
     * @var MockObject|CustomerCollectionFactory
     */
    protected $customerCollectionFactory;

    /**
     * @var MockObject|CustomerCollection
     */
    protected $customerCollection;

    /**
     * @var MockObject|SubscriberCollectionFactory
     */
    protected $subscriberCollectionFactory;

    /**
     * @var MockObject|SubscriberCollection
     */
    protected $subscriberCollection;

    /**
     * @var MockObject|ProgressBarFactory
     */
    protected $progressBarFactory;

    /**
     * @var MockObject|PublisherInterface
     */
    protected $publisher;

    /**
     * @var ExportContactCommand
     */
    protected $exportContactCommand;

    /**
     * @var CommandTester
     */
    protected $exportContactCommandTester;

    protected function setUp()
    {
        $this->configHelper = $this->createMock(ConfigHelper::class);

        $this->customerCollectionFactory = $this->getMockBuilder(CustomerCollectionFactory::class)
            ->disableOriginalConstructor()
            ->setMethods(['create'])
            ->getMock();

        $this->customerCollection = $this->createMock(CustomerCollection::class);

        $this->customerCollectionFactory->expects($this->any())
            ->method('create')
            ->willReturn($this->customerCollection);

        $this->subscriberCollectionFactory = $this->getMockBuilder(SubscriberCollectionFactory::class)
            ->disableOriginalConstructor()
            ->setMethods(['create'])
            ->getMock();

        $this->subscriberCollection = $this->createMock(SubscriberCollection::class);

        $this->subscriberCollectionFactory->expects($this->any())
            ->method('create')
            ->willReturn($this->subscriberCollection);

        $this->progressBarFactory = $this->getMockBuilder(ProgressBarFactory::class)
            ->disableOriginalConstructor()
            ->setMethods(['create'])
            ->getMock();

        $this->publisher = $this->createMock(PublisherInterface::class);

        $this->exportContactCommand = new ExportContactCommand(
            $this->configHelper,
            $this->customerCollectionFactory,
            $this->subscriberCollectionFactory,
            $this->progressBarFactory,
            $this->publisher
        );

        $this->exportContactCommandTester = new CommandTester($this->exportContactCommand);
    }

    public function testExecuteDisabled()
    {
        $this->configHelper->expects($this->once())
                             expects($this->once())
            ->method('isEnabled')
            ->willReturn(false);

        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('Export disabled by system configuration');

        $this->exportContactCommandTester->execute([]);
    }

    public function testExecuteContactExportDisabled()
    {
        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(false);

        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('Export disabled by system configuration');

        $this->exportContactCommandTester->execute([]);
    }

    public function testExecuteWithoutOptions()
    {
        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('Please provide at least one option');

        $this->exportContactCommandTester->execute([]);
    }

    public function testExecuteWithEmailAndOtherOptions()
    {
        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('You cannot use --email together with another option');

        $this->exportContactCommandTester->execute(
            ['--email' => '[email protected]', '--omitted' => true, '--all' => true]
        );
    }

    public function testExecuteWithAllAndOmittedOption()
    {
        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->expectException(RuntimeException::class);
        $this->expectExceptionMessage('You cannot use --omitted and --all together');

        $this->exportContactCommandTester->execute(
            ['--omitted' => true, '--all' => true]
        );
    }

    public function testExecuteWithoutCustomerIdsAndSubscriberEmails()
    {
        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->customerCollection->expects($this->once())
                                   expects($this->once())
            ->method('getAllIds')
            ->willReturn([]);

        $this->subscriberCollection->expects($this->once())
                                     expects($this->once())
            ->method('getAllEmails')
            ->willReturn([]);

        $this->exportContactCommandTester->execute(
            ['--all' => true]
        );

        $this->assertContains(
            'No contact(s) found matching your criteria',
            $this->exportContactCommandTester->getDisplay()
        );

        $this->assertEquals(
            Cli::RETURN_FAILURE,
            $this->exportContactCommandTester->getStatusCode()
        );
    }

    public function testExecuteWithEmailFromCustomerOption()
    {
        $email = '[email protected]';
        $customerId = 123;

        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->customerCollection->expects($this->once())
            ->method('addEmailFilter')
            ->with($email)
            ->willReturnSelf();

        $this->customerCollection->expects($this->never())
            ->method('addCustomerOmittedFilter');

        $this->customerCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn([$customerId]);

        $progressBar = new ProgressBar(new TestOutput());

        $this->progressBarFactory->expects($this->once())
            ->method('create')
            ->willReturn($progressBar);

        $this->publisher->expects($this->once())
                          expects($this->once())
            ->method('publish')
            ->with(
                Topics::CUSTOMER_CONTACT_EXPORT,
                json_encode(['magento_customer_id' => $customerId])
            );

        $this->exportContactCommandTester->execute(
            ['--email' => $email]
        );

        $this->assertContains(
            '1 contact(s) have been scheduled for export.',
            $this->exportContactCommandTester->getDisplay()
        );

        $this->assertEquals(Cli::RETURN_SUCCESS, $this->exportContactCommandTester->getStatusCode());
    }

    public function testExecuteWithEmailFromSubscriberOption()
    {
        $email = '[email protected]';

        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->customerCollection->expects($this->once())
            ->method('addEmailFilter')
            ->with($email)
            ->willReturnSelf();

        $this->customerCollection->expects($this->never())
            ->method('addCustomerOmittedFilter');

        $this->customerCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn([]);

        $this->subscriberCollection->expects($this->once())
            ->method('excludeCustomers')
            ->willReturnSelf();

        $this->subscriberCollection->expects($this->once())
            ->method('addEmailFilter')
            ->willReturnSelf();

        $this->subscriberCollection->expects($this->never())
            ->method('addContactOmittedFilter');

        $this->subscriberCollection->expects($this->once())
            ->method('getAllEmails')
            ->willReturn([$email]);

        $progressBar = new ProgressBar(new TestOutput());

        $this->progressBarFactory->expects($this->once())
            ->method('create')
            ->willReturn($progressBar);

        $this->publisher->expects($this->once())
            ->method('publish')
            ->with(
                Topics::NEWSLETTER_CONTACT_EXPORT,
                json_encode(['email' => $email])
            );

        $this->exportContactCommandTester->execute(
            ['--email' => $email]
        );

        $this->assertContains(
            '1 contact(s) have been scheduled for export.',
            $this->exportContactCommandTester->getDisplay()
        );

        $this->assertEquals(Cli::RETURN_SUCCESS, $this->exportContactCommandTester->getStatusCode());
    }

    public function testExecuteWithOmittedOption()
    {
        $customerIds = [123, 456];
        $emails = ['[email protected]', '[email protected]'];

        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->customerCollection->expects($this->never())
            ->method('addEmailFilter');

        $this->customerCollection->expects($this->once())
            ->method('addContactOmittedFilter')
            ->willReturnSelf();

        $this->customerCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn($customerIds);

        $this->subscriberCollection->expects($this->never())
            ->method('addEmailFilter');

        $this->subscriberCollection->expects($this->once())
            ->method('addContactOmittedFilter')
            ->willReturnSelf();

        $this->subscriberCollection->expects($this->once())
            ->method('getAllEmails')
            ->willReturn($emails);

        $progressBar = new ProgressBar(new TestOutput());

        $this->progressBarFactory->expects($this->exactly(2))
            ->method('create')
            ->willReturn($progressBar);

        $this->publisher->expects($this->exactly(4))
            ->method('publish');

        $this->exportContactCommandTester->execute(
            ['--omitted' => true]
        );

        $this->assertContains(
            '4 contact(s) have been scheduled for export.',
            $this->exportContactCommandTester->getDisplay()
        );

        $this->assertEquals(Cli::RETURN_SUCCESS, $this->exportContactCommandTester->getStatusCode());
    }


    public function testExecuteWithAllOption()
    {
        $customerIds = [123, 456];
        $emails = ['[email protected]', '[email protected]'];

        $this->configHelper->expects($this->once())
            ->method('isEnabled')
            ->willReturn(true);

        $this->configHelper->expects($this->once())
            ->method('isContactExportEnabled')
            ->willReturn(true);

        $this->customerCollection->expects($this->never())
            ->method('addEmailFilter');

        $this->customerCollection->expects($this->never())
            ->method('addContactOmittedFilter');

        $this->customerCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn($customerIds);

        $this->subscriberCollection->expects($this->never())
            ->method('addEmailFilter');

        $this->subscriberCollection->expects($this->never())
            ->method('addContactOmittedFilter');

        $this->subscriberCollection->expects($this->once())
            ->method('getAllEmails')
            ->willReturn($emails);

        $progressBar = new ProgressBar(new TestOutput());

        $this->progressBarFactory->expects($this->exactly(2))
            ->method('create')
            ->willReturn($progressBar);

        $this->publisher->expects($this->exactly(4))
            ->method('publish');

        $this->exportContactCommandTester->execute(
            ['--all' => true]
        );

        $this->assertContains(
            '4 contact(s) have been scheduled for export.',
            $this->exportContactCommandTester->getDisplay()
        );

        $this->assertEquals(Cli::RETURN_SUCCESS, $this->exportContactCommandTester->getStatusCode());
    }
}

commerceleague / magento2-module-activecampaign

GitHub Access Token became invalid

Push — master ( c92bdf...416677 )

testExecuteContactExportDisabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
