Re-register the DI container in setUp() of tests with PHP-version-dependent reflection assertions - fixes racy/flaky tests (#5917)

Co-authored-by: staabm <120441+staabm@users.noreply.github.com>
Co-authored-by: Markus Staab <maggus.staab@googlemail.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

Author: 3 people

src/Testing/PHPStanTestCase.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Testing;
 
+use Override;
 use PHPStan\Analyser\ConstantResolver;
 use PHPStan\Analyser\DirectInternalScopeFactoryFactory;
 use PHPStan\Analyser\Error;
@@ -40,6 +41,24 @@ abstract class PHPStanTestCase extends TestCase
 
 	use PHPStanTestCaseTrait;
 
+	/**
+	 * Re-register the runtime container as the global static reflection provider before
+	 * every test. Enable this in tests that construct Type objects directly and assert
+	 * PHP-version-dependent reflection results, so a foreign PhpVersion leaked by another
+	 * test can't flake them. See https://github.com/phpstan/phpstan/issues/14860
+	 */
+	protected bool $reinitializeContainerBeforeEachTest = false;
+
+	#[Override]
+	protected function setUp(): void
+	{
+		if (!$this->reinitializeContainerBeforeEachTest) {
+			return;
+		}
+
+		self::getContainer();
+	}
+
 	public static function getParser(): Parser
 	{
 		/** @var Parser $parser */

tests/PHPStan/Analyser/AnalyserTraitsIntegrationTest.php

@@ -22,6 +22,7 @@ class AnalyserTraitsIntegrationTest extends PHPStanTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		$this->fileHelper = self::getContainer()->getByType(FileHelper::class);
 	}
 

tests/PHPStan/Analyser/TypeSpecifierTest.php

@@ -61,6 +61,7 @@ class TypeSpecifierTest extends PHPStanTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		$reflectionProvider = self::createReflectionProvider();
 		$this->printer = new Printer();
 		$this->typeSpecifier = self::getContainer()->getService('typeSpecifier');

tests/PHPStan/Command/ErrorFormatter/RawErrorFormatterTest.php

@@ -19,6 +19,7 @@ class RawErrorFormatterTest extends ErrorFormatterTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		foreach (AgentDetector::ENV_VARS as $var) {
 			$this->originalEnvVars[$var] = getenv($var);
 			putenv($var);

tests/PHPStan/Command/ErrorFormatter/TableErrorFormatterTest.php

@@ -23,6 +23,7 @@ class TableErrorFormatterTest extends ErrorFormatterTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		putenv('GITHUB_ACTIONS');
 
 		$this->terminalEmulator = getenv('TERMINAL_EMULATOR');

tests/PHPStan/PhpDoc/DefaultStubFilesProviderTest.php

@@ -17,6 +17,7 @@ class DefaultStubFilesProviderTest extends PHPStanTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		$this->currentWorkingDirectory = $this->getContainer()->getParameter('currentWorkingDirectory');
 	}
 

tests/PHPStan/Rules/Functions/PrintfHelperTest.php

@@ -15,6 +15,7 @@ class PrintfHelperTest extends PHPStanTestCase
 	#[Override]
 	protected function setUp(): void
 	{
+		parent::setUp();
 		$this->printf = new PrintfHelper(new PhpVersion(PHP_VERSION_ID));
 	}
 

tests/PHPStan/Type/Accessory/HasPropertyTypeTest.php

@@ -23,6 +23,11 @@
 class HasPropertyTypeTest extends PHPStanTestCase
 {
 
+	// Pin the runtime container so a foreign PhpVersion leaked by another test
+	// can't flake the version-dependent Closure data set below.
+	// See https://github.com/phpstan/phpstan/issues/14860
+	protected bool $reinitializeContainerBeforeEachTest = true;
+
 	public static function dataIsSuperTypeOf(): array
 	{
 		return [

tests/PHPStan/Type/Generic/GenericObjectTypeTest.php

@@ -32,6 +32,11 @@
 class GenericObjectTypeTest extends PHPStanTestCase
 {
 
+	// Pin the runtime container so a foreign PhpVersion leaked by another test
+	// can't flake the version-dependent data sets (reflected variance of built-in
+	// generics). See https://github.com/phpstan/phpstan/issues/14860
+	protected bool $reinitializeContainerBeforeEachTest = true;
+
 	public static function dataIsSuperTypeOf(): array
 	{
 		return [

tests/PHPStan/Type/ObjectTypeTest.php

@@ -51,6 +51,11 @@
 class ObjectTypeTest extends PHPStanTestCase
 {
 
+	// Pin the runtime container so a foreign PhpVersion leaked by another test
+	// can't flake the version-dependent Closure data sets (dynamic-property
+	// handling). See https://github.com/phpstan/phpstan/issues/14860
+	protected bool $reinitializeContainerBeforeEachTest = true;
+
 	public static function dataIsIterable(): array
 	{
 		return [