Update testing framework.

Author: schlessera

features/bootstrap/FeatureContext.php

@@ -19,7 +19,7 @@
 		if ( ! empty( $composer->autoload->files ) ) {
 			$contents = 'require:' . PHP_EOL;
 			foreach( $composer->autoload->files as $file ) {
-				$contents .= '  - ' . dirname( dirname( dirname( __FILE__ ) ) ) . '/' . $file;
+				$contents .= '  - ' . dirname( dirname( dirname( __FILE__ ) ) ) . '/' . $file . PHP_EOL;
 			}
 			@mkdir( sys_get_temp_dir() . '/wp-cli-package-test/' );
 			$project_config = sys_get_temp_dir() . '/wp-cli-package-test/config.yml';
@@ -59,9 +59,10 @@ class FeatureContext extends BehatContext implements ClosuredContextInterface {
 	 */
 	private static function get_process_env_variables() {
 		// Ensure we're using the expected `wp` binary
-		$bin_dir = getenv( 'WP_CLI_BIN_DIR' ) ?: realpath( __DIR__ . "/../../bin" );
+		$bin_dir = getenv( 'WP_CLI_BIN_DIR' ) ?: realpath( __DIR__ . '/../../bin' );
+		$vendor_dir = realpath( __DIR__ . '/../../vendor/bin' );
 		$env = array(
-			'PATH' =>  $bin_dir . ':' . getenv( 'PATH' ),
+			'PATH' =>  $bin_dir . ':' . $vendor_dir . ':' . getenv( 'PATH' ),
 			'BEHAT_RUN' => 1,
 			'HOME' => '/tmp/wp-cli-home',
 		);
@@ -178,6 +179,9 @@ public static function create_cache_dir() {
 	 * @param array $parameters context parameters (set them up through behat.yml)
 	 */
 	public function __construct( array $parameters ) {
+		if ( getenv( 'WP_CLI_TEST_DBHOST' ) ) {
+			self::$db_settings['dbhost'] = getenv( 'WP_CLI_TEST_DBHOST' );
+		}
 		$this->drop_db();
 		$this->set_cache_dir();
 		$this->variables['CORE_CONFIG_SETTINGS'] = Utils\assoc_args_to_str( self::$db_settings );
@@ -215,9 +219,21 @@ public function create_run_dir() {
 	public function build_phar( $version = 'same' ) {
 		$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . '/' . uniqid( "wp-cli-build-", TRUE ) . '.phar';
 
+		// Test running against WP-CLI proper
+		$make_phar_path = __DIR__ . '/../../utils/make-phar.php';
+		if ( ! file_exists( $make_phar_path ) ) {
+			// Test running against a package installed as a WP-CLI dependency
+			// WP-CLI installed as a project dependency
+			$make_phar_path = __DIR__ . '/../../../../../utils/make-phar.php';
+			if ( ! file_exists( $make_phar_path ) ) {
+				// WP-CLI as a dependency of this project
+				$make_phar_path = __DIR__ . '/../../vendor/wp-cli/wp-cli/utils/make-phar.php';
+			}
+		}
+
 		$this->proc( Utils\esc_cmd(
 			'php -dphar.readonly=0 %1$s %2$s --version=%3$s && chmod +x %2$s',
-			__DIR__ . '/../../utils/make-phar.php',
+			$make_phar_path,
 			$this->variables['PHAR_PATH'],
 			$version
 		) )->run_check();
@@ -315,7 +331,8 @@ public function download_wp( $subdir = '' ) {
 
 	public function create_config( $subdir = '' ) {
 		$params = self::$db_settings;
-		$params['dbprefix'] = $subdir ?: 'wp_';
+		// Replaces all characters that are not alphanumeric or an underscore into an underscore.
+		$params['dbprefix'] = $subdir ? preg_replace( '#[^a-zA-Z\_0-9]#', '_', $subdir ) : 'wp_';
 
 		$params['skip-salts'] = true;
 		$this->proc( 'wp core config', $params, $subdir )->run_check();

features/bootstrap/utils.php

@@ -6,6 +6,7 @@
 
 use \Composer\Semver\Comparator;
 use \Composer\Semver\Semver;
+use \WP_CLI;
 use \WP_CLI\Dispatcher;
 use \WP_CLI\Iterators\Transform;
 
@@ -34,7 +35,11 @@ function extract_from_phar( $path ) {
 
 function load_dependencies() {
 	if ( inside_phar() ) {
-		require WP_CLI_ROOT . '/vendor/autoload.php';
+		if ( file_exists( WP_CLI_ROOT . '/vendor/autoload.php' ) ) {
+			require WP_CLI_ROOT . '/vendor/autoload.php';
+		} elseif ( file_exists( dirname( dirname( WP_CLI_ROOT ) ) . '/autoload.php' ) ) {
+			require dirname( dirname( WP_CLI_ROOT ) ) . '/autoload.php';
+		}
 		return;
 	}
 
@@ -762,3 +767,76 @@ function parse_ssh_url( $url, $component = -1 ) {
 			return $bits;
 	}
 }
+
+/**
+ * Report the results of the same operation against multiple resources.
+ *
+ * @access public
+ * @category Input
+ *
+ * @param string  $noun      Resource being affected (e.g. plugin)
+ * @param string  $verb      Type of action happening to the noun (e.g. activate)
+ * @param integer $total     Total number of resource being affected.
+ * @param integer $successes Number of successful operations.
+ * @param integer $failures  Number of failures.
+ */
+function report_batch_operation_results( $noun, $verb, $total, $successes, $failures ) {
+	$plural_noun = $noun . 's';
+	if ( in_array( $verb, array( 'reset' ), true ) ) {
+		$past_tense_verb = $verb;
+	} else {
+		$past_tense_verb = 'e' === substr( $verb, -1 ) ? $verb . 'd' : $verb . 'ed';
+	}
+	$past_tense_verb_upper = ucfirst( $past_tense_verb );
+	if ( $failures ) {
+		if ( $successes ) {
+			WP_CLI::error( "Only {$past_tense_verb} {$successes} of {$total} {$plural_noun}." );
+		} else {
+			WP_CLI::error( "No {$plural_noun} {$past_tense_verb}." );
+		}
+	} else {
+		if ( $successes ) {
+			WP_CLI::success( "{$past_tense_verb_upper} {$successes} of {$total} {$plural_noun}." );
+		} else {
+			$message = $total > 1 ? ucfirst( $plural_noun ) : ucfirst( $noun );
+			WP_CLI::success( "{$message} already {$past_tense_verb}." );
+		}
+	}
+}
+
+/**
+ * Parse a string of command line arguments into an $argv-esqe variable.
+ *
+ * @access public
+ * @category Input
+ *
+ * @param string $arguments
+ * @return array
+ */
+function parse_str_to_argv( $arguments ) {
+	preg_match_all ('/(?<=^|\s)([\'"]?)(.+?)(?<!\\\\)\1(?=$|\s)/', $arguments, $matches );
+	$argv = isset( $matches[0] ) ? $matches[0] : array();
+	$argv = array_map( function( $arg ){
+		foreach( array( '"', "'" ) as $char ) {
+			if ( $char === substr( $arg, 0, 1 ) && $char === substr( $arg, -1 ) ) {
+				$arg = substr( $arg, 1, -1 );
+				break;
+			}
+		}
+		return $arg;
+	}, $argv );
+	return $argv;
+}
+
+/**
+ * Locale-independent version of basename()
+ *
+ * @access public
+ *
+ * @param string $path
+ * @param string $suffix
+ * @return string
+ */
+function basename( $path, $suffix = '' ) {
+	return urldecode( \basename( str_replace( array( '%2F', '%5C' ), '/', urlencode( $path ) ), $suffix ) );
+}

features/steps/given.php

@@ -25,6 +25,13 @@ function ( $world, $path, PyStringNode $content ) {
 	}
 );
 
+$steps->Given( '/^"([^"]+)" replaced with "([^"]+)" in the ([^\s]+) file$/', function( $world, $search, $replace, $path ) {
+	$full_path = $world->variables['RUN_DIR'] . "/$path";
+	$contents = file_get_contents( $full_path );
+	$contents = str_replace( $search, $replace, $contents );
+	file_put_contents( $full_path, $contents );
+});
+
 $steps->Given( '/^WP files$/',
 	function ( $world ) {
 		$world->download_wp();
@@ -102,7 +109,7 @@ function ( $world, TableNode $table ) {
 	}
 );
 
-$steps->Given( '/^save (STDOUT|STDERR) ([\'].+[^\'])?as \{(\w+)\}$/',
+$steps->Given( '/^save (STDOUT|STDERR) ([\'].+[^\'])?\s?as \{(\w+)\}$/',
 	function ( $world, $stream, $output_filter, $key ) {
 
 		$stream = strtolower( $stream );
@@ -154,4 +161,4 @@ function($world) {
 
 		file_put_contents( $wp_config_path, $wp_config_code );
 	}
-);
+);

features/steps/then.php

@@ -145,6 +145,15 @@ function ( $world, $stream ) {
 	}
 );
 
+$steps->Then( '/^(STDOUT|STDERR) should be a version string (<|<=|>|>=|==|=|!=|<>) ([+\w\.-]+)$/',
+	function ( $world, $stream, $operator, $goal_ver ) {
+		$stream = strtolower( $stream );
+		if ( false === version_compare( trim( $world->result->$stream, "\n" ), $goal_ver, $operator ) ) {
+			throw new Exception( $world->result );
+		}
+	}
+);	
+
 $steps->Then( '/^the (.+) (file|directory) should (exist|not exist|be:|contain:|not contain:)$/',
 	function ( $world, $path, $type, $action, $expected = null ) {
 		$path = $world->replace_variables( $path );

utils/behat-tags.php

@@ -15,7 +15,7 @@
 
 function version_tags( $prefix, $current, $operator = '<' ) {
 	if ( ! $current )
-		return;
+		return array();
 
 	exec( "grep '@{$prefix}-[0-9\.]*' -h -o features/*.feature | uniq", $existing_tags );
 
@@ -40,6 +40,26 @@ function version_tags( $prefix, $current, $operator = '<' ) {
 # Skip Github API tests by default because of rate limiting. See https://github.com/wp-cli/wp-cli/issues/1612
 $skip_tags[] = '@github-api';
 
+# Require PHP extension, eg 'imagick'.
+function extension_tags() {
+	$extension_tags = array();
+	exec( "grep '@require-extension-[A-Za-z_]*' -h -o features/*.feature | uniq", $extension_tags );
+
+	$skip_tags = array();
+
+	$substr_start = strlen( '@require-extension-' );
+	foreach ( $extension_tags as $tag ) {
+		$extension = substr( $tag, $substr_start );
+		if ( ! extension_loaded( $extension ) ) {
+			$skip_tags[] = $tag;
+		}
+	}
+
+	return $skip_tags;
+}
+
+$skip_tags = array_merge( $skip_tags, extension_tags() );
+
 if ( !empty( $skip_tags ) ) {
 	echo '--tags=~' . implode( '&&~', $skip_tags );
 }