ADD e2e testing into own directory

DaveLiddament · DaveLiddament · commit 9b794b723c32 · 2024-08-13T22:05:09.000+01:00
diff --git a/build/e2e/data/BaseTraitClass.php b/build/e2e/data/BaseTraitClass.php
diff --git a/build/e2e/data/TraitClass.php b/build/e2e/data/TraitClass.php
diff --git a/build/e2e/data/TraitClassProblems.php b/build/e2e/data/TraitClassProblems.php
diff --git a/composer.json b/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": {
diff --git a/e2e/PHPStanResultsChecker.php b/e2e/PHPStanResultsChecker.php
@@ -1,14 +1,17 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e;
-
+/**
+ * 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 = 'build/e2e/data/';
+    private const FILE_PATH_TO_REMOVE = 'e2e/data/';
 
     /**
-     * @param array<int,string> $expectedResults
+     * @param array<int,string> $expectedResults see `test-runner` script for format
      */
     public function checkResults(string $phpstanResultsAsJsonString, array $expectedResults): void
     {
diff --git a/e2e/data/BaseTraitClass.php b/e2e/data/BaseTraitClass.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace data;
+
+class BaseTraitClass
+{
+}
diff --git a/e2e/data/FriendProblems.php b/e2e/data/FriendProblems.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 class FriendProblems
 {
diff --git a/e2e/data/MustUse.php b/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();
+    }
+}
diff --git a/e2e/data/MyTrait.php b/e2e/data/MyTrait.php
@@ -1,11 +1,10 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 use DaveLiddament\PhpLanguageExtensions\RestrictTraitTo;
 
 #[RestrictTraitTo(BaseTraitClass::class)]
 trait MyTrait
 {
-
-}
+}
diff --git a/e2e/data/Person.php b/e2e/data/Person.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 use DaveLiddament\PhpLanguageExtensions\Friend;
 
diff --git a/e2e/data/PersonBuilder.php b/e2e/data/PersonBuilder.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 class PersonBuilder
 {
diff --git a/e2e/data/PersonRepository.php b/e2e/data/PersonRepository.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace data;
+
+class PersonRepository implements Repository
+{
+
+}
diff --git a/e2e/data/Repository.php b/e2e/data/Repository.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace data;
+
+use DaveLiddament\PhpLanguageExtensions\InjectableVersion;
+
+#[InjectableVersion]
+interface Repository
+{
+
+}
diff --git a/e2e/data/Shape.php b/e2e/data/Shape.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 class Shape
 {
diff --git a/e2e/data/Square.php b/e2e/data/Square.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;
+namespace data;
 
 class Square extends Shape
 {
diff --git a/e2e/data/TraitClass.php b/e2e/data/TraitClass.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace data;
+
+class TraitClass extends BaseTraitClass
+{
+    use MyTrait;
+}
diff --git a/e2e/data/TraitClassProblems.php b/e2e/data/TraitClassProblems.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace data;
+
+class TraitClassProblems
+{
+    use MyTrait;
+}
diff --git a/e2e/phpstan-e2e.neon b/e2e/phpstan-e2e.neon
@@ -1,7 +1,7 @@
 parameters:
     level: max
     paths:
-    - build/e2e/data
+    - data
 
 includes:
-    - extension.neon
+    - ../extension.neon
diff --git a/e2e/test-runner b/e2e/test-runner
@@ -1,3 +1,4 @@
+#!/bin/php
 <?php
 
 /**
@@ -18,13 +19,14 @@
     'FriendProblems:10:friend',
     'FriendProblems:11:friend',
     'TraitClassProblems:7:restrictTraitTo',
+    'MustUse:18:mustUseResult',
 ];
 
 /**
  * Main script.
  */
-require_once __DIR__.'/build/e2e/PHPStanResultsChecker.php';
-$phpStanResultsChecker = new DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\PHPStanResultsChecker();
+require_once __DIR__.'/PHPStanResultsChecker.php';
+$phpStanResultsChecker = new PHPStanResultsChecker();
 $stdIn = file_get_contents('php://stdin');
 
 if (false === $stdIn) {
@@ -34,7 +36,7 @@
 
 try {
     $phpStanResultsChecker->checkResults($stdIn, $expectedErrors);
-    echo "All OK\n";
+    echo "E2E tests OK\n";
     exit(0);
 } catch (Exception $e) {
     echo $e->getMessage().\PHP_EOL;
diff --git a/phpstan.neon b/phpstan.neon
@@ -4,9 +4,10 @@ parameters:
     - src
     - tests
     - build
+    - e2e
     excludePaths:
     - tests/Rules/data
-    - build/e2e/data
+    - e2e/data
 
 services:
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +namespace data;
++
 +class BaseTraitClass
 +{
 +}
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`
`3`		`-namespace DaveLiddament\PhpstanPhpLanguageExtensions\Build\e2e\data;`
	`3`	`+namespace data;`
`4`	`4`
`5`	`5`	`class FriendProblems`
`6`	`6`	`{`