Skip to content

Tests: Various harness improvements, especially on Windows #326

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
swissspidy merged 22 commits into from
Mar 31, 2026
Merged

Tests: Various harness improvements, especially on Windows #326

Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
02300f9
Try windows logging
swissspidy Mar 27, 2026
7a2a75b
inject T(E)MP var into sub-processes
swissspidy Mar 27, 2026
a8ca70d
realpath run_dir
swissspidy Mar 27, 2026
6b5c279
mkdir tweak
swissspidy Mar 27, 2026
262e616
escape % to %% for all commands run on Windows
swissspidy Mar 28, 2026
2c0c130
remove logging again
swissspidy Mar 28, 2026
509b57d
real path
swissspidy Mar 28, 2026
44a832f
Partial revert
swissspidy Mar 28, 2026
661f366
undo
swissspidy Mar 29, 2026
ecb21c0
revert for testing
swissspidy Mar 29, 2026
be25fa4
pass down differently
swissspidy Mar 29, 2026
63834f9
add test
swissspidy Mar 29, 2026
2f15de8
add windir and systemroot
swissspidy Mar 29, 2026
8d0e2ce
fix matcher
swissspidy Mar 29, 2026
4da0cd2
more resilient downloading
swissspidy Mar 29, 2026
7927152
undo
swissspidy Mar 29, 2026
b7a36f7
Split by newline instead
swissspidy Mar 30, 2026
3e1fe8d
Prepend 'php ' on Windows if the command starts with the phar path.
swissspidy Mar 30, 2026
6c2e67a
fix
swissspidy Mar 30, 2026
13a813d
try hardening in remove_dir
swissspidy Mar 31, 2026
149885d
Normalize dir names
swissspidy Mar 31, 2026
2042250
fix indentation
swissspidy Mar 31, 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
8 changes: 8 additions & 0 deletions features/testing.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,11 @@ Feature: Test that WP-CLI loads.
This should only run on MySQL or MariaDB
"""

Scenario: Verify sys_get_temp_dir() in sub-process
Given a WP install
When I run `wp eval 'echo sys_get_temp_dir();'`
Then STDOUT should not contain:
"""
C:\Windows
Comment thread
swissspidy marked this conversation as resolved.
Outdated
"""
Comment thread
swissspidy marked this conversation as resolved.
Outdated

60 changes: 48 additions & 12 deletions src/Context/FeatureContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,13 @@ private static function get_process_env_variables(): array {

$env = array_merge( $_ENV, $env );

foreach ( [ 'TEMP', 'TMP', 'SystemRoot', 'windir' ] as $key ) {
$value = getenv( $key );
if ( false !== $value ) {
$env[ $key ] = $value;
}
}

if ( self::running_with_code_coverage() ) {
$has_coverage_driver = ( new Runtime() )->hasXdebug() || ( new Runtime() )->hasPCOV();

Expand Down Expand Up @@ -683,7 +690,7 @@ private static function configure_sqlite( $dir ): void {
private static function cache_wp_files( $version = '' ): void {
$wp_version = $version ?: getenv( 'WP_VERSION' );
$wp_version_suffix = $wp_version ? "-$wp_version" : '';
self::$cache_dir = sys_get_temp_dir() . '/wp-cli-test-core-download-cache' . $wp_version_suffix;
$cache_dir = sys_get_temp_dir() . '/wp-cli-test-core-download-cache' . $wp_version_suffix;
self::$sqlite_cache_dir = sys_get_temp_dir() . '/wp-cli-test-sqlite-integration-cache';

if ( 'sqlite' === getenv( 'WP_CLI_TEST_DBTYPE' ) ) {
Expand All @@ -699,15 +706,34 @@ private static function cache_wp_files( $version = '' ): void {
}
}

if ( is_readable( self::$cache_dir . '/wp-config-sample.php' ) ) {
if ( is_readable( $cache_dir . '/wp-includes/version.php' ) ) {
self::$cache_dir = $cache_dir;
return;
}

$cmd = Utils\esc_cmd( 'wp core download --force --path=%s', self::$cache_dir );
$cmd = Utils\esc_cmd( 'wp core download --force --path=%s', $cache_dir );
if ( $wp_version ) {
$cmd .= Utils\esc_cmd( ' --version=%s', $wp_version );
}
Process::create( $cmd, null, self::get_process_env_variables() )->run_check();

$max_retries = 3;
$retry_count = 0;
$completed = false;

// This is in addition to the retry logic inside Utils\http_request().
while ( $retry_count < $max_retries && ! $completed ) {
try {
Process::create( $cmd, null, self::get_process_env_variables() )->run_check();
$completed = true;
} catch ( \Exception $e ) {
++$retry_count;
if ( $retry_count >= $max_retries ) {
throw $e;
}
}
}

self::$cache_dir = $cache_dir;
}

/**
Expand Down Expand Up @@ -1183,17 +1209,18 @@ private static function get_event_file( $scope, &$line ): ?string {
*/
public function create_run_dir(): void {
if ( ! isset( $this->variables['RUN_DIR'] ) ) {
self::$run_dir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid( 'wp-cli-test-run-' . self::$temp_dir_infix . '-', true );
$temp_run_dir = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid( 'wp-cli-test-run-' . self::$temp_dir_infix . '-', true );
mkdir( $temp_run_dir );
self::$run_dir = $temp_run_dir;
$this->variables['RUN_DIR'] = self::$run_dir;
mkdir( $this->variables['RUN_DIR'] );
}
}

/**
* @param string $version
*/
public function build_phar( $version = 'same' ): void {
$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . '/' . uniqid( 'wp-cli-build-', true ) . '.phar';
$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . DIRECTORY_SEPARATOR . uniqid( 'wp-cli-build-', true ) . '.phar';

$is_bundle = false;

Expand Down Expand Up @@ -1249,7 +1276,7 @@ public function download_phar( $version = 'same' ): void {
$version
);

$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . '/'
$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . DIRECTORY_SEPARATOR
. uniqid( 'wp-cli-download-', true )
. '.phar';

Expand Down Expand Up @@ -1369,6 +1396,11 @@ public function proc( $command, $assoc_args = [], $path = '' ): Process {
$command .= Utils\assoc_args_to_str( $assoc_args );
}

// Prepend 'php ' on Windows if the command starts with the phar path.
if ( Utils\is_windows() && isset( $this->variables['PHAR_PATH'] ) && 0 === strpos( $command, $this->variables['PHAR_PATH'] ) ) {
$command = 'php ' . $command;
}

$env = self::get_process_env_variables();

if ( isset( $this->variables['SUITE_CACHE_DIR'] ) ) {
Expand Down Expand Up @@ -1525,7 +1557,7 @@ public static function copy_dir( $src_dir, $dest_dir ): void {
* @var \SplFileInfo $item
*/
foreach ( $iterator as $item ) {
$dest_path = $dest_dir . '/' . $iterator->getSubPathname();
$dest_path = rtrim( $dest_dir, '/\\' ) . DIRECTORY_SEPARATOR . $iterator->getSubPathname();
if ( $item->isDir() ) {
if ( ! is_dir( $dest_path ) ) {
mkdir( $dest_path, 0777, true );
Expand Down Expand Up @@ -1565,7 +1597,7 @@ public function download_wp( $subdir = '', $version = '' ): void {
echo "WordPress {$result->stdout}\n";
}

$dest_dir = $this->variables['RUN_DIR'] . "/$subdir";
$dest_dir = rtrim( $this->variables['RUN_DIR'], '/\\' ) . ( $subdir ? DIRECTORY_SEPARATOR . $subdir : '' );

if ( $subdir ) {
mkdir( $dest_dir, 0777, true /*recursive*/ );
Expand Down Expand Up @@ -1833,8 +1865,12 @@ public function composer_add_wp_cli_local_repository(): void {
self::remove_dir( self::$composer_local_repository . '/.git' );
self::remove_dir( self::$composer_local_repository . '/vendor' );
}
$dest = self::$composer_local_repository . '/';
$this->composer_command( "config repositories.wp-cli '{\"type\": \"path\", \"url\": \"$dest\", \"options\": {\"symlink\": false, \"versions\": { \"wp-cli/wp-cli\": \"dev-main\"}}}'" );
if ( Utils\is_windows() ) {
$json_config = '{\"type\": \"path\", \"url\": \"' . str_replace( '\\', '/', self::$composer_local_repository ) . '\", \"options\": {\"symlink\": false, \"versions\": { \"wp-cli/wp-cli\": \"dev-main\"}}}';
$this->composer_command( "config repositories.wp-cli \"$json_config\"" );
} else {
$this->composer_command( "config repositories.wp-cli '{\"type\": \"path\", \"url\": \"" . self::$composer_local_repository . "\", \"options\": {\"symlink\": false, \"versions\": { \"wp-cli/wp-cli\": \"dev-main\"}}}'" );
}
$this->variables['COMPOSER_LOCAL_REPOSITORY'] = self::$composer_local_repository;
}

Expand Down
2 changes: 1 addition & 1 deletion src/Context/ThenStepDefinitions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ public function then_a_specific_file_folder_should_exist( $path, $type, $strictl
foreach ( $files as &$file ) {
$file = str_replace( $path . '/', '', $file );
}
$contents = implode( PHP_EOL, $files );
$contents = implode( "\n", $files );
Comment thread
swissspidy marked this conversation as resolved.
}
$this->check_string( $contents, $expected, $action, false, (bool) $strictly );
}
Expand Down
Loading