Missing Xdebug from phpunit and other images

[kasparsd]

It is currently impossible to generate code coverage reports using the phpunit or any other images containing PHP that are generated by this repository.

@wordpress/env attempts to enable Xdebug support here:

https://github.com/WordPress/gutenberg/blob/d5915916abc45e6682f4bdb70888aa41e98aa395/packages/env/lib/init-config.js#L84-L90

but it doesn't do it for images that could actually be used for running CLI tasks such as phpunit, tests, cli and others as reported here WordPress/gutenberg#42286

[kasparsd]

Could we update all images to install Xdebug but leave it disabled by default? Or install and enable Xdebug only for php-cli usage so that it doesn't impact the performance of non-CLI requests?

[desrosj]

Hey @kasparsd,

xDebug is currently installed and disabled by default. WordPress Core actually generates a code coverage report using them and submits it to Codecov.io.

To boot the Docker containers with xDebug, a few environment variables need be set:

• LOCAL_PHP_XDEBUG needs to be set to true.
• To configure xDebug to generate coverage reports, LOCAL_PHP_XDEBUG_MODE needs to be set to coverage (develop,debug is the default).

Could you give this a try, or confirm that you've tried this and are experiencing issues?

[kasparsd]

Thanks! I'm not sure how I missed the LOCAL_PHP_XDEBUG conditional in common.sh:

wpdev-docker-images/entrypoint/common.sh

Lines 4 to 11 in 2106858

	# If LOCAL_PHP_XDEBUG=true xdebug extension will be enabled
	if [ "$LOCAL_PHP_XDEBUG" = true ]; then
	docker-php-ext-enable xdebug
	rm -f /usr/local/etc/php/conf.d/docker-php-ext-opcache.ini
	else
	docker-php-ext-enable opcache
	rm -f /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
	fi

So we just need to update wp-env to set these environment variables whenever xdebug is being requested via the custom CLI param WordPress/gutenberg#42286