wordpress/docker-compose.yml
Jonathan Desrosiers c40b46525c Build/Test Tools: Configure Xdebug modes in the local Docker environment.
One change in the update from Xdebug version 2.x to 3.x was a shift from enabling features to switching into modes.

When the version of Xdebug installed in the PHP 7.4 Docker container was updated from 2.x to 3.x, the code coverage reporting workflow stopped generating reports due to a lack of available coverage drivers.

This change adds the `XDEBUG_MODE` environment variable to the local Docker environment configuration to allow the active modes to be changed. This environment variable takes precedence over the `xdebug.mode` setting, but will not change the value of the `xdebug.mode` setting.

The `LOCAL_PHP_XDEBUG_MODE` environment variable has been added to the `.env` file and can be used to change the modes enabled in the Docker container. The code coverage reporting workflow uses this variable to enable the `coverage` mode, which is required for generating a test coverage report.

By default, `debug` and `debug modes are active, which enables the more commonly used features of Xdebug: development helpers and step debugging.

Props afragen, johnbillion, desrosj.
Fixes #56022.

git-svn-id: https://develop.svn.wordpress.org/trunk@53552 602fd350-edb4-49c9-b593-d223f7449a82
2022-06-21 23:45:19 +00:00

106 lines
2.4 KiB
YAML

version: '3.7'
services:
##
# The web server container.
##
wordpress-develop:
image: nginx:alpine
networks:
- wpdevnet
ports:
- ${LOCAL_PORT-8889}:80
environment:
LOCAL_DIR: ${LOCAL_DIR-src}
volumes:
- ./tools/local-env/default.template:/etc/nginx/conf.d/default.template
- ./:/var/www
# Load our config file, substituting environment variables into the config.
command: /bin/sh -c "envsubst '$$LOCAL_DIR' < /etc/nginx/conf.d/default.template > /etc/nginx/conf.d/default.conf && exec nginx -g 'daemon off;'"
depends_on:
- php
##
# The PHP container.
##
php:
image: wordpressdevelop/php:${LOCAL_PHP-latest}
networks:
- wpdevnet
environment:
- LOCAL_PHP_XDEBUG=${LOCAL_PHP_XDEBUG-false}
- XDEBUG_MODE=${LOCAL_PHP_XDEBUG_MODE-develop,debug}
- LOCAL_PHP_MEMCACHED=${LOCAL_PHP_MEMCACHED-false}
- PHP_FPM_UID=${PHP_FPM_UID-1000}
- PHP_FPM_GID=${PHP_FPM_GID-1000}
- GITHUB_REF=${GITHUB_REF-false}
- GITHUB_EVENT_NAME=${GITHUB_EVENT_NAME-false}
volumes:
- ./tools/local-env/php-config.ini:/usr/local/etc/php/conf.d/php-config.ini
- ./:/var/www
depends_on:
- mysql
##
# The MySQL container.
##
mysql:
image: ${LOCAL_DB_TYPE-mysql}:${LOCAL_DB_VERSION-latest}
networks:
- wpdevnet
ports:
- "3306"
environment:
MYSQL_ROOT_PASSWORD: password
volumes:
- ./tools/local-env/mysql-init.sql:/docker-entrypoint-initdb.d/mysql-init.sql
- mysql:/var/lib/mysql
# For compatibility with PHP versions that don't support the caching_sha2_password auth plugin used in MySQL 8.0.
command: --default-authentication-plugin=mysql_native_password
##
# The WP CLI container.
##
cli:
image: wordpressdevelop/cli:${LOCAL_PHP-latest}
networks:
- wpdevnet
environment:
- LOCAL_PHP_XDEBUG=${LOCAL_PHP_XDEBUG-false}
- LOCAL_PHP_MEMCACHED=${LOCAL_PHP_MEMCACHED-false}
- PHP_FPM_UID=${PHP_FPM_UID-1000}
- PHP_FPM_GID=${PHP_FPM_GID-1000}
volumes:
- ./:/var/www
# The init directive ensures the command runs with a PID > 1, so Ctrl+C works correctly.
init: true
volumes:
# So that sites aren't wiped every time containers are restarted, MySQL uses a persistent volume.
mysql: {}
networks:
# Creating our own network allows us to connect between containers using their service name.
wpdevnet:
driver: bridge