Skip to content

Simplify SQLite installation caching #367

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 1 commit into from
Oct 5, 2026
Merged

Simplify SQLite installation caching #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 40 additions & 0 deletions features/testing.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,46 @@ Feature: Test that WP-CLI loads.
sqlite
"""

@require-sqlite
Scenario: Restore independent SQLite databases from the installation cache
Given a WP installation in 'cached'
When I run `wp eval 'echo substr( defined( "DB_PATH" ) ? DB_PATH : FQDB, strlen( ABSPATH ) );'` from 'cached'
Then save STDOUT as {DATABASE_PATH}

When I run `php -r "rename('cached', 'first');"`
And I run `wp eval 'update_option( "blogname", "First installation" );'` from 'first'

# Reuse the subdirectory to select the same installation cache.
Given a WP installation in 'cached'
Then the cached/{DATABASE_PATH} file should exist
When I run `wp eval 'echo get_option( "blogname" );'` from 'cached'
Then STDOUT should be:
"""
WP CLI Site
"""

When I run `php -r "rename('cached', 'second');"`
And I run `wp eval 'update_option( "blogname", "Second installation" );'` from 'second'

Given a WP installation in 'cached'
Then the cached/{DATABASE_PATH} file should exist
When I run `wp eval 'echo get_option( "blogname" );'` from 'cached'
Then STDOUT should be:
"""
WP CLI Site
"""

When I run `wp eval 'echo get_option( "blogname" );'` from 'first'
Then STDOUT should be:
"""
First installation
"""
When I run `wp eval 'echo get_option( "blogname" );'` from 'second'
Then STDOUT should be:
"""
Second installation
"""

@require-mysql
Scenario: Uses MySQL
Given a WP install
Expand Down
60 changes: 3 additions & 57 deletions src/Context/FeatureContext.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1953,50 +1953,11 @@ public function install_wp( $subdir = '', $version = '' ): void {

$install_cache_path = self::$install_cache_dir . '/install_' . md5( implode( ':', $install_args ) . ':subdir=' . $subdir . ':object_cache=' . getenv( 'WP_CLI_TEST_OBJECT_CACHE' ) );

$install_cache_is_valid = is_dir( $install_cache_path )
&& ( 'sqlite' !== self::$db_type || file_exists( "{$install_cache_path}.sqlite" ) );

if ( ! $install_cache_is_valid && file_exists( $install_cache_path ) ) {
if ( is_dir( $install_cache_path ) ) {
$iterator = new \RecursiveIteratorIterator(
new \RecursiveDirectoryIterator( $install_cache_path, \FilesystemIterator::SKIP_DOTS ),
\RecursiveIteratorIterator::CHILD_FIRST
);
foreach ( $iterator as $fileinfo ) {
if ( $fileinfo->isDir() ) {
rmdir( $fileinfo->getPathname() );
} else {
unlink( $fileinfo->getPathname() );
}
}
rmdir( $install_cache_path );
} else {
unlink( $install_cache_path );
}

$sqlite_cache = "{$install_cache_path}.sqlite";
if ( file_exists( $sqlite_cache ) && is_file( $sqlite_cache ) ) {
unlink( $sqlite_cache );
}

$sql_cache = "{$install_cache_path}.sql";
if ( file_exists( $sql_cache ) && is_file( $sql_cache ) ) {
unlink( $sql_cache );
}
}
if ( $install_cache_is_valid ) {
// The cache includes the SQLite database, stored under "wp-content/database".
if ( is_dir( $install_cache_path ) ) {
self::copy_dir( $install_cache_path, $run_dir );

// This is the sqlite equivalent of restoring a database dump in MySQL
if ( 'sqlite' === self::$db_type ) {
$sqlite_dest_dir = "$run_dir/wp-content/database";
if ( ! is_dir( $sqlite_dest_dir ) ) {
mkdir( $sqlite_dest_dir, 0755, true );
}
if ( file_exists( "{$install_cache_path}.sqlite" ) ) {
copy( "{$install_cache_path}.sqlite", "$sqlite_dest_dir/.ht.sqlite.php" );
}
} else {
if ( 'sqlite' !== self::$db_type ) {
$ssl_flag = 'mariadb' === self::$db_type ? ' --skip-ssl-verify-server-cert' : '';
self::run_sql( self::$mysql_binary . ' --no-defaults' . $ssl_flag, [ 'execute' => "source {$install_cache_path}.sql" ], true /*add_database*/ );
}
Expand All @@ -2021,21 +1982,6 @@ public function install_wp( $subdir = '', $version = '' ): void {
}
self::run_sql( $command, [ 'result-file' => "{$install_cache_path}.sql" ], true /*add_database*/ );
}

if ( 'sqlite' === self::$db_type ) {
// This is the sqlite equivalent of creating a database dump in MySQL
// Support both the new (.ht.sqlite.php) and legacy (.ht.sqlite) file names.
$sqlite_source = "$run_dir/wp-content/database/.ht.sqlite.php";
if ( ! file_exists( $sqlite_source ) ) {
$sqlite_source = "$run_dir/wp-content/database/.ht.sqlite";
}
if ( file_exists( $sqlite_source ) ) {
copy( $sqlite_source, "{$install_cache_path}.sqlite" );
} elseif ( file_exists( "{$install_cache_path}.sqlite" ) ) {
// Ensure we don't keep a stale cached SQLite DB if the source wasn't produced
unlink( "{$install_cache_path}.sqlite" );
}
}
}
}

Expand Down
Loading