Docker: Make WP unit test versions match installed WP version #41934

tbradsha · 2025-02-20T20:50:19Z

In a fresh jetpack docker instance, running PHPUnit tests were failing because the version of core unit tests (trunk latest) was trying to load a file that didn't exist in the version of WordPress (6.7.2).

With this PR they should be in sync on init. In particular:

A new jetpack docker update-core command was added. This runs a script that updates both WP core and WP unit tests to the same version.
The jetpack docker update-core-unit-tests command was removed.
The unit tests checkout version now matches the WP core version initially installed.

See also: p1739803957236829-slack-C05Q5HSS013

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

jetpack docker clean
jetpack docker build-image
jetpack docker up -d
jetpack docker install
jetpack docker phpunit

In trunk, the last command will fail. With this branch, the last command will run PHPUnit correctly.

As for the other stuff, try some commands to upgrade and downgrade:

jetpack docker update-core <-- updates to latest
jetpack docker update-core 6.6.0
jetpack docker update-core latest

This should successfully update both WordPress and core unit tests to the same version.

github-actions · 2025-02-20T20:51:22Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

tbradsha · 2025-02-20T20:54:33Z

tools/docker/bin/run.sh

@@ -79,14 +79,15 @@ fi
 if [ "$COMPOSE_PROJECT_NAME" == "jetpack_dev" ] ; then
 	# If we don't have the wordpress test helpers, download them
 	if [ ! -d /tmp/wordpress-develop/tests ]; then
+		CUR_WP_VERSION=$(wp --allow-root core version);


I've updated a few lines in this file, but I'm not sure when this runs or how to test it...

This file runs as the default command whenever the container is started.

This particular code path will run when /tmp/wordpress-develop/tests (which is mounted from the host's tools/docker/wordpress-develop) doesn't exist.

Note that run.sh didn't seem to run when the container started; I could only get it to run when the docker image was built.

It does for me. 🤷

anomiex

I'm not sure what needs to be done to test the initial state/updating the Docker image, etc.

To update the image, you can either jetpack docker build-image to build it locally or wait for CI to finish and change the docker-compose.yml to use ghcr.io/automattic/jetpack-wordpress-dev:pr-41934.

jetpack/tools/docker/docker-compose.yml

Line 35 in 877c10e

image: automattic/jetpack-wordpress-dev:latest

To test the startup, you may have to remove tools/docker/wordpress-develop/tests on your host, or maybe even start from a fresh clone.

anomiex · 2025-02-20T21:29:10Z

tools/docker/bin/run.sh

@@ -79,14 +79,15 @@ fi
 if [ "$COMPOSE_PROJECT_NAME" == "jetpack_dev" ] ; then
 	# If we don't have the wordpress test helpers, download them
 	if [ ! -d /tmp/wordpress-develop/tests ]; then
+		CUR_WP_VERSION=$(wp --allow-root core version);


This file runs as the default command whenever the container is started.

This particular code path will run when /tmp/wordpress-develop/tests (which is mounted from the host's tools/docker/wordpress-develop) doesn't exist.

tools/docker/bin/update-core.sh

anomiex

LGTM. One suggestion inline.

anomiex · 2025-02-21T19:21:28Z

tools/docker/mu-plugins/bypass_circular_refs_during_core_update.php

+ * Remove problematic call to `_upgrade_422_remove_genericons()` from `wp-admin/includes/update-core.php`. That call
+ * recursively searches all directories for genericons files, which results in a circular reference loop for some
+ * of our projects.
+ *


Should we mention that there's unfortunately no direct filter for the upgrade stuff, but it happens to call wp_opcache_invalidate() before requiring the file which gives us a chance to hack it?

tbradsha added 3 commits February 20, 2025 13:39

Add script to update core

e1b8185

Replace update-core-unit-tests subcommand with update-core

d12add8

Update initial unit test checkout version

877c10e

tbradsha added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. [Type] Janitorial labels Feb 20, 2025

tbradsha requested a review from a team February 20, 2025 20:50

tbradsha self-assigned this Feb 20, 2025

github-actions bot added [Tools] Development CLI The tools/cli to assist during JP development. Docker labels Feb 20, 2025

tbradsha commented Feb 20, 2025

View reviewed changes

anomiex reviewed Feb 20, 2025

View reviewed changes

tbradsha added 2 commits February 21, 2025 09:14

Patch core update file

a5f4546

Allow downgrade as well

5961587

tbradsha requested a review from anomiex February 21, 2025 18:19

anomiex previously approved these changes Feb 21, 2025

View reviewed changes

tbradsha added 2 commits February 21, 2025 12:35

Add plugin to .gitignore

424af74

Comment tweaks

e5917f5

tbradsha dismissed anomiex’s stale review via e5917f5 February 21, 2025 19:36

tbradsha requested a review from anomiex February 21, 2025 19:36

anomiex approved these changes Feb 21, 2025

View reviewed changes

tbradsha merged commit 6389b56 into trunk Feb 21, 2025
60 checks passed

tbradsha deleted the fix/tooling/allow_docker_unit_test_versions_to_be_updated branch February 21, 2025 20:50

github-actions bot removed the [Status] Needs Review A Jetpack Crew expert's review is needed. Typically for significant changes to core functionality. label Feb 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker: Make WP unit test versions match installed WP version #41934

Docker: Make WP unit test versions match installed WP version #41934

tbradsha commented Feb 20, 2025 •

edited

Loading

github-actions bot commented Feb 20, 2025

tbradsha Feb 20, 2025

anomiex Feb 20, 2025

tbradsha Feb 21, 2025

anomiex Feb 21, 2025

anomiex left a comment •

edited

Loading

anomiex Feb 20, 2025

anomiex left a comment

anomiex Feb 21, 2025

tbradsha Feb 21, 2025

Docker: Make WP unit test versions match installed WP version #41934

Docker: Make WP unit test versions match installed WP version #41934

Conversation

tbradsha commented Feb 20, 2025 • edited Loading

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Feb 20, 2025

tbradsha Feb 20, 2025

Choose a reason for hiding this comment

anomiex Feb 20, 2025

Choose a reason for hiding this comment

tbradsha Feb 21, 2025

Choose a reason for hiding this comment

anomiex Feb 21, 2025

Choose a reason for hiding this comment

anomiex left a comment • edited Loading

Choose a reason for hiding this comment

anomiex Feb 20, 2025

Choose a reason for hiding this comment

anomiex left a comment

Choose a reason for hiding this comment

anomiex Feb 21, 2025

Choose a reason for hiding this comment

tbradsha Feb 21, 2025

Choose a reason for hiding this comment

tbradsha commented Feb 20, 2025 •

edited

Loading

anomiex left a comment •

edited

Loading