AC-15182: PHPUnit 12 Upgrade | Refactoring helper classes

Author: manishranjan-adobe

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

@@ -8,7 +8,6 @@
 namespace Magento\Backend\Test\Unit\Helper;
 
 use Magento\Backend\Model\Auth\Session;
-use Magento\Framework\DataObject;
 use Magento\Framework\Session\Test\Unit\Helper\StorageTestHelper;
 use Magento\User\Model\User;
 
@@ -18,6 +17,11 @@
  * This helper extends the concrete Auth\Session class directly, providing a clean
  * way to add test-specific methods without using anonymous classes.
  * Extends Auth\Session to be compatible with type hints requiring that specific class.
+ *
+ * METHODS PROVIDED:
+ * - setUser() / getUser() - User management
+ * - setIsLoggedIn() / isLoggedIn() - Login state management
+ * - setSkipLoggingAction() - Logging control
  */
 class SessionTestHelper extends Session
 {
@@ -31,27 +35,11 @@ class SessionTestHelper extends Session
      */
     private $isLoggedIn = false;
 
-    /**
-     * @var DataObject|null
-     */
-    private $sessionData = null;
-    
-    /**
-     * @var mixed
-     */
-    private $skipLoggingAction = null;
-    
-    /**
-     * @var callable|null
-     */
-    private $isLoggedInCallback = null;
-    
-    public function __construct(?DataObject $sessionData = null)
+    public function __construct()
     {
         // Skip parent constructor for testing
         // Initialize storage with the StorageTestHelper
         $this->storage = new StorageTestHelper();
-        $this->sessionData = $sessionData;
     }
 
     /**
@@ -77,46 +65,6 @@ public function setUser($user)
         return $this;
     }
 
-    /**
-     * Set data
-     *
-     * @param string|array $key
-     * @param mixed $value
-     * @return $this
-     */
-    public function setData($key, $value = null)
-    {
-        if ($this->sessionData) {
-            $this->sessionData->setData($key, $value);
-        }
-        return $this;
-    }
-    
-    /**
-     * Get data
-     *
-     * @param string $key
-     * @param mixed $index
-     * @return mixed
-     */
-    public function getData($key = '', $index = null)
-    {
-        if ($this->sessionData) {
-            return $this->sessionData->getData($key, $index);
-        }
-        return null;
-    }
-    
-    /**
-     * Get skip logging action
-     *
-     * @return mixed
-     */
-    public function getSkipLoggingAction()
-    {
-        return $this->skipLoggingAction;
-    }
-    
     /**
      * Set skip logging action
      *
@@ -125,32 +73,20 @@ public function getSkipLoggingAction()
      */
     public function setSkipLoggingAction($value)
     {
-        $this->skipLoggingAction = $value;
+        // Store in parent's storage using magic method (via StorageTestHelper::__call)
+        // phpcs:ignore Magento2.Functions.StaticFunction
+        /** @phpstan-ignore-next-line - StorageTestHelper::__call handles dynamic methods */
+        $this->storage->setSkipLoggingAction($value);
         return $this;
     }
 
     /**
-     * Set is logged in callback
-     *
-     * @param callable $callback
-     * @return $this
-     */
-    public function setIsLoggedInCallback($callback)
-    {
-        $this->isLoggedInCallback = $callback;
-        return $this;
-    }
-    
-    /**
-     * Override isLoggedIn to use callback if set
+     * Check if user is logged in
      *
      * @return bool
      */
     public function isLoggedIn()
     {
-        if ($this->isLoggedInCallback) {
-            return call_user_func($this->isLoggedInCallback);
-        }
         return $this->isLoggedIn;
     }
 
@@ -165,16 +101,4 @@ public function setIsLoggedIn($value)
         $this->isLoggedIn = $value;
         return $this;
     }
-
-    /**
-     * Set URL notice flag
-     *
-     * @param bool $flag
-     * @return $this
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    public function setIsUrlNotice($flag)
-    {
-        return $this;
-    }
 }

app/code/Magento/Catalog/Test/Unit/Helper/ProductInterfaceTestHelper.php

@@ -13,28 +13,14 @@
  * Test helper for Magento\Catalog\Model\Product
  *
  * This helper provides custom logic that cannot be achieved with standard PHPUnit mocks:
- * 1. isObjectNew() with call counter - tracks how many times the method is called
- * 2. isRecurring() custom flag - not available in parent Product class
+ * 1. Constructor that accepts cost parameter - used by TotalsTest
+ * 2. getCost() method - called by production code in NegotiableQuote/Model/Quote/Totals
+ * 3. hasOptions() method - mocked by SkuTest to control option behavior
  *
- * All other methods are inherited from the parent Product class or work via DataObject magic methods.
+ * Other methods (setIsObjectNew, isObjectNew) are inherited from AbstractModel.
  */
 class ProductTestHelper extends Product
 {
-    /**
-     * @var bool
-     */
-    private $isObjectNew = false;
-
-    /**
-     * @var bool
-     */
-    private $isRecurring = false;
-
-    /**
-     * @var int
-     */
-    private $isObjectNewCallCount = 0;
-
     /**
      * @var float
      */
@@ -54,94 +40,21 @@ public function __construct($cost = 0.0)
     /**
      * Set is object new
      *
+     * Convenience wrapper for parent's isObjectNew($flag) method.
+     *
      * @param bool $flag
      * @return $this
      */
     public function setIsObjectNew($flag)
     {
-        $this->isObjectNew = $flag;
+        parent::isObjectNew($flag);
         return $this;
     }
 
     /**
-     * Is object new with call counter
+     * Check if product has options
      *
-     * Custom logic: Tracks how many times this method is called
-     *
-     * @param bool|null $flag
-     * @return bool
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
-     */
-    public function isObjectNew($flag = null)
-    {
-        $this->isObjectNewCallCount++;
-        return $this->isObjectNew;
-    }
-
-    /**
-     * Get is object new call count
-     *
-     * Custom logic: Returns the number of times isObjectNew() was called
-     *
-     * @return int
-     */
-    public function getIsObjectNewCallCount()
-    {
-        return $this->isObjectNewCallCount;
-    }
-
-    /**
-     * Reset is object new call count
-     *
-     * Custom logic: Resets the call counter
-     *
-     * @return $this
-     */
-    public function resetIsObjectNewCallCount()
-    {
-        $this->isObjectNewCallCount = 0;
-        return $this;
-    }
-
-    /**
-     * Set is recurring
-     *
-     * Custom logic: Sets custom recurring flag (not available in parent)
-     *
-     * @param bool $value
-     * @return $this
-     */
-    public function setIsRecurring($value)
-    {
-        $this->isRecurring = $value;
-        return $this;
-    }
-
-    /**
-     * Is recurring
-     *
-     * Custom logic: Returns custom recurring flag
-     *
-     * @return bool
-     */
-    public function isRecurring()
-    {
-        return $this->isRecurring;
-    }
-
-    /**
-     * Get is recurring (alias for compatibility)
-     *
-     * @return bool
-     * @SuppressWarnings(PHPMD.BooleanGetMethodName)
-     */
-    public function getIsRecurring()
-    {
-        return $this->isRecurring();
-    }
-
-    /**
-     * Check if product has options.
+     * This method is mocked by tests to control option behavior.
      *
      * @return bool
      */