Fix usages of invocation matcher for PHPUnit 7

Author: mikeymike

dev/tests/integration/framework/tests/unit/testsuite/Magento/Test/Event/TransactionTest.php

@@ -9,20 +9,22 @@
  */
 namespace Magento\Test\Event;
 
+use PHPUnit\Framework\MockObject\Matcher\Invocation;
+
 class TransactionTest extends \PHPUnit\Framework\TestCase
 {
     /**
-     * @var \Magento\TestFramework\Event\Transaction|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\TestFramework\Event\Transaction|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $_object;
 
     /**
-     * @var \Magento\TestFramework\EventManager|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\TestFramework\EventManager|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $_eventManager;
 
     /**
-     * @var \Magento\TestFramework\Db\Adapter\TransactionInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Magento\TestFramework\Db\Adapter\TransactionInterface|\PHPUnit\Framework\MockObject\MockObject
      */
     protected $_adapter;
 
@@ -69,9 +71,9 @@ protected function _imitateTransactionStartRequest($eventName)
     /**
      * Setup expectations for "transaction start" use case
      *
-     * @param \PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher
+     * @param Invocation $invocationMatcher
      */
-    protected function _expectTransactionStart(\PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher)
+    protected function _expectTransactionStart(Invocation $invocationMatcher)
     {
         $this->_eventManager->expects($invocationMatcher)->method('fireEvent')->with('startTransaction');
         $this->_adapter->expects($this->once())->method('beginTransaction');
@@ -103,9 +105,9 @@ protected function _imitateTransactionRollbackRequest($eventName)
     /**
      * Setup expectations for "transaction rollback" use case
      *
-     * @param \PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher
+     * @param Invocation $invocationMatcher
      */
-    protected function _expectTransactionRollback(\PHPUnit_Framework_MockObject_Matcher_Invocation $invocationMatcher)
+    protected function _expectTransactionRollback(Invocation $invocationMatcher)
     {
         $this->_eventManager->expects($invocationMatcher)->method('fireEvent')->with('rollbackTransaction');
         $this->_adapter->expects($this->once())->method('rollback');

lib/internal/Magento/Framework/TestFramework/Unit/Matcher/MethodInvokedAtIndex.php

@@ -6,10 +6,13 @@
 
 namespace Magento\Framework\TestFramework\Unit\Matcher;
 
+use PHPUnit\Framework\ExpectationFailedException;
+use PHPUnit\Framework\MockObject\Invocation;
+
 /**
  * Class MethodInvokedAtIndex
  * Matches invocations per 'method' at 'position'
- * Example:
+ * Example:§
  * $mock->expects(new MethodInvokedAtIndex(0))->method('getMethod')->willReturn(1);
  * $mock->expects(new MethodInvokedAtIndex(1))->method('getMethod')->willReturn(2);
  *
@@ -18,30 +21,82 @@
  *
  * @package Magento\TestFramework\Matcher
  */
-class MethodInvokedAtIndex extends \PHPUnit_Framework_MockObject_Matcher_InvokedAtIndex
+class MethodInvokedAtIndex implements \PHPUnit\Framework\MockObject\Matcher\Invocation
 {
     /**
      * @var array
      */
     protected $indexes = [];
 
     /**
-     * @param  \PHPUnit_Framework_MockObject_Invocation $invocation
+     * @var int
+     */
+    private $currentIndex = -1;
+
+    /**
+     * @var int
+     */
+    private $sequenceIndex;
+
+    /**
+     * @param int $sequenceIndex
+     */
+    public function __construct($sequenceIndex)
+    {
+        $this->sequenceIndex = $sequenceIndex;
+    }
+
+    /**
+     * @return string
+     */
+    public function toString(): string
+    {
+        return 'invoked at sequence index ' . $this->sequenceIndex;
+    }
+
+    /**
+     * @param  \PHPUnit\Framework\MockObject\Invocation $invocation
      * @return boolean
      */
-    public function matches(\PHPUnit_Framework_MockObject_Invocation $invocation)
+    public function matches(Invocation $invocation): bool
     {
         /** @noinspection PhpUndefinedFieldInspection */
-        if (!isset($this->indexes[$invocation->methodName])) {
+        if (!isset($this->indexes[$invocation->getMethodName()])) {
             /** @noinspection PhpUndefinedFieldInspection */
-            $this->indexes[$invocation->methodName] = 0;
+            $this->indexes[$invocation->getMethodName()] = 0;
         } else {
             /** @noinspection PhpUndefinedFieldInspection */
-            $this->indexes[$invocation->methodName]++;
+            $this->indexes[$invocation->getMethodName()]++;
         }
         $this->currentIndex++;
 
         /** @noinspection PhpUndefinedFieldInspection */
-        return $this->indexes[$invocation->methodName] == $this->sequenceIndex;
+        return $this->indexes[$invocation->getMethodName()] === $this->sequenceIndex;
+    }
+
+    /**
+     * Verifies that the current expectation is valid. If everything is OK the
+     * code should just return, if not it must throw an exception.
+     *
+     * @throws ExpectationFailedException
+     */
+    public function verify(): void
+    {
+        if ($this->currentIndex < $this->sequenceIndex) {
+            throw new ExpectationFailedException(
+                \sprintf(
+                    'The expected invocation at index %s was never reached.',
+                    $this->sequenceIndex
+                )
+            );
+        }
+    }
+
+    /**
+     * @param Invocation $invocation Object containing information on a mocked or stubbed method which was invoked
+     * @return mixed
+     */
+    public function invoked(Invocation $invocation)
+    {
     }
 }