Add support for running tests against SQLite database (#181)

* Add support for running tests against SQLite database

This adds support for the SQLite Database Integration plugin, which allows WordPress to be installed using a SQLite databse instead of MySQL.

If the environment variable DB_TYPE is set to SQLITE then we will install the SQLite Database Integration plugin and uses its db.php dropin to addn SQLite support to the copy of WordPress that tests are run against.

* Update src/Context/FeatureContext.php

Co-authored-by: Pascal Birchler <[email protected]>

* Suggested changes

* Change this logic since exiting tests do not define DB_TYPE

* Make sure cached core files are in the proper state

When switching between MySQL and SQLite behat might use the same set of cached core files, so make sure they are set up properly to use the correct database method for the current run.

* Fix phpunit tests to work with new tags

* Fix more phpunit tests

* Remove previous hardcoded cache dir

* Make downloading and configuring sqlite two separate steps per suggetions

Now we can keep one cached copy of the plugin separate from core WordPress files and only use it when DB_TYPE=sqlite

* Fix Typo

* Update FeatureContext.php

Co-authored-by: Pascal Birchler <[email protected]>

* Remove db type check

---------

Co-authored-by: Pascal Birchler <[email protected]>

Author: mrsdizzie

features/testing.feature

@@ -23,3 +23,21 @@ Feature: Test that WP-CLI loads.
       """
       DISABLE_WP_CRON is: true
       """
+
+  @require-sqlite
+  Scenario: Uses SQLite
+  Given a WP install
+  When I run `wp eval 'echo DB_ENGINE;'`
+  Then STDOUT should contain:
+    """
+    sqlite
+    """
+
+  @require-mysql
+  Scenario: Uses MySQL
+  Given a WP install
+  When I run `wp eval 'var_export( defined("DB_ENGINE") );'`
+  Then STDOUT should be:
+    """
+    false
+    """

src/Context/FeatureContext.php

@@ -45,6 +45,11 @@ class FeatureContext implements SnippetAcceptingContext {
 	 */
 	private static $install_cache_dir;
 
+	/**
+	 * The directory that holds a copy of the sqlite-database-integration plugin, and which is copied to RUN_DIR during a "Given a WP installation" step. Lives until manually deleted.
+	 */
+	private static $sqlite_cache_dir;
+
 	/**
 	 * The directory that the WP-CLI cache (WP_CLI_CACHE_DIR, normally "$HOME/.wp-cli/cache") is set to on a "Given an empty cache" step.
 	 * Variable SUITE_CACHE_DIR. Lives until the end of the scenario (or until another "Given an empty cache" step within the scenario).
@@ -67,6 +72,11 @@ class FeatureContext implements SnippetAcceptingContext {
 		'dbhost' => '127.0.0.1',
 	];
 
+	/**
+	 *  What type of database should WordPress use for the test installations. Default to MySQL
+	 */
+	private static $db_type = 'mysql';
+
 	/**
 	 * Array of background process ids started by the current scenario. Used to terminate them at the end of the scenario.
 	 */
@@ -319,14 +329,82 @@ private static function get_behat_internal_variables() {
 		return $variables;
 	}
 
+	/**
+	* Download and extract a single copy of the sqlite-database-integration plugin
+	* for use in subsequent WordPress copies
+	*/
+	private static function download_sqlite_plugin( $dir ) {
+		$download_url      = 'https://downloads.wordpress.org/plugin/sqlite-database-integration.zip';
+		$download_location = $dir . '/sqlite-database-integration.zip';
+
+		if ( ! is_dir( $dir ) ) {
+			mkdir( $dir );
+		}
+
+		Process::create(
+			Utils\esc_cmd(
+				'curl -sSfL %1$s > %2$s',
+				$download_url,
+				$download_location
+			)
+		)->run_check();
+
+		$zip          = new \ZipArchive();
+		$new_zip_file = $download_location;
+
+		if ( $zip->open( $new_zip_file ) === true ) {
+			if ( $zip->extractTo( $dir ) ) {
+				$zip->close();
+				unlink( $new_zip_file );
+			} else {
+				$error_message = $zip->getStatusString();
+				throw new RuntimeException( sprintf( 'Failed to extract files from the zip: %s', $error_message ) );
+			}
+		} else {
+			$error_message = $zip->getStatusString();
+			throw new RuntimeException( sprintf( 'Failed to open the zip file: %s', $error_message ) );
+		}
+	}
+
+	/**
+	* Given a WordPress installation with the sqlite-database-integration plugin,
+	* configure it to use SQLite as the database by placing the db.php dropin file
+	*/
+	private static function configure_sqlite( $dir ) {
+		$db_copy   = $dir . '/wp-content/plugins/sqlite-database-integration/db.copy';
+		$db_dropin = $dir . '/wp-content/db.php';
+
+		/* similar to https://github.com/WordPress/sqlite-database-integration/blob/3306576c9b606bc23bbb26c15383fef08e03ab11/activate.php#L95 */
+		$file_contents = str_replace(
+			array(
+				'\'{SQLITE_IMPLEMENTATION_FOLDER_PATH}\'',
+				'{SQLITE_PLUGIN}',
+			),
+			array(
+				'__DIR__ . \'plugins/sqlite-database-integration\'',
+				'sqlite-database-integration/load.php',
+			),
+			file_get_contents( $db_copy )
+		);
+
+		file_put_contents( $db_dropin, $file_contents );
+	}
+
 	/**
 	 * We cache the results of `wp core download` to improve test performance.
 	 * Ideally, we'd cache at the HTTP layer for more reliable tests.
 	 */
 	private static function cache_wp_files() {
-		$wp_version        = getenv( 'WP_VERSION' );
-		$wp_version_suffix = ( false !== $wp_version ) ? "-$wp_version" : '';
-		self::$cache_dir   = sys_get_temp_dir() . '/wp-cli-test-core-download-cache' . $wp_version_suffix;
+		$wp_version             = getenv( 'WP_VERSION' );
+		$wp_version_suffix      = ( false !== $wp_version ) ? "-$wp_version" : '';
+		self::$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( 'DB_TYPE' ) ) {
+			if ( ! is_readable( self::$sqlite_cache_dir . '/sqlite-database-integration/db.copy' ) ) {
+				self::download_sqlite_plugin( self::$sqlite_cache_dir );
+			}
+		}
 
 		if ( is_readable( self::$cache_dir . '/wp-config-sample.php' ) ) {
 			return;
@@ -533,6 +611,10 @@ public function __construct() {
 			$this->variables['MYSQL_HOST'] = getenv( 'MYSQL_HOST' );
 		}
 
+		if ( 'sqlite' === getenv( 'DB_TYPE' ) ) {
+			self::$db_type = 'sqlite';
+		}
+
 		self::$db_settings['dbname'] = $this->variables['DB_NAME'];
 		self::$db_settings['dbuser'] = $this->variables['DB_USER'];
 		self::$db_settings['dbpass'] = $this->variables['DB_PASSWORD'];
@@ -757,11 +839,18 @@ private static function run_sql( $sql_cmd, $assoc_args = [], $add_database = fal
 	}
 
 	public function create_db() {
+		if ( 'sqlite' === self::$db_type ) {
+			return;
+		}
+
 		$dbname = self::$db_settings['dbname'];
 		self::run_sql( 'mysql --no-defaults', [ 'execute' => "CREATE DATABASE IF NOT EXISTS $dbname" ] );
 	}
 
 	public function drop_db() {
+		if ( 'sqlite' === self::$db_type ) {
+			return;
+		}
 		$dbname = self::$db_settings['dbname'];
 		self::run_sql( 'mysql --no-defaults', [ 'execute' => "DROP DATABASE IF EXISTS $dbname" ] );
 	}
@@ -854,6 +943,12 @@ public function download_wp( $subdir = '' ) {
 
 		// Add polyfills.
 		copy( dirname( dirname( __DIR__ ) ) . '/utils/polyfills.php', $dest_dir . '/wp-content/mu-plugins/polyfills.php' );
+
+		if ( 'sqlite' === self::$db_type ) {
+			self::copy_dir( self::$sqlite_cache_dir, $dest_dir . '/wp-content/plugins' );
+			self::configure_sqlite( $dest_dir );
+
+		}
 	}
 
 	public function create_config( $subdir = '', $extra_php = false ) {
@@ -897,7 +992,9 @@ public function install_wp( $subdir = '' ) {
 		// Disable WP Cron by default to avoid bogus HTTP requests in CLI context.
 		$config_extra_php = "if ( ! defined( 'DISABLE_WP_CRON' ) ) { define( 'DISABLE_WP_CRON', true ); }\n";
 
-		$this->create_db();
+		if ( 'mysql' === self::$db_type ) {
+			$this->create_db();
+		}
 		$this->create_run_dir();
 		$this->download_wp( $subdir );
 		$this->create_config( $subdir, $config_extra_php );
@@ -919,21 +1016,33 @@ public function install_wp( $subdir = '' ) {
 
 		if ( $install_cache_path && file_exists( $install_cache_path ) ) {
 			self::copy_dir( $install_cache_path, $run_dir );
-			self::run_sql( 'mysql --no-defaults', [ 'execute' => "source {$install_cache_path}.sql" ], true /*add_database*/ );
+
+			// This is the sqlite equivalent of restoring a database dump in MySQL
+			if ( 'sqlite' === self::$db_type ) {
+				copy( "{$install_cache_path}.sqlite", "$run_dir/wp-content/database/.ht.sqlite" );
+			} else {
+				self::run_sql( 'mysql --no-defaults', [ 'execute' => "source {$install_cache_path}.sql" ], true /*add_database*/ );
+			}
 		} else {
 			$this->proc( 'wp core install', $install_args, $subdir )->run_check();
 			if ( $install_cache_path ) {
 				mkdir( $install_cache_path );
 				self::dir_diff_copy( $run_dir, self::$cache_dir, $install_cache_path );
 
-				$mysqldump_binary          = Utils\force_env_on_nix_systems( 'mysqldump' );
-				$support_column_statistics = exec( "{$mysqldump_binary} --help | grep 'column-statistics'" );
-				$command                   = "{$mysqldump_binary} --no-defaults --no-tablespaces";
-				if ( $support_column_statistics ) {
-					$command .= ' --skip-column-statistics';
+				if ( 'mysql' === self::$db_type ) {
+					$mysqldump_binary          = Utils\force_env_on_nix_systems( 'mysqldump' );
+					$support_column_statistics = exec( "{$mysqldump_binary} --help | grep 'column-statistics'" );
+					$command                   = "{$mysqldump_binary} --no-defaults --no-tablespaces";
+					if ( $support_column_statistics ) {
+						$command .= ' --skip-column-statistics';
+					}
+					self::run_sql( $command, [ 'result-file' => "{$install_cache_path}.sql" ], true /*add_database*/ );
 				}
 
-				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
+					copy( "$run_dir/wp-content/database/.ht.sqlite", "{$install_cache_path}.sqlite" );
+				}
 			}
 		}
 	}
@@ -969,6 +1078,11 @@ public function install_wp_with_composer( $vendor_directory = 'vendor' ) {
 			'skip-email'     => true,
 		];
 
+		if ( 'sqlite' === self::$db_type ) {
+			self::copy_dir( self::$sqlite_cache_dir, $this->variables['RUN_DIR'] . '/WordPress/wp-content/plugins' );
+			self::configure_sqlite( $this->variables['RUN_DIR'] . '/WordPress' );
+		}
+
 		$this->proc( 'wp core install', $install_args )->run_check();
 	}
 

tests/test-behat-tags.php

@@ -34,6 +34,7 @@ protected function tear_down() {
 	public function test_behat_tags_wp_version_github_token( $env, $expected ) {
 		$env_wp_version   = getenv( 'WP_VERSION' );
 		$env_github_token = getenv( 'GITHUB_TOKEN' );
+		$db_type          = getenv( 'DB_TYPE' );
 
 		putenv( 'WP_VERSION' );
 		putenv( 'GITHUB_TOKEN' );
@@ -49,6 +50,14 @@ public function test_behat_tags_wp_version_github_token( $env, $expected ) {
 		if ( in_array( $env, array( 'WP_VERSION=trunk', 'WP_VERSION=nightly' ), true ) ) {
 			$expected .= '&&~@broken-trunk';
 		}
+
+		if ( 'sqlite' !== $db_type ) {
+			$expected .= '&&~@require-sqlite';
+		}
+		if ( 'sqlite' === $db_type ) {
+			$expected .= '&&~@require-mysql';
+		}
+
 		$this->assertSame( '--tags=' . $expected, $output );
 
 		putenv( false === $env_wp_version ? 'WP_VERSION' : "WP_VERSION=$env_wp_version" );
@@ -122,13 +131,14 @@ public function test_behat_tags_php_version() {
 		file_put_contents( $this->temp_dir . '/features/php_version.feature', $contents );
 
 		$output = exec( "cd {$this->temp_dir}; php $behat_tags" );
-		$this->assertSame( '--tags=' . $expected . '&&~@github-api&&~@broken', $output );
+		$this->assertSame( '--tags=' . $expected . '&&~@github-api&&~@broken&&~@require-sqlite', $output );
 
 		putenv( false === $env_github_token ? 'GITHUB_TOKEN' : "GITHUB_TOKEN=$env_github_token" );
 	}
 
 	public function test_behat_tags_extension() {
 		$env_github_token = getenv( 'GITHUB_TOKEN' );
+		$db_type          = getenv( 'DB_TYPE' );
 
 		putenv( 'GITHUB_TOKEN' );
 
@@ -137,12 +147,20 @@ public function test_behat_tags_extension() {
 		file_put_contents( $this->temp_dir . '/features/extension.feature', '@require-extension-imagick @require-extension-curl' );
 
 		$expecteds = array();
+
+		if ( 'sqlite' !== $db_type ) {
+			$expecteds[] = '~@require-sqlite';
+		}
+		if ( 'sqlite' === $db_type ) {
+			$expecteds[] = '~@require-mysql';
+		}
 		if ( ! extension_loaded( 'imagick' ) ) {
 			$expecteds[] = '~@require-extension-imagick';
 		}
 		if ( ! extension_loaded( 'curl' ) ) {
 			$expecteds[] = '~@require-extension-curl';
 		}
+
 		$expected = '--tags=' . implode( '&&', array_merge( array( '~@github-api', '~@broken' ), $expecteds ) );
 		$output   = exec( "cd {$this->temp_dir}; php $behat_tags" );
 		$this->assertSame( $expected, $output );

utils/behat-tags.php

@@ -72,14 +72,22 @@ function version_tags(
 if ( ! getenv( 'GITHUB_TOKEN' ) ) {
 	$skip_tags[] = '@github-api';
 }
-
 # Skip tests known to be broken.
 $skip_tags[] = '@broken';
 
 if ( $wp_version && in_array( $wp_version, array( 'nightly', 'trunk' ), true ) ) {
 	$skip_tags[] = '@broken-trunk';
 }
 
+if ( 'sqlite' === getenv( 'DB_TYPE' ) ) {
+	$skip_tags[] = '@require-mysql';
+}
+
+if ( 'sqlite' !== getenv( 'DB_TYPE' ) ) {
+	$skip_tags[] = '@require-sqlite';
+}
+
+
 # Require PHP extension, eg 'imagick'.
 function extension_tags( $features_folder = 'features' ) {
 	$extension_tags = array();