Skip to content
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

Unit tests for Magento\Csp\Model\Mode\ConfigManager and Magento\Csp\Observer\Render #26770

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 127 additions & 0 deletions app/code/Magento/Csp/Test/Unit/Model/Mode/ConfigManagerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Csp\Test\Unit\Model\Mode;

use Magento\Csp\Model\Mode\ConfigManager;
use Magento\Csp\Model\Mode\Data\ModeConfigured;
use Magento\Framework\App\Area;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\State;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
use Magento\Store\Model\Store;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

/**
* Unit Test for \Magento\Csp\Model\Mode\ConfigManager
*/
class ConfigManagerTest extends TestCase
{
const STUB_REPORT_ONLY = true;
const STUB_AREA_CODE_OTHER = 'other';

/**
* @var MockObject|ScopeConfigInterface
*/
private $configMock;

/**
* @var MockObject|Store
*/
private $storeModelMock;

/**
* @var MockObject|State
*/
private $stateMock;

/**
* @var ConfigManager
*/
private $model;

/**
* @inheritDoc
*/
protected function setUp()
{
$this->configMock = $this->createMock(ScopeConfigInterface::class);
$this->storeModelMock = $this->createMock(Store::class);
$this->stateMock = $this->createMock(State::class);

$objectManagerHelper = new ObjectManagerHelper($this);
$this->model = $objectManagerHelper->getObject(
ConfigManager::class,
[
'config' => $this->configMock,
'storeModel' => $this->storeModelMock,
'state' => $this->stateMock
]
);
}

/**
* Test case with correct Area codes.
*
* @param string $area
* @param string $pathReportOnly
* @param string $pathReportUri
* @dataProvider dataProviderGetConfiguredWithCorrectArea
*/
public function testGetConfiguredWithCorrectArea(string $area, string $pathReportOnly, string $pathReportUri)
{
$this->stateMock->expects($this->once())->method('getAreaCode')->willReturn($area);

$this->configMock->expects($this->once())->method('getValue')->with($pathReportUri);
$this->configMock->expects($this->once())
->method('isSetFlag')
->with($pathReportOnly)
->willReturn(self::STUB_REPORT_ONLY);

$this->assertInstanceOf(ModeConfigured::class, $this->model->getConfigured());
}

/**
* Data Provider with appropriate areas.
*
* @return array
*/
public function dataProviderGetConfiguredWithCorrectArea(): array
{
return [
[
'area' => Area::AREA_ADMINHTML,
'pathReportOnly' => 'csp/mode/admin/report_only',
'pathReportUri' => 'csp/mode/admin/report_uri'
],
[
'area' => Area::AREA_FRONTEND,
'pathReportOnly' => 'csp/mode/storefront/report_only',
'pathReportUri' => 'csp/mode/storefront/report_uri'
]
];
}

/**
* Test case with an inappropriate Area code.
*/
public function testGetConfiguredWithWrongArea()
{
$this->stateMock->expects($this->once())
->method('getAreaCode')
->willReturn(self::STUB_AREA_CODE_OTHER);

$this->configMock->expects($this->never())->method('isSetFlag');
$this->configMock->expects($this->never())->method('getValue');
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('CSP can only be configured for storefront or admin area');

$this->model->getConfigured();
}
}
52 changes: 52 additions & 0 deletions app/code/Magento/Csp/Test/Unit/Observer/RenderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

declare(strict_types=1);

namespace Magento\Csp\Test\Unit\Observer;

use Magento\Csp\Api\CspRendererInterface;
use Magento\Csp\Observer\Render;
use Magento\Framework\App\Response\Http as ResponseHttp;
use Magento\Framework\Event;
use Magento\Framework\Event\Observer;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;

/**
* Unit Test for \Magento\Csp\Observer\Render
*/
class RenderTest extends TestCase
{
/**
* Check if the render method is called
*/
public function testExecuteExpectsRenderCalled()
{
$eventMock = $this->createMock(Event::class);
$responseMock = $this->createMock(ResponseHttp::class);
$eventMock->expects($this->once())
->method('getData')
->with('response')
->willReturn($responseMock);

/** @var MockObject|Observer $eventObserverMock */
$eventObserverMock = $this->createMock(Observer::class);
$eventObserverMock->expects($this->once())->method('getEvent')->willReturn($eventMock);

$cspRendererMock = $this->createMock(CspRendererInterface::class);
$cspRendererMock->expects($this->once())->method('render');

$objectManagerHelper = new ObjectManager($this);
/** @var Render $renderObserver */
$renderObserver = $objectManagerHelper->getObject(
Render::class,
['cspRenderer' => $cspRendererMock]
);
$renderObserver->execute($eventObserverMock);
}
}