Support doubling `readonly` classes #5804

sebastianbergmann · 2024-04-07T13:09:48Z

Refactor test double runtime to hold state in readonly properties
Allow readonly classes to be doubled
Investigate failing test for cloning of test doubles
Emit error when clone is used on the test double for a readonly class on PHP 8.2
Test doubling of readonly classes

codecov · 2024-04-09T05:51:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.13%. Comparing base (e91fafb) to head (b53b04c).

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5804      +/-   ##
============================================
+ Coverage     90.11%   90.13%   +0.01%     
- Complexity     6616     6630      +14     
============================================
  Files           697      697              
  Lines         20008    20026      +18     
============================================
+ Hits          18031    18051      +20     
+ Misses         1977     1975       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

sebastianbergmann · 2024-04-09T05:55:59Z

I was able to implement support for doubling readonly classes.

However, this implementation breaks support for cloning test double objects on PHP 8.2 using clone, regardless of whether they were created based on an extendable class, an extendable readonly class, or an interface. With PHP >= 8.3, cloning test double objects continues to work.

I cannot be sure, but I assume that cloning test double objects is not commonly done and that this breakage is acceptable. The current state of this PR reflects this.

Alternatively, we could delay support for doubling readonly classes until PHPUnit 12 which will require PHP 8.3. This way, PHPUnit 11 would not break existing behaviour for PHP 8.2. Of course, it would delay support for doubling readonly classes even more.

…nvocationHandler()

…operty

…HP 8.2

sebastianbergmann · 2024-04-10T16:07:43Z

I may have found a solution to the problem explained in #5804 (comment).

With the current state of this PR, using clone on test doubles for classes that are not declared readonly continues to work with PHP 8.2.

Using clone on test doubles for classes that are declared readonly will not work with PHP 8.2, but this is not a regression as doubling classes that are declared readonly was not supported before.

Using clone on test doubles for classes that are declared readonly works on PHP >= 8.3.

…rting

…is not supported on PHP 8.2

…mutually exclusive

…n PHP 8.2

PHPUnit refactored the double creation to support doubling readonly classes [1], thus breaking classes where the class constructor is called with constructor arguments, but calling itself a class method which is mocked using the `onlyMethods()` setup option. This leads now to some internal state setup issue and is reported as `regression` [2] providing steps to reproduce it. This change adds `phpunit 11.2.0` as conflict to the monorepo version to avoid using it in nightly tests for now, until a proper regression fix has been implemented in phpunit. Used command(s): \ cat \ <<< $(jq --indent 1 --tab \ '."conflict" += {"phpunit/phpunit": "11.2.0"}' \ composer.json) > composer.json \ && Build/Scripts/runTests.sh -s composer -- update --lock [1] sebastianbergmann/phpunit#5804 [2] sebastianbergmann/phpunit#5857 Resolves: #104007 Releases: main Change-Id: Ia384ff98a9ea4e318738a48bd9ff8afcc4faff15 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84533 Reviewed-by: Anja Leichsenring <[email protected]> Reviewed-by: Simon Schaufelberger <[email protected]> Tested-by: Anja Leichsenring <[email protected]> Tested-by: core-ci <[email protected]> Reviewed-by: Stefan Bürk <[email protected]> Tested-by: Simon Schaufelberger <[email protected]> Tested-by: Stefan Bürk <[email protected]>

PHPUnit changed the way how double creation is handled internally and now emits an exception if a manually defined `mock class name` should be registered. In some places within the unit tests, manual mock class names have been used, because the names are needed for cross referencing at a later point. For this, different approaches have been used, for example hardcoded MD5 hashes as strings or creating hashes of static values like `md5('1')`, and also reused hashes in different places or in tests using data providers. This now leads to an exception: PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException The name "b70551b2b2db62b6b15a9bbfcbd50614" is already in use This change mitigates the issue by using `StringUtility::getUniqueId('somePrefix')` as is already done in other places. As a sideeffect, four phpstan baseline entries can be removed. Used command(s): Build/Scripts/runTests.sh -s phpstanGenerateBaseline [1] sebastianbergmann/phpunit#5804 Resolves: #104005 Releases: main, 12.4 Change-Id: Icc558844275c9ae9f67a0e7c20daa318f5ad6b41 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84530 Reviewed-by: Christian Kuhn <[email protected]> Tested-by: core-ci <[email protected]> Tested-by: Christian Kuhn <[email protected]> Tested-by: Andreas Wolf <[email protected]> Reviewed-by: Andreas Wolf <[email protected]>

PHPUnit changed the way how double creation is handled internally and now emits an exception if a manually defined `mock class name` should be registered. In some places within the unit tests, manual mock class names have been used, because the names are needed for cross referencing at a later point. For this, different approaches have been used, for example hardcoded MD5 hashes as strings or creating hashes of static values like `md5('1')`, and also reused hashes in different places or in tests using data providers. This now leads to an exception: PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException The name "b70551b2b2db62b6b15a9bbfcbd50614" is already in use This change mitigates the issue by using `StringUtility::getUniqueId('somePrefix')` as is already done in other places. As a sideeffect, four phpstan baseline entries can be removed. Used command(s): Build/Scripts/runTests.sh -s phpstanGenerateBaseline [1] sebastianbergmann/phpunit#5804 Resolves: #104005 Releases: main, 12.4 Change-Id: Icc558844275c9ae9f67a0e7c20daa318f5ad6b41 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84531 Tested-by: core-ci <[email protected]> Reviewed-by: Christian Kuhn <[email protected]> Tested-by: Christian Kuhn <[email protected]>

PHPUnit changed the way how double creation is handled internally and now emits an exception if a manually defined `mock class name` should be registered. In some places within the unit tests, manual mock class names have been used, because the names are needed for cross referencing at a later point. For this, different approaches have been used, for example hardcoded MD5 hashes as strings or creating hashes of static values like `md5('1')`, and also reused hashes in different places or in tests using data providers. This now leads to an exception: PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException The name "b70551b2b2db62b6b15a9bbfcbd50614" is already in use This change mitigates the issue by using `StringUtility::getUniqueId('somePrefix')` as is already done in other places. As a sideeffect, four phpstan baseline entries can be removed. Used command(s): Build/Scripts/runTests.sh -s phpstanGenerateBaseline [1] sebastianbergmann/phpunit#5804 Resolves: #104005 Releases: main, 12.4 Change-Id: Icc558844275c9ae9f67a0e7c20daa318f5ad6b41 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84530 Reviewed-by: Christian Kuhn <[email protected]> Tested-by: core-ci <[email protected]> Tested-by: Christian Kuhn <[email protected]> Tested-by: Andreas Wolf <[email protected]> Reviewed-by: Andreas Wolf <[email protected]>

PHPUnit changed the way how double creation is handled internally and now emits an exception if a manually defined `mock class name` should be registered. In some places within the unit tests, manual mock class names have been used, because the names are needed for cross referencing at a later point. For this, different approaches have been used, for example hardcoded MD5 hashes as strings or creating hashes of static values like `md5('1')`, and also reused hashes in different places or in tests using data providers. This now leads to an exception: PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException The name "b70551b2b2db62b6b15a9bbfcbd50614" is already in use This change mitigates the issue by using `StringUtility::getUniqueId('somePrefix')` as is already done in other places. As a sideeffect, four phpstan baseline entries can be removed. Used command(s): Build/Scripts/runTests.sh -s phpstanGenerateBaseline [1] sebastianbergmann/phpunit#5804 Resolves: #104005 Releases: main, 12.4 Change-Id: Icc558844275c9ae9f67a0e7c20daa318f5ad6b41 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/84531 Tested-by: core-ci <[email protected]> Reviewed-by: Christian Kuhn <[email protected]> Tested-by: Christian Kuhn <[email protected]>

sebastianbergmann added type/enhancement A new idea that should be implemented feature/test-doubles Test Stubs and Mock Objects labels Apr 7, 2024

sebastianbergmann mentioned this pull request Apr 7, 2024

Allow doubling readonly classes #5663

Closed

sebastianbergmann changed the title ~~Support doubling of readonly classes~~ Support doubling readonly classes Apr 7, 2024

sebastianbergmann force-pushed the test-doubles-for-readonly-classes branch from 14c74b5 to 5af0410 Compare April 9, 2024 05:46

sebastianbergmann marked this pull request as ready for review April 9, 2024 05:57

sebastianbergmann added 8 commits April 10, 2024 17:35

Make it explicit that the embedding class must provide __phpunit_getI…

85e760e

…nvocationHandler()

Initial work on storing internal state of test doubles in readonly pr…

f419f51

…operty

Also assert that we have a MockObject instance

83bbb81

Allow doubling of readonly classes

b972208

Simplify

bebb3d8

Clone TestDoubleState object

4adbc2f

Cloning readonly properties does not work in PHP 8.2

4628535

Restore clone-ability of test doubles for non-readonly classes with P…

d660f26

…HP 8.2

sebastianbergmann force-pushed the test-doubles-for-readonly-classes branch from 5af0410 to d660f26 Compare April 10, 2024 16:04

sebastianbergmann added this to the PHPUnit 11.2 milestone Apr 10, 2024

sebastianbergmann added 7 commits April 10, 2024 18:40

Ignore code that is only executed on PHP 8.2 from code coverage

4704177

Rename test fixture class

f764ea0

Add tests

28df31b

Ignore execution path that is not interesting from code coverage repo…

50a0f3d

…rting

Document through test that cloning test doubles for readonly classes …

a783a02

…is not supported on PHP 8.2

Make it clear(er) that DoubledCloneMethod and ProxiedCloneMethod are …

baec6a0

…mutually exclusive

Throw exception when test double for readonly class is to be cloned o…

b53b04c

…n PHP 8.2

sebastianbergmann closed this in eb52978 Apr 11, 2024

sebastianbergmann deleted the test-doubles-for-readonly-classes branch April 11, 2024 09:03

sebastianbergmann mentioned this pull request Apr 11, 2024

Support for doubling readonly classes sebastianbergmann/phpunit-documentation-english#349

Closed

sebastianbergmann mentioned this pull request Jun 9, 2024

Mocked methods cannot be called from the original constructor of a partially mocked class #5857

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support doubling `readonly` classes #5804

Support doubling `readonly` classes #5804

sebastianbergmann commented Apr 7, 2024 •

edited

Loading

codecov bot commented Apr 9, 2024 •

edited

Loading

sebastianbergmann commented Apr 9, 2024

sebastianbergmann commented Apr 10, 2024

Support doubling readonly classes #5804

Support doubling readonly classes #5804

Conversation

sebastianbergmann commented Apr 7, 2024 • edited Loading

codecov bot commented Apr 9, 2024 • edited Loading

Codecov Report

sebastianbergmann commented Apr 9, 2024

sebastianbergmann commented Apr 10, 2024

Support doubling `readonly` classes #5804

Support doubling `readonly` classes #5804

sebastianbergmann commented Apr 7, 2024 •

edited

Loading

codecov bot commented Apr 9, 2024 •

edited

Loading