Repository navigation
Add host-tools/testrunner.sh to run the full test cycle in one step - #346
Conversation
Updates the runner, loads .env, and runs prepare, test, report and cleanup. The report still runs when tests fail, cleanup always runs, and a lock stops overlapping runs from cron. Fixes WordPress#260. Creates the host-tools directory from WordPress#259. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @iarif4u, @jazzsequence. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. Props Bot commandsYou can trigger Props Bot actions by commenting on this PR:
|
|
!!!! |
The examples hardcoded /home/wptestrunner. Use /path/to/phpunit-test-runner instead, and note that the script finds the runner from its own location.
|
Thanks @ramonfincken, fair point. I took |
ekamran
left a comment
There was a problem hiding this comment.
Thanks @iarif4u, this makes the runner much easier to schedule. I re-ran all eight cases from your table with stub steps, and they match. Shellcheck is clean.
Two cases break, details inline: SSH mode, and a second runner checkout on the same host. Both suggestions are tested; with them, only those two cases change and everything else behaves the same. Happy to approve once they are in.
- With WPT_SSH_CONNECT set, run the runner steps with the local php: WPT_PHP_EXECUTABLE is the PHP on the remote test host. - Key the lock on the checkout, so a second checkout on the same host (for example one per PHP version) can run at the same time. - Show a PATH line in the cron example: cron's default PATH misses npm and composer from /usr/local/bin or nvm. - Allow .env lines that use an unset variable.
ekamran
left a comment
There was a problem hiding this comment.
Thanks @iarif4u. I re-checked 28be5d0 as a whole on macOS (bash 3.2) and Linux (bash 5.2, real flock): SSH mode runs the steps with the local php, a second checkout runs while the first is active, the same checkout is refused, a SIGTERM still runs the cleanup, and a .env with an unset variable no longer stops the script.
|
Thanks @ekamran for the approval, and for testing it on both macOS and Linux! |
WPT_PHP_EXECUTABLE values with an env var prefix or a space in the path broke, because read -a splits on whitespace instead of running the value as a command. A shell command string keeps it as one unit. flock not found (for example on a plain macOS host) turned off the overlap check with no notice; print a warning instead.
A second testrunner.sh run, or a bare prepare.php/cleanup.php call, against the same WPT_PREPARE_DIR could delete the first run's checkout and drop its test tables while it was still testing. mkdir claims the directory up front; a run that cannot claim it stops instead. Credit: ekamran, reported with a real repro on WordPress#346.
ekamran
left a comment
There was a problem hiding this comment.
Thanks @iarif4u. I re-checked 9edcc08 as a whole. The new mkdir claim is the same change I tested on October 28, byte for byte, and the PR still merges cleanly with master, including setup.sh from #348.
I ran it again on Linux (bash 5.2, real flock, MySQL 8.4) with the real prepare.php and cleanup.php. A second checkout, or a run started by hand with php prepare.php, now stops with the message, and the first run keeps its checkout and tables and passes. When two runs start at the same moment, only one claims the directory (3 of 3 tries). A leftover directory stops the next run until cleanup.php removes it.
On macOS (bash 3.2) with stub steps, a wrong PHP path no longer leaves the directory behind, and the signal and WPT_PHP_EXECUTABLE cases behave as before. A git clone into the empty claimed directory works, so prepare.php is unaffected.
One small follow-up, not blocking: the README still says the script "always cleans up". After a killed run, the next run now stops until cleanup.php runs, which the error message explains.
ekamran's follow-up on WordPress#346: "always cleans up" stopped being true once a killed run leaves its directory claimed until cleanup.php runs.
|
Thanks for the thorough re-check, ekamran! Took your README follow-up too — pushed 45ab9ff, it no longer says the script always cleans up. |
Fixes #260. Fixes #259 (creates the
host-tools/directory; @aialvi agreed to the handover in #260).Purpose
Hosts say that running the runner is tedious (#257). This adds a ready-made script that runs the full cycle in one step, after the runner is set up.
What
host-tools/testrunner.shdoeshost-tools/, orWPT_RUNNER_DIR..envdoes not exist.flock), so cron runs cannot overlap.git pull --ff-only origin master. If the update fails, it warns and continues. SetWPT_SKIP_UPDATE=1to skip the update..envand runsprepare.php,test.php,report.phpandcleanup.phpwithWPT_PHP_EXECUTABLE, the same PHP that the runner uses.Differences from the example in the issue and the README:
test.phpexits with 1 when any test fails. A plainset -escript would then skip the report, so failures would never be reported.trap).The README "Script en Bash" section now points to this script. The systemd example is not changed.
Testing
I used stub
prepare/test/report/cleanup.phpfiles that exit 0 or 1:.envtest.phpfailsprepare.phpfailscleanup.phpfailsgit pullfailsContributed at WordCamp Contributor Day.