Compatibility with PHPUnit 10, 11, 12, 13 and PHP 8.1-8.4

[unfulvio]

Summary

Modernizes WP_Mock's test harness for current PHPUnit and assumes this will be a 2.0.0 major release. The supported floor moves to PHP 8.1 + PHPUnit 10, and the library runs on PHPUnit 10, 11, 12 and 13 from a single codebase — Composer installs the highest PHPUnit your PHP allows (8.1 → 10 … 8.4 → 13). The public assertion API is unchanged.

Per review feedback on the original 9–13 approach: rather than bridge PHPUnit 9 with dual annotation+attribute metadata, 2.0 is a clean modern major and support for PHPUnit 9 is dropped. Since v10 requires 8.1, PHP 7.4/8.0 and PHPUnit 9 users must stay on the 1.x line, which continues to work as usual.

What changed

• Floor raised to PHP 8.1 / PHPUnit 10 in composer.json; PHPUnit 9 dropped.
• Tests are attributes-only. Removed the dual @dataProvider / @runInSeparateProcess / @preserveGlobalState doc-annotations (the #[...] attributes already existed) and converted 152 method-level @covers to class-level #[CoversClass]. Doc-comment metadata stopped working in PHPUnit 12, so this is required for 12/13, not cosmetic.
• Deprecation reporting uses trigger_error(E_USER_DEPRECATED) (PHPUnit's TestResult/RiskyTestError were removed in 10); set failOnDeprecation="true" to fail on them.
• Output assertions: PHPUnit 10 removed setOutputCallback() and made expectOutputString() final, so the implicit @stripTabsAndNewlinesFromOutput stripping is replaced by TestCase::assertOutputEqualsHtml($expectedHtml, $callback).
• IsEqualHtml reworked onto matches()/toString() (single-arg constructor; $other now typed mixed).
• Dropped the abandoned sempro/phpunit-pretty-print; removed the now-unused direct sebastian/comparator dev dependency (PHPUnit pulls it transitively); bumped mockery and PHPStan tooling to ^2.
• Fixed WP_Mock::expectFilterNotAdded() defaulting $args to 10 instead of 1, so the "not added" expectation never matched a standard add_filter() call (note: consider backporting this change in the 1.x branch for the v1.1.1 untagged release).

A deliberate exception to the #[CoversClass] conversion: the two trait tests and the global-function-mock test are left without coverage metadata. #[CoversTrait] requires PHPUnit 11+ (above the floor), and #[CoversFunction] pointing at conditionally-defined global mocks is fragile under failOnWarning. They contribute whole-suite coverage instead, and each carries a one-line comment explaining why.

CI

• Matrix trimmed to the supported range: PHP 8.1 → PU10, 8.2 → PU11, 8.3 → PU12, 8.4 → PU13 — dropping the old 7.4, 8.0 since the min is now 8.1. Each leg composer updates to the highest PHPUnit its PHP allows (a single committed lock can't satisfy every PHP/PHPUnit pair).
• One --prefer-lowest leg (now PHP 8.1) keeps the declared dependency floors honest.
• Coverage is measured on the 8.1 / PHPUnit 10 leg — flagged with a coverage: true matrix entry — with a single Coveralls upload, replacing the old 8.0/PU9 leg.

Upgrading

composer require --dev 10up/wp_mock:^2.0

Requires PHP 8.1+ and PHPUnit 10+. Two behavior changes (see UPGRADE.md):

• Deprecated WP_Mock calls now surface as PHPUnit deprecations (failOnDeprecation) rather than marking tests "risky".
• Use assertOutputEqualsHtml() where you relied on automatic output whitespace-stripping.

Behat

Left mostly untouched — it hadn't been properly run since ~1.0.0 (a parse error; it isn't wired into CI), now restored to passing with minimal fixes. I think Behat should either be dropped since this package is no longer using it consistently or brought up to parity with current phpunit tests. Either way this should be work for a follow up PR since the scope is quite large then.

Release suggestion before/after merging

I see you have an unreleased v1.1.1 despite this PR #263 -- I think you could tag v1.1.1 first as the last/current v1.x branch. Actually, you could consider backporting this fix to it as well (see changelog notes above):

• Fixed WP_Mock::expectFilterNotAdded() defaulting $args to 10 instead of 1, so the "not added" expectation never matched a standard add_filter() call

After that's done, tag v1.1.1. Then, merge this branch and tag 2.0.0 if tests go well on your end.

[coveralls]

coverage: 70.899% (+4.8%) from 66.142% — feature/phpunit-9-13-compatibility into trunk

[unfulvio]

hey @ajaynes-godaddy @agibson-godaddy @nmolham-godaddy @wvega-godaddy @rneudorf-godaddy how have you been?

I hope you are still using this library at GD and I remember even back then we were trying to add support to phpunit 10... now even that has been sunset / EOL -- so I tried to give it a pass with Claude to see what would it take to level up compatibility.

I don't have a large codebase as you probably do to try this with... Let me know what you think, or if a v2 branch can be merged alongside the current v1 (by the way I think you have an unreleased 1.1.1).

Cheers

[Copilot]

Pull request overview

This PR updates WP_Mock to support PHPUnit 9.6 through 13 (and PHP 7.4–8.4) from a single codebase, including internal behavioral changes around deprecation reporting and output assertions, plus aligned test/CI/tooling updates for cross-version compatibility.

Changes:

• Replaces deprecated-call “risky test” reporting with native E_USER_DEPRECATED notices and updates tests accordingly.
• Reworks HTML/output assertions for PHPUnit 10+ compatibility by introducing TestCase::assertOutputEqualsHtml() and refactoring IsEqualHtml.
• Expands CI/test configuration and tooling (dual annotations/attributes, phpunit config split, updated composer/phpstan/phpcs settings) to run across the full supported PHP/PHPUnit matrix.

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
UPGRADE.md	Adds upgrade guidance for 1.x → 2.0 behavior changes and configuration notes.
tests/WP_MockTestCase.php	Adds a cross-version helper to detect process isolation (PHPUnit 9 vs 10+).
tests/Unit/WP_MockTest.php	Updates unit tests to use PHPUnit attributes and static data providers where required.
tests/Unit/WP_Mock/Traits/MockWordPressObjectsTraitTest.php	Replaces trait mocking approach for compatibility with newer PHPUnit mocking behavior.
tests/Unit/WP_Mock/Tools/TestCaseTest.php	Updates tests to reflect removed internals and the new output assertion helper.
tests/Unit/WP_Mock/Tools/Constraints/IsEqualHtmlTest.php	Aligns constraint tests with the refactored IsEqualHtml API.
tests/Unit/WP_Mock/Matcher/FuzzyObjectTest.php	Migrates data providers to attributes/static providers for PHPUnit 10+.
tests/Unit/WP_Mock/HookTest.php	Updates tests to use attributes/static providers and partial mocks.
tests/Unit/WP_Mock/FunctionsTest.php	Adds attributes/static providers and isolation where needed for global-function mocking.
tests/Unit/WP_Mock/Functions/HandlerTest.php	Runs key tests in separate processes to avoid global-state bleed.
tests/Unit/WP_Mock/DeprecatedMethodListenerTest.php	Reworks tests to validate E_USER_DEPRECATED behavior and message formatting.
tests/Unit/WP_Mock/API/FunctionMocksTest.php	Adds process isolation attributes for function-mock integration behavior.
tests/Integration/WP_MockTest.php	Updates integration tests for isolation detection and static providers/constants.
phpunit9.xml.dist	Removes abandoned pretty-printer configuration for PHPUnit 9 runs.
phpunit.xml.dist	Adds PHPUnit 10+ configuration (including deprecation handling) and test suites/source includes.
phpstan.neon	Tunes PHPStan checked-exception handling for PHPUnit mock infrastructure exceptions.
phpstan-baseline.neon	Refreshes baseline format/identifiers and updates ignored error patterns.
phpcs.xml	Updates PHPCompatibility testVersion range configuration.
php/WP_Mock/Tools/TestCase.php	Removes PHPUnit 10-incompatible overrides and introduces assertOutputEqualsHtml().
php/WP_Mock/Tools/Constraints/IsEqualHtml.php	Refactors constraint to matches()/toString() and single-arg constructor.
php/WP_Mock/DeprecatedMethodListener.php	Switches deprecated-call signaling to trigger_error(E_USER_DEPRECATED) and removes removed-PHPUnit-API dependencies.
php/WP_Mock.php	Fixes expectFilterNotAdded() default $args from 10 to 1.
features/bootstrap/FunctionsContext.php	Fixes deprecated Behat step wrapper and corrects implementation call.
features/bootstrap/FeatureContext.php	Updates ReflectionProperty::setValue() usage for PHP 8.3 deprecation.
docs/tools/wp-mock-test-case.md	Documents the new assertOutputEqualsHtml() helper and the 2.0 change rationale.
docs/general/installation.md	Updates dependency documentation for PHPUnit 9–13 and Mockery floor.
composer.json	Broadens PHPUnit constraints, bumps dependency floors, updates tooling versions, and adjusts test scripts.
CHANGELOG.md	Adds 2.0.0 entry describing compatibility work and breaking internal behavior changes.
.github/workflows/ci.yml	Expands CI matrix (PHP 7.4–8.4), switches to per-leg composer update, adds prefer-lowest leg, and splits phpunit configs.

Comments suppressed due to low confidence (1)

tests/Integration/WP_MockTest.php:55

• This override of setUp() doesn't call parent::setUp(), so the base WP_MockTestCase setup (including its Mockery reset/cleanup) is skipped for this entire test class. That can cause test-order-dependent failures or leaking Mockery state between tests.

    protected function setUp(): void
    {
        if (! $this->isRunningInIsolation()) {
            WP_Mock::setUp();
        }

        require_once(dirname(__DIR__).'/Mocks/Functions.php');
    }

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[agibson-godaddy]

Hi @unfulvio ! Thanks for taking a stab at this. Wondering what we think about just dropping PHPUnit 9 if we're doing a major version anyway?

[unfulvio]

hey @agibson-godaddy sure up to you, makes sense too, I can take another pass removing 9.x support. WooCommerce itself still supports 9.x - not sure of the limitations in the stack though, could be something I have missed. On your end, does running this on the MWC packages or SV plugins does it work out of the box?

[agibson-godaddy]

@unfulvio I think I figure if someone still needs PHPUnit 9 they could just not upgrade to future v2. Not really any harm in hanging back!

I haven't had a chance to test this yet but I'll see if I can carve out time later this week!

[unfulvio]

hey @agibson-godaddy here's another pass -- phpunit v9.x support dropped, test coverage from coveralls increased as a result 🙃

some suggestions for release path:

I see you have an unreleased v1.1.1 despite this PR #263 -- I think you could tag v1.1.1 first as the last/current v1.x branch. Actually, you could consider backporting this fix to it as well (best done it in separate PR, I can also open that after this PR is ready to go from your end):

• Fixed WP_Mock::expectFilterNotAdded() defaulting $args to 10 instead of 1, so the "not added" expectation never matched a standard add_filter() call

After that's done, tag v1.1.1. Then, merge this branch and tag 2.0.0 if tests go well on your end.