Skip to content

[Theme] Covered Unit Test for \Magento\Theme\Controller\Result\JsFooterPlugin #26820

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.

Sign up for GitHub

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

Merged
magento-engcom-team merged 4 commits into from
Feb 13, 2020
Merged

[Theme] Covered Unit Test for \Magento\Theme\Controller\Result\JsFooterPlugin #26820

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6220474
[Theme] Covered Unit Test for \Magento\Theme\controller\Result\JsFoot…
srsathish92 Feb 11, 2020
a208226
Test case updated with if content NULL & fixed health check issue
srsathish92 Feb 11, 2020
6a82bf7
Data Provider keys added with description
srsathish92 Feb 11, 2020
c9dcd27
Fixed static test
srsathish92 Feb 12, 2020
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
164 changes: 164 additions & 0 deletions app/code/Magento/Theme/Test/Unit/Controller/Result/JsFooterPluginTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Theme\Test\Unit\Controller\Result;

use Magento\Theme\Controller\Result\JsFooterPlugin;
use Magento\Framework\App\Response\Http;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\MockObject\MockObject;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Store\Model\ScopeInterface;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;

/**
* Unit test for Magento\Theme\Test\Unit\Controller\Result\JsFooterPlugin.
*/
class JsFooterPluginTest extends TestCase
{
const STUB_XML_PATH_DEV_MOVE_JS_TO_BOTTOM = 'dev/js/move_script_to_bottom';

/**
* @var JsFooterPlugin
*/
private $plugin;

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

/**
* @var Http|MockObject
*/
private $httpMock;

/**
* @inheritdoc
*/
protected function setUp(): void
{
$this->scopeConfigMock = $this->getMockBuilder(ScopeConfigInterface::class)
->setMethods(['isSetFlag'])
->disableOriginalConstructor()
->getMockForAbstractClass();

$this->httpMock = $this->createMock(Http::class);

$objectManager = new ObjectManagerHelper($this);
$this->plugin = $objectManager->getObject(
JsFooterPlugin::class,
[
'scopeConfig' => $this->scopeConfigMock
]
);
}

/**
* Data Provider for testBeforeSendResponse()
*
* @return array
*/
public function sendResponseDataProvider(): array
{
return [
[
"content" => "<body><h1>Test Title</h1>" .
"<script type=\"text/x-magento-init\">test</script>" .
"<script type=\"text/x-magento-template\">test</script>" .
"<p>Test Content</p></body>",
"flag" => true,
"result" => "<body><h1>Test Title</h1>" .
"<script type=\"text/x-magento-template\">test</script>" .
"<p>Test Content</p>" .
"<script type=\"text/x-magento-init\">test</script>" .
"\n</body>"
],
[
"content" => "<body><p>Test Content</p></body>",
"flag" => false,
"result" => "<body><p>Test Content</p></body>"
],
[
"content" => "<body><p>Test Content</p></body>",
"flag" => true,
"result" => "<body><p>Test Content</p>\n</body>"
]
];
}

/**
* Test beforeSendResponse
*
* @param string $content
* @param bool $isSetFlag
* @param string $result
* @return void
* @dataProvider sendResponseDataProvider
*/
public function testBeforeSendResponse($content, $isSetFlag, $result): void
{
$this->httpMock->expects($this->once())
->method('getContent')
->willReturn($content);

$this->scopeConfigMock->expects($this->once())
->method('isSetFlag')
->with(
self::STUB_XML_PATH_DEV_MOVE_JS_TO_BOTTOM,
ScopeInterface::SCOPE_STORE
)
->willReturn($isSetFlag);

$this->httpMock->expects($this->any())
->method('setContent')
->with($result);

$this->plugin->beforeSendResponse($this->httpMock);
}

/**
* Data Provider for testBeforeSendResponseIfGetContentIsNotAString()
*
* @return array
*/
public function ifGetContentIsNotAStringDataProvider(): array
{
return [
[
'content' => []
],
[
'content' => NULL
]
Copy link
Contributor

@lbajsarowicz lbajsarowicz Feb 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can replace this with:

'empty_array' => ['content' => []],
'null' => ['content' => NULL]

As a result - when one of them fail - You'll know on which data set it failed (key of dataProvider is added to error message (Test failed with: X))

Copy link
Contributor Author

@srsathish92 srsathish92 Feb 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lbajsarowicz Thanks for the feedback, I have updated the keys.

];
}

/**
* Test BeforeSendResponse if content is not a string
*
* @param string $content
* @return void
* @dataProvider ifGetContentIsNotAStringDataProvider
*/
public function testBeforeSendResponseIfGetContentIsNotAString($content): void
{
$this->httpMock->expects($this->once())
->method('getContent')
->willReturn($content);

$this->scopeConfigMock->expects($this->never())
->method('isSetFlag')
->with(
self::STUB_XML_PATH_DEV_MOVE_JS_TO_BOTTOM,
ScopeInterface::SCOPE_STORE
)
->willReturn(false);

$this->plugin->beforeSendResponse($this->httpMock);
}
}