Unit test trait to allow options to be globally set in isolation between tests

[sol-loup]

Description

Introduced a new abstract test class, AbstractWPUnitTestWithOptionIsolation, designed to provide isolation for unit tests that interact with WordPress options (get_option, update_option).

Motivation & Context:
Previously, unit tests modifying WordPress options could potentially interfere with each other or leave persistent changes in the test database, leading to unreliable test results and side effects. This change aims to improve test reliability and independence by ensuring option modifications within one test do not affect others.

Implementation:
The AbstractWPUnitTestWithOptionIsolation class extends AbstractWPUnitTestWithSafeFiltering and utilizes WordPress filters (pre_option, pre_update_option) to intercept calls to get_option and update_option. Instead of interacting with the database, option values are stored and retrieved from a local array ($mocked_options) within the test class instance. The setUp() method initializes this mechanism for each test, and tearDown() ensures the local store is cleared and filters are removed (via the parent class).

Changes:

• Created tests/Unit/AbstractWPUnitTestWithOptionIsolation.php.
• Refactored the following test classes to extend AbstractWPUnitTestWithOptionIsolation instead of their previous base class:
  • tests/Unit/WCFacebookCommerceIntegrationTest.php
  • tests/Unit/Handlers/MetaExtensionTest.php
  • tests/Unit/Api/REST/RestAPITest.php
  • tests/Unit/Feed/AbstractFeedTest.php (Note: Affects tests extending this)
  • tests/Unit/Feed/FeedUploadUtilsTest.php
  • tests/Unit/FacebookCommercePixelEventTest.php
  • tests/Unit/ExternalVersionUpdate/UpdateTest.php
  • tests/Unit/Admin/Settings_Screens/ConnectionTest.php
  • tests/Unit/Admin/Settings_Screens/ShopsTest.php
• Corrected visibility (protected to public) for setUp methods in child classes where necessary to match the parent.
• Added a new test test_options_are_reset_after_previous_test to RestAPITest.php to explicitly verify the isolation mechanism.

Dependencies:
Requires the existing AbstractWPUnitTestWithSafeFiltering class for filter management.

Type of change

• New feature (non-breaking change which adds functionality)
• Bug fix (non-breaking change which fixes an issue - potential test interference)

Checklist

• I have commented my code, particularly in hard-to-understand areas (Docblocks added to new class).
• I have confirmed that my changes do not introduce any new PHPCS warnings or errors.
• I followed general Pull Request best practices.
• I have added tests (if necessary) and all the new and existing unit tests pass locally with my changes (Added verification test, confirmed existing tests pass).
• I have completed dogfooding and QA testing, or I have conducted thorough due diligence to ensure that it does not break existing functionality (Tested the test suite with the changes).
• I have updated or requested update to plugin documentations (if necessary) (Included README section below).

Changelog entry

Added test isolation for WordPress options (get_option/update_option) to improve unit test reliability.

Test Plan

1. Run individual modified test files using vendor/bin/phpunit path/to/test/file.php. Verify they pass.
2. Run the full unit test suite for the relevant directory: vendor/bin/phpunit tests/Unit.
3. Observe that tests in the modified files pass.
4. Specifically check that tests/Unit/Api/REST/RestAPITest.php::test_options_are_reset_after_previous_test passes, confirming option state is reset between tests within that class.
5. Confirm that no new failures were introduced in other test files due to these changes.

Screenshots

N/A

[facebook-github-bot]

@sol-loup has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[facebook-github-bot]

@sol-loup merged this pull request in bfaaa60.