docker: Add script for selecting different PHP versions #32929
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -328,6 +328,8 @@ const buildExecCmd = argv => { | |
| opts.push( 'bash' ); | ||
| } else if ( cmd === 'db' ) { | ||
| opts.push( 'mysql', '--defaults-group-suffix=docker' ); | ||
| } else if ( cmd === 'select-php' ) { | ||
| opts.push( 'select-php', argv.version ); | ||
| } else if ( cmd === 'phpunit' ) { | ||
| // @todo: Make this scale. | ||
| console.warn( chalk.yellow( 'This currently only run tests for the Jetpack plugin.' ) ); | ||
|
|
@@ -624,6 +626,18 @@ export function dockerDefine( yargs ) { | |
| builder: yargExec => defaultOpts( yargExec ), | ||
| handler: argv => execDockerCmdHandler( argv ), | ||
| } ) | ||
| .command( { | ||
| command: 'select-php <version>', | ||
| description: | ||
| 'Select the version of PHP for use inside the container. See documentation for important notes!', | ||
| builder: yargCmd => { | ||
| yargCmd.positional( 'version', { | ||
| describe: 'The version to select, or "default".', | ||
|
There was a problem hiding this comment. Hmm, can we maybe put a list of supported version numbers in there? I personally find little things like that quite helpful, even if it's just to check the expected format. It's a small list anyway. Adding some basic validation on that would be cool too. There was a problem hiding this comment. Not here without manually hard-coding them. It depends on which versions are available from https://deb.sury.org/. I didn't bother with validation here since the exec'ed command itself does what would be the same validation. |
||
| type: 'string', | ||
| } ); | ||
| }, | ||
| handler: argv => execDockerCmdHandler( argv ), | ||
| } ) | ||
| .command( { | ||
| command: 'phpunit', | ||
| description: 'Run PHPUnit tests inside container', | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -212,6 +212,25 @@ wp> get_bloginfo( 'name' ); | |
|
|
||
| Note that each `wp shell` session counts as a single request, causing unexpected situations with WP cache. You might want to run [`wp_cache_flush()`](https://developer.wordpress.org/reference/functions/wp_cache_flush/) between requests you expect to get cached by WordPress. | ||
|
|
||
| ### Changing PHP versions | ||
|
|
||
| You can select different versions of PHP. For example, to use PHP 8.0 inside the container: | ||
|
|
||
| ```sh | ||
| jetpack docker select-php 8.0 | ||
| ``` | ||
|
|
||
| If you're already inside the container after using `jetpack docker sh`, you can use `select-php 8.0` there too. | ||
|
|
||
| Note some caveats: | ||
|
|
||
| * Running `jetpack docker down` or otherwise recreating the containers will reset to the default PHP version. | ||
| * If you're wanting the new version of PHP to be used to serve web requests, you'll need to `jetpack docker stop && jetpack docker up -d` or the like. | ||
| * You may need to update Composer packages from inside the container before you can successfully run `phpunit` or the like, in order to install a version compatible with the new version of PHP. | ||
|
There was a problem hiding this comment. I have a couple of questions here:
There was a problem hiding this comment.
Some of changelogger's Symfony deps probably will too. At least some PHPCS sniffs may crash with particularly old PHP as well.
There's nothing we can do about upstream projects deciding to drop support for older versions of PHP more aggressively than we do.
That would make it harder for everything outside of the docker container to run phpunit, as then they'd have to download the appropriate phar instead of letting Composer handle it. We already have things set up so Composer can choose the correct version of phpunit to install based on the PHP version. The problem is that Composer has to be run with that PHP version to do that, and that |
||
| * For example, `jetpack docker exec -- composer -d /usr/local/src/jetpack-monorepo/projects/plugins/jetpack update` | ||
| * Be careful not to commit any resulting changes to `composer.lock` files! | ||
| * On Linux systems, doing this may result in odd ownership of files in relevant `vendor/` and `jetpack_vendor/` directories. Removing them (probaby using `sudo`) is a valid fix. | ||
|
|
||
| ## MySQL database | ||
|
|
||
| You can see your database files via local file system at `./tools/docker/data/mysql` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -eo pipefail | ||
|
|
||
| source /etc/docker-args.sh | ||
|
|
||
| VER=$1 | ||
| if [[ "$1" == default ]]; then | ||
| VER="$PHP_VERSION" | ||
| elif [[ ! "$1" =~ ^[0-9]+\.[0-9]+$ ]]; then | ||
| cat <<-EOF | ||
| USAGE: $0 <version> | ||
|
|
||
| <version> may be "default" or a two-part version number like "$PHP_VERSION". | ||
| EOF | ||
| exit 1 | ||
| fi | ||
|
|
||
| export DEBIAN_FRONTEND=noninteractive | ||
|
|
||
| # Determine packages to install. | ||
| PKGS=( | ||
| "libapache2-mod-php${VER}" | ||
| "php${VER}" | ||
| "php${VER}-bcmath" | ||
| "php${VER}-cli" | ||
| "php${VER}-curl" | ||
| "php${VER}-intl" | ||
| "php${VER}-ldap" | ||
| "php${VER}-mbstring" | ||
| "php${VER}-mysql" | ||
| "php${VER}-opcache" | ||
| "php${VER}-pgsql" | ||
| "php${VER}-soap" | ||
| "php${VER}-sqlite3" | ||
| "php${VER}-xdebug" | ||
| "php${VER}-xml" | ||
| "php${VER}-xsl" | ||
| "php${VER}-zip" | ||
| ) | ||
| NO_RECOMMENDS_PKGS=( | ||
| "php${VER}-apcu" | ||
| "php${VER}-gd" | ||
| "php${VER}-imagick" | ||
| ) | ||
|
|
||
| # php-json is built in in 8.0+. | ||
| if [[ "$VER" == [57].* ]]; then | ||
| PKGS+=( "php${VER}-json" ) | ||
| fi | ||
|
|
||
| # Install selected packages. | ||
| printf '\e[1m== Installing PHP %s ==\e[0m\n' "$VER" | ||
| apt-get update -q | ||
| apt-get install -qy "${PKGS[@]}" | ||
| apt-get install -qy --no-install-recommends "${NO_RECOMMENDS_PKGS[@]}" | ||
|
|
||
| # Enable our custom config for the new version. | ||
| [[ -e "/etc/php/${VER}/mods-available/jetpack-wordpress.ini" ]] || ln -s /var/lib/jetpack-config/php.ini "/etc/php/${VER}/mods-available/jetpack-wordpress.ini" | ||
| phpenmod -v "$VER" jetpack-wordpress | ||
|
|
||
| # Upgrade or downgrade Composer if necessary. | ||
| if command -v composer &> /dev/null; then | ||
| printf '\n\e[1m== Installing Composer ==\e[0m\n' | ||
| if [[ "$VER" == 5.6 || "$VER" == 7.[01] ]]; then | ||
| CV=2.2.18 | ||
| else | ||
| CV="$COMPOSER_VERSION" | ||
| fi | ||
| # Execute with whichever version of PHP is newer. | ||
| if php -r 'exit( version_compare( PHP_VERSION, $argv[1], ">" ) ? 0 : 1 );' "$PHP_VERSION"; then | ||
| composer self-update "$CV" | ||
| else | ||
| "php$VER" "$(command -v composer)" self-update "$CV" | ||
| fi | ||
| fi | ||
|
|
||
| # Select the new version to be used for stuff. | ||
| printf '\n\e[1m== Setting PHP %s as default ==\e[0m\n' "$VER" | ||
| for name in php phar phar.phar; do | ||
| update-alternatives --quiet --set "$name" "/usr/bin/$name$VER" | ||
| done | ||
| if a2query -m | grep -q "^php$VER "; then | ||
| : | ||
| else | ||
| if a2query -m | grep -q '^php'; then | ||
| a2dismod 'php*' | ||
| fi | ||
| a2enmod "php$VER" | ||
|
|
||
| printf '\n\e[30;43mThe web server is still running the old version of PHP!\e[0m\n' | ||
| printf '\e[30;43mRestart the docker container (e.g. `jetpack docker stop && jetpack docker up -d`) to use the new version.\e[0m\n' | ||
| fi |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While switching the default version on the entire PHP container could be useful when some manual debugging is required, I'm thinking the most common use case for this will be to run unit tests.
Maybe we could also expand the
jetpack docker phpunitcommand with a--php=option like so:What I find particularly appealing about this is the given version would only affect the single command, so you don't have to worry about switching back to what you had before.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately it's not that simple considering the need for re-running composer to get a compatible version of phpunit (and maybe other deps, like if we keep the use of
johnkary/phpunit-speedtrap), and in some cases upgrading or downgrading composer to get a compatible version of that.We could certainly try something that would only work for
jetpack docker phpunitif we want. It'd still need a script like up to line 60 of the one in this PR, and we might avoid screwing up the monorepovendor/by installing PHPUnit and whatever other deps out-of-tree (with a composer.json making use of.config.platform.phpto get the right versions) and running from there instead.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Proof of concept for that is in #32979.