ExportOrderCommandTest::testExecuteDisabled() - 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
ExportOrderCommandTest::testExecuteDisabled() A

↳ Parent: ExportOrderCommandTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	10
Code Lines	6
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace CommerceLeague\ActiveCampaign\Test\Unit\Console\Command;

use CommerceLeague\ActiveCampaign\Console\Command\ExportOrderCommand;
use CommerceLeague\ActiveCampaign\Helper\Config as ConfigHelper;
use CommerceLeague\ActiveCampaign\MessageQueue\Topics;
use Magento\Framework\Console\Cli;
use Magento\Framework\MessageQueue\PublisherInterface;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Order\CollectionFactory as OrderCollectionFactory;
filter:
    dependency_paths: ["lib/*"]
use CommerceLeague\ActiveCampaign\Model\ResourceModel\Order\Collection as OrderCollection;
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 ExportOrderCommandTest extends TestCase
{
    /**
     * @var MockObject|ConfigHelper
     */
    protected $configHelper;

    /**
     * @var MockObject|OrderCollectionFactory
     */
    protected $orderCollectionFactory;

    /**
     * @var MockObject|OrderCollection
     */
    protected $orderCollection;

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

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

    /**
     * @var ExportOrderCommand
     */
    protected $exportOrderCommand;

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

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

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

        $this->orderCollection = $this->createMock(OrderCollection::class);

        $this->orderCollectionFactory->expects($this->any())
            ->method('create')
            ->willReturn($this->orderCollection);

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

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

        $this->exportOrderCommand = new ExportOrderCommand(
            $this->configHelper,
            $this->orderCollectionFactory,
            $this->progressBarFactory,
            $this->publisher
        );

        $this->exportOrderCommandTester = new CommandTester($this->exportOrderCommand);
    }

    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->exportOrderCommandTester->execute([]);
    }

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

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

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

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

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

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

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

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

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

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

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

        $this->exportOrderCommandTester->execute(
            ['--order-id' => 123, '--omitted' => true, '--all' => true]
        );
    }

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

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

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

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

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

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

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

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

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

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

    public function testExecuteWithOrderIdOption()
    {
        $orderId = 123;

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

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

        $this->orderCollection->expects($this->once())
            ->method('addExcludeGuestFilter')
            ->willReturnSelf();

        $this->orderCollection->expects($this->once())
            ->method('addIdFilter')
            ->with($orderId)
            ->willReturnSelf();

        $this->orderCollection->expects($this->never())
            ->method('addOmittedFilter');

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

        $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::SALES_ORDER_EXPORT,
                json_encode(['magento_order_id' => $orderId])
            );

        $this->exportOrderCommandTester->execute(
            ['--order-id' => $orderId]
        );

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

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

    public function testWithOmittedOption()
    {
        $orderIds = [123, 456];

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

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

        $this->orderCollection->expects($this->once())
            ->method('addExcludeGuestFilter')
            ->willReturnSelf();

        $this->orderCollection->expects($this->never())
            ->method('addIdFilter');

        $this->orderCollection->expects($this->once())
            ->method('addOmittedFilter')
            ->willReturnSelf();

        $this->orderCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn($orderIds);

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

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

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

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

        $this->assertContains(
            '2 order(s) have been scheduled for export.',
            $this->exportOrderCommandTester->getDisplay()
        );

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

    public function testExecuteWithAllOption()
    {
        $orderIds = [123, 456, 789];

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

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

        $this->orderCollection->expects($this->once())
            ->method('addExcludeGuestFilter')
            ->willReturnSelf();

        $this->orderCollection->expects($this->never())
            ->method('addIdFilter');

        $this->orderCollection->expects($this->never())
            ->method('addOmittedFilter');

        $this->orderCollection->expects($this->once())
            ->method('getAllIds')
            ->willReturn($orderIds);

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

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

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

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

        $this->assertContains(
            '3 order(s) have been scheduled for export.',
            $this->exportOrderCommandTester->getDisplay()
        );

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

commerceleague / magento2-module-activecampaign

GitHub Access Token became invalid

Push — master ( c92bdf...416677 )

ExportOrderCommandTest::testExecuteDisabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
