Merge branch 'main' into add/phpstan-enhancements

Author: swissspidy

.gitignore

@@ -12,4 +12,5 @@ phpunit.xml
 phpcs.xml
 .phpcs.xml
 .phpunit.result.cache
+.phpunit.cache
 build/logs

composer.json

@@ -27,7 +27,7 @@
         "wp-cli/eval-command": "^1 || ^2",
         "wp-cli/wp-cli": "^2.12",
         "wp-coding-standards/wpcs": "^3",
-        "yoast/phpunit-polyfills": "^1.0.3 || ^2.0.1"
+        "yoast/phpunit-polyfills": "^4.0.0"
     },
     "require-dev": {
         "roave/security-advisories": "dev-latest"

phpunit.xml.dist

@@ -1,10 +1,13 @@
+<?xml version="1.0" ?>
 <phpunit
 	bootstrap="tests/bootstrap.php"
 	colors="true"
 	convertErrorsToExceptions="true"
 	convertWarningsToExceptions="true"
 	convertNoticesToExceptions="true"
 	convertDeprecationsToExceptions="true"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
 	>
 	<testsuites>
 		<testsuite name="default">

src/Context/FeatureContext.php

@@ -271,12 +271,21 @@ public static function forget_feature( AfterFeatureScope $scope ): void {
 	}
 
 	/**
-	 * @AfterSuite
+	 * Whether tests are currently running with code coverage collection.
+	 *
+	 * @return bool
 	 */
-	public static function merge_coverage_reports(): void {
+	private static function running_with_code_coverage() {
 		$with_code_coverage = (string) getenv( 'WP_CLI_TEST_COVERAGE' );
 
-		if ( ! \in_array( $with_code_coverage, [ 'true', '1' ], true ) ) {
+		return \in_array( $with_code_coverage, [ 'true', '1' ], true );
+	}
+
+	/**
+	 * @AfterSuite
+	 */
+	public static function merge_coverage_reports(): void {
+		if ( ! self::running_with_code_coverage() ) {
 			return;
 		}
 
@@ -438,9 +447,7 @@ private static function get_process_env_variables(): array {
 			'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 ) ) {
+		if ( self::running_with_code_coverage() ) {
 			$has_coverage_driver = ( new Runtime() )->hasXdebug() || ( new Runtime() )->hasPCOV();
 
 			if ( ! $has_coverage_driver ) {
@@ -1023,14 +1030,27 @@ public function create_run_dir(): void {
 	public function build_phar( $version = 'same' ): void {
 		$this->variables['PHAR_PATH'] = $this->variables['RUN_DIR'] . '/' . uniqid( 'wp-cli-build-', true ) . '.phar';
 
+		$is_bundle = false;
+
 		// Test running against a package installed as a WP-CLI dependency
 		// WP-CLI bundle installed as a project dependency
 		$make_phar_path = self::get_vendor_dir() . '/wp-cli/wp-cli-bundle/utils/make-phar.php';
 		if ( ! file_exists( $make_phar_path ) ) {
 			// Running against WP-CLI bundle proper
+			$is_bundle = true;
+
 			$make_phar_path = self::get_vendor_dir() . '/../utils/make-phar.php';
 		}
 
+		// Temporarily modify the Composer autoloader used within the Phar
+		// so that it doesn't clash if autoloading is already happening outside of it,
+		// for example when generating code coverage.
+		// This modifies composer.json.
+		if ( $is_bundle && self::running_with_code_coverage() ) {
+			$this->composer_command( 'config autoloader-suffix "WpCliTestsPhar" --working-dir=' . dirname( self::get_vendor_dir() ) );
+			$this->composer_command( 'dump-autoload --working-dir=' . dirname( self::get_vendor_dir() ) );
+		}
+
 		$this->proc(
 			Utils\esc_cmd(
 				'php -dphar.readonly=0 %1$s %2$s --version=%3$s && chmod +x %2$s',
@@ -1039,6 +1059,12 @@ public function build_phar( $version = 'same' ): void {
 				$version
 			)
 		)->run_check();
+
+		// Revert the suffix change again
+		if ( $is_bundle && self::running_with_code_coverage() ) {
+			$this->composer_command( 'config autoloader-suffix "WpCliBundle" --working-dir=' . dirname( self::get_vendor_dir() ) );
+			$this->composer_command( 'dump-autoload --working-dir=' . dirname( self::get_vendor_dir() ) );
+		}
 	}
 
 	/**

tests/tests/TestBehatTags.php

@@ -4,6 +4,7 @@
 
 use WP_CLI\Tests\TestCase;
 use WP_CLI\Utils;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class TestBehatTags extends TestCase {
 
@@ -39,6 +40,7 @@ protected function tear_down(): void {
 	 * @param string $env
 	 * @param string $expected
 	 */
+	#[DataProvider( 'data_behat_tags_wp_version_github_token' )] // phpcs:ignore PHPCompatibility.Attributes.NewAttributes.PHPUnitAttributeFound
 	public function test_behat_tags_wp_version_github_token( $env, $expected ): void {
 		$env_wp_version   = getenv( 'WP_VERSION' );
 		$env_github_token = getenv( 'GITHUB_TOKEN' );
@@ -112,25 +114,7 @@ public function test_behat_tags_php_version(): void {
 		$contents    = '';
 		$expected    = '';
 
-		if ( '5.3' === $php_version ) {
-			$contents = '@require-php-5.2 @require-php-5.3 @require-php-5.4 @less-than-php-5.2 @less-than-php-5.3 @less-than-php-5.4';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '5.4' === $php_version ) {
-			$contents = '@require-php-5.3 @require-php-5.4 @require-php-5.5 @less-than-php-5.3 @less-than-php-5.4 @less-than-php-5.5';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '5.5' === $php_version ) {
-			$contents = '@require-php-5.4 @require-php-5.5 @require-php-5.6 @less-than-php-5.4 @less-than-php-5.5 @less-than-php-5.6';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '5.6' === $php_version ) {
-			$contents = '@require-php-5.5 @require-php-5.6 @require-php-7.0 @less-than-php-5.5 @less-than-php-5.6 @less-than-php-7.0';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '7.0' === $php_version ) {
-			$contents = '@require-php-5.6 @require-php-7.0 @require-php-7.1 @less-than-php-5.6 @less-than-php-7.0 @less-than-php-7.1';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '7.1' === $php_version ) {
-			$contents = '@require-php-7.0 @require-php-7.1 @require-php-7.2 @less-than-php-7.0 @less-than-php-7.1 @less-than-php-7.2';
-			$expected = '[email protected]&&[email protected]&&[email protected]';
-		} elseif ( '7.2' === $php_version ) {
+		if ( '7.2' === $php_version ) {
 			$contents = '@require-php-7.1 @require-php-7.2 @require-php-7.3 @less-than-php-7.1 @less-than-php-7.2 @less-than-php-7.3';
 			$expected = '[email protected]&&[email protected]&&[email protected]';
 		} elseif ( '7.3' === $php_version ) {
@@ -145,6 +129,15 @@ public function test_behat_tags_php_version(): void {
 		} elseif ( '8.1' === $php_version ) {
 			$contents = '@require-php-8.0 @require-php-8.1 @require-php-8.2 @less-than-php-8.0 @less-than-php-8.1 @less-than-php-8.2';
 			$expected = '[email protected]&&[email protected]&&[email protected]';
+		} elseif ( '8.2' === $php_version ) {
+			$contents = '@require-php-8.0 @require-php-8.1 @require-php-8.2 @require-php-8.3 @less-than-php-8.0 @less-than-php-8.1 @less-than-php-8.2 @less-than-php-8.3 @less-than-php-8.4';
+			$expected = '[email protected]&&[email protected]&&[email protected]&&[email protected]';
+		} elseif ( '8.3' === $php_version ) {
+			$contents = '@require-php-8.1 @require-php-8.2 @require-php-8.3 @require-php-8.4 @less-than-php-8.0 @less-than-php-8.1 @less-than-php-8.2 @less-than-php-8.3 @less-than-php-8.4';
+			$expected = '[email protected]&&[email protected]&&[email protected]&&[email protected]&&[email protected]';
+		} elseif ( '8.4' === $php_version ) {
+			$contents = '@require-php-8.2 @require-php-8.3 @require-php-8.4 @require-php-8.5 @less-than-php-8.0 @less-than-php-8.1 @less-than-php-8.2 @less-than-php-8.3 @less-than-php-8.4 @less-than-php-8.5';
+			$expected = '[email protected]&&[email protected]&&[email protected]&&[email protected]&&[email protected]&&[email protected]';
 		} else {
 			$this->markTestSkipped( "No test for PHP_VERSION $php_version." );
 		}