Closes #4564

ChangeLog-10.0.md

@@ -41,6 +41,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * [#4397](https://github.com/sebastianbergmann/phpunit/issues/4397): Remove confusing parameter options for XML assertions
 * [#4531](https://github.com/sebastianbergmann/phpunit/pull/4531): Remove `--loader` option as well as `testSuiteLoaderClass` and `testSuiteLoaderFile` XML configuration settings
 * [#4536](https://github.com/sebastianbergmann/phpunit/issues/4536): Remove `assertFileNotIsWritable()`
+* [#4564](https://github.com/sebastianbergmann/phpunit/issues/4564): Deprecate `withConsecutive()`
 * [#4567](https://github.com/sebastianbergmann/phpunit/issues/4567): Deprecate support for generators in `assertCount()` and `Count` constraint
 * Removed the `PHPUnit\Runner\TestSuiteLoader` interface
 

src/Framework/MockObject/Builder/InvocationMocker.php

@@ -12,6 +12,7 @@
 use function array_map;
 use function array_merge;
 use function count;
+use function debug_backtrace;
 use function in_array;
 use function is_string;
 use function strtolower;
@@ -35,6 +36,7 @@
 use PHPUnit\Framework\MockObject\Stub\ReturnStub;
 use PHPUnit\Framework\MockObject\Stub\ReturnValueMap;
 use PHPUnit\Framework\MockObject\Stub\Stub;
+use PHPUnit\Framework\TestCase;
 use Throwable;
 
 /**
@@ -188,11 +190,27 @@ public function with(...$arguments): self
      * @throws MethodParametersAlreadyConfiguredException
      *
      * @return $this
+     *
+     * @deprecated https://github.com/sebastianbergmann/phpunit/issues/4564
      */
     public function withConsecutive(...$arguments): self
     {
         $this->ensureParametersCanBeConfigured();
 
+        $stack = debug_backtrace();
+
+        while (!empty($stack)) {
+            $frame = array_pop($stack);
+
+            if (isset($frame['object']) && $frame['object'] instanceof TestCase) {
+                $frame['object']->addWarning(
+                    'The withConsecutive() method has been deprecated. It will be removed in PHPUnit 11.'
+                );
+
+                break;
+            }
+        }
+
         $this->matcher->setParametersRule(new Rule\ConsecutiveParameters($arguments));
 
         return $this;

tests/unit/Framework/MockObject/Builder/InvocationMockerTest.php

@@ -52,20 +52,6 @@ public function testWillReturnWithMultipleValues(): void
         $this->assertEquals(3, $mock->foo());
     }
 
-    public function testWillReturnOnConsecutiveCalls(): void
-    {
-        $mock = $this->getMockBuilder(stdClass::class)
-            ->addMethods(['foo'])
-            ->getMock();
-
-        $mock->method('foo')
-             ->willReturnOnConsecutiveCalls(1, 2, 3);
-
-        $this->assertEquals(1, $mock->foo());
-        $this->assertEquals(2, $mock->foo());
-        $this->assertEquals(3, $mock->foo());
-    }
-
     public function testWillReturnByReference(): void
     {
         $mock = $this->getMockBuilder(stdClass::class)

tests/unit/Framework/MockObject/MockObjectTest.php

@@ -319,29 +319,6 @@ public function testStubbedReturnSelf(): void
         $this->assertEquals($mock, $mock->doSomething());
     }
 
-    public function testStubbedReturnOnConsecutiveCalls(): void
-    {
-        $mock = $this->getMockBuilder(AnInterface::class)
-                     ->getMock();
-
-        $mock->method('doSomething')
-             ->will($this->onConsecutiveCalls('a', 'b', 'c'));
-
-        $this->assertEquals('a', $mock->doSomething());
-        $this->assertEquals('b', $mock->doSomething());
-        $this->assertEquals('c', $mock->doSomething());
-
-        $mock = $this->getMockBuilder(AnInterface::class)
-                     ->getMock();
-
-        $mock->method('doSomething')
-             ->willReturnOnConsecutiveCalls('a', 'b', 'c');
-
-        $this->assertEquals('a', $mock->doSomething());
-        $this->assertEquals('b', $mock->doSomething());
-        $this->assertEquals('c', $mock->doSomething());
-    }
-
     public function testStaticMethodCallback(): void
     {
         $mock = $this->getMockBuilder(SomeClass::class)