Tests: Further improve Windows compatibility#327
Conversation
|
Hello! 👋 Thanks for opening this pull request! Please check out our contributing guidelines. We appreciate you taking the initiative to contribute to this project. Contributing isn't limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation. Here are some useful Composer commands to get you started:
To run a single Behat test, you can use the following command: # Run all tests in a single file
composer behat features/some-feature.feature
# Run only a specific scenario (where 123 is the line number of the "Scenario:" title)
composer behat features/some-feature.feature:123You can find a list of all available Behat steps in our handbook. |
There was a problem hiding this comment.
Code Review
This pull request updates a wp eval command in features/core.feature to use double quotes, which improves compatibility with Windows environments. The reviewer recommends extending this change to other similar commands within the same file to ensure consistency and prevent parsing issues across the entire test suite.
features/core.feature
Outdated
| And the return code should be 0 | ||
| When I run `wp eval 'echo $GLOBALS["current_site"]->domain;'` | ||
| When I run `wp eval "echo $GLOBALS['current_site']->domain;"` |
There was a problem hiding this comment.
While this change improves Windows compatibility for this command, other wp eval calls in this file still use single quotes (e.g., on line 249), which can cause parsing issues on Windows. For consistency and to fully address the compatibility issue, please consider updating all wp eval calls in this file to use double quotes for the command argument.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Co-authored-by: Wojciech Smoliński <wojsmol@wp.pl>
There was a problem hiding this comment.
Pull request overview
Updates Behat acceptance tests in core-command to behave more reliably across platforms (especially Windows), primarily by avoiding shell-quoting pitfalls and skipping scenarios that depend on Unix-specific paths/behavior.
Changes:
- Replaced an inline
wp eval '...'assertion with awp eval-filerun against a generated PHP file to avoid quoting issues. - Added
@skip-windowsto scenarios that are not portable to Windows (custom multisite base path scenario; root-level absolute path permission scenario). - Split out the root-level path failure checks into their own scenario in
core-download.feature.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| features/core.feature | Uses eval-file with a generated PHP file for a multisite-domain assertion; marks a multisite-base-path scenario as skipped on Windows. |
| features/core-download.feature | Adds a Windows skip tag and isolates the absolute root-level path permission checks into a dedicated scenario. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| @skip-windows | ||
| Scenario: Fail if path can't be created (root-level-directory) | ||
| Given an empty directory |
There was a problem hiding this comment.
This new scenario is environment-dependent: creating /root-level-directory will succeed when tests run with elevated privileges (or in some container setups), and it can also behave differently if the directory already exists from a previous run. That makes the test potentially flaky on CI and locally. Consider making the failure deterministic by ensuring the directory is removed before the scenario (using the existing “non-existent … directory” step) and/or by targeting a consistently non-writable location or a non-writable directory created within the test workspace.
| Given an empty directory | |
| Given an empty directory | |
| And a non-existent '/root-level-directory' directory |
No description provided.