Creating PHPUnit Test Trait to safely update and restore option values with update_option

[sol-loup]

Description

This PR introduces a new reusable mechanism, SafelyUpdateOptionsTestTrait, designed to improve the reliability and isolation of PHPUnit tests that need to modify WordPress options.

Motivation & Context:
Unit tests often require temporarily changing WordPress options (wp_options table entries) to simulate specific environments or configurations. Modifying these global options directly within tests can lead to several problems:

• Tests interfering with each other if cleanup isn't perfect.
• Leaving the testing environment in a dirty state after test runs.
• Requiring repetitive boilerplate code in multiple tests for setting up and tearing down options.

Solution:
The SafelyUpdateOptionsTestTrait addresses these issues by providing helper methods (set_option_safely_only_for_this_test and remove_option_safely_only_for_this_test) that automatically:

1. Record the original value of an option (or the fact that it didn't exist) the first time it's modified within a test method using the trait's functions.
2. Use PHPUnit's @before hook (setup_options_safely_trait) to reset the tracking for each test.
3. Use PHPUnit's @after hook (tear_down_options_safely_trait) to automatically restore all modified options back to their recorded original state after each test method finishes executing.

Changes:

• New Trait: tests/Unit/SafelyUpdateOptionsTestTrait.php - Contains the core logic for safe option management.
• New Test: tests/Unit/SafelyUpdateOptionsTestTraitTest.php - Provides comprehensive unit tests specifically for the SafelyUpdateOptionsTestTrait itself, ensuring it records and restores options correctly under various scenarios (setting new/existing, deleting new/existing, multiple changes).
• Trait Consumption: The trait has been added to tests/Unit/WCFacebookCommerceIntegrationTest.php (and potentially other test files where safe option handling is beneficial, though this specific PR might focus on its initial introduction and testing). [Note: Update this section if you've added the use statement to other specific files in this PR]

This approach ensures that tests using this trait leave the WordPress options environment exactly as they found it, improving test stability and reducing boilerplate.

Type of change

• New feature (non-breaking change which adds functionality - specifically testing infrastructure)
• Syntax change (non-breaking change which improves test code modularity and reliability)

Checklist

• I have commented my code, particularly in hard-to-understand areas.
• I have confirmed that my changes do not introduce any new PHPCS warnings or errors.
• I followed general Pull Request best practices. Meta employees to follow this wiki.
• I have added tests (if necessary) and all the new and existing unit tests pass locally with my changes. (Includes the new test for the trait itself).
• I have completed dogfooding and QA testing, or I have conducted thorough due diligence to ensure that it does not break existing functionality. (Tested via PHPUnit).
• I have updated or requested update to plugin documentations (if necessary). Meta employees to follow this wiki. (Likely N/A for internal test trait).

Changelog entry

Dev - Add SafelyUpdateOptionsTestTrait for reliable WordPress option management in unit tests.

Test Plan

1. Run the specific tests for the new trait to ensure its core logic works:

   vendor/bin/phpunit tests/Unit/SafelyUpdateOptionsTestTraitTest.php

   Verify all tests within this file pass.
2. Run the full PHPUnit suite to ensure the trait integrates correctly and doesn't negatively impact other tests:

   vendor/bin/phpunit

   Verify all tests pass, paying attention to any tests that now use SafelyUpdateOptionsTestTrait (e.g., WCFacebookCommerceIntegrationTest).

Screenshots

N/A - Changes are internal to testing infrastructure.

Before

N/A

After

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 has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.