Skip to content

Keep the shared opcode cache from changing what the code does #417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 2 commits into from
Nov 2, 2026
Merged

Keep the shared opcode cache from changing what the code does #417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d12115
Keep the shared opcode cache from changing what the code does
schlessera Nov 2, 2026
87d1bf1
Name the cache after its settings and restore PHPRC as well
schlessera Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions features/testing.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,14 @@ Feature: Test that WP-CLI loads.
C:\Windows
"""


@skip-windows
Scenario: Run WP-CLI with a disabled function after it ran without
Given an empty directory
When I run `wp cli version`
And I try `{INVOKE_WP_CLI_WITH_PHP_ARGS--ddisable_functions=ini_set} cli info`
Then the return code should be 0
And STDOUT should contain:
"""
PHP binary
"""
45 changes: 35 additions & 10 deletions src/Context/FeatureContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,12 @@ private static function get_process_env_variables(): array {
$env['WP_CLI_REQUIRE'] = $updated;
}

$env = array_merge( $env, self::get_php_tuning_env_variables() );
$env = array_filter(
array_merge( $env, self::get_php_tuning_env_variables() ),
static function ( $value ) {
return null !== $value;
}
);

$config_path = getenv( 'WP_CLI_CONFIG_PATH' );
if ( false !== $config_path ) {
Expand Down Expand Up @@ -569,7 +574,7 @@ private static function get_process_env_variables(): array {
*
* Set WP_CLI_TEST_PHP_TUNING=off to launch the processes with the PHP configuration as it is.
*
* @return array<string, string>
* @return array<string, string|null> Null for variables to leave out.
*/
private static function get_php_tuning_env_variables(): array {
if ( 'off' === getenv( 'WP_CLI_TEST_PHP_TUNING' ) || self::running_with_code_coverage() ) {
Expand All @@ -587,9 +592,13 @@ private static function get_php_tuning_env_variables(): array {
return $env;
}

// The directories are named after the settings, so that a cache written with other settings,
// such as by an older version of this package, is never used, nor its configuration file.
$settings = [ 'opcache.enable_cli=1', 'opcache.file_cache_only=1', 'opcache.optimization_level=0' ];
$key = substr( md5( implode( "\n", $settings ) ), 0, 8 );
$temp_dir = rtrim( sys_get_temp_dir(), '/' );
$config_dir = "{$temp_dir}/wp-cli-test-php-config";
$cache_dir = "{$temp_dir}/wp-cli-test-opcache";
$config_dir = "{$temp_dir}/wp-cli-test-php-config-{$key}";
$cache_dir = "{$temp_dir}/wp-cli-test-opcache-{$key}";

foreach ( [ $config_dir, $cache_dir ] as $dir ) {
if ( ! is_dir( $dir ) && ! @mkdir( $dir, 0777, true ) && ! is_dir( $dir ) ) {
Expand All @@ -600,16 +609,32 @@ private static function get_php_tuning_env_variables(): array {
$excluded = array_unique( array_filter( [ $temp_dir, realpath( $temp_dir ) ] ) );
file_put_contents( "{$config_dir}/opcache-blacklist.txt", implode( "/\n", $excluded ) . "/\n" );

$ini = [
'opcache.enable_cli=1',
"opcache.file_cache={$cache_dir}",
'opcache.file_cache_only=1',
"opcache.blacklist_filename={$config_dir}/opcache-blacklist.txt",
];
// The optimizer bakes in what it finds at compile time, such as whether a function exists,
// which differs between processes with other settings, such as disabled functions.
$ini = array_merge(
$settings,
[
"opcache.file_cache={$cache_dir}",
"opcache.blacklist_filename={$config_dir}/opcache-blacklist.txt",
]
);
file_put_contents( "{$config_dir}/wp-cli-tests.ini", implode( "\n", $ini ) . "\n" );
Comment thread
schlessera marked this conversation as resolved.
Resolved

// Add to the directories PHP scans for configuration files rather than replacing them.
$scan_dirs = getenv( 'PHP_INI_SCAN_DIR' );

// Behat and Composer restart without Xdebug through composer/xdebug-handler, which clears
// the directories, and keeps the original ones in its settings, with "*" if there were none.
// The configuration file it points PHPRC to holds the scanned files already, so restore that too.
$restart_settings = getenv( 'XDEBUG_HANDLER_SETTINGS' );
if ( '' === $scan_dirs && is_string( $restart_settings ) ) {
$restart = explode( '|', $restart_settings );
if ( isset( $restart[2], $restart[3] ) ) {
$scan_dirs = '*' === $restart[2] ? false : $restart[2];
$env['PHPRC'] = '*' === $restart[3] ? null : $restart[3];
}
}

if ( false === $scan_dirs ) {
$scan_dirs = PHP_CONFIG_FILE_SCAN_DIR;
}
Expand Down
2 changes: 1 addition & 1 deletion utils/docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ RUN if dpkg --compare-versions "$(dpkg-query -W -f '${Version}' libsqlite3-0)" l
&& [ "$(openssl dgst -sha3-256 -r sqlite.tar.gz | cut -d' ' -f1)" = "${SQLITE_SHA3_256}" ] \
&& tar xzf sqlite.tar.gz \
&& cd "sqlite-autoconf-${SQLITE_VERSION}" \
&& CFLAGS="-O2 -DSQLITE_ALLOW_ROWID_IN_VIEW -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_DBPAGE_VTAB -DSQLITE_ENABLE_DBSTAT_VTAB -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS -DSQLITE_ENABLE_FTS3_TOKENIZER -DSQLITE_ENABLE_FTS4 -DSQLITE_ENABLE_FTS5 -DSQLITE_ENABLE_LOAD_EXTENSION -DSQLITE_ENABLE_MATH_FUNCTIONS -DSQLITE_ENABLE_PREUPDATE_HOOK -DSQLITE_ENABLE_RTREE -DSQLITE_ENABLE_SESSION -DSQLITE_ENABLE_STMTVTAB -DSQLITE_ENABLE_UNLOCK_NOTIFY -DSQLITE_ENABLE_UPDATE_DELETE_LIMIT -DSQLITE_LIKE_DOESNT_MATCH_BLOBS -DSQLITE_MAX_SCHEMA_RETRY=25 -DSQLITE_SECURE_DELETE -DSQLITE_SOUNDEX -DSQLITE_USE_URI=1" \
&& CFLAGS="-O2 -DSQLITE_ALLOW_ROWID_IN_VIEW -DSQLITE_ENABLE_COLUMN_METADATA=1 -DSQLITE_ENABLE_DBPAGE_VTAB -DSQLITE_ENABLE_DBSTAT_VTAB -DSQLITE_ENABLE_FTS3 -DSQLITE_ENABLE_FTS3_PARENTHESIS -DSQLITE_ENABLE_FTS3_TOKENIZER -DSQLITE_ENABLE_FTS4 -DSQLITE_ENABLE_FTS5 -DSQLITE_ENABLE_LOAD_EXTENSION -DSQLITE_ENABLE_MATH_FUNCTIONS -DSQLITE_ENABLE_PREUPDATE_HOOK -DSQLITE_ENABLE_RTREE -DSQLITE_ENABLE_SESSION -DSQLITE_ENABLE_STMTVTAB -DSQLITE_ENABLE_UNLOCK_NOTIFY -DSQLITE_LIKE_DOESNT_MATCH_BLOBS -DSQLITE_MAX_SCHEMA_RETRY=25 -DSQLITE_SECURE_DELETE -DSQLITE_SOUNDEX -DSQLITE_USE_URI=1" \
./configure --prefix=/usr/local --disable-static > /dev/null \
&& make -j"$(nproc)" > /dev/null \
&& make install > /dev/null \
Expand Down
Loading