Merge branch 'main' into phpstan-2

Author: DaveLiddament

composer.json

@@ -46,12 +46,14 @@
     "analyse": "phpstan analyse",
     "lint": "parallel-lint src tests",
     "test": "phpunit",
+    "e2e": "phpstan analyse --configuration=e2e/phpstan-e2e.neon --error-format=json | php e2e/test-runner",
     "ci": [
       "@composer-validate",
       "@lint",
       "@cs",
       "@test",
-      "@analyse"
+      "@analyse",
+      "@e2e"
     ]
   },
   "extra": {

e2e/PHPStanResultsChecker.php

@@ -0,0 +1,100 @@
+<?php
+
+/**
+ * Script takes JSON output from PHPStan and a list of expected errors. It checks this list matches.
+ *
+ * This should be called from the `test-runner` script.
+ */
+final class PHPStanResultsChecker
+{
+    private const IDENTIFIER_PREFIX = 'phpExtensionLibrary.';
+    private const FILE_PATH_TO_REMOVE = 'e2e/data/';
+
+    /**
+     * @param array<int,string> $expectedResults see `test-runner` script for format
+     */
+    public function checkResults(string $phpstanResultsAsJsonString, array $expectedResults): void
+    {
+        $asJson = json_decode($phpstanResultsAsJsonString, true);
+        $this->assertArray($asJson, 'Failed to decode PHPStan results');
+
+        $totals = $asJson['totals'] ?? null;
+        $this->assertArray($totals, 'Failed to find totals in PHPStan results');
+
+        $errorCount = $totals['errors'] ?? null;
+        $this->assertNotNull($errorCount, 'Failed to find error count in PHPStan results');
+        if ((int) $errorCount > 0) {
+            $errors = $asJson['errors'] ?? null;
+            throw new RuntimeException('PHPStan reported errors: '.var_export($errors, true));
+        }
+
+        $files = $asJson['files'] ?? null;
+        $this->assertArray($files, 'Failed to find files in PHPStan results');
+
+        $additionalReportedErrors = [];
+
+        foreach ($files as $fullFileName => $fileIssues) {
+            $filePath = $this->getCleanFilename($fullFileName);
+
+            $this->assertArray($fileIssues, 'Failed to find issues in PHPStan results');
+            $messages = $fileIssues['messages'] ?? null;
+            $this->assertArray($messages, 'Failed to find messages in PHPStan results');
+
+            foreach ($messages as $issue) {
+                $line = $issue['line'] ?? null;
+                $identifier = $issue['identifier'] ?? '';
+                $cleanIdentifier = str_replace(self::IDENTIFIER_PREFIX, '', $identifier);
+
+                $key = sprintf('%s:%d:%s', $filePath, $line, $cleanIdentifier);
+
+                $expectedResultsKey = array_search($key, $expectedResults, true);
+                if (false === $expectedResultsKey) {
+                    $additionalReportedErrors[] = $key;
+                } else {
+                    unset($expectedResults[$expectedResultsKey]);
+                }
+            }
+        }
+
+        if (([] === $additionalReportedErrors) && ([] === $expectedResults)) {
+            // ALL OK
+            return;
+        }
+
+        $errorMessage = implode("\n", [
+            'Additional reported errors:',
+            var_export(array_values($additionalReportedErrors), true),
+            'Expected errors not reported:',
+            var_export(array_values($expectedResults), true),
+        ]);
+
+        throw new RuntimeException($errorMessage);
+    }
+
+    /** @phpstan-assert !null $value  */
+    private function assertNotNull(mixed $value, string $error): void
+    {
+        if (null === $value) {
+            throw new RuntimeException($error);
+        }
+    }
+
+    /** @phpstan-assert array $value  */
+    private function assertArray(mixed $value, string $error): void
+    {
+        if (!is_array($value)) {
+            throw new RuntimeException($error);
+        }
+    }
+
+    private function getCleanFilename(string $fullFileName): string
+    {
+        $position = strpos($fullFileName, self::FILE_PATH_TO_REMOVE);
+        if (false === $position) {
+            throw new RuntimeException('Failed to find '.self::FILE_PATH_TO_REMOVE.' in '.$fullFileName);
+        }
+        $filePath = substr($fullFileName, $position + strlen(self::FILE_PATH_TO_REMOVE));
+
+        return str_replace('.php', '', $filePath);
+    }
+}

e2e/data/BaseTraitClass.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace data;
+
+class BaseTraitClass
+{
+}

e2e/data/FriendProblems.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace data;
+
+class FriendProblems
+{
+    public function badCode(Person $person): void
+    {
+        new Person();
+        Person::aStaticMethod();
+        $person->aMethod();
+    }
+}

e2e/data/InjectableBad.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace data;
+
+class InjectableBad
+{
+    public function __construct(
+        public PersonRepository $repository,
+    ) {
+    }
+}

e2e/data/InjectableGood.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace data;
+
+class InjectableGood
+{
+    public function __construct(
+        public Repository $repository,
+    ) {
+    }
+}

e2e/data/MustUse.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace data;
+
+use DaveLiddament\PhpLanguageExtensions\MustUseResult;
+
+class MustUse
+{
+    #[MustUseResult]
+    public function getResult(): int
+    {
+        return 1;
+    }
+
+    public function code(): void
+    {
+        echo $this->getResult();
+        $this->getResult();
+    }
+}

e2e/data/MyTrait.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace data;
+
+use DaveLiddament\PhpLanguageExtensions\RestrictTraitTo;
+
+#[RestrictTraitTo(BaseTraitClass::class)]
+trait MyTrait
+{
+}

e2e/data/Person.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace data;
+
+use DaveLiddament\PhpLanguageExtensions\Friend;
+
+#[Friend(PersonBuilder::class)]
+class Person
+{
+    public function __construct()
+    {
+    }
+
+    public function aMethod(): void
+    {
+    }
+
+    public static function aStaticMethod(): void
+    {
+    }
+}

e2e/data/PersonBuilder.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace data;
+
+class PersonBuilder
+{
+    public function create(): Person
+    {
+        return new Person();
+    }
+}