🔃 [EngCom] Public Pull Requests - 2.2-develop

Accepted Public Pull Requests:
 - #16240: Removed double occurrence of 'it' from sentences. (by @namratachangani)
 - #16247: Fixed typo error (by @vgelani)
 - #16141: Fix case mismatch call (class/method) (by @lfluvisotto)
 - #15629: Fix #15627: Product order in category changed in Magento 2.2.4 (by @dverkade)
 - #16215: PHPDoc (by @lfluvisotto)
 - #15532: FIX for issue #15501 - M2.2.4 missing meta title tag and doesn't show� (by @phoenix128)
 - #15637: Create ability to set is_visible_on_front to order status history comment (by @markoshust)
 - #15521: Move breadcrumb json configuration to viewmodel (by @diedburn)


Fixed GitHub Issues:
 - #15627: Product order in category changed after update to Magento 2.2.4 (reported by @dverkade) has been fixed in #15629 by @dverkade in 2.2-develop branch
   Related commits:
     1. 8981225

 - #15501: M2.2.4 missing meta title tag and doesn't show product name if meta title is empty (reported by @Naturegreen) has been fixed in #15532 by @phoenix128 in 2.2-develop branch
   Related commits:
     1. 0a38b84
     2. 85ac3be
     3. 432cf00
     4. 1413d65

Author: Stanislav Idolov

app/code/Magento/AdminNotification/Test/Unit/Model/System/Message/CacheOutdatedTest.php

@@ -62,6 +62,9 @@ public function testGetIdentity($expectedSum, $cacheTypes)
         $this->assertEquals($expectedSum, $this->_messageModel->getIdentity());
     }
 
+    /**
+     * @return array
+     */
     public function getIdentityDataProvider()
     {
         $cacheTypeMock1 = $this->createPartialMock(\stdClass::class, ['getCacheType']);
@@ -95,6 +98,9 @@ public function testIsDisplayed($expected, $allowed, $cacheTypes)
         $this->assertEquals($expected, $this->_messageModel->isDisplayed());
     }
 
+    /**
+     * @return array
+     */
     public function isDisplayedDataProvider()
     {
         $cacheTypesMock = $this->createPartialMock(\stdClass::class, ['getCacheType']);

app/code/Magento/AdminNotification/Test/Unit/Model/System/Message/Media/Synchronization/ErrorTest.php

@@ -72,6 +72,9 @@ public function testIsDisplayed($expectedFirstRun, $data)
         $this->assertEquals($expectedFirstRun, $model->isDisplayed());
     }
 
+    /**
+     * @return array
+     */
     public function isDisplayedDataProvider()
     {
         return [

app/code/Magento/AdminNotification/Test/Unit/Model/System/Message/SecurityTest.php

@@ -76,6 +76,9 @@ public function testIsDisplayed($expectedResult, $cached, $response)
         $this->assertEquals($expectedResult, $this->_messageModel->isDisplayed());
     }
 
+    /**
+     * @return array
+     */
     public function isDisplayedDataProvider()
     {
         return [

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Export/AdvancedPricingTest.php

@@ -213,7 +213,7 @@ protected function setUp()
             '_getCustomerGroupById',
             'correctExportData'
         ]);
-        $this->advancedPricing = $this->getMockbuilder(
+        $this->advancedPricing = $this->getMockBuilder(
             \Magento\AdvancedPricingImportExport\Model\Export\AdvancedPricing::class
         )
             ->setMethods($mockMethods)

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricing/Validator/TierPriceTest.php

@@ -181,6 +181,9 @@ public function testIsValidAddMessagesCall($value, $hasEmptyColumns, $customerGr
         $this->tierPrice->isValid($value);
     }
 
+    /**
+     * @return array
+     */
     public function isValidResultFalseDataProvider()
     {
         return [
@@ -286,6 +289,9 @@ public function isValidResultFalseDataProvider()
         ];
     }
 
+    /**
+     * @return array
+     */
     public function isValidAddMessagesCallDataProvider()
     {
         return [

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricing/Validator/WebsiteTest.php

@@ -114,6 +114,9 @@ public function testGetAllWebsitesValue()
         $this->assertEquals($expectedResult, $result);
     }
 
+    /**
+     * @return array
+     */
     public function isValidReturnDataProvider()
     {
         return [

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricing/ValidatorTest.php

@@ -77,6 +77,9 @@ public function testInit()
         $this->validator->init(null);
     }
 
+    /**
+     * @return array
+     */
     public function isValidDataProvider()
     {
         return [

app/code/Magento/AdvancedPricingImportExport/Test/Unit/Model/Import/AdvancedPricingTest.php

@@ -768,6 +768,9 @@ public function testSaveProductPrices($priceData, $oldSkus, $priceIn, $callNum)
         $this->invokeMethod($this->advancedPricing, 'saveProductPrices', [$priceData, 'table']);
     }
 
+    /**
+     * @return array
+     */
     public function saveProductPricesDataProvider()
     {
         return [
@@ -839,6 +842,9 @@ public function testDeleteProductTierPrices(
         );
     }
 
+    /**
+     * @return array
+     */
     public function deleteProductTierPricesDataProvider()
     {
         return [
@@ -921,6 +927,9 @@ public function testProcessCountExistingPrices(
         $this->invokeMethod($this->advancedPricing, 'processCountExistingPrices', [$prices, 'table']);
     }
 
+    /**
+     * @return array
+     */
     public function processCountExistingPricesDataProvider()
     {
         return [

app/code/Magento/Analytics/Test/Unit/Block/Adminhtml/System/Config/AdditionalCommentTest.php

@@ -65,11 +65,11 @@ public function testRender()
             ->method('getLabel')
             ->willReturn('Comment label');
         $html = $this->additionalComment->render($this->abstractElementMock);
-        $this->assertRegexp(
+        $this->assertRegExp(
             "/New comment/",
             $html
         );
-        $this->assertRegexp(
+        $this->assertRegExp(
             "/Comment label/",
             $html
         );

app/code/Magento/Analytics/Test/Unit/Block/Adminhtml/System/Config/CollectionTimeLabelTest.php

@@ -73,7 +73,7 @@ public function testRender()
         $this->abstractElementMock->expects($this->any())
             ->method('getComment')
             ->willReturn('Eastern Standard Time (America/New_York)');
-        $this->assertRegexp(
+        $this->assertRegExp(
             "/Eastern Standard Time \(America\/New_York\)/",
             $this->collectionTimeLabel->render($this->abstractElementMock)
         );

app/code/Magento/Analytics/Test/Unit/Block/Adminhtml/System/Config/SubscriptionStatusLabelTest.php

@@ -77,7 +77,7 @@ public function testRender()
         $this->abstractElementMock->expects($this->any())
             ->method('getComment')
             ->willReturn('Subscription status: Enabled');
-        $this->assertRegexp(
+        $this->assertRegExp(
             "/Subscription status: Enabled/",
             $this->subscriptionStatusLabel->render($this->abstractElementMock)
         );

app/code/Magento/Analytics/Test/Unit/Block/Adminhtml/System/Config/VerticalTest.php

@@ -65,7 +65,7 @@ public function testRender()
             ->method('getHint')
             ->willReturn('New hint');
         $html = $this->vertical->render($this->abstractElementMock);
-        $this->assertRegexp(
+        $this->assertRegExp(
             "/New comment/",
             $html
         );

app/code/Magento/Analytics/Test/Unit/ReportXml/QueryTest.php

@@ -49,7 +49,7 @@ protected function setUp()
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->selectHydratorMock = $this->getMockBuilder(selectHydrator::class)
+        $this->selectHydratorMock = $this->getMockBuilder(SelectHydrator::class)
             ->disableOriginalConstructor()
             ->getMock();
 

app/code/Magento/Authorization/Test/Unit/Model/Acl/AclRetrieverTest.php

@@ -78,6 +78,9 @@ public function testGetAllowedResourcesByUser()
         );
     }
 
+    /**
+     * @return AclRetriever
+     */
     protected function createAclRetriever()
     {
         $this->roleMock = $this->createPartialMock(\Magento\Authorization\Model\Role::class, ['getId', '__wakeup']);

app/code/Magento/Authorizenet/Test/Unit/Model/Directpost/ResponseTest.php

@@ -37,6 +37,9 @@ public function testGenerateHash($merchantMd5, $merchantApiLogin, $amount, $amou
         );
     }
 
+    /**
+     * @return array
+     */
     public function generateHashDataProvider()
     {
         return [
@@ -57,6 +60,14 @@ public function generateHashDataProvider()
         ];
     }
 
+    /**
+     * @param $merchantMd5
+     * @param $merchantApiLogin
+     * @param $amount
+     * @param $transactionId
+     *
+     * @return string
+     */
     protected function generateHash($merchantMd5, $merchantApiLogin, $amount, $transactionId)
     {
         return strtoupper(md5($merchantMd5 . $merchantApiLogin . $transactionId . $amount));

app/code/Magento/Backend/Test/Unit/App/Action/Plugin/AuthenticationTest.php

@@ -146,6 +146,9 @@ public function testProcessNotLoggedInUser($isIFrameParam, $isAjaxParam, $isForw
         $this->assertEquals($expectedResult, $this->plugin->aroundDispatch($subject, $proceed, $request));
     }
 
+    /**
+     * @return array
+     */
     public function processNotLoggedInUserDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/App/Action/Plugin/MassactionKeyTest.php

@@ -74,6 +74,9 @@ public function testBeforeDispatchWhenMassactionPrepareKeyRequestExists($postDat
         $this->plugin->beforeDispatch($this->subjectMock, $this->requestMock);
     }
 
+    /**
+     * @return array
+     */
     public function beforeDispatchDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/App/Action/Stub/ActionStub.php

@@ -8,6 +8,9 @@
 
 class ActionStub extends \Magento\Backend\App\Action
 {
+    /**
+     * @return \Magento\Framework\App\ResponseInterface|\Magento\Framework\Controller\ResultInterface|void
+     */
     public function execute()
     {
         // Empty method stub for test

app/code/Magento/Backend/Test/Unit/App/Area/FrontNameResolverTest.php

@@ -118,6 +118,9 @@ public function testIsHostBackend($url, $host, $useCustomAdminUrl, $customAdminU
         $this->assertEquals($this->model->isHostBackend(), $expectedValue);
     }
 
+    /**
+     * @return array
+     */
     public function hostsDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/App/ConfigTest.php

@@ -70,6 +70,9 @@ public function testIsSetFlag($configPath, $configValue, $expectedResult)
         $this->assertEquals($expectedResult, $this->model->isSetFlag($configPath));
     }
 
+    /**
+     * @return array
+     */
     public function isSetFlagDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/AnchorRendererTest.php

@@ -141,6 +141,9 @@ public function testRenderAnchorLevelIsNotOne($hasTarget)
         );
     }
 
+    /**
+     * @return array
+     */
     public function targetDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Cache/AdditionalTest.php

@@ -88,6 +88,9 @@ public function testIsInProductionMode($mode, $expected)
         $this->assertEquals($expected, $this->additonalBlock->isInProductionMode());
     }
 
+    /**
+     * @return array
+     */
     public function isInProductionModeDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/GlobalSearchTest.php

@@ -103,6 +103,9 @@ public function testGetEntitiesToShow(array $results, int $expectedEntitiesQty)
         $this->assertSame($expectedEntitiesQty, count($this->globalSearch->getEntitiesToShow()));
     }
 
+    /**
+     * @return array
+     */
     public function getEntitiesToShowDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/MenuItemCheckerTest.php

@@ -74,6 +74,9 @@ public function testIsItemActiveLevelNotZero()
         );
     }
 
+    /**
+     * @return array
+     */
     public function dataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/ButtonTest.php

@@ -61,6 +61,9 @@ public function testGetAttributesHtml($data, $expect)
         $this->assertRegExp($expect, $attributes);
     }
 
+    /**
+     * @return array
+     */
     public function getAttributesHtmlDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/Column/Renderer/Radio/ExtendedTest.php

@@ -54,6 +54,9 @@ public function testRender(array $rowData, $expectedResult)
         $this->assertEquals($expectedResult, $this->_object->render(new \Magento\Framework\DataObject($rowData)));
     }
 
+    /**
+     * @return array
+     */
     public function renderDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/Column/Renderer/RadioTest.php

@@ -63,6 +63,9 @@ public function testRender(array $rowData, $expectedResult)
         $this->assertEquals($expectedResult, $this->_object->render(new \Magento\Framework\DataObject($rowData)));
     }
 
+    /**
+     * @return array
+     */
     public function renderDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/ColumnTest.php

@@ -86,6 +86,9 @@ public function testGetSortable($value)
         $this->assertFalse($this->_block->getSortable());
     }
 
+    /**
+     * @return array
+     */
     public function getSortableDataProvider()
     {
         return ['zero' => ['0'], 'false' => [false], 'null' => [null]];
@@ -374,6 +377,9 @@ public function testColumnIsGrouped($groupedData, $expected)
         $this->assertEquals($expected, $block->isGrouped());
     }
 
+    /**
+     * @return array
+     */
     public function columnGroupedDataProvider()
     {
         return [[[], false], [['grouped' => 0], false], [['grouped' => 1], true]];

app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/Massaction/ExtendedTest.php

@@ -152,6 +152,9 @@ public function testGetGridIdsJsonWithUseSelectAll(array $items, $result)
         $this->assertEquals($result, $this->_block->getGridIdsJson());
     }
 
+    /**
+     * @return array
+     */
     public function dataProviderGetGridIdsJsonWithUseSelectAll()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/Grid/MassactionTest.php

@@ -243,6 +243,9 @@ public function testSelected($param, $expectedJson, $expected)
         $this->assertEquals($expected, $this->_block->getSelected());
     }
 
+    /**
+     * @return array
+     */
     public function selectedDataProvider()
     {
         return [

app/code/Magento/Backend/Test/Unit/Block/Widget/TabTest.php

@@ -34,6 +34,9 @@ public function testGetters($method, $field, $value, $expected)
         $this->assertEquals($expected, $object->{$method}());
     }
 
+    /**
+     * @return array
+     */
     public function dataProvider()
     {
         return [

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

@@ -60,6 +60,9 @@ public function testPrepareFilterStringValues(array $inputString, array $expecte
         $this->assertEquals($expected, $actual);
     }
 
+    /**
+     * @return array
+     */
     public function getPrepareFilterStringValuesDataProvider()
     {
         return [