MC-40561: Stabilize unit tests

svera · svera · commit 198c76f66b2b · 2021-02-19T12:29:06.000+01:00
diff --git a/app/code/Magento/BundleImportExport/Test/Unit/Model/Import/Product/Type/BundleTest.php b/app/code/Magento/BundleImportExport/Test/Unit/Model/Import/Product/Type/BundleTest.php
@@ -7,7 +7,7 @@
 namespace Magento\BundleImportExport\Test\Unit\Model\Import\Product\Type;
 
 /**
- * Class BundleTest
+ * Tests for Bundle
  *
  * @SuppressWarnings(PHPMD.ExcessiveParameterList)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
diff --git a/app/code/Magento/Catalog/Model/Product/TierPriceManagement.php b/app/code/Magento/Catalog/Model/Product/TierPriceManagement.php
@@ -90,7 +90,10 @@ public function __construct(
      */
     public function add($sku, $customerGroupId, $price, $qty)
     {
-        if (!\Zend_Validate::is((string)$price, 'Float') || $price <= 0 || !\Zend_Validate::is((string)$qty, 'Float') || $qty <= 0) {
+        if (!\Zend_Validate::is((string)$price, 'Float')
+            || $price <= 0 || !\Zend_Validate::is((string)$qty, 'Float')
+            || $qty <= 0
+        ) {
             throw new InputException(__('The data was invalid. Verify the data and try again.'));
         }
         $product = $this->productRepository->get($sku, ['edit_mode' => true]);
diff --git a/app/code/Magento/Catalog/Test/Unit/Model/ProductLink/RepositoryTest.php b/app/code/Magento/Catalog/Test/Unit/Model/ProductLink/RepositoryTest.php
@@ -251,7 +251,9 @@ public function testDeleteWithInvalidDataException()
     public function testDeleteWithNoSuchEntityException()
     {
         $this->expectException(\Magento\Framework\Exception\NoSuchEntityException::class);
-        $this->expectExceptionMessage('Product with SKU \'linkedProduct\' is not linked to product with SKU \'product\'');
+        $this->expectExceptionMessage(
+            'Product with SKU \'linkedProduct\' is not linked to product with SKU \'product\''
+        );
 
         $entityMock = $this->createMock(\Magento\Catalog\Model\ProductLink\Link::class);
         $productMock = $this->createMock(\Magento\Catalog\Model\Product::class);
diff --git a/app/code/Magento/Checkout/Model/Sidebar.php b/app/code/Magento/Checkout/Model/Sidebar.php
@@ -13,6 +13,8 @@
 use Magento\Quote\Model\Quote\Address\Total;
 
 /**
+ * Data model for the sidebar
+ *
  * @deprecated 100.1.0
  */
 class Sidebar
diff --git a/app/code/Magento/Customer/Test/Unit/Model/ResourceModel/AddressTest.php b/app/code/Magento/Customer/Test/Unit/Model/ResourceModel/AddressTest.php
@@ -6,6 +6,7 @@
 
 namespace Magento\Customer\Test\Unit\Model\ResourceModel;
 
+use Magento\Customer\Model\Address;
 use Magento\Framework\Model\ResourceModel\Db\VersionControl\RelationComposite;
 use Magento\Framework\Model\ResourceModel\Db\VersionControl\Snapshot;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
@@ -261,7 +262,6 @@ public function testGetType()
 /**
  * Class SubResourceModelAddress
  * Mock method getAttributeLoader
- * @package Magento\Customer\Test\Unit\Model\ResourceModel
  * @codingStandardsIgnoreStart
  */
 class SubResourceModelAddress extends \Magento\Customer\Model\ResourceModel\Address
diff --git a/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerReindexCommandTest.php b/app/code/Magento/Indexer/Test/Unit/Console/Command/IndexerReindexCommandTest.php
@@ -97,12 +97,10 @@ public function testExecuteAll()
         $this->configMock->expects($this->once())
             ->method('getIndexer')
             ->willReturn(
-
                 [
                     'title' => 'Title_indexerOne',
                     'shared_index' => null
                 ]
-
             );
         $this->configureAdminArea();
         $this->initIndexerCollectionByItems(
@@ -139,8 +137,7 @@ public function testExecuteWithIndex(
         array $reindexAllCallMatchers,
         array $executedIndexers,
         array $executedSharedIndexers
-    )
-    {
+    ) {
         $this->addSeparateIndexersToConfigMock($indexers);
         $this->addAllIndexersToConfigMock($indexers);
 
diff --git a/app/code/Magento/Integration/Test/Unit/Controller/Token/AccessTest.php b/app/code/Magento/Integration/Test/Unit/Controller/Token/AccessTest.php
@@ -116,8 +116,12 @@ protected function setUp(): void
 
         $this->helperMock = $this->createMock(\Magento\Framework\Oauth\Helper\Request::class);
         $this->frameworkOauthSvcMock = $this->getMockForAbstractClass(\Magento\Framework\Oauth\OauthInterface::class);
-        $this->intOauthServiceMock = $this->getMockForAbstractClass(\Magento\Integration\Api\OauthServiceInterface::class);
-        $this->integrationServiceMock = $this->getMockForAbstractClass(\Magento\Integration\Api\IntegrationServiceInterface::class);
+        $this->intOauthServiceMock = $this->getMockForAbstractClass(
+            \Magento\Integration\Api\OauthServiceInterface::class
+        );
+        $this->integrationServiceMock = $this->getMockForAbstractClass(
+            \Magento\Integration\Api\IntegrationServiceInterface::class
+        );
         /** @var \Magento\Framework\TestFramework\Unit\Helper\ObjectManager $objectManagerHelper */
         $this->objectManagerHelper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
         $this->accessAction = $this->objectManagerHelper->getObject(
diff --git a/app/code/Magento/SalesRule/Test/Unit/Model/Coupon/MassgeneratorTest.php b/app/code/Magento/SalesRule/Test/Unit/Model/Coupon/MassgeneratorTest.php
@@ -6,7 +6,7 @@
 namespace Magento\SalesRule\Test\Unit\Model\Coupon;
 
 /**
- * Class MassgeneratorTest
+ * Tests for Massgenerator
  */
 class MassgeneratorTest extends \PHPUnit\Framework\TestCase
 {
@@ -36,7 +36,9 @@ protected function setUp(): void
      */
     public function testGenerateCode(array $data, $length)
     {
-        $salesRuleCouponMock = $this->createPartialMock(\Magento\SalesRule\Helper\Coupon::class, ['getCharset', 'getCodeSeparator']);
+        $salesRuleCouponMock = $this->createPartialMock(
+            \Magento\SalesRule\Helper\Coupon::class, ['getCharset', 'getCodeSeparator']
+        );
 
         /** @var \Magento\SalesRule\Model\Coupon\Massgenerator $massgenerator */
         $massgenerator = $this->objectManager->getObject(
@@ -160,7 +162,9 @@ public function testGeneratePool()
     public function testGeneratePoolException()
     {
         $this->expectException(\Magento\Framework\Exception\LocalizedException::class);
-        $this->expectExceptionMessage('We cannot create the requested Coupon Qty. Please check your settings and try again.');
+        $this->expectExceptionMessage(
+            'We cannot create the requested Coupon Qty. Please check your settings and try again.'
+        );
 
         $data = [
             'qty' => 3,
@@ -169,7 +173,9 @@ public function testGeneratePoolException()
             'max_attempts' => 0,
         ];
 
-        $salesRuleCouponMock = $this->createPartialMock(\Magento\SalesRule\Helper\Coupon::class, ['getCharset', 'getCodeSeparator']);
+        $salesRuleCouponMock = $this->createPartialMock(
+            \Magento\SalesRule\Helper\Coupon::class, ['getCharset', 'getCodeSeparator']
+        );
         $resourceMock = $this->createPartialMock(
             \Magento\SalesRule\Model\ResourceModel\Coupon::class,
             ['exists', '__wakeup', 'getIdFieldName']
diff --git a/app/code/Magento/User/Observer/Backend/AuthObserver.php b/app/code/Magento/User/Observer/Backend/AuthObserver.php
@@ -20,7 +20,9 @@
 
 /**
  * User backend observer model for authentication
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)
  */
 class AuthObserver implements ObserverInterface
 {
diff --git a/lib/internal/Magento/Framework/App/Route/Config.php b/lib/internal/Magento/Framework/App/Route/Config.php
@@ -9,6 +9,9 @@
 
 use Magento\Framework\Serialize\SerializerInterface;
 
+/**
+ * Config holds the configuration of a route
+ */
 class Config implements ConfigInterface
 {
     /**
@@ -101,7 +104,7 @@ protected function _getRoutes($scope = null)
      * Retrieve route front name
      *
      * @param string $routeId
-     * @param null $scope
+     * @param string $scope
      * @return string
      */
     public function getRouteFrontName($routeId, $scope = null)
@@ -111,6 +114,8 @@ public function getRouteFrontName($routeId, $scope = null)
     }
 
     /**
+     * Retrieve route ID by front name
+     *
      * @param string $frontName
      * @param string $scope
      * @return bool|int|string
@@ -127,6 +132,8 @@ public function getRouteByFrontName($frontName, $scope = null)
     }
 
     /**
+     * Retrieve modules by front name
+     *
      * @param string $frontName
      * @param string $scope
      * @return string[]
diff --git a/lib/internal/Magento/Framework/Archive/Tar.php b/lib/internal/Magento/Framework/Archive/Tar.php
@@ -16,7 +16,7 @@
 class Tar extends \Magento\Framework\Archive\AbstractArchive implements \Magento\Framework\Archive\ArchiveInterface
 {
     /**
-     * Tar block size
+     * Tar block size in bytes
      *
      * @const int
      */
diff --git a/lib/internal/Magento/Framework/Code/Generator/ClassGenerator.php b/lib/internal/Magento/Framework/Code/Generator/ClassGenerator.php
@@ -112,12 +112,12 @@ public function addMethods(array $methods)
             $this->_setDataToObject($methodObject, $methodOptions, $this->_methodOptions);
 
             if (isset(
-                    $methodOptions['parameters']
-                ) && is_array(
-                    $methodOptions['parameters']
-                ) && count(
-                    $methodOptions['parameters']
-                ) > 0
+                $methodOptions['parameters']
+            ) && is_array(
+                $methodOptions['parameters']
+            ) && count(
+                $methodOptions['parameters']
+            ) > 0
             ) {
                 $parametersArray = [];
                 foreach ($methodOptions['parameters'] as $parameterOptions) {
diff --git a/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php b/lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php
@@ -7,11 +7,11 @@
 
 use Laminas\Code\Generator\ValueGenerator;
 
+/**
+ * Parent class for entities
+ */
 abstract class EntityAbstract
 {
-    /**
-     * Entity type
-     */
     const ENTITY_TYPE = 'abstract';
 
     /**
@@ -237,6 +237,8 @@ protected function _addError($message)
     }
 
     /**
+     * Ensures that data is valid
+     *
      * @return bool
      */
     protected function _validateData()
@@ -262,6 +264,8 @@ protected function _validateData()
     }
 
     /**
+     * Retrieves documentation block from class
+     *
      * @return array
      */
     protected function _getClassDocBlock()
@@ -271,6 +275,8 @@ protected function _getClassDocBlock()
     }
 
     /**
+     * Retrieves generated code
+     *
      * @return string
      */
     protected function _getGeneratedCode()
@@ -280,6 +286,8 @@ protected function _getGeneratedCode()
     }
 
     /**
+     * Fixes code style errors
+     *
      * @param string $sourceCode
      * @return string
      */
@@ -304,6 +312,8 @@ protected function _getNullDefaultValue()
     }
 
     /**
+     * Retrieve type from parameter
+     *
      * @param \ReflectionParameter $parameter
      * @return null|string
      */
@@ -334,6 +344,8 @@ private function extractParameterType(
     }
 
     /**
+     * Retrieve default value from parameter
+     *
      * @param \ReflectionParameter $parameter
      * @return null|ValueGenerator
      * @throws \ReflectionException
diff --git a/lib/internal/Magento/Framework/DB/FieldDataConverter.php b/lib/internal/Magento/Framework/DB/FieldDataConverter.php
@@ -21,9 +21,6 @@ class FieldDataConverter
      */
     const BATCH_SIZE_VARIABLE_NAME = 'DATA_CONVERTER_BATCH_SIZE';
 
-    /**
-     * Default batch size
-     */
     const DEFAULT_BATCH_SIZE = 50000;
 
     /**
diff --git a/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Repository.php b/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Repository.php
@@ -21,9 +21,6 @@
  */
 class Repository extends \Magento\Framework\Code\Generator\EntityAbstract
 {
-    /**
-     * Entity type
-     */
     const ENTITY_TYPE = 'repository';
 
     /**
@@ -129,6 +126,7 @@ protected function _getSourcePersistorPropertyName()
 
     /**
      * Returns source collection factory property name
+     *
      * @return string
      */
     protected function _getSourceCollectionFactoryPropertyName()
@@ -619,7 +617,7 @@ protected function _getClassMethods()
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     protected function _validateData()
     {
diff --git a/lib/internal/Magento/Framework/View/Test/Unit/Asset/RepositoryTest.php b/lib/internal/Magento/Framework/View/Test/Unit/Asset/RepositoryTest.php
@@ -240,7 +240,13 @@ public function updateDesignParamsDataProvider()
                 ['area' => 'AREA', 'themeModel' => $this->getThemeMock(), 'module' => false, 'locale' => 'locale']],
             [
                 ['themeId' => 'ThemeID'],
-                ['area' => 'area', 'themeId' => 'ThemeID', 'themeModel' => 'ThemeID', 'module' => false, 'locale' => 'locale']
+                [
+                    'area' => 'area',
+                    'themeId' => 'ThemeID',
+                    'themeModel' => 'ThemeID',
+                    'module' => false,
+                    'locale' => 'locale'
+                ]
             ]
         ];
     }
@@ -255,7 +261,7 @@ public function testCreateAsset()
             ->method('getThemeByFullPath')
             ->willReturnArgument(0);
 
-        $fallbackContextMock = $this->getMockBuilder(\Magento\Framework\View\Asset\File\FallbackContex::class)
+        $fallbackContextMock = $this->getMockBuilder(\Magento\Framework\View\Asset\File\FallbackContext::class)
             ->disableOriginalConstructor()
             ->getMock();
         $this->fallbackFactoryMock
@@ -320,7 +326,7 @@ public function testGetStaticViewFileContext()
             ->method('isSecure')
             ->willReturn(false);
 
-        $fallbackContextMock = $this->getMockBuilder(\Magento\Framework\View\Asset\File\FallbackContex::class)
+        $fallbackContextMock = $this->getMockBuilder(\Magento\Framework\View\Asset\File\FallbackContext::class)
             ->disableOriginalConstructor()
             ->getMock();
         $this->fallbackFactoryMock
diff --git a/setup/src/Magento/Setup/Fixtures/Quote/QuoteGenerator.php b/setup/src/Magento/Setup/Fixtures/Quote/QuoteGenerator.php
@@ -583,7 +583,7 @@ private function prepareQueryTemplates()
      * @param array $replacements
      * @return void
      */
-    protected function query($table, ... $replacements)
+    protected function query($table, ...$replacements)
     {
         $query = $this->queryTemplates[$table];
         foreach ($replacements as $data) {

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`namespace Magento\BundleImportExport\Test\Unit\Model\Import\Product\Type;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Class BundleTest`
	`10`	`+ * Tests for Bundle`
`11`	`11`	`*`
`12`	`12`	`* @SuppressWarnings(PHPMD.ExcessiveParameterList)`
`13`	`13`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,10 @@ public function __construct(`
`90`	`90`	`*/`
`91`	`91`	`public function add($sku, $customerGroupId, $price, $qty)`
`92`	`92`	`{`
`93`		`- if (!\Zend_Validate::is((string)$price, 'Float') \|\| $price <= 0 \|\| !\Zend_Validate::is((string)$qty, 'Float') \|\| $qty <= 0) {`
	`93`	`+ if (!\Zend_Validate::is((string)$price, 'Float')`
	`94`	`+ \|\| $price <= 0 \|\| !\Zend_Validate::is((string)$qty, 'Float')`
	`95`	`+ \|\| $qty <= 0`
	`96`	`+ ) {`
`94`	`97`	`throw new InputException(__('The data was invalid. Verify the data and try again.'));`
`95`	`98`	`}`
`96`	`99`	`$product = $this->productRepository->get($sku, ['edit_mode' => true]);`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* User backend observer model for authentication`
	`23`	`+ *`
`23`	`24`	`* @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`25`	`+ * @SuppressWarnings(PHPMD.CookieAndSessionMisuse)`
`24`	`26`	`*/`
`25`	`27`	`class AuthObserver implements ObserverInterface`
`26`	`28`	`{`