Compatibility with PHPUnit 10

[mgubala-edge1s]

Feature request

WP_Mock is not compatible with PHPUnit 10 / PHP 8.1.

Proposed solution

Make it compatible. Maybe You have it already in plans?

[unfulvio-godaddy]

hey @mgubala-edge1s thanks for getting in touch - support for PHP 8.1 should already exist as WP_Mock should work also in PHP 8.2 with the recent Mockery updates. As for PHPUnit 10, it's definitely under the radar but unfortunately can't give you an estimate for when support will be ready.

[tobeycodes]

@mgubala-edge1s @unfulvio-godaddy From what I can tell phpunit 10 is already supported. If you install phpunit 10 and then you install 10up/wp_mock it will install the version 0.4.2 of 10up/wp_mock. This happens because the requirements for this version where PHPUnit >= 7 and now the later versions lock to PHPUnit v9. I only noticed this now when I was trying to debug an issue with php stubs for phpstan. It seems that the php stubs loaded were from 10up/wp_mock but version 0.4.2 which had incorrect docblocks for add_action instead of the stubs I wanted to use that were https://github.com/php-stubs/wordpress-stubs. I was able to fix that in my phpstan config by pointing to the correct stubs so they get loaded before 10up/wp_mock runs.

But regardless I am running the following versions of things (with phpunit 10 and do not seem to have any issues with 10up/wp_mock but I have not extensively used all the features, mostly just mocking functions, and expecting actions/filters)

10up/wp_mock                        0.4.2   A mocking library to take the pain out of unit testing for WordPress
antecedent/patchwork                2.1.26  Method redefinition (monkey-patching) functionality for PHP.
brianium/paratest                   v7.3.1  Parallel testing for PHP
mockery/mockery                     1.6.6   Mockery is a simple yet flexible PHP mock object framework
pestphp/pest                        v2.24.2 The elegant PHP Testing Framework.
pestphp/pest-plugin                 v2.1.1  The Pest plugin manager
pestphp/pest-plugin-arch            v2.4.1  The Arch plugin for Pest PHP.
phpstan/phpdoc-parser               1.24.2  PHPDoc parser with support for nullable, intersection and generic types
phpunit/php-code-coverage           10.1.7  Library that provides collection, processing, and rendering functionality for PHP code coverage information.
phpunit/php-file-iterator           4.1.0   FilterIterator implementation that filters files based on a list of suffixes.
phpunit/php-invoker                 4.0.0   Invoke callables with a timeout
phpunit/php-text-template           3.0.1   Simple template engine.
phpunit/php-timer                   6.0.0   Utility class for timing
phpunit/phpunit                     10.4.2  The PHP Unit Testing framework.

I was able to get 1.0.0 installed with this in my composer.json and everything still appears to be working with phpunit 10.

"require-dev": {
	"pestphp/pest": "^2.24",
	"mockery/mockery": "^1.6",
	"php-mock/php-mock-mockery": "^1.4",
	"phpunit/phpunit": "10.4.2 as 9.6.0",
	"10up/wp_mock": "^1.0.0"
},

[Narimm]

To be honest I dont understand why composer wont install 1.0.0. The below extract from composer.json will install 0.4.2

"require-dev": {
    "phpunit/phpunit": "^10",
    "donatj/mock-webserver": "v2.7.1",
    "wp-cli/wp-cli-bundle": "*",
    "10up/wp_mock": "@dev"

  }

If I change to wp_mock "1.0.0" the composer update fails with the message .

Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires 10up/wp_mock 1.0.0 -> satisfiable by 10up/wp_mock[1.0.0].
    - 10up/wp_mock 1.0.0 requires phpunit/phpunit ^9.6 -> found phpunit/phpunit[9.6.0, ..., 9.6.15] but it conflicts with your root composer.json require (^10).

Honestly semantic versioning means 10 exceeds ^9.6 and it should proceed..

[tobeycodes]

@Narimm That is not how caret constraints work

https://jubianchi.github.io/semver-check/#/^9.6/10.0.0

My solution above is still working above

[unfulvio-godaddy]

@tobeycodes solution seems the correct one for the time being

We will eventually support PHPUnit 10 natively -- please check this PR for helping with 8.3 (which PHPUnit 10 supports as well): #237

[tobeycodes]

That PR is looking good. It would be interesting if the project that consumes wp_mock can require php-stubs/wordpress-stubs that matches their WP version. I am not familiar enough to know if composer the best way to do that though.

I did play around with PHP Unit 10 on the trunk version of wp_mock and there are definitely some breaking changes that need to be resolved in wp_mock. When running the test suite some things are failing. I am guessing that within my specific project these features are not being used so the issues go unoticed, so I would definitely use my solution above with caution.

[unfulvio-godaddy]

the stubs are only a dev dependency in WP Mock for PHPStan mostly so if you require WP_Mock, you are not including the stubs in your projects you can add those in your dev dependencies in your project's composer -- indeed there should be some compat work for achieving full PhpUnit 10 support

[kumiega]

What should I do to make WP_Mock working well with PHPUnit 10?

[calebsmithdev]

Has there been any movement with PHPUnit 10? I'd like to use my current wp-env setup with this, but they already use PHPUnit 10 in that Docker container.

[fiskhandlarn]

@tobeycodes solution seems the correct one for the time being

We will eventually support PHPUnit 10 natively -- please check this PR for helping with 8.3 (which PHPUnit 10 supports as well): #237

#237 was merged 10 months ago, what's left to do from there?

[unfulvio]

I am no longer involved with GoDaddy so the rest of the team at GoDaddy (or 10up) maintaining this will have to chime in as I am not sure if support is worked on or not. I did try a fork myself to install PHPUnit10 to see what would entail to add support. Unfortunately the changes to be made seem non-trivial. PhpUnit10 marks several methods final while WP_Mock currently extends at least the expectOutputString method in the main test case from PhpUnit. This method is essential in the current architecture to tap into filters to handle string value expectations when hooks are applied. This is one of the core features of WP_Mock. There are also methods in PhpUnit10 that have been removed or deprecated so WP_Mock needs to account for those (these seem to affect WP_Mock own testing, but likely there's a larger audit to be performed to ensure coesiveness). All this would require likely putting together a version 2.0.0 of WP_Mock that won't be backwards compatible with the current branch. This would give however an opportunity to really overhaul WP_Mock which contains a lot of outdated code at this point in time.

CC @jeffpaul

PS -- Maybe a way around the final method could be using https://github.com/dg/bypass-finals ? I think this package is really intended to mock on final methods/classes and not really to force production code (even when it's just a test suite) to be non-final for convenience (may also have impact on test speed performance). Notetheless that method overriding alone isn't the only problem. Noteworthy is that Patchwork (used by WP_Mock) also filters the output stream to make changes to code on the fly and as such it may collide with the bypass-finals package.