Merge pull request #18 from wp-cli/update-tests-readme

Update package tests and README for the move

Author: danielbachhuber

README.md

@@ -1,11 +1,11 @@
-runcommand/dist-archive
-=======================
+wp-cli/dist-archive-command
+===========================
 
 Create a distribution .zip or .tar.gz based on a plugin or theme's .distignore file.
 
-[![runcommand open source](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/runcommand-open-source.svg)](https://runcommand.io/pricing/) [![CircleCI](https://circleci.com/gh/runcommand/dist-archive/tree/master.svg?style=svg)](https://circleci.com/gh/runcommand/dist-archive/tree/master)
+[![Build Status](https://travis-ci.org/wp-cli/dist-archive-command.svg?branch=master)](https://travis-ci.org/wp-cli/dist-archive-command)
 
-Quick links: [Using](#using) | [Installing](#installing) | [Support](#support)
+Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing)
 
 ## Using
 
@@ -52,16 +52,38 @@ script in each project.
 
 Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with `wp cli update`.
 
-Once you've done so, you can install this package with `wp package install runcommand/dist-archive`.
+Once you've done so, you can install this package with `wp package install wp-cli/dist-archive-command`.
 
-## Support
+## Contributing
 
-This WP-CLI package is free for anyone to use. Support, including usage questions and feature requests, is available to [paying runcommand customers](https://runcommand.io/pricing/).
+We appreciate you taking the initiative to contribute to this project.
 
-Think you’ve found a bug? Before you create a new issue, you should [search existing issues](https://github.com/runcommand/sparks/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version. Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/runcommand/sparks/issues/new) with description of what you were doing, what you saw, and what you expected to see.
+Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
 
-Want to contribute a new feature? Please first [open a new issue](https://github.com/runcommand/sparks/issues/new) to discuss whether the feature is a good fit for the project. Once you've decided to work on a pull request, please include [functional tests](https://wp-cli.org/docs/pull-requests/#functional-tests) and follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
+### Reporting a bug
 
-runcommand customers can also email [[email protected]](mailto:[email protected]) for private support.
+Think you’ve found a bug? We’d love for you to help us get it fixed.
 
+Before you create a new issue, you should [search existing issues](https://github.com/wp-cli/dist-archive-command/issues?q=label%3Abug%20) to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
 
+Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please [create a new issue](https://github.com/wp-cli/dist-archive-command/issues/new) with the following:
+
+1. What you were doing (e.g. "When I run `wp post list`").
+2. What you saw (e.g. "I see a fatal about a class being undefined.").
+3. What you expected to see (e.g. "I expected to see the list of posts.")
+
+Include as much detail as you can, and clear steps to reproduce if possible.
+
+### Creating a pull request
+
+Want to contribute a new feature? Please first [open a new issue](https://github.com/wp-cli/dist-archive-command/issues/new) to discuss whether the feature is a good fit for the project.
+
+Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
+
+1. Create a feature branch for each contribution.
+2. Submit your pull request early for feedback.
+3. Include functional tests with your changes. [Read the WP-CLI documentation](https://wp-cli.org/docs/pull-requests/#functional-tests) for an introduction.
+4. Follow the [WordPress Coding Standards](http://make.wordpress.org/core/handbook/coding-standards/).
+
+
+*This README.md is generated dynamically from the project's codebase using `wp scaffold package-readme` ([doc](https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme)). To suggest changes, please submit a pull request against the corresponding part of the codebase.*

bin/install-package-tests.sh

@@ -2,39 +2,9 @@
 
 set -ex
 
-PACKAGE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/../ && pwd )"
-
-download() {
-    if [ `which curl` ]; then
-        curl -s "$1" > "$2";
-    elif [ `which wget` ]; then
-        wget -nv -O "$2" "$1"
-    fi
-}
-
-install_wp_cli() {
-
-	# the Behat test suite will pick up the executable found in $WP_CLI_BIN_DIR
-	mkdir -p $WP_CLI_BIN_DIR
-	download https://raw.githubusercontent.com/wp-cli/builds/gh-pages/phar/wp-cli-nightly.phar $WP_CLI_BIN_DIR/wp
-	chmod +x $WP_CLI_BIN_DIR/wp
-
-}
-
-download_behat() {
-
-	cd $PACKAGE_DIR
-	download https://getcomposer.org/installer installer
-	php installer
-	php composer.phar require --dev behat/behat='~2.5'
-
-}
-
 install_db() {
 	mysql -e 'CREATE DATABASE IF NOT EXISTS wp_cli_test;' -uroot
 	mysql -e 'GRANT ALL PRIVILEGES ON wp_cli_test.* TO "wp_cli_test"@"localhost" IDENTIFIED BY "password1"' -uroot
 }
 
-install_wp_cli
-download_behat
 install_db

bin/test.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -ex
+
+# Run the functional tests
+BEHAT_TAGS=$(php utils/behat-tags.php)
+behat --format progress $BEHAT_TAGS --strict

circle.yml

@@ -2,14 +2,28 @@ machine:
   php:
     version: 5.6.22
   environment:
-    WP_CLI_BIN_DIR: /tmp/wp-cli-phar
+    PATH: "$HOME/$CIRCLE_PROJECT_REPONAME/vendor/bin:$PATH"
+    WP_CLI_BIN_DIR: "$HOME/$CIRCLE_PROJECT_REPONAME/vendor/bin"
 
 dependencies:
   cache_directories:
     - ~/.composer/cache
+  pre:
+    # Set the PHP timezone so that Behat does not fail.
+    - echo "date.timezone = 'US/Central'" > /opt/circleci/php/$(phpenv global)/etc/conf.d/wp-cli-timezone.ini
+    # Disable xdebug, which makes Composer slower.
+    - echo ""  > /opt/circleci/php/$(phpenv global)/etc/conf.d/xdebug.ini
+    # Increase memory limit
+    - echo "memory_limit = 512M" > /opt/circleci/php/$(phpenv global)/etc/conf.d/memory.ini
+  override:
+    - composer require wp-cli/wp-cli:dev-master
+    - composer install
+    - bash bin/install-package-tests.sh
 
 test:
   pre:
-    - bash bin/install-package-tests.sh
+    - composer validate
   override:
-    - ./vendor/bin/behat --strict
+    - WP_VERSION=latest bash bin/test.sh
+    - rm -rf '/tmp/wp-cli-test core-download-cache'
+    - WP_VERSION=trunk bash bin/test.sh

composer.json

@@ -13,7 +13,7 @@
     ],
     "minimum-stability": "dev",
     "autoload": {
-        "files": [ "command.php" ]
+        "files": [ "dist-archive-command.php" ]
     },
     "require": {},
     "require-dev": {
@@ -22,21 +22,6 @@
     "extra": {
         "commands": [
             "dist-archive"
-        ],
-        "readme": {
-            "shields": [
-                "[![runcommand open source](https://runcommand.io/wp-content/themes/runcommand-theme/bin/shields/runcommand-open-source.svg)](https://runcommand.io/pricing/)",
-                "[![CircleCI](https://circleci.com/gh/runcommand/dist-archive/tree/master.svg?style=svg)](https://circleci.com/gh/runcommand/dist-archive/tree/master)"
-            ],
-            "sections": [
-                "Using",
-                "Installing",
-                "Support"
-            ],
-            "support": {
-                "body": "https://raw.githubusercontent.com/runcommand/runcommand-theme/master/bin/readme-partials/support-open-source.md"
-            },
-            "show_powered_by": false
-        }
+        ]
     }
 }

command.php dist-archive-command.phpcommand.php renamed to dist-archive-command.php

@@ -12,13 +12,14 @@
 if ( file_exists( __DIR__ . '/utils.php' ) ) {
 	require_once __DIR__ . '/utils.php';
 	require_once __DIR__ . '/Process.php';
+	require_once __DIR__ . '/ProcessRun.php';
 	$project_composer = dirname( dirname( dirname( __FILE__ ) ) ) . '/composer.json';
 	if ( file_exists( $project_composer ) ) {
 		$composer = json_decode( file_get_contents( $project_composer ) );
 		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';
@@ -30,6 +31,7 @@
 } else {
 	require_once __DIR__ . '/../../php/utils.php';
 	require_once __DIR__ . '/../../php/WP_CLI/Process.php';
+	require_once __DIR__ . '/../../php/WP_CLI/ProcessRun.php';
 	require_once __DIR__ . '/../../vendor/autoload.php';
 }
 
@@ -57,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',
 		);
@@ -78,6 +81,9 @@ private static function cache_wp_files() {
 			return;
 
 		$cmd = Utils\esc_cmd( 'wp core download --force --path=%s', self::$cache_dir );
+		if ( getenv( 'WP_VERSION' ) ) {
+			$cmd .= Utils\esc_cmd( ' --version=%s', getenv( 'WP_VERSION' ) );
+		}
 		Process::create( $cmd, null, self::get_process_env_variables() )->run_check();
 	}
 
@@ -90,6 +96,9 @@ public static function prepare( SuiteEvent $event ) {
 		echo $result->stdout;
 		echo PHP_EOL;
 		self::cache_wp_files();
+		$result = Process::create( Utils\esc_cmd( 'wp core version --path=%s', self::$cache_dir ) , null, self::get_process_env_variables() )->run_check();
+		echo 'WordPress ' . $result->stdout;
+		echo PHP_EOL;
 	}
 
 	/**
@@ -119,6 +128,11 @@ public function afterScenario( $event ) {
 			}
 		}
 
+		// Remove WP-CLI package directory
+		if ( isset( $this->variables['PACKAGE_PATH'] ) ) {
+			$this->proc( Utils\esc_cmd( 'rm -rf %s', $this->variables['PACKAGE_PATH'] ) )->run();
+		}
+
 		foreach ( $this->running_procs as $proc ) {
 			self::terminate_proc( $proc );
 		}
@@ -165,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 );
@@ -202,22 +219,60 @@ 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();
 	}
 
+	public function download_phar( $version = 'same' ) {
+		if ( 'same' === $version ) {
+			$version = WP_CLI_VERSION;
+		}
+
+		$download_url = sprintf(
+			'https://github.com/wp-cli/wp-cli/releases/download/v%1$s/wp-cli-%1$s.phar',
+			$version
+		);
+
+		$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . '/'
+		                                . uniqid( 'wp-cli-download-', true )
+		                                . '.phar';
+
+		Process::create( \WP_CLI\Utils\esc_cmd(
+			'curl -sSL %s > %s',
+			$download_url,
+			$this->variables['PHAR_PATH']
+		) )->run_check();
+
+		Process::create( \WP_CLI\Utils\esc_cmd(
+			'chmod +x %s',
+			$this->variables['PHAR_PATH']
+		) )->run_check();
+	}
+
 	private function set_cache_dir() {
 		$path = sys_get_temp_dir() . '/wp-cli-test-cache';
 		$this->proc( Utils\esc_cmd( 'mkdir -p %s', $path ) )->run_check();
 		$this->variables['CACHE_DIR'] = $path;
 	}
 
 	private static function run_sql( $sql ) {
-		Utils\run_mysql_command( 'mysql --no-defaults', array(
+		Utils\run_mysql_command( '/usr/bin/env mysql --no-defaults', array(
 			'execute' => $sql,
 			'host' => self::$db_settings['dbhost'],
 			'user' => self::$db_settings['dbuser'],
@@ -302,7 +357,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/FeatureContext.php

@@ -73,33 +73,3 @@ public function run_check() {
 		return $r;
 	}
 }
-
-/**
- * Results of an executed command.
- */
-class ProcessRun {
-
-	/**
-	 * @var array $props Properties of executed command.
-	 */
-	public function __construct( $props ) {
-		foreach ( $props as $key => $value ) {
-			$this->$key = $value;
-		}
-	}
-
-	/**
-	 * Return properties of executed command as a string.
-	 *
-	 * @return string
-	 */
-	public function __toString() {
-		$out  = "$ $this->command\n";
-		$out .= "$this->stdout\n$this->stderr";
-		$out .= "cwd: $this->cwd\n";
-		$out .= "exit status: $this->return_code";
-
-		return $out;
-	}
-
-}

features/bootstrap/Process.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace WP_CLI;
+
+/**
+ * Results of an executed command.
+ */
+class ProcessRun {
+
+	/**
+	 * @var array $props Properties of executed command.
+	 */
+	public function __construct( $props ) {
+		foreach ( $props as $key => $value ) {
+			$this->$key = $value;
+		}
+	}
+
+	/**
+	 * Return properties of executed command as a string.
+	 *
+	 * @return string
+	 */
+	public function __toString() {
+		$out  = "$ $this->command\n";
+		$out .= "$this->stdout\n$this->stderr";
+		$out .= "cwd: $this->cwd\n";
+		$out .= "exit status: $this->return_code";
+
+		return $out;
+	}
+
+}