Avoid side effects in FeatureContext file

[swissspidy]

When working on https://github.com/wp-cli/handbook I noticed some issues when using ReflectionClass on FeatureContext because the file contains side effects such as function calls which load other files. So there were errors about functions already being declared etc.

Drive-by change: do not use deprecated SnippetAcceptingContext class

[gemini-code-assist]

Summary of Changes

Hello @swissspidy, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request refactors the FeatureContext.php file to eliminate problematic side effects that were causing issues with ReflectionClass and potential function re-declaration errors. It achieves this by encapsulating global functions and direct execution logic into static methods within the FeatureContext class, ensuring that necessary setup is performed explicitly during the Behat test lifecycle. Additionally, it updates the Behat context interface to use the currently recommended Context interface.

Highlights

• Refactored FeatureContext Bootstrapping: The global bootstrapping logic for the Behat FeatureContext was moved into a static method bootstrap_feature_context() within the class itself. This change prevents side effects that occurred when the file was merely included, resolving issues with ReflectionClass and potential function re-declarations.
• Eliminated Global Debug Function: The previously global wp_cli_behat_env_debug() function has been replaced by a static class method self::debug(), further encapsulating functionality within the FeatureContext class.
• Updated Behat Context Interface: The FeatureContext class now implements the current Behat\Behat\Context\Context interface, moving away from the deprecated SnippetAcceptingContext interface.
• Explicit Coverage Report Merging: The merge_coverage_reports method is now explicitly called within the afterSuite hook, rather than relying on a direct annotation, ensuring controlled execution.
• Behat Command Update: The bin/run-behat-tests script has been updated to use the --snippets-for option, explicitly targeting WP_CLI\Tests\Context\FeatureContext for snippet generation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[codecov]

Codecov Report

❌ Patch coverage is 0% with 41 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/Context/FeatureContext.php	0.00%	41 Missing ⚠️

📢 Thoughts on this report? Let us know!

[gemini-code-assist]

Code Review

This is a great refactoring. Moving the bootstrapping logic out of the global scope and into a method within FeatureContext effectively removes the side effects on file inclusion, which resolves the issues with reflection and improves the overall testability of the code. The drive-by change to use the modern Context interface is also a welcome improvement. I've added one suggestion to make the new bootstrapping method idempotent, which would make it more robust given it's called from multiple hooks.