Dev: Only one WordPress

[kraftbj]

For unit testing, we often use WorDBless, a variant of WordPress that does not require database setup. Except, we include it a lot so there are a lot of copies of WordPress within the repo when fully installed.

Before and after the changes proposed below (conducted in clean directories on my M1 with composer's cache cleared)

Before:
1st run of jetpack install --all: Between 2m 57s and 3m 17s
2nd run: 56s
Size: (du of monorepo with du of .git subtracted): 5.1 GB

After:
1st run: Between 1m 20s and 1m 52s
2nd run: 55s
Size: 2.7 GB

Proposed changes:

• Remove inclusion of the WorDBless package in packages that did not use it for testing.
• Add a new test-environment package to serve as the WorDBless loader for monorepo projects.
• Replaced all inclusion of WorDBless package in individual packages with the new test-environment, updated bootstraps.
• Added a new tools/php-test-env package that will install WorDBless once in that directory.
• Updated monorepo root to install/update tools/php-test-env when itself is installed/updated (so jetpack install --all, -r will cover it.

In short, this changes the packages consumed by individual projects to use the internal test-environment. This ensure it is easy to modify all in the future and required little change to each individual package.

The test-environment loads a class that loads the test-php-env autoloader and loads WorDBless.

The test-php-env quasi-package does a singular install of WorDBless.

Other solution investigated was having the test-environment package directly require WorDBless, but that meant it would be re-installed every time test-environment was installed. No gain (at least) to install time, but it would have ended up with only one copy of WP.

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

None yet.

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

No.

Testing instructions:

• jetpack install -r (at least) and jetpack install a package that uses worDBLess, like packages/admin-ui
• jetpack test phh packages/admin-ui

Does it still run the test successfully?

[jeherve]

I gave it a try, it seems to test well. Let's give it a try!

I have a few remarks below:

---

I think you'll need to update packages/account-protection as well.

---

What do you think about updating the docs in docs/automated-testing.md and docs/monorepo.md to explain that setup?

---

You should be able to remove this now?

jetpack/projects/plugins/boost/.gitattributes

Line 30 in e9d9bc9

/vendor/automattic/wordbless/** production-exclude

---

I think you may have to update the generate command so folks do not set up WorDBless again in new packages:

jetpack/tools/cli/commands/generate.js

Lines 715 to 722 in bb536db

	if ( answers.wordbless ) {
	composerJson.scripts[ 'post-install-cmd' ] = 'WorDBless\\Composer\\InstallDropin::copy';
	composerJson.scripts[ 'post-update-cmd' ] = 'WorDBless\\Composer\\InstallDropin::copy';
	composerJson[ 'require-dev' ][ 'automattic/wordbless' ] = 'dev-master';
	composerJson.config = composerJson.config || {};
	composerJson.config[ 'allow-plugins' ] = composerJson.config[ 'allow-plugins' ] || {};
	composerJson.config[ 'allow-plugins' ][ 'roots/wordpress-core-installer' ] = true;
	}

[kraftbj]

@jeherve I believe I resolved or explained all of the items in your feedback.

[github-actions]

Code Coverage Summary

Coverage changed in 2 files.

File	Coverage	Δ%	Δ Uncovered
projects/plugins/jetpack/extensions/store/membership-products/resolvers.js	56/106 (52.83%)	0.94%	-1 💚
projects/packages/sync/src/modules/class-callables.php	45/177 (25.42%)	8.47%	-15 💚

1 file are newly covered.

File	Coverage
projects/packages/test-environment/src/class-test-environment.php	0/20 (0.00%) 💔

Full summary · PHP report · JS report

[anomiex]

While this works, IMO it would be a little cleaner to have an array that works like $extra_stubs, which gets array_merged into the two config entries below, instead of changing the $options directly.

[kraftbj]

I'm down for fixing this in a follow-up. I'm itchy to get it in and iterate on it vs holding up the PR too much longer.