Added more PhpUnit tests

.ddev/commands/web/phpunit-coverage

@@ -5,5 +5,5 @@
 ## Example: ddev phpunit-coverage
 
 enable_xdebug
-XDEBUG_MODE=coverage php vendor/bin/phpunit --testdox
+XDEBUG_MODE=coverage php vendor/bin/phpunit "$@" --testdox
 disable_xdebug

.ddev/commands/web/phpunit-coverage-local

@@ -5,5 +5,5 @@
 ## Example: ddev phpunit-coverage-local
 
 enable_xdebug
-XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-html build/coverage --testdox
+XDEBUG_MODE=coverage php vendor/bin/phpunit --coverage-html build/coverage "$@" --testdox
 disable_xdebug

.github/workflows/rector.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   rector:
-    name: Validation
+    name: Rector
     runs-on: [ubuntu-latest]
 
     steps:

app/code/core/Mage/Admin/Model/Block.php

@@ -37,7 +37,7 @@ protected function _construct()
     }
 
     /**
-     * @return array|bool
+     * @return array|true
      * @throws Exception
      * @throws Zend_Validate_Exception
      */

app/code/core/Mage/Admin/Model/User.php

@@ -364,7 +364,7 @@ public function getAclRole()
     }
 
     /**
-     * Authenticate user name and password and save loaded record
+     * Authenticate username and password and save loaded record
      *
      * @param string $username
      * @param string $password
@@ -384,7 +384,7 @@ public function authenticate($username, $password)
             $this->loadByUsername($username);
             $sensitive = ($config) ? $username == $this->getUsername() : true;
 
-            if ($sensitive && $this->getId() && Mage::helper('core')->validateHash($password, $this->getPassword())) {
+            if ($sensitive && $this->getId() && $this->validatePasswordHash($password, $this->getPassword())) {
                 if ($this->getIsActive() != '1') {
                     Mage::throwException(Mage::helper('adminhtml')->__('This account is inactive.'));
                 }
@@ -411,6 +411,11 @@ public function authenticate($username, $password)
         return $result;
     }
 
+    public function validatePasswordHash(string $string1, string $string2): bool
+    {
+        return Mage::helper('core')->validateHash($string1, $string2);
+    }
+
     /**
      * Login user
      *

app/code/core/Mage/Adminhtml/Block/Newsletter/Template/Edit.php

@@ -269,6 +269,7 @@ public function getJsTemplateName()
         if ($templateCode === null) {
             return '';
         }
+        // phpcs:ignore Ecg.Security.ForbiddenFunction.Found
         return addcslashes($this->escapeHtml($templateCode), "\"\r\n\\");
     }
 

app/code/core/Mage/Api2/Model/Route/ApiType.php

@@ -45,6 +45,7 @@ public function __construct(
         ?Zend_Translate $translator = null,
         $locale = null
     ) {
+        // phpcs:ignore Ecg.Security.ForbiddenFunction.Found
         parent::__construct([Mage_Api2_Model_Route_Abstract::PARAM_ROUTE => str_replace('.php', '', basename(getenv('SCRIPT_FILENAME'))) . '/:api_type']);
     }
 }

app/code/core/Mage/Bundle/Model/Product/Price.php

@@ -79,7 +79,6 @@ public function getTotalBundleItemsPrice($product, $qty = null)
                 $selectionIds = unserialize($customOption->getValue(), ['allowed_classes' => false]);
                 /** @var Mage_Bundle_Model_Product_Type $productType */
                 $productType = $product->getTypeInstance(true);
-                /** @var Mage_Bundle_Model_Resource_Selection_Collection $selections */
                 $selections = $productType->getSelectionsByIds($selectionIds, $product);
                 $selections->addTierPriceData();
                 Mage::dispatchEvent('prepare_catalog_product_collection_prices', [

app/code/core/Mage/Captcha/Helper/Data.php

@@ -62,7 +62,7 @@ public function isEnabled(): bool
      * Get Captcha
      *
      * @param string $formId
-     * @return Mage_Captcha_Model_Interface
+     * @return Mage_Captcha_Model_Zend
      */
     public function getCaptcha($formId)
     {
@@ -76,7 +76,7 @@ public function getCaptcha($formId)
     /**
      * Returns value of the node with respect to current area (frontend or backend)
      *
-     * @param string $id The last part of XML_PATH_$area_CAPTCHA_ constant (case insensitive)
+     * @param string $id The last part of XML_PATH_$area_CAPTCHA_ constant (case-insensitive)
      * @param Mage_Core_Model_Store $store
      * @return Mage_Core_Model_Config_Element
      */

app/code/core/Mage/Catalog/Helper/Data.php

@@ -44,7 +44,7 @@ class Mage_Catalog_Helper_Data extends Mage_Core_Helper_Abstract
     /**
      * Breadcrumb Path cache
      *
-     * @var string
+     * @var string|array<string, array<string, string|null>>
      */
     protected $_categoryPath;
 
@@ -236,7 +236,7 @@ public function isPriceGlobal()
     /**
      * Indicate whether to save URL Rewrite History or not (create redirects to old URLs)
      *
-     * @param int $storeId Store View
+     * @param null|string|bool|int|Mage_Core_Model_Store $storeId Store View
      * @return bool
      */
     public function shouldSaveUrlRewritesHistory($storeId = null)

app/code/core/Mage/Catalog/Model/Api/Resource.php

@@ -75,7 +75,7 @@ protected function _isAllowedAttribute($attribute, $attributes = null)
 
     /**
      * Retrieves store id from store code, if no store id specified,
-     * it use seted session or admin store
+     * it uses set session or admin store
      *
      * @param string|int $store
      * @return int

app/code/core/Mage/Catalog/Model/Category.php

@@ -441,14 +441,14 @@ public function getLayoutUpdateHandle()
     /**
      * Return store id.
      *
-     * If store id is underfined for category return current active store id
+     * If store id is undefined for category return current active store id
      *
      * @return int
      */
     public function getStoreId()
     {
         if ($this->hasData('store_id')) {
-            return $this->_getData('store_id');
+            return (int)$this->_getData('store_id');
         }
         return Mage::app()->getStore()->getId();
     }

app/code/core/Mage/Catalog/Model/Product.php

@@ -138,7 +138,7 @@
  * @method string getMetaDescription()
  * @method string getMetaKeyword()
  * @method string getMetaTitle()
- * @method $this hasMsrpEnabled(bool $value)
+ * @method $this hasMsrpEnabled()
  * @method bool getMsrpEnabled()
  * @method string getMsrpDisplayActualPriceType()
  *
@@ -365,7 +365,7 @@ protected function _initOldFieldsMap()
     public function getStoreId()
     {
         if ($this->hasData('store_id')) {
-            return $this->getData('store_id');
+            return (int)$this->getData('store_id');
         }
         return Mage::app()->getStore()->getId();
     }
@@ -417,7 +417,7 @@ public function validate()
     /**
      * Get product name
      *
-     * @return string
+     * @return string|null
      */
     public function getName()
     {
@@ -442,16 +442,18 @@ public function getPrice()
      * Set Price calculation flag
      *
      * @param bool $calculate
+     * @return $this
      */
     public function setPriceCalculation($calculate = true)
     {
         $this->_calculatePrice = $calculate;
+        return $this;
     }
 
     /**
      * Get product type identifier
      *
-     * @return string
+     * @return string|null
      */
     public function getTypeId()
     {
@@ -876,7 +878,7 @@ public function cleanCache()
     /**
      * Get product price model
      *
-     * @return Mage_Catalog_Model_Product_Type_Price|Mage_Bundle_Model_Product_Price
+     * @return Mage_Bundle_Model_Product_Price
      */
     public function getPriceModel()
     {

app/code/core/Mage/Catalog/Model/Resource/Category/Flat/Collection.php

@@ -237,16 +237,6 @@ public function addAttributeToSelect($attribute = '*')
         return $this;
     }
 
-    /**
-     * Retrieve resource instance
-     *
-     * @inheritDoc
-     */
-    public function getResource()
-    {
-        return parent::getResource();
-    }
-
     /**
      * Add attribute to sort order
      *
@@ -325,6 +315,7 @@ public function addPathsFilter($paths)
         $select = $this->getSelect();
         $cond   = [];
         foreach ($paths as $path) {
+            // phpcs:ignore Ecg.Sql.SlowQuery.SlowRawSql
             $cond[] = $this->getResource()->getReadConnection()->quoteInto('main_table.path LIKE ?', "$path%");
         }
         if ($cond) {

app/code/core/Mage/Catalog/Model/Resource/Category/Tree.php

@@ -93,7 +93,7 @@ public function __construct()
      */
     public function setStoreId($storeId)
     {
-        $this->_storeId = (int) $storeId;
+        $this->_storeId = $storeId;
         return $this;
     }
 
@@ -467,13 +467,15 @@ public function loadByIds($ids, $addCollectionData = true, $updateAnchorProductC
             ->where('entity_id IN (?)', $ids);
         $where = [$levelField . '=0' => true];
 
+        // phpcs:ignore Ecg.Performance.FetchAll.Found
         foreach ($this->_conn->fetchAll($select) as $item) {
             if (!preg_match("#^[0-9\/]+$#", $item['path'])) {
                 $item['path'] = '';
             }
             $pathIds  = explode('/', $item['path']);
             $level = (int)$item['level'];
             while ($level > 0) {
+                // phpcs:ignore Ecg.Performance.Loop.ArraySize
                 $pathIds[count($pathIds) - 1] = '%';
                 $path = implode('/', $pathIds);
                 $where["$levelField=$level AND $pathField LIKE '$path'"] = true;
@@ -493,6 +495,7 @@ public function loadByIds($ids, $addCollectionData = true, $updateAnchorProductC
         $select->where(implode(' OR ', $where));
 
         // get array of records and add them as nodes to the tree
+        // phpcs:ignore Ecg.Performance.FetchAll.Found
         $arrNodes = $this->_conn->fetchAll($select);
         if (!$arrNodes) {
             return false;
@@ -535,6 +538,7 @@ public function loadBreadcrumbsArray($path, $addCollectionData = true, $withRoot
             $select
                 ->where('e.entity_id IN(?)', $pathIds)
                 ->order($this->_conn->getLengthSql('e.path') . ' ' . Varien_Db_Select::SQL_ASC);
+            // phpcs:ignore Ecg.Performance.FetchAll.Found
             $result = $this->_conn->fetchAll($select);
             $this->_updateAnchorProductCount($result);
         }
@@ -623,6 +627,7 @@ protected function _createCollectionDataSelect($sorted = true, $optionalAttribut
                 ['COUNT(DISTINCT scp.product_id)']
             )
             ->where('see.entity_id = e.entity_id')
+            // phpcs:ignore Ecg.Sql.SlowQuery.SlowRawSql
             ->orWhere('see.path LIKE ?', $subConcat);
         $select->columns(['product_count' => $subSelect]);
 

app/code/core/Mage/Catalog/Model/Url.php

@@ -135,7 +135,7 @@ protected function _addCategoryUrlPath($category)
      * Retrieve stores array or store model
      *
      * @param int|null $storeId
-     * @return Mage_Core_Model_Store|array
+     * @return Mage_Core_Model_Store|Mage_Core_Model_Store[]
      */
     public function getStores($storeId = null)
     {
@@ -211,7 +211,7 @@ public function setShouldSaveRewritesHistory($flag)
     /**
      * Indicate whether to save URL Rewrite History or not (create redirects to old URLs)
      *
-     * @param int $storeId Store View
+     * @param null|string|bool|int|Mage_Core_Model_Store $storeId Store View
      * @return bool
      */
     public function getShouldSaveRewritesHistory($storeId = null)

app/code/core/Mage/Checkout/Model/Api/Resource.php

@@ -72,7 +72,7 @@ protected function _isQuoteExist($quoteId)
 
     /**
      * Retrieves store id from store code, if no store id specified,
-     * it use set session or admin store
+     * it uses set session or admin store
      *
      * @param string|int $store
      * @return int

app/code/core/Mage/Core/Helper/Data.php

@@ -331,7 +331,7 @@ public function getVersionHash(Mage_Core_Model_Encryption $encryptionModel)
     /**
      * Retrieve store identifier
      *
-     * @param   mixed $store
+     * @param   bool|int|Mage_Core_Model_Store|null|string $store
      * @return  int
      */
     public function getStoreId($store = null)
@@ -842,6 +842,7 @@ public function mergeFiles(
                     }
                     // phpcs:ignore Ecg.Security.ForbiddenFunction.Found
                     $contents = file_get_contents($file) . "\n";
+                    // phpcs:ignore Ecg.Security.ForbiddenFunction.Found
                     if ($beforeMergeCallback && is_callable($beforeMergeCallback)) {
                         // phpcs:ignore Ecg.Security.ForbiddenFunction.Found
                         $contents = call_user_func($beforeMergeCallback, $file, $contents);

app/code/core/Mage/Core/Helper/String.php

@@ -34,7 +34,7 @@ class Mage_Core_Helper_String extends Mage_Core_Helper_Abstract
      * Truncate a string to a certain length if necessary, appending the $etc string.
      * $remainder will contain the string that has been replaced with $etc.
      *
-     * @param string $string
+     * @param string|null $string
      * @param int $length
      * @param string $etc
      * @param string &$remainder
@@ -241,7 +241,7 @@ public function str_split($str, $length = 1, $keepWords = false, $trim = false,
     /**
      * Split words
      *
-     * @param string $str The source string
+     * @param string|null $str The source string
      * @param bool $uniqueOnly Unique words only
      * @param int $maxWordLength Limit words count
      * @param string $wordSeparatorRegexp
@@ -513,7 +513,7 @@ public function uniOrd($c)
 
     /**
      * UnSerialize string
-     * @param string $str
+     * @param string|null $str
      * @return mixed|null
      * @throws Exception
      */

app/code/core/Mage/Core/Model/Abstract.php

@@ -48,7 +48,7 @@ abstract class Mage_Core_Model_Abstract extends Varien_Object
     /**
      * Original data that was loaded
      *
-     * @var array
+     * @var array|null
      */
     protected $_origData;