AC-15503: PHPUnit 12: Upgrade Advanced, Tax & Integration related test cases

Author: DeepaAdobe

app/code/Magento/Integration/Test/Unit/Model/Config/Consolidated/_files/integration.xml

@@ -5,8 +5,7 @@
  * All Rights Reserved.
  */
 -->
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Integration:etc/integration/integration.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Integration:etc/integration/integration.xsd">
     <integration name="TestIntegration1">
         <email>[email protected]</email>
         <endpoint_url>http://endpoint.com</endpoint_url>

app/code/Magento/Integration/Test/Unit/Model/ResourceModel/Oauth/ConsumerTest.php

@@ -7,6 +7,7 @@
 
 namespace Magento\Integration\Test\Unit\Model\ResourceModel\Oauth;
 
+use \Magento\Integration\Model\ResourceModel\Oauth\Consumer as ConsumerResourceModel;
 use Magento\Framework\App\ObjectManager as AppObjectManager;
 use Magento\Framework\App\ResourceConnection;
 use Magento\Framework\DB\Adapter\AdapterInterface;
@@ -21,7 +22,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * Unit test for \Magento\Integration\Model\ResourceModel\Oauth\Consumer
+ * Unit test for ConsumerResourceModel
  */
 class ConsumerTest extends TestCase
 {
@@ -43,7 +44,7 @@ class ConsumerTest extends TestCase
     protected $consumerMock;
 
     /**
-     * @var \Magento\Integration\Model\ResourceModel\Oauth\Consumer
+     * @var ConsumerResourceModel
      */
     protected $consumerResource;
 
@@ -66,7 +67,7 @@ protected function setUp(): void
         $objectManagerMock = $this->createMock(ObjectManagerInterface::class);
         AppObjectManager::setInstance($objectManagerMock);
 
-        $this->consumerResource = new \Magento\Integration\Model\ResourceModel\Oauth\Consumer(
+        $this->consumerResource = new ConsumerResourceModel(
             $contextMock,
             new DateTime()
         );
@@ -76,7 +77,7 @@ public function testAfterDelete(): void
     {
         $this->connectionMock->expects($this->exactly(2))->method('delete');
         $this->assertInstanceOf(
-            \Magento\Integration\Model\ResourceModel\Oauth\Consumer::class,
+            ConsumerResourceModel::class,
             $this->consumerResource->_afterDelete($this->consumerMock)
         );
     }

app/code/Magento/Tax/Test/Unit/Model/Calculation/CalculatorFactoryTest.php

@@ -14,7 +14,6 @@
 use Magento\Tax\Model\Calculation\CalculatorFactory;
 use Magento\Tax\Model\Calculation\RowBaseCalculator;
 use Magento\Tax\Model\Calculation\TotalBaseCalculator;
-
 use Magento\Tax\Model\Calculation\UnitBaseCalculator;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
@@ -126,7 +125,7 @@ public function testCreate(
 
     protected function getMockForAddress()
     {
-        $address = $this->createMock(\Magento\Customer\Api\Data\AddressInterface::class);
+        $address = $this->createMock(CustomerAddress::class);
 
         return $address;
     }

app/code/Magento/Tax/Test/Unit/Model/TaxClass/Source/CustomerTest.php

@@ -25,7 +25,7 @@
 
 class CustomerTest extends TestCase
 {
-    use MockCreationTrait;
+    // use MockCreationTrait;
 
     /**
      * @var TaxClassRepositoryInterface|MockObject

app/code/Magento/Tax/Test/Unit/Observer/GetPriceConfigurationObserverTest.php

@@ -8,6 +8,7 @@
 namespace Magento\Tax\Test\Unit\Observer;
 
 use Magento\Bundle\Model\ResourceModel\Selection\Collection;
+use Magento\Bundle\Model\Product\Type as BundleProductType;
 use Magento\Catalog\Model\Product;
 use Magento\Catalog\Model\Product\Type;
 use Magento\Catalog\Pricing\Price\BasePrice;
@@ -130,7 +131,7 @@ public function testExecute(array $testArray, array $expectedArray): void
         );
 
         $product = $this->createPartialMockWithReflection(
-            \Magento\Bundle\Model\Product\Type::class,
+            BundleProductType::class,
             ['getTypeInstance', 'getTypeId', 'getStoreId', 'getId', 'getSelectionsCollection']
         );
         $product->expects($this->any())

app/code/Magento/Tax/Test/Unit/Ui/DataProvider/Product/Listing/Collector/TaxTest.php

@@ -17,67 +17,84 @@
 use Magento\Catalog\Pricing\Price\FinalPrice;
 use Magento\Framework\Pricing\Amount\AmountInterface;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
+use Magento\Framework\Pricing\PriceInfoInterface as FrameworkPriceInfoInterface;
 use Magento\Framework\TestFramework\Unit\Helper\MockCreationTrait;
 use Magento\Tax\Ui\DataProvider\Product\Listing\Collector\Tax;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * Unit test for Tax collector
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class TaxTest extends TestCase
 {
     use MockCreationTrait;
 
     /**
      * @var Tax
      */
-    protected $model;
+    private Tax $model;
 
     /**
      * @var PriceCurrencyInterface|MockObject
      */
-    protected $priceCurrencyMock;
+    private MockObject $priceCurrencyMock;
 
     /**
      * @var PriceInfoInterface|MockObject
      */
-    private $priceMock;
+    private MockObject $renderPriceInfoMock;
 
     /**
      * @var PriceInfoInterfaceFactory|MockObject
      */
-    private $priceInfoFactory;
+    private MockObject $priceInfoFactory;
 
     /**
      * @var PriceInfoExtensionInterface|MockObject
      */
-    private $extensionAttributes;
+    private MockObject $extensionAttributes;
 
     /**
      * @var PriceInfoExtensionInterfaceFactory|MockObject
      */
-    private $priceInfoExtensionFactory;
+    private MockObject $priceInfoExtensionFactory;
 
     /**
      * @var FormattedPriceInfoBuilder|MockObject
      */
-    private $formattedPriceInfoBuilder;
+    private MockObject $formattedPriceInfoBuilder;
+
+    /**
+     * @var FrameworkPriceInfoInterface|MockObject
+     */
+    private MockObject $frameworkPriceInfoMock;
 
     protected function setUp(): void
     {
         $this->priceCurrencyMock = $this->createMock(PriceCurrencyInterface::class);
 
-        // PriceInfoInterface: The test needs to mock getPrice() which doesn't exist in the interface
-        // This is a test design issue - ideally should mock a concrete implementation
-        // Workaround: Using getMockBuilder()->getMock() which allows any method configuration in PHPUnit 12
-        $this->priceMock = $this->getMockBuilder(PriceInfoInterface::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        // Note: PriceInfoExtensionInterface is a generated extension attribute interface
-        // Using createMock would fail as the interface doesn't exist until DI compilation
-        // Keeping original approach but migrated to PHPUnit 12
-        $this->extensionAttributes = $this->getMockBuilder(PriceInfoExtensionInterface::class)
-            ->disableOriginalConstructor()
-            ->getMock();
+        // PriceInfoInterface (Catalog API) - used for product render DTO
+        $this->renderPriceInfoMock = $this->createMock(PriceInfoInterface::class);
+
+        // PriceInfoExtensionInterface is a generated extension attribute interface
+        // All interface methods must be included when using createPartialMockWithReflection
+        $this->extensionAttributes = $this->createPartialMockWithReflection(
+            PriceInfoExtensionInterface::class,
+            [
+                // All interface methods from generated interface
+                'getMsrp',
+                'setMsrp',
+                'getTaxAdjustments',
+                'setTaxAdjustments',
+                'getWeeeAttributes',
+                'setWeeeAttributes',
+                'getWeeeAdjustment',
+                'setWeeeAdjustment'
+            ]
+        );
 
         $this->priceInfoFactory = $this->getMockBuilder(PriceInfoInterfaceFactory::class)
             ->disableOriginalConstructor()
@@ -88,9 +105,11 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->onlyMethods(['create'])
             ->getMock();
-        $this->formattedPriceInfoBuilder = $this->getMockBuilder(FormattedPriceInfoBuilder::class)
-            ->disableOriginalConstructor()
-            ->getMock();
+
+        $this->formattedPriceInfoBuilder = $this->createMock(FormattedPriceInfoBuilder::class);
+
+        // Framework PriceInfoInterface - has getPrice() method, returned by Product::getPriceInfo()
+        $this->frameworkPriceInfoMock = $this->createMock(FrameworkPriceInfoInterface::class);
 
         $this->model = new Tax(
             $this->priceCurrencyMock,
@@ -101,79 +120,119 @@ protected function setUp(): void
     }
 
     /**
+     * Test collect method
+     *
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function testCollect(): void
     {
-        $this->markTestSkipped(
-            'Test requires mocking getPrice() method which does not exist in PriceInfoInterface. ' .
-            'PHPUnit 12 removed addMethods() and getMockForAbstractClass() methods, ' .
-            'making it impossible to mock non-existent methods without test refactoring. ' .
-            'This test needs to be refactored to mock a concrete implementation that has getPrice() method.'
-        );
-
         $amountValue = 10;
         $minAmountValue = 5;
         $storeId = 1;
         $currencyCode = 'usd';
 
         $productMock = $this->createMock(Product::class);
         $productRender = $this->createMock(ProductRenderInterface::class);
-        $price = $this->createMock(FinalPrice::class);
-        // PriceInfoInterface: Using the mock already created in setUp() instead of creating a new one
-        // This avoids the issue of mocking getPrice() which doesn't exist in the interface
-        $priceInfo = $this->priceMock;
+        $finalPrice = $this->createMock(FinalPrice::class);
+        $regularPrice = $this->createMock(FinalPrice::class);
         $amount = $this->createMock(AmountInterface::class);
         $minAmount = $this->createMock(AmountInterface::class);
+        $maxAmount = $this->createMock(AmountInterface::class);
 
-        $priceInfo->expects($this->exactly(4))
-            ->method('getPrice')
-            ->willReturn($price);
-        $this->priceInfoFactory->expects($this->once())
-            ->method('create')
-            ->willReturn($priceInfo);
-        $productRender->expects($this->once())
-            ->method('getPriceInfo')
-            ->willReturn($priceInfo);
+        // Product::getPriceInfo() returns Framework's PriceInfoInterface (has getPrice())
         $productMock->expects($this->any())
             ->method('getPriceInfo')
-            ->willReturn($priceInfo);
-        $priceInfo->expects($this->once())
-            ->method('getExtensionAttributes')
-            ->willReturn($this->extensionAttributes);
-        $priceInfo->expects($this->atLeastOnce())
-            ->method('getPrice')
-            ->willReturn($price);
-
-        $price->expects($this->once())
-            ->method('getMaximalPrice')
+            ->willReturn($this->frameworkPriceInfoMock);
+
+        // Framework PriceInfo's getPrice() returns price objects
+        $this->frameworkPriceInfoMock->method('getPrice')
+            ->willReturnCallback(function ($priceCode) use ($finalPrice, $regularPrice) {
+                if ($priceCode === 'final_price') {
+                    return $finalPrice;
+                }
+                if ($priceCode === 'regular_price') {
+                    return $regularPrice;
+                }
+                return $finalPrice;
+            });
+
+        // Setup price amounts
+        $finalPrice->expects($this->atLeastOnce())
+            ->method('getAmount')
             ->willReturn($amount);
-        $price->expects($this->once())
+        $finalPrice->expects($this->once())
+            ->method('getMaximalPrice')
+            ->willReturn($maxAmount);
+        $finalPrice->expects($this->once())
             ->method('getMinimalPrice')
             ->willReturn($minAmount);
-        $price->expects($this->exactly(2))
+
+        $regularPrice->expects($this->once())
             ->method('getAmount')
             ->willReturn($amount);
-        $amount->expects($this->exactly(3))
+
+        $amount->expects($this->atLeastOnce())
             ->method('getValue')
+            ->with(['tax', 'weee'])
             ->willReturn($amountValue);
+
+        $maxAmount->expects($this->once())
+            ->method('getValue')
+            ->with(['tax', 'weee'])
+            ->willReturn($amountValue);
+
         $minAmount->expects($this->once())
             ->method('getValue')
+            ->with(['tax', 'weee'])
             ->willReturn($minAmountValue);
+
+        // ProductRender::getPriceInfo() returns Catalog API's PriceInfoInterface (DTO)
+        $productRender->expects($this->once())
+            ->method('getPriceInfo')
+            ->willReturn($this->renderPriceInfoMock);
+
+        // PriceInfo factory creates new PriceInfo DTOs
+        $newPriceInfo = $this->createMock(PriceInfoInterface::class);
+        $this->priceInfoFactory->expects($this->once())
+            ->method('create')
+            ->willReturn($newPriceInfo);
+
+        // Setup extension attributes
+        $this->renderPriceInfoMock->expects($this->once())
+            ->method('getExtensionAttributes')
+            ->willReturn($this->extensionAttributes);
+
+        // Extension attributes setTaxAdjustments is called
+        $this->extensionAttributes->expects($this->once())
+            ->method('setTaxAdjustments')
+            ->with($newPriceInfo);
+
+        // Setup price info setters on new DTO
+        $newPriceInfo->expects($this->once())->method('setFinalPrice')->with($amountValue);
+        $newPriceInfo->expects($this->once())->method('setMaxPrice')->with($amountValue);
+        $newPriceInfo->expects($this->once())->method('setMinimalPrice')->with($minAmountValue);
+        $newPriceInfo->expects($this->once())->method('setSpecialPrice');
+        $newPriceInfo->expects($this->once())->method('setRegularPrice')->with($amountValue);
+        $newPriceInfo->method('getFinalPrice')->willReturn($amountValue);
+
+        $this->renderPriceInfoMock->expects($this->once())
+            ->method('setExtensionAttributes')
+            ->with($this->extensionAttributes);
+
         $productRender->expects($this->once())
             ->method('setPriceInfo')
-            ->with($priceInfo);
+            ->with($this->renderPriceInfoMock);
 
         $productRender->expects($this->once())
             ->method('getStoreId')
-            ->willReturn(1);
+            ->willReturn($storeId);
         $productRender->expects($this->once())
             ->method('getCurrencyCode')
             ->willReturn($currencyCode);
 
         $this->formattedPriceInfoBuilder->expects($this->once())
             ->method('build')
-            ->with($priceInfo, $storeId, $currencyCode);
+            ->with($newPriceInfo, $storeId, $currencyCode);
 
         $this->model->collect($productMock, $productRender);
     }