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/Session/
  • core/tests/Drupal/Tests/Core/State/
  • core/tests/Drupal/Tests/Core/TempStore/
  • core/tests/Drupal/Tests/Core/Template/
  • core/tests/Drupal/Tests/Core/Recipe/
  • core/tests/Drupal/Tests/Core/Transliteration/
  • core/tests/Drupal/Tests/Core/TypedData/

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3579868

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 !15120

dcam’s picture

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

dcam commented
Title: Convert expectation-less test mocks to stubs - batch 8 » Convert expectation-less test mocks to stubs - Session, State, TempStore, Template, Recipe, Transliteration, TypedData
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

Session = OK (134 tests, 275 assertions)
State = OK (17 tests, 107 assertions)
TempStore = OK (20 tests, 125 assertions)
Template = OK (107 tests, 212 assertions)
Recipe = OK (47 tests, 89 assertions)
Transliteration = OK (3 tests, 3 assertions)
TypedData = OK (15 tests, 40 assertions)

All deprecations are taken care of. All instances of any() replaced.

catch’s picture

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

All looks good. PHPStan baseline conflicted, but regenerated that locally prior to commit.

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.

catch closed merge request !15120

  • catch committed 0998f9fe on main 
    task: #3579868 Convert expectation-less test mocks to stubs - Session,...

Status: Fixed » Closed (fixed)

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