Skip to content

[Backport] GoogleAnalytics: Added unit test for order success observer #17471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\GoogleAnalytics\Test\Unit\Block;

use Magento\Framework\Event;
use Magento\Framework\Event\Observer;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use Magento\Framework\View\Element\AbstractBlock;
use Magento\Framework\View\LayoutInterface;
use Magento\GoogleAnalytics\Helper\Data as GaDataHelper;
use Magento\GoogleAnalytics\Observer\SetGoogleAnalyticsOnOrderSuccessPageViewObserver;
use Magento\Store\Model\StoreManagerInterface;
use PHPUnit\Framework\TestCase;

class SetGoogleAnalyticsOnOrderSuccessPageViewObserverTest extends TestCase
{
/**
* @var Event|\PHPUnit_Framework_MockObject_MockObject
*/
private $eventMock;

/**
* @var Observer|\PHPUnit_Framework_MockObject_MockObject
*/
private $observerMock;

/**
* @var GaDataHelper|\PHPUnit_Framework_MockObject_MockObject
*/
private $googleAnalyticsDataMock;

/**
* @var LayoutInterface|\PHPUnit_Framework_MockObject_MockObject
*/
private $layoutMock;

/**
* @var StoreManagerInterface|\PHPUnit_Framework_MockObject_MockObject
*/
private $storeManagerMock;

/**
* @var SetGoogleAnalyticsOnOrderSuccessPageViewObserver
*/
private $orderSuccessObserver;

protected function setUp()
{
$this->googleAnalyticsDataMock = $this->getMockBuilder(GaDataHelper::class)
->disableOriginalConstructor()
->getMock();
$this->storeManagerMock = $this->getMockBuilder(StoreManagerInterface::class)
->disableOriginalConstructor()
->getMock();
$this->layoutMock = $this->getMockBuilder(LayoutInterface::class)
->disableOriginalConstructor()
->getMock();
$this->observerMock = $this->getMockBuilder(Observer::class)->getMock();
$this->eventMock = $this->getMockBuilder(Event::class)->getMock();

$objectManager = new ObjectManager($this);

$this->orderSuccessObserver = $objectManager->getObject(
SetGoogleAnalyticsOnOrderSuccessPageViewObserver::class,
[
'storeManager' => $this->storeManagerMock,
'layout' => $this->layoutMock,
'googleAnalyticsData' => $this->googleAnalyticsDataMock
]
);
}

public function testExecuteWithNoOrderIds()
{
$this->observerMock->expects($this->once())
->method('getEvent')
->willReturn($this->eventMock);
$this->eventMock->expects($this->once())
->method('__call')
->with(
$this->equalTo('getOrderIds')
)
->willReturn([]);
$this->layoutMock->expects($this->never())
->method('getBlock');

$this->orderSuccessObserver->execute($this->observerMock);
}

public function testExecuteWithOrderIds()
{
$blockMock = $this->getMockBuilder(AbstractBlock::class)
->disableOriginalConstructor()
->getMock();
$orderIds = [8];

$this->observerMock->expects($this->once())
->method('getEvent')
->willReturn($this->eventMock);
$this->eventMock->expects($this->once())
->method('__call')
->with(
$this->equalTo('getOrderIds')
)
->willReturn($orderIds);
$this->layoutMock->expects($this->once())
->method('getBlock')
->willReturn($blockMock);
$blockMock->expects($this->once())
->method('__call')
->with(
$this->equalTo('setOrderIds'),
$this->equalTo([$orderIds])
);

$this->orderSuccessObserver->execute($this->observerMock);
}
}