Merge pull request #244 from wp-cli/use-wp-cli-require

Use WP_CLI_REQUIRE to require codecov file for testing

Author: swissspidy

src/Context/FeatureContext.php

@@ -297,6 +297,19 @@ private static function get_process_env_variables() {
 			'TEST_RUN_DIR' => self::$behat_run_dir,
 		];
 
+		$with_code_coverage = (string) getenv( 'WP_CLI_TEST_COVERAGE' );
+		if ( \in_array( $with_code_coverage, [ 'true', '1' ], true ) ) {
+			$coverage_require_file = self::$behat_run_dir . '/vendor/wp-cli/wp-cli-tests/utils/generate-coverage.php';
+			if ( ! file_exists( $coverage_require_file ) ) {
+				// This file is not vendored inside the wp-cli-tests project
+				$coverage_require_file = self::$behat_run_dir . '/utils/generate-coverage.php';
+			}
+
+			$current               = getenv( 'WP_CLI_REQUIRE' );
+			$updated               = $current ? "{$current},{$coverage_require_file}" : $coverage_require_file;
+			$env['WP_CLI_REQUIRE'] = $updated;
+		}
+
 		$config_path = getenv( 'WP_CLI_CONFIG_PATH' );
 		if ( false !== $config_path ) {
 			$env['WP_CLI_CONFIG_PATH'] = $config_path;
@@ -377,7 +390,6 @@ private static function get_behat_internal_variables() {
 			'FRAMEWORK_ROOT' => realpath( $framework_root ),
 			'SRC_DIR'        => realpath( dirname( dirname( __DIR__ ) ) ),
 			'PROJECT_DIR'    => realpath( dirname( dirname( dirname( dirname( dirname( __DIR__ ) ) ) ) ) ),
-			'TEST_RUN_DIR'   => self::$behat_run_dir,
 		];
 
 		return $variables;
@@ -690,46 +702,6 @@ public function __construct() {
 		$this->set_cache_dir();
 	}
 
-	/**
-	 * Enhances a `wp <command>` string with an additional `--require` for code coverage collection.
-	 *
-	 * Only applies if `WP_CLI_TEST_COVERAGE` is set.
-	 *
-	 * @param string $cmd Command string.
-	 * @return string Possibly enhanced command string.
-	 */
-	public function get_command_with_coverage( $cmd ) {
-		$with_code_coverage = (string) getenv( 'WP_CLI_TEST_COVERAGE' );
-
-		if ( \in_array( $with_code_coverage, [ 'true', '1' ], true ) ) {
-
-			$modify_command = function ( $part ) {
-				if ( preg_match( '/(^wp )|( wp )|(\/wp )/', $part ) ) {
-					$part = preg_replace( '/(^wp )|( wp )|(\/wp )/', '$1$2$3', $part );
-
-					$require_path = '{TEST_RUN_DIR}/vendor/wp-cli/wp-cli-tests/utils/generate-coverage.php';
-					if ( ! file_exists( $this->variables['TEST_RUN_DIR'] . '/vendor/wp-cli/wp-cli-tests/utils/generate-coverage.php' ) ) {
-						// This file is not vendored inside the wp-cli-tests project
-						$require_path = '{TEST_RUN_DIR}/utils/generate-coverage.php';
-					}
-					$part .= " --require={$require_path}";
-
-				}
-				return $part;
-			};
-
-			if ( strpos( $cmd, '|' ) !== false ) {
-				$parts = explode( '|', $cmd );
-				$parts = array_map( $modify_command, $parts );
-				$cmd   = implode( '|', $parts );
-			} else {
-				$cmd = $modify_command( $cmd );
-			}
-		}
-
-		return $cmd;
-	}
-
 	/**
 	 * Replace standard {VARIABLE_NAME} variables and the special {INVOKE_WP_CLI_WITH_PHP_ARGS-args} and {WP_VERSION-version-latest} variables.
 	 * Note that standard variable names can only contain uppercase letters, digits and underscores and cannot begin with a digit.

src/Context/WhenStepDefinitions.php

@@ -35,7 +35,6 @@ public function when_i_launch_in_the_background( $cmd ) {
 	 * @When /^I (run|try) `([^`]+)`$/
 	 */
 	public function when_i_run( $mode, $cmd ) {
-		$cmd          = $this->get_command_with_coverage( $cmd );
 		$cmd          = $this->replace_variables( $cmd );
 		$this->result = $this->wpcli_tests_invoke_proc( $this->proc( $cmd ), $mode );
 		list( $this->result->stdout, $this->email_sends ) = $this->wpcli_tests_capture_email_sends( $this->result->stdout );
@@ -45,7 +44,6 @@ public function when_i_run( $mode, $cmd ) {
 	 * @When /^I (run|try) `([^`]+)` from '([^\s]+)'$/
 	 */
 	public function when_i_run_from_a_subfolder( $mode, $cmd, $subdir ) {
-		$cmd          = $this->get_command_with_coverage( $cmd );
 		$cmd          = $this->replace_variables( $cmd );
 		$this->result = $this->wpcli_tests_invoke_proc( $this->proc( $cmd, array(), $subdir ), $mode );
 		list( $this->result->stdout, $this->email_sends ) = $this->wpcli_tests_capture_email_sends( $this->result->stdout );