Problem/Motivation

PHPUnit 12.5.0+ is changing the way that mock objects work:

  • Mock objects that do not configure expectations should be converted to stubs. Otherwise, they throw a notice: No expectations were configured for the mock object for \Drupal\comment\CommentManagerInterface. You should refactor your test code and use a test stub instead.
  • $this->any() is deprecated. It was equivalent to having no expectation, in which case the object should be a stub (see the previous bullet) or a more exact number of expectations should be added.
  • with() is deprecated for stubs because it was deemed to be equally pointless.

Steps to reproduce

  1. Require PHPUnit 12 with Composer.
  2. Fix compatibility issues with PHPUnit 12 by applying this patch.
  3. Run the Unit tests for a library with --display-phpunit-notices --display-phpunit-deprecations.
  4. Observe the PHPUnit notices that occur.

Proposed resolution

Fix notices in the tests for the following core libraries, which currently only represents 10 affected classes.

  • core/tests/Drupal/Tests/Core/Display/
  • core/tests/Drupal/Tests/Core/Extension/
  • core/tests/Drupal/Tests/Core/Field/
  • core/tests/Drupal/Tests/Core/File/
  • core/tests/Drupal/Tests/Core/Flood/
  • core/tests/Drupal/Tests/Core/Htmx/
  • core/tests/Drupal/Tests/Core/Http/
  • core/tests/Drupal/Tests/Core/Language/

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3579856

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

dcam created an issue. See original summary.

dcam opened merge request !15115

dcam’s picture

dcam commented
Status: Active » Needs review
smustgrave’s picture

smustgrave commented

I got to extension and still hit 13 notices but leaving in review.

dcam’s picture

dcam commented

Thank you again for pointing them out. I'm going to be better about noting the notices covered by other MRs.

The mentioned notices are covered by #3578904: Convert expectation-less test mocks to stubs - UnitTestCase. When I run the tests without the #3578904 changes I get 17 notices from these tests. When I apply the MR from #3578904 I get 0.

dcam’s picture

dcam commented
Title: Convert expectation-less test mocks to stubs - batch 5 » Convert expectation-less test mocks to stubs - Display, Extension, Field, File, Flood, HTMX, HTTP, Language
dcam’s picture

dcam commented

FYI: the recently-committed UnitTestCase changes have been merged into this MR, so they do not need to be applied separately for testing.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Ran all these and 0 notices are left. Extension has 3 skipped but that was the case before I believe.

catch closed merge request !15115

  • catch committed e32e82c3 on main 
    task: #3579856 Convert expectation-less test mocks to stubs - Display,...
catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

phpstan baseline had commit conflicts, but I went ahead and regenerated it locally. Committed/pushed to main, thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.