perf: enable PHPUnit 12 execution ordering and GC control in test configs#40697
Open
lbajsarowicz wants to merge 1 commit intomagento:2.4-developfrom
Open
Conversation
…figs - Add `executionOrder="depends"` to integration test config to ensure @depends/@Depends chains are respected. Using `depends` only (not `depends,duration`) preserves the explicit "Memory Usage Tests run first" guarantee that the suite definition requires. - Add `executionOrder="depends,duration"` to unit test config where there are no ordering constraints between suites, allowing PHPUnit to schedule faster tests first within each level. - Add `controlGarbageCollector="true"` with thresholds of 50 (integration) and 200 (unit) to periodically run PHP GC during long test suite runs, preventing gradual memory bloat that causes slowdowns and OOM kills in CI.
|
Hi @lbajsarowicz. Thank you for your contribution!
Allowed build names are:
You can find more information about the builds here For more details, review the Code Contributions documentation. |
Contributor
Author
|
@magento run all tests |
Contributor
|
@magento create issue |
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Enables three PHPUnit 12 configuration attributes across integration and unit test configs to improve test execution time and memory stability:
executionOrder="depends"(integration) — ensures@depends/#[Depends]chains execute in the correct order. Usesdependsonly (notdepends,duration) to preserve the explicit "Memory Usage Tests run first" guarantee documented in the suite definition.executionOrder="depends,duration"(unit) — respects dependency chains and schedules faster tests first. Safe here because there are no ordering constraints between unit test suites.controlGarbageCollector="true"(both) — lets PHPUnit triggergc_collect_cycles()periodically during long runs, preventing gradual memory bloat that causes slowdowns and OOM kills in CI. Thresholds: 50 tests for integration (heavier fixture graphs), 200 for unit (lightweight).Problem
Test ordering: The current configs use PHPUnit's default discovery order. 22 integration test files use
@depends/#[Depends](e.g.ConfigurableTest.php), but withoutexecutionOrder="depends", PHPUnit does not guarantee dependency chains execute correctly — leading to intermittent failures.Memory growth: Long integration test runs accumulate cyclic references from fixture graphs, DI containers, and service objects. Without periodic GC, PHP's refcount-based memory management cannot reclaim these, causing memory usage to grow monotonically until the process is killed or becomes swap-bound.
Changes
dev/tests/integration/phpunit.xml.distexecutionOrderdepends@dependswithout reordering suites (preserves Memory Usage Tests priority)dev/tests/integration/phpunit.xml.distcontrolGarbageCollectortruedev/tests/integration/phpunit.xml.distnumberOfTestsBeforeGarbageCollection50dev/tests/unit/phpunit.xml.distexecutionOrderdepends,durationdev/tests/unit/phpunit.xml.distcontrolGarbageCollectortruedev/tests/unit/phpunit.xml.distnumberOfTestsBeforeGarbageCollection200Test plan
php vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist --list-suites— config accepted by PHPUnit 12.5.14php vendor/bin/phpunit -c dev/tests/unit/phpunit.xml.dist --no-coverage app/code/Magento/Catalog/Test/Unit/— 2632 tests passReferences
⭐ Support my work
Do you like the fix? Remember to react with "👍🏻" to get it merged faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.
Learn more at https://github.com/sponsors/lbajsarowicz
Resolved issues: