[Magento Community Engineering] Community Contributions - 2.4-develop

 - merged latest code from mainline branch

Author: magento-engcom-team

app/code/Magento/Backend/Test/Unit/Helper/Dashboard/DataTest.php

@@ -0,0 +1,111 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Magento\Backend\Test\Unit\Helper\Dashboard;
+
+use Magento\Backend\Helper\Dashboard\Data as HelperData;
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\Config\ConfigOptionsListConstants;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Store\Model\ResourceModel\Store\Collection as StoreCollection;
+use Magento\Store\Model\Store;
+use Magento\Store\Model\StoreManagerInterface;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class DataTest extends TestCase
+{
+    /**
+     * Stub path install
+     */
+    private const STUB_PATH_INSTALL = 'Sat, 6 Sep 2014 16:46:11 UTC';
+
+    /**
+     * Stub chart data hash
+     */
+    private const STUB_CHART_DATA_HASH = '52870842b23068a78220e01eb9d4404d';
+
+    /**
+     * @var \Magento\Backend\Helper\Dashboard\Data
+     */
+    private $helper;
+
+    /**
+     * @var StoreManagerInterface|MockObject
+     */
+    private $storeManagerMock;
+
+    /**
+     * @var DeploymentConfig|MockObject
+     */
+    private $deploymentConfigMock;
+
+    /**
+     * Prepare environment for test
+     */
+    protected function setUp()
+    {
+        $this->storeManagerMock = $this->createMock(StoreManagerInterface::class);
+        $this->deploymentConfigMock = $this->createMock(DeploymentConfig::class);
+        $this->deploymentConfigMock->expects($this->once())->method('get')
+            ->with(ConfigOptionsListConstants::CONFIG_PATH_INSTALL_DATE)
+            ->will($this->returnValue(self::STUB_PATH_INSTALL));
+
+        $objectManager = new ObjectManager($this);
+        $this->helper = $objectManager->getObject(
+            HelperData::class,
+            [
+                'storeManager' => $this->storeManagerMock,
+                'deploymentConfig' => $this->deploymentConfigMock
+            ]
+        );
+    }
+
+    /**
+     * Test getStores() when $_stores attribute is null
+     */
+    public function testGetStoresWhenStoreAttributeIsNull()
+    {
+        $storeMock = $this->createPartialMock(Store::class, ['getResourceCollection']);
+        $storeCollectionMock = $this->createMock(StoreCollection::class);
+
+        $storeCollectionMock->expects($this->once())->method('load')->willReturnSelf();
+        $storeMock->expects($this->once())->method('getResourceCollection')->willReturn($storeCollectionMock);
+        $this->storeManagerMock->expects($this->once())->method('getStore')->willReturn($storeMock);
+
+        $this->assertEquals($storeCollectionMock, $this->helper->getStores());
+    }
+
+    /**
+     * Test getDatePeriods() method
+     */
+    public function testGetDatePeriods()
+    {
+        $this->assertEquals(
+            [
+                '24h' => (string)__('Last 24 Hours'),
+                '7d' => (string)__('Last 7 Days'),
+                '1m' => (string)__('Current Month'),
+                '1y' => (string)__('YTD'),
+                '2y' => (string)__('2YTD')
+            ],
+            $this->helper->getDatePeriods()
+        );
+    }
+
+    /**
+     * Test getChartDataHash() method
+     */
+    public function testGetChartDataHash()
+    {
+        $this->assertEquals(
+            self::STUB_CHART_DATA_HASH,
+            $this->helper->getChartDataHash(self::STUB_PATH_INSTALL)
+        );
+    }
+}

app/code/Magento/Catalog/Test/Unit/ViewModel/Product/BreadcrumbsTest.php

@@ -12,6 +12,7 @@
 use Magento\Catalog\ViewModel\Product\Breadcrumbs;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Framework\Serialize\Serializer\JsonHexTag;
 
 /**
  * Unit test for Magento\Catalog\ViewModel\Product\Breadcrumbs.
@@ -38,6 +39,11 @@ class BreadcrumbsTest extends \PHPUnit\Framework\TestCase
      */
     private $objectManager;
 
+    /**
+     * @var JsonHexTag|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $serializer;
+
     /**
      * @inheritdoc
      */
@@ -55,12 +61,15 @@ protected function setUp() : void
 
         $escaper = $this->getObjectManager()->getObject(\Magento\Framework\Escaper::class);
 
+        $this->serializer = $this->createMock(JsonHexTag::class);
+
         $this->viewModel = $this->getObjectManager()->getObject(
             Breadcrumbs::class,
             [
                 'catalogData' => $this->catalogHelper,
                 'scopeConfig' => $this->scopeConfig,
-                'escaper' => $escaper
+                'escaper' => $escaper,
+                'jsonSerializer' => $this->serializer
             ]
         );
     }
@@ -141,6 +150,8 @@ public function testGetJsonConfiguration($product, string $expectedJson) : void
             ->with('catalog/seo/category_url_suffix', \Magento\Store\Model\ScopeInterface::SCOPE_STORE)
             ->willReturn('."html');
 
+        $this->serializer->expects($this->once())->method('serialize')->willReturn($expectedJson);
+
         $this->assertEquals($expectedJson, $this->viewModel->getJsonConfiguration());
     }
 

app/code/Magento/Catalog/ViewModel/Product/Breadcrumbs.php

@@ -11,6 +11,7 @@
 use Magento\Framework\App\ObjectManager;
 use Magento\Framework\DataObject;
 use Magento\Framework\Serialize\Serializer\Json;
+use Magento\Framework\Serialize\Serializer\JsonHexTag;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
 use Magento\Framework\Escaper;
 
@@ -36,24 +37,32 @@ class Breadcrumbs extends DataObject implements ArgumentInterface
      */
     private $escaper;
 
+    /**
+     * @var JsonHexTag
+     */
+    private $jsonSerializer;
+
     /**
      * @param Data $catalogData
      * @param ScopeConfigInterface $scopeConfig
      * @param Json|null $json
      * @param Escaper|null $escaper
+     * @param JsonHexTag|null $jsonSerializer
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         Data $catalogData,
         ScopeConfigInterface $scopeConfig,
         Json $json = null,
-        Escaper $escaper = null
+        Escaper $escaper = null,
+        JsonHexTag $jsonSerializer = null
     ) {
         parent::__construct();
 
         $this->catalogData = $catalogData;
         $this->scopeConfig = $scopeConfig;
         $this->escaper = $escaper ?: ObjectManager::getInstance()->get(Escaper::class);
+        $this->jsonSerializer = $jsonSerializer ?: ObjectManager::getInstance()->get(JsonHexTag::class);
     }
 
     /**
@@ -101,15 +110,14 @@ public function getProductName(): string
      */
     public function getJsonConfigurationHtmlEscaped() : string
     {
-        return json_encode(
+        return $this->jsonSerializer->serialize(
             [
                 'breadcrumbs' => [
                     'categoryUrlSuffix' => $this->escaper->escapeHtml($this->getCategoryUrlSuffix()),
                     'useCategoryPathInUrl' => (int)$this->isCategoryUsedInProductUrl(),
                     'product' => $this->escaper->escapeHtml($this->getProductName())
                 ]
-            ],
-            JSON_HEX_TAG
+            ]
         );
     }