Similar reflection provider in Broker::getInstance() for unit tests via static reflection

Author: ondrejmirtes

src/Testing/TestCase-staticReflection.neon

@@ -0,0 +1,56 @@
+parameters:
+	featureToggles:
+		# these are needed only with "partial static reflection"
+		disableRobotLoader: true
+		disableRuntimeReflectionProvider: false
+		enableScanningPaths: false
+
+services:
+	-
+		class: PHPStan\Testing\TestCaseSourceLocatorFactory
+		arguments:
+			phpParser: @phpParserDecorator
+
+	testCaseBetterReflectionProvider:
+		class: PHPStan\Reflection\BetterReflection\BetterReflectionProvider
+		arguments:
+			classReflector: @testCaseClassReflector
+			functionReflector: @testCaseFunctionReflector
+			constantReflector: @testCaseConstantReflector
+		autowired: false
+
+	testCaseClassReflector:
+		class: PHPStan\Reflection\BetterReflection\Reflector\MemoizingClassReflector
+		arguments:
+			sourceLocator: @testCaseSourceLocator
+		autowired: false
+
+	testCaseFunctionReflector:
+		class: PHPStan\Reflection\BetterReflection\Reflector\MemoizingFunctionReflector
+		arguments:
+			classReflector: @testCaseClassReflector
+			sourceLocator: @testCaseSourceLocator
+		autowired: false
+
+	testCaseConstantReflector:
+		class: PHPStan\Reflection\BetterReflection\Reflector\MemoizingConstantReflector
+		arguments:
+			classReflector: @testCaseClassReflector
+			sourceLocator: @testCaseSourceLocator
+		autowired: false
+
+	testCaseSourceLocator:
+		class: Roave\BetterReflection\SourceLocator\Type\SourceLocator
+		factory: @PHPStan\Testing\TestCaseSourceLocatorFactory::create()
+		autowired: false
+
+	# total static reflection without RuntimeReflectionProvider involved
+	#reflectionProvider:
+	#	factory: @testCaseBetterReflectionProvider
+	#	autowired:
+	#		- PHPStan\Reflection\ReflectionProvider
+
+	# partial static reflection with RuntimeReflectionProvider involved
+	phpParserReflectionProvider:
+		factory: @testCaseBetterReflectionProvider
+		arguments!: []

src/Testing/TestCase.php

@@ -65,6 +65,7 @@
 use Roave\BetterReflection\SourceLocator\Ast\Locator;
 use Roave\BetterReflection\SourceLocator\SourceStubber\PhpStormStubsSourceStubber;
 use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\MemoizingSourceLocator;
 use Roave\BetterReflection\SourceLocator\Type\PhpInternalSourceLocator;
 
 abstract class TestCase extends \PHPUnit\Framework\TestCase
@@ -92,6 +93,10 @@ public static function getContainer(): Container
 				self::fail(sprintf('Cannot create temp directory %s', $tmpDir));
 			}
 
+			if (self::$useStaticReflectionProvider) {
+				$additionalConfigFiles[] = __DIR__ . '/TestCase-staticReflection.neon';
+			}
+
 			$rootDir = __DIR__ . '/../..';
 			$containerFactory = new ContainerFactory($rootDir);
 			self::$containers[$cacheKey] = $containerFactory->create($tmpDir, array_merge([
@@ -503,6 +508,8 @@ private static function getReflectors(): array
 			self::fail('Could not create composer source locator');
 		}
 
+		// these need to be synced with TestCase-staticReflection.neon file and TestCaseSourceLocatorFactory
+
 		$locators = [
 			$composerSourceLocator,
 		];
@@ -516,7 +523,7 @@ private static function getReflectors(): array
 		});
 		$locators[] = new AutoloadSourceLocator($astLocator);
 		$locators[] = new PhpInternalSourceLocator($astLocator, new PhpStormStubsSourceStubber($phpParser));
-		$sourceLocator = new AggregateSourceLocator($locators);
+		$sourceLocator = new MemoizingSourceLocator(new AggregateSourceLocator($locators));
 
 		$classReflector = new MemoizingClassReflector($sourceLocator);
 		$functionReflector = new MemoizingFunctionReflector($sourceLocator, $classReflector);

src/Testing/TestCaseSourceLocatorFactory.php

@@ -0,0 +1,71 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Testing;
+
+use Composer\Autoload\ClassLoader;
+use PHPStan\DependencyInjection\Container;
+use PHPStan\Reflection\BetterReflection\SourceLocator\AutoloadSourceLocator;
+use PHPStan\Reflection\BetterReflection\SourceLocator\ComposerJsonAndInstalledJsonSourceLocatorMaker;
+use Roave\BetterReflection\Reflector\FunctionReflector;
+use Roave\BetterReflection\SourceLocator\Ast\Locator;
+use Roave\BetterReflection\SourceLocator\SourceStubber\PhpStormStubsSourceStubber;
+use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\MemoizingSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\PhpInternalSourceLocator;
+use Roave\BetterReflection\SourceLocator\Type\SourceLocator;
+
+class TestCaseSourceLocatorFactory
+{
+
+	private Container $container;
+
+	private ComposerJsonAndInstalledJsonSourceLocatorMaker $composerJsonAndInstalledJsonSourceLocatorMaker;
+
+	private \PhpParser\Parser $phpParser;
+
+	private PhpStormStubsSourceStubber $phpStormStubsSourceStubber;
+
+	public function __construct(
+		Container $container,
+		ComposerJsonAndInstalledJsonSourceLocatorMaker $composerJsonAndInstalledJsonSourceLocatorMaker,
+		\PhpParser\Parser $phpParser,
+		PhpStormStubsSourceStubber $phpStormStubsSourceStubber
+	)
+	{
+		$this->container = $container;
+		$this->composerJsonAndInstalledJsonSourceLocatorMaker = $composerJsonAndInstalledJsonSourceLocatorMaker;
+		$this->phpParser = $phpParser;
+		$this->phpStormStubsSourceStubber = $phpStormStubsSourceStubber;
+	}
+
+	public function create(): SourceLocator
+	{
+		$classLoaderReflection = new \ReflectionClass(ClassLoader::class);
+		if ($classLoaderReflection->getFileName() === false) {
+			throw new \PHPStan\ShouldNotHappenException('Unknown ClassLoader filename');
+		}
+
+		$composerProjectPath = dirname($classLoaderReflection->getFileName(), 3);
+		if (!is_file($composerProjectPath . '/composer.json')) {
+			throw new \PHPStan\ShouldNotHappenException(sprintf('composer.json not found in directory %s', $composerProjectPath));
+		}
+
+		$composerSourceLocator = $this->composerJsonAndInstalledJsonSourceLocatorMaker->create($composerProjectPath);
+		if ($composerSourceLocator === null) {
+			throw new \PHPStan\ShouldNotHappenException('Could not create composer source locator');
+		}
+
+		$locators = [
+			$composerSourceLocator,
+		];
+		$astLocator = new Locator($this->phpParser, function (): FunctionReflector {
+			return $this->container->getService('testCaseFunctionReflector');
+		});
+
+		$locators[] = new AutoloadSourceLocator($astLocator);
+		$locators[] = new PhpInternalSourceLocator($astLocator, $this->phpStormStubsSourceStubber);
+
+		return new MemoizingSourceLocator(new AggregateSourceLocator($locators));
+	}
+
+}

tests/bootstrap-runtime-reflection.php

@@ -0,0 +1,5 @@
+<?php declare(strict_types = 1);
+
+require_once __DIR__ . '/bootstrap.php';
+
+\PHPStan\Testing\TestCase::getContainer();

tests/bootstrap-static-reflection.php

@@ -3,3 +3,5 @@
 require_once __DIR__ . '/bootstrap.php';
 
 \PHPStan\Testing\TestCase::$useStaticReflectionProvider = true;
+
+\PHPStan\Testing\TestCase::getContainer();

tests/bootstrap.php

@@ -1,7 +1,5 @@
 <?php declare(strict_types = 1);
 
-use PHPStan\Testing\TestCase;
-
 error_reporting(E_ALL);
 
 require_once __DIR__ . '/../vendor/autoload.php';
@@ -22,5 +20,3 @@ public function doFoo($i)
 	}
 
 }');
-
-TestCase::getContainer();

tests/phpunit.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:noNamespaceSchemaLocation="phpunit.xsd"
-	bootstrap="bootstrap.php"
+	bootstrap="bootstrap-runtime-reflection.php"
 	colors="true"
 	failOnRisky="true"
 	failOnWarning="true"