Add WP_ENV_TESTS_MYSQL_PORT / .wp-env.json .env.tests.mysqlPort option etc

[BrianHenryIE]

Fix: #50677

What?

Currently, the tests container's database port is assigned randomly each time wp-env is started. This PR adds the ability to set the MySQL port number in the .wp-env.json file or via a WP_ENV_TESTS_MYSQL_PORT environmental variable.

Why?

I'd like to be able to use the database in unit tests.

How?

By adding a config option to keep the port number static.

Testing Instructions

Set testsMysqlPort in .wp-env.json

{
	"testsMysqlPort": 52666
}

$ cat .wp-env.json | jq '.testsMySqlPort = 52666' | sponge .wp-env.json`
$ npx wp-env start
...
MySQL for automated testing is listening on port 52666

$ WP_ENV_TESTS_MYSQL_PORT=56678 npx wp-env start
...
MySQL for automated testing is listening on port 56678

Screenshots or screencast

Note

I tried to also add it as a setting env.tests.mysqlPort but I got a parsing error:

✖ Invalid /Users/brian.henry/Sites/wpcs-autoload/.wp-env.json: "tests.mysqlPort" is not a configuration option.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @shashwatahalder01.

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.

Unlinked contributors: shashwatahalder01.

Co-authored-by: BrianHenryIE <brianhenryie@git.wordpress.org>
Co-authored-by: ObliviousHarmony <obliviousharmony@git.wordpress.org>
Co-authored-by: desrosj <desrosj@git.wordpress.org>
Co-authored-by: alanef <fullworks@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @BrianHenryIE! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

[ObliviousHarmony]

This seems like a reasonable addition to wp-env, thanks!

I've left some comments 😄

[ObliviousHarmony]

I view the top-level port and testsPort properties are more of a legacy thing. It's more intuitive to set configuration like this only at the environment level. How would you feel about dropping the root testsMysqlPort in favor of just having development.mysqlPort and tests.mysqlPort?

[ObliviousHarmony]

If we're going to support customizing the port like this let's go ahead and also support the development environment's MySQL port too.

[BrianHenryIE]

To test, checkout this PR and create a project with its package.json referencing it:

{
  "name": "gutenberg-61057-test",
  "devDependencies": {
    "@wordpress/env": "file:/path/to/checked/out/gutenberg/packages/env"
  }
}

npm install;
npx wp-env start;

Observe default behaviour with randomly assigned MySQL ports:

MySQL is listening on port 54916
MySQL for automated testing is listening on port 54922

Add .wp-env.json:

{
  "env": {
    "development": {
      "mysqlPort": 13306
    },
    "tests": {
      "mysqlPort": 13307
    }
  }
}

npx wp-env start;

Observe specified ports used:

MySQL is listening on port 13306
MySQL for automated testing is listening on port 13307

Test Bash env variables:

WP_ENV_MYSQL_PORT=13304 npx wp-env start

MySQL is listening on port 13304
MySQL for automated testing is listening on port 13307

WP_ENV_TESTS_MYSQL_PORT=13305 npx wp-env start

MySQL is listening on port 13306
MySQL for automated testing is listening on port 13305

I'll take another look at the automated tests soon. At first glance the failures don't seem related to these changes but are obviously wp-env config parsing failures. Fixed.

[desrosj]

This seems sensible to me. Thanks for adding tests! @ObliviousHarmony has this been updated to your liking?

[desrosj]

Actually on second look I mistook these changes as new tests. It would be great to add a few if you could.

[desrosj]

It seems like all of the feedback has been reasonably addressed. Since this is only being blocked by the review points to be confirmed as addressed, I'm going to merge this to give it a try.

[github-actions]

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

• Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
• Labels found: [Type] Enhancement, [Type] Build Tooling, First-time Contributor.

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.