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 module with --display-phpunit-notices --display-phpunit-deprecations.
  4. Observe the PHPUnit notices that occur.

Proposed resolution

This issue will fix mocks in a number of Core modules where only a single class was affected per module. These include:

  • announcements_feed
  • big_pipe
  • breakpoint
  • ckeditor5
  • content_moderation
  • datetime
  • jsonapi
  • menu_link_content
  • mysql
  • navigation
  • responsive_image
  • shortcut
  • sqlite
  • workspaces

Remaining tasks

Information on how to review these issues and the types of changes you're likely to find in them is included in the parent issue's comments.

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3567121

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:

Comments

dcam created an issue. See original summary.

dcam’s picture

Status: Active » Needs review

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.

dcam’s picture

Issue summary: View changes
smustgrave’s picture

Status: Needs review » Needs work

Appears to need a rebase

dcam’s picture

Status: Needs work » Needs review

Rebased

dcam’s picture

Issue summary: View changes

I removed changes to ban and history from the MR since they've been split off to contrib.

dcam’s picture

Status: Needs review » Needs work

Needs work due to PHPUnit 12.5.11 and a new deprecation.
The deprecations are in responsive_image.

dcam’s picture

Issue summary: View changes
Status: Needs work » Needs review

New development: stubs cannot set with(). The IS and MR have been updated.

dcam’s picture

Issue summary: View changes
smustgrave’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Needs Review Queue Initiative

Reviewed this like the others

Uses of any() appear to be replaced. Checking stub vs mock and the ones replaced make sense (leaning on the other tickets for this check)
And results are still green.

LGTM

catch’s picture

Status: Reviewed & tested by the community » Needs work

Needs a rebase.

smustgrave’s picture

Status: Needs work » Reviewed & tested by the community

Rebased for @dcam. Issue was core/modules/datetime/tests/src/Unit/Plugin/migrate/field/DateFieldTest.php which was deleted when migrate drupal was removed.

  • catch committed 785945f2 on main
    task: #3567121 Convert expectation-less test mocks to stubs - batch 1...
catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed/pushed to main, thanks!

This doesn't cherry-pick cleanly to 11.x so leaving it in just main.

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.