test: Allow to specify the running PHP version (#1039)

This is not 100% correct as it won't change the actual runtime but it will adapt the PHP Parser version used.
humbug · Jun 10, 2024 · f21ea1b · f21ea1b
1 parent 49af316
commit f21ea1b
Show file tree

Hide file tree

Showing 12 changed files with 209 additions and 16 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -58,3 +58,5 @@ parameters:
           path: 'src/Symbol/SymbolsRegistry.php'
         - message: '#Stmt\:\:\$stmts#'
           path: 'src/PhpParser/NodeVisitor/ClassAliasStmtAppender.php'
+        - message: '#PhpVersion::fromComponents#'
+          path: 'tests/SpecFramework/SpecScenario.php'
diff --git a/src/Container.php b/src/Container.php
@@ -30,12 +30,14 @@
 use PhpParser\PhpVersion;
 use PhpParser\PrettyPrinter\Standard;
 use Symfony\Component\Filesystem\Filesystem;
+use Webmozart\Assert\Assert;
 
 final class Container
 {
     private Filesystem $filesystem;
     private ConfigurationFactory $configFactory;
     private Parser $parser;
+    private ?PhpVersion $phpVersion = null;
     private Reflector $reflector;
     private ScoperFactory $scoperFactory;
     private EnrichedReflectorFactory $enrichedReflectorFactory;
@@ -64,11 +66,11 @@ public function getConfigurationFactory(): ConfigurationFactory
         return $this->configFactory;
     }
 
-    public function getScoperFactory(): ScoperFactory
+    public function getScoperFactory(?PhpVersion $phpVersion = null): ScoperFactory
     {
         if (!isset($this->scoperFactory)) {
             $this->scoperFactory = new ScoperFactory(
-                $this->getParser(),
+                $this->getParser($phpVersion),
                 $this->getEnrichedReflectorFactory(),
                 $this->getPrinter(),
             );
@@ -77,21 +79,33 @@ public function getScoperFactory(): ScoperFactory
         return $this->scoperFactory;
     }
 
-    public function getParser(): Parser
+    public function getParser(?PhpVersion $phpVersion = null): Parser
     {
         if (!isset($this->parser)) {
-            $this->parser = $this->createParser();
+            $this->phpVersion = $phpVersion;
+            $this->parser = $this->createParser($phpVersion);
+        }
+
+        $parserVersion = $this->phpVersion;
+
+        $parserMessage = 'Cannot use the existing parser: its PHP version is different than the one requested.';
+
+        if (null === $parserVersion) {
+            Assert::null($phpVersion, $parserMessage);
+        } else {
+            Assert::notNull($phpVersion, $parserMessage);
+            Assert::true($parserVersion->equals($phpVersion), $parserMessage);
         }
 
         return $this->parser;
     }
 
-    private function createParser(): Parser
+    private function createParser(?PhpVersion $phpVersion): Parser
     {
-        $version = PhpVersion::getNewestSupported();
+        $version = $phpVersion ?? PhpVersion::getHostVersion();
         $lexer = $version->isHostVersion() ? new Lexer() : new Emulative($version);
 
-        return $version->id >= 80000
+        return $version->id >= 80_000
             ? new Php8($lexer, $version)
             : new Php7($lexer, $version);
     }

diff --git a/tests/ContainerTest.php b/tests/ContainerTest.php
@@ -14,6 +14,8 @@
 
 namespace Humbug\PhpScoper;
 
+use InvalidArgumentException;
+use PhpParser\PhpVersion;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
@@ -58,4 +60,72 @@ public static function provideServiceGetter(): iterable
             }
         }
     }
+
+    #[DataProvider('samePhpVersionProvider')]
+    public function test_it_can_get_the_parser_if_the_version_does_not_change(
+        ?PhpVersion $version1,
+        ?PhpVersion $version2,
+    ): void {
+        $container = new Container();
+
+        $container->getParser($version1);
+        $container->getParser($version2);
+
+        $this->addToAssertionCount(1);
+    }
+
+    public static function samePhpVersionProvider(): iterable
+    {
+        yield 'no PHP version configured' => [
+            null,
+            null,
+        ];
+
+        $phpVersion = PhpVersion::fromString('7.2');
+
+        yield 'same PHP version instance' => [
+            $phpVersion,
+            $phpVersion,
+        ];
+
+        yield 'same PHP version, different instances' => [
+            PhpVersion::fromString('7.3'),
+            PhpVersion::fromString('7.3'),
+        ];
+    }
+
+    #[DataProvider('differentPhpVersionProvider')]
+    public function test_it_cannot_create_two_different_versions_of_the_parser(
+        ?PhpVersion $version1,
+        ?PhpVersion $version2,
+    ): void {
+        $container = new Container();
+
+        $container->getParser($version1);
+
+        $this->expectException(InvalidArgumentException::class);
+
+        $container->getParser($version2);
+    }
+
+    public static function differentPhpVersionProvider(): iterable
+    {
+        $phpVersion = PhpVersion::fromString('7.2');
+        $anotherPhpVersion = PhpVersion::fromString('7.3');
+
+        yield 'no PHP version configured' => [
+            null,
+            $phpVersion,
+        ];
+
+        yield 'no PHP version requested' => [
+            $phpVersion,
+            null,
+        ];
+
+        yield 'different PHP versions' => [
+            $phpVersion,
+            $anotherPhpVersion,
+        ];
+    }
 }
diff --git a/tests/Scoper/PhpScoperSpecTest.php b/tests/Scoper/PhpScoperSpecTest.php
@@ -26,6 +26,7 @@
 use Humbug\PhpScoper\Symbol\Reflector;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
 use PhpParser\Error as PhpParserError;
+use PhpParser\PhpVersion;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\TestCase;
@@ -59,7 +60,7 @@ public function test_it_uses_the_right_specs_directory(): void
     #[DataProvider('provideValidFiles')]
     public function test_can_scope_valid_files(SpecScenario $scenario): void
     {
-        $scenario->checkPHPVersionRequirements();
+        $scenario->checkPHPVersionRequirements($scenario->phpVersionUsed);
 
         $filePath = 'file.php';
         $symbolsRegistry = new SymbolsRegistry();
@@ -68,6 +69,7 @@ public function test_can_scope_valid_files(SpecScenario $scenario): void
             $scenario->prefix,
             $scenario->symbolsConfiguration,
             $symbolsRegistry,
+            $scenario->getPhpParserVersion(),
         );
 
         try {
@@ -109,7 +111,8 @@ public static function provideValidFiles(): iterable
     private static function createScoper(
         string $prefix,
         SymbolsConfiguration $symbolsConfiguration,
-        SymbolsRegistry $symbolsRegistry
+        SymbolsRegistry $symbolsRegistry,
+        ?PhpVersion $phpVersionUsed,
     ): Scoper {
         $container = new Container();
 
@@ -126,7 +129,7 @@ private static function createScoper(
         );
 
         return new PhpScoper(
-            $container->getParser(),
+            $container->getParser($phpVersionUsed),
             new FakeScoper(),
             new TraverserFactory(
                 $enrichedReflector,

diff --git a/tests/SpecFramework/Config/Meta.php b/tests/SpecFramework/Config/Meta.php
@@ -23,6 +23,7 @@ public function __construct(
         public string $prefix = 'Humbug',
         public ?int $minPhpVersion = null,
         public ?int $maxPhpVersion = null,
+        public ?int $phpVersionUsed = null,
         public bool $exposeGlobalConstants = false,
         public bool $exposeGlobalClasses = false,
         public bool $exposeGlobalFunctions = false,

diff --git a/tests/SpecFramework/Config/SpecWithConfig.php b/tests/SpecFramework/Config/SpecWithConfig.php
@@ -33,6 +33,7 @@ public static function create(
         ?string $prefix = null,
         ?int $minPhpVersion = null,
         ?int $maxPhpVersion = null,
+        ?int $phpVersionUsed = null,
         ?bool $exposeGlobalConstants = null,
         ?bool $exposeGlobalClasses = null,
         ?bool $exposeGlobalFunctions = null,
@@ -55,6 +56,7 @@ public static function create(
             $prefix,
             $minPhpVersion,
             $maxPhpVersion,
+            $phpVersionUsed,
             $exposeGlobalConstants,
             $exposeGlobalClasses,
             $exposeGlobalFunctions,
@@ -77,6 +79,7 @@ private function __construct(
         public ?string $prefix,
         public ?int $minPhpVersion,
         public ?int $maxPhpVersion,
+        public ?int $phpVersionUsed,
         public ?bool $exposeGlobalConstants,
         public ?bool $exposeGlobalClasses,
         public ?bool $exposeGlobalFunctions,

diff --git a/tests/SpecFramework/SpecParser.php b/tests/SpecFramework/SpecParser.php
@@ -120,6 +120,7 @@ private static function parseSpec(
         return new SpecScenario(
             $specWithConfig->minPhpVersion ?? $meta->minPhpVersion ?? null,
             $specWithConfig->maxPhpVersion ?? $meta->maxPhpVersion ?? null,
+            $specWithConfig->phpVersionUsed ?? $meta->phpVersionUsed ?? null,
             $file,
             $completeTitle,
             $specWithConfig->inputCode,

diff --git a/tests/SpecFramework/SpecScenario.php b/tests/SpecFramework/SpecScenario.php
@@ -16,17 +16,20 @@
 
 use Humbug\PhpScoper\Configuration\SymbolsConfiguration;
 use Humbug\PhpScoper\Symbol\SymbolsRegistry;
+use PhpParser\PhpVersion;
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\SkippedWithMessageException;
 use PHPUnit\Framework\TestCase;
 use Throwable;
 use function usort;
+use const PHP_VERSION_ID;
 
 final readonly class SpecScenario
 {
     public function __construct(
         public ?int $minPhpVersion,
         public ?int $maxPhpVersion,
+        public ?int $phpVersionUsed,
         public string $file,
         public string $title,
         public string $inputCode,
@@ -38,12 +41,28 @@ public function __construct(
     ) {
     }
 
-    public function checkPHPVersionRequirements(): void
+    public function getPhpParserVersion(): ?PhpVersion
     {
+        $phpVersionId = $this->phpVersionUsed;
+
+        if (null === $phpVersionId) {
+            return null;
+        }
+
+        $minorRemainder = $phpVersionId % 1000;
+        $minor = $minorRemainder / 100;
+        $major = ($phpVersionId - $minorRemainder) / 10_000;
+
+        return PhpVersion::fromComponents($major, $minor);
+    }
+
+    public function checkPHPVersionRequirements(?int $phpVersionIdUsed): void
+    {
+        $phpVersionIdUsed ??= PHP_VERSION_ID;
         $minPhpVersion = $this->minPhpVersion;
         $maxPhpVersion = $this->maxPhpVersion;
 
-        if (null !== $minPhpVersion && $minPhpVersion > PHP_VERSION_ID) {
+        if (null !== $minPhpVersion && $minPhpVersion > $phpVersionIdUsed) {
             throw new SkippedWithMessageException(
                 sprintf(
                     'Min PHP version not matched for spec "%s".',
@@ -52,7 +71,7 @@ public function checkPHPVersionRequirements(): void
             );
         }
 
-        if (null !== $maxPhpVersion && $maxPhpVersion <= PHP_VERSION_ID) {
+        if (null !== $maxPhpVersion && $maxPhpVersion <= $phpVersionIdUsed) {
             throw new SkippedWithMessageException(
                 sprintf(
                     'Max PHP version not matched for spec "%s".',

diff --git a/tests/SpecFrameworkTest/Fixtures/complete-spec-file.php b/tests/SpecFrameworkTest/Fixtures/complete-spec-file.php
@@ -21,6 +21,7 @@
         prefix: 'Humbug',
         minPhpVersion: 70_200,
         maxPhpVersion: 80_300,
+        phpVersionUsed: 70_400,
         exposeGlobalConstants: true,
         exposeGlobalClasses: true,
         exposeGlobalFunctions: true,
@@ -62,6 +63,7 @@
         prefix: 'AnotherPrefix',
         minPhpVersion: 70_300,
         maxPhpVersion: 80_200,
+        phpVersionUsed: 80_300,
         exposeGlobalConstants: false,
         exposeGlobalClasses: false,
         exposeGlobalFunctions: false,

diff --git a/tests/SpecFrameworkTest/SpecParserTest.php b/tests/SpecFrameworkTest/SpecParserTest.php
@@ -68,6 +68,7 @@ public static function specProvider(): iterable
             self::FIXTURE_DIR.'/simple-spec-file.php',
             [
                 'Fixtures/simple-spec-file.php: 0' => new SpecScenario(
+                    null,
                     null,
                     null,
                     'Fixtures/simple-spec-file.php',
@@ -84,6 +85,7 @@ public static function specProvider(): iterable
                     [],
                 ),
                 'Fixtures/simple-spec-file.php: A spec with a title' => new SpecScenario(
+                    null,
                     null,
                     null,
                     'Fixtures/simple-spec-file.php:33',
@@ -108,7 +110,8 @@ public static function specProvider(): iterable
                 'Fixtures/complete-spec-file.php: Spec with default meta values' => new SpecScenario(
                     70_200,
                     80_300,
-                    'Fixtures/complete-spec-file.php:39',
+                    70_400,
+                    'Fixtures/complete-spec-file.php:40',
                     '[Example of simple spec file] Spec with default meta values',
                     $specCode,
                     'Humbug',
@@ -132,7 +135,8 @@ public static function specProvider(): iterable
                 'Fixtures/complete-spec-file.php: Spec with the more verbose form' => new SpecScenario(
                     70_200,
                     80_300,
-                    'Fixtures/complete-spec-file.php:49',
+                    70_400,
+                    'Fixtures/complete-spec-file.php:50',
                     '[Example of simple spec file] Spec with the more verbose form',
                     $specCode,
                     'Humbug',
@@ -156,7 +160,8 @@ public static function specProvider(): iterable
                 'Fixtures/complete-spec-file.php: Spec with overridden meta values' => new SpecScenario(
                     70_300,
                     80_200,
-                    'Fixtures/complete-spec-file.php:61',
+                    80_300,
+                    'Fixtures/complete-spec-file.php:62',
                     '[Example of simple spec file] Spec with overridden meta values',
                     $specCode,
                     'AnotherPrefix',

diff --git a/tests/SpecFrameworkTest/SpecPrinterTest.php b/tests/SpecFrameworkTest/SpecPrinterTest.php
@@ -69,6 +69,7 @@ public static function scenarioProvider(): iterable
 
         yield 'simple scenario' => [
             new SpecScenario(
+                null,
                 null,
                 null,
                 'Fixtures/complete-spec-file.php',
@@ -139,6 +140,7 @@ public static function scenarioProvider(): iterable
             new SpecScenario(
                 70_200,
                 80_300,
+                70_400,
                 'Fixtures/complete-spec-file.php',
                 '[Example of simple spec file] Spec with the more verbose form',
                 $specCode,
@@ -219,6 +221,7 @@ public static function scenarioProvider(): iterable
             new SpecScenario(
                 70_200,
                 80_300,
+                70_400,
                 'Fixtures/complete-spec-file.php',
                 '[Example of simple spec file] Spec with the more verbose form',
                 $specCode,
@@ -333,6 +336,7 @@ public static function scenarioProvider(): iterable
 
         yield 'simple scenario with recorded symbols' => [
             new SpecScenario(
+                null,
                 null,
                 null,
                 'Fixtures/complete-spec-file.php',