AC-15498: PHPUnit 12 Upgrade | Added createInvocationMatcher() to MockCreationTrait

Author: manishranjan-adobe

app/code/Magento/Reports/Test/Unit/Model/ResourceModel/Order/CollectionTest.php

@@ -25,17 +25,19 @@
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
-use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\MockObject\Matcher\InvokedCount;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
-
+use PHPUnit\Framework\Attributes\DataProvider;
+use Magento\Framework\TestFramework\Unit\Helper\MockCreationTrait;
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class CollectionTest extends TestCase
 {
+    use MockCreationTrait;
+
     /**
      * @var Collection
      */
@@ -229,25 +231,19 @@ public function testCheckIsLive(): void
      * @param int $useAggregatedData
      * @param string $mainTable
      * @param int $isFilter
-     * @param InvokedCount $getIfNullSqlResult
+     * @param string $getIfNullSqlResult
      *
      * @return void
      */
     #[DataProvider('useAggregatedDataDataProvider')]
     public function testPrepareSummary($useAggregatedData, $mainTable, $isFilter, $getIfNullSqlResult): void
     {
-        // Convert string matcher to actual matcher
-        if ($getIfNullSqlResult === 'never') {
-            $getIfNullSqlResult = $this->never();
-        } elseif (str_starts_with($getIfNullSqlResult, 'exactly_')) {
-            $count = (int)str_replace('exactly_', '', $getIfNullSqlResult);
-            $getIfNullSqlResult = $this->exactly($count);
-        }
-        
         $range = '';
         $customStart = 1;
         $customEnd = 10;
 
+        $getIfNullSqlResult = $this->createInvocationMatcher($getIfNullSqlResult);
+
         $this->scopeConfigMock
             ->expects($this->once())
             ->method('getValue')
@@ -315,6 +311,7 @@ public function testGetDateRangeFirstPart($range, $customStart, $customEnd, $exp
     #[DataProvider('secondPartDateRangeDataProvider')]
     public function testGetDateRangeSecondPart($range, $customStart, $customEnd, $config, $expectedYear): void
     {
+
         $this->scopeConfigMock
             ->expects($this->once())
             ->method('getValue')
@@ -355,21 +352,15 @@ public function testAddItemCountExpr(): void
      * @param int $isFilter
      * @param int $useAggregatedData
      * @param string $mainTable
-     * @param InvokedCount $getIfNullSqlResult
+     * @param string $getIfNullSqlResult
      *
      * @return void
      */
     #[DataProvider('totalsDataProvider')]
     public function testCalculateTotals($isFilter, $useAggregatedData, $mainTable, $getIfNullSqlResult): void
     {
-        // Convert string matcher to actual matcher
-        if ($getIfNullSqlResult === 'never') {
-            $getIfNullSqlResult = $this->never();
-        } elseif (str_starts_with($getIfNullSqlResult, 'exactly_')) {
-            $count = (int)str_replace('exactly_', '', $getIfNullSqlResult);
-            $getIfNullSqlResult = $this->exactly($count);
-        }
-        
+        $getIfNullSqlResult = $this->createInvocationMatcher($getIfNullSqlResult);
+
         $this->scopeConfigMock
             ->expects($this->once())
             ->method('getValue')

lib/internal/Magento/Framework/TestFramework/Unit/Helper/MockCreationTrait.php

@@ -8,6 +8,7 @@
 namespace Magento\Framework\TestFramework\Unit\Helper;
 
 use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
 use ReflectionClass;
 
 /**
@@ -42,4 +43,90 @@ protected function createPartialMockWithReflection(string $className, array $met
         $mockBuilder->disableOriginalConstructor();
         return $mockBuilder->getMock();
     }
+
+    /**
+     * Convert a string matcher specification to a PHPUnit invocation matcher.
+     *
+     * This is useful in data providers where you cannot call PHPUnit matcher methods
+     * directly (since they are non-static). Instead, pass a string representation
+     * and convert it to the actual matcher in your test method.
+     *
+     * Supported string formats:
+     * - 'never'         → $this->never()
+     * - 'once'          → $this->once()
+     * - 'any'           → $this->any()
+     * - 'atLeastOnce'   → $this->atLeastOnce()
+     * - 'exactly_N'     → $this->exactly(N)     e.g., 'exactly_3'
+     * - 'atLeast_N'     → $this->atLeast(N)     e.g., 'atLeast_2'
+     * - 'atMost_N'      → $this->atMost(N)      e.g., 'atMost_5'
+     *
+     * @param string $matcherSpec The string specification of the matcher
+     * @return InvocationOrder The PHPUnit invocation matcher
+     * @throws \InvalidArgumentException If the matcher specification is not recognized
+     *
+     * @example
+     * // In data provider:
+     * public static function dataProvider(): array
+     * {
+     *     return [
+     *         ['methodName', 'returnValue', 'once'],
+     *         ['methodName', 'returnValue', 'exactly_3'],
+     *         ['methodName', 'returnValue', 'never'],
+     *     ];
+     * }
+     *
+     * // In test method:
+     * public function testMethod(string $method, string $returnValue, string $matcherSpec): void
+     * {
+     *     $matcher = $this->createInvocationMatcher($matcherSpec);
+     *     $mock->expects($matcher)->method($method)->willReturn($returnValue);
+     * }
+     */
+    protected function createInvocationMatcher(string $matcherSpec): InvocationOrder
+    {
+        // Handle simple string matchers
+        return match ($matcherSpec) {
+            'never' => $this->never(),
+            'once' => $this->once(),
+            'any' => $this->any(),
+            'atLeastOnce' => $this->atLeastOnce(),
+            default => $this->parseParameterizedMatcher($matcherSpec),
+        };
+    }
+
+    /**
+     * Parse parameterized matcher specifications like 'exactly_3', 'atLeast_2', 'atMost_5'.
+     *
+     * @param string $matcherSpec The parameterized matcher specification
+     * @return InvocationOrder
+     * @throws \InvalidArgumentException If the matcher specification is not recognized
+     */
+    private function parseParameterizedMatcher(string $matcherSpec): InvocationOrder
+    {
+        // Handle 'exactly_N' format
+        if (str_starts_with($matcherSpec, 'exactly_')) {
+            $count = (int)substr($matcherSpec, 8);
+            return $this->exactly($count);
+        }
+
+        // Handle 'atLeast_N' format
+        if (str_starts_with($matcherSpec, 'atLeast_')) {
+            $count = (int)substr($matcherSpec, 8);
+            return $this->atLeast($count);
+        }
+
+        // Handle 'atMost_N' format
+        if (str_starts_with($matcherSpec, 'atMost_')) {
+            $count = (int)substr($matcherSpec, 7);
+            return $this->atMost($count);
+        }
+
+        throw new \InvalidArgumentException(
+            sprintf(
+                'Unrecognized matcher specification: "%s". ' .
+                'Supported: never, once, any, atLeastOnce, exactly_N, atLeast_N, atMost_N',
+                $matcherSpec
+            )
+        );
+    }
 }