MockBuilder::setMethods is deprecated in PHPUnit8 and removed from PHPUnit10

We call setMethods() in many more places, so we should fix them all at once instead of just this one instance.

However, we don't even support PHPUnit 9 yet, and #3127141: Use PHPUnit 9 for PHP 7.4+, while keeping support for PHPUnit 8.4 in PHP 7.3 didn't seem to trigger this deprecation message either from what I can see.

Hi @longwave,

can we fixed Component-based: as an example of an aggregator module, it's a bit difficult to solve all (Modules) in a single patch.

@shaktik If we are fixing any deprecation improvement then why not pick all at once. module by module will increase no of issues as well as efforts.

Hi @Rkumar,

replace all deprecated method setMethods(), Kindly check

Hi @Rkumar,

replace all deprecated method setMethods(), Kindly check

Sorry .I am stuck in another task which will take more time so i am un-assign this issue .

fixing Test Case.

I tried my best and replaced almost all the instances but a few instances are still available which is not working after replacement, please check.

Reparenting, tagging, updating IS

Needs reroll.

Changed to MR workflow and rerolled.

Bumping to critical because as of PHPUnit 9.6 a Warning will be thrown and testing will fail if the conversion is not done or the Warning not silenced.

See milestone of https://github.com/sebastianbergmann/phpunit/issues/4775

Converted usage of ::setMethods() to either ::onlyMethods() or ::addMethods().

The usage of ::onlyMethods([]) smells like we do not need a mock, but I did not make changes, maybe follow-ups?

For instance, in ImageTest, this seems to work fine:

diff --git a/core/tests/Drupal/Tests/Core/Image/ImageTest.php b/core/tests/Drupal/Tests/Core/Image/ImageTest.php
index 30c37e9669..b2d9636129 100644
--- a/core/tests/Drupal/Tests/Core/Image/ImageTest.php
+++ b/core/tests/Drupal/Tests/Core/Image/ImageTest.php
@@ -210,10 +210,7 @@ public function testSave() {
       ->method('save')
       ->will($this->returnValue(TRUE));
 
-    $image = $this->getMockBuilder('Drupal\Core\Image\Image')
-      ->onlyMethods([])
-      ->setConstructorArgs([$toolkit, $this->image->getSource()])
-      ->getMock();
+    $image = new Image($toolkit, $this->image->getSource());
 
     $file_system = $this->prophesize(FileSystemInterface::class);
     $file_system->chmod($this->image->getSource())
@@ -255,10 +252,7 @@ public function testChmodFails() {
       ->method('save')
       ->will($this->returnValue(TRUE));
 
-    $image = $this->getMockBuilder('Drupal\Core\Image\Image')
-      ->onlyMethods([])
-      ->setConstructorArgs([$toolkit, $this->image->getSource()])
-      ->getMock();
+    $image = new Image($toolkit, $this->image->getSource());
 
     $file_system = $this->prophesize(FileSystemInterface::class);
     $file_system->chmod($this->image->getSource())

Should there not be a deprecation message test for the method setMethods()?

#35 not in Drupal, no. This is a PHPUnit deprecation, they should deal with it. Only thing when we have a PHPUnit release that will throw a Warning here (likely, 9.6.0), we can intercept that Warning and convert it to a deprecation via Drupal\Tests\Traits\PhpUnitWarnings.

All the changes look correct to me and review points by @daffie were addressed, nothing to add from me.

Agree that onlyMethods([]) is a smell, in most cases it looks like we are mocking the object under test e.g. where ForumNodeBreadcrumbBuilderTest creates a mock ForumNodeBreadcrumbBuilder. I think we should be using the real object in most if not all of these cases, so tagged "needs followup" to investigate this.

All code changes look good to me.
I have updated the IS.
I have installed the patch and I could not find any more use of the method setMethods() in core.
We cannot do anything for a deprecation warning, as there it not one added for it by the PHPUnit project.
For me it is RTBC.

Committed/pushed to 9.3.x and cherry-picked to 9.2.x, thanks!

Filed #3232714: Replace, in tests, mocks that do not configure doubles with their actual objects as a follow-up.

Hadn't actually done the 9.2.x cherry-pick when I wrote #40, then got distracted, and this doesn't cherry-pick cleanly, so re-opening for backport.

Rerolled for 9.2

Visually compared with diff -u <(curl https://git.drupalcode.org/project/drupal/-/merge_requests/1188.diff) <(curl https://www.drupal.org/files/issues/2021-09-15/3130606-44.patch), only fuzz in a couple of tests that meant it wouldn't apply directly.

Committed fbb8e86 and pushed to 9.2.x. Thanks!

Unfortunately this issue #3194768: The plugin system should only consider NULL context values to be empty to facilitate the use of otherwise FALSE values introduced the deprecated setMethods method. I'll open a new issue as the method was inserted after this issue was committed.

The new issue: #3250629: MockBuilder::setMethods is deprecated in PHPUnit8 and removed from PHPUnit10