fix: Upgrade to phpstan 2, phpunit 12 and allow safe 3

Stephan Wentz · pl-github · commit f7ed11749c35 · 2025-02-11T16:03:38.000+01:00
diff --git a/composer.json b/composer.json
@@ -1,35 +1,34 @@
 {
     "name": "brainbits/functional-test-helpers",
-    "type": "library",
     "description": "brainbits controlling functional test helpers",
     "license": "MIT",
+    "type": "library",
     "require": {
         "php": "^8.3",
-        "thecodingmachine/safe": "^2.0"
+        "thecodingmachine/safe": "^2.0 || ^3.0"
     },
     "require-dev": {
         "ext-dom": "*",
         "ext-iconv": "*",
         "ext-mbstring": "*",
         "ext-simplexml": "*",
         "ext-tidy": "*",
-        "brainbits/phpcs-standard": "^7.0",
-        "brainbits/phpstan-rules": "^3.1.2",
-        "dama/doctrine-test-bundle": "^8.0",
-        "doctrine/dbal": "^3.4",
-        "ergebnis/phpstan-rules": "^2.5.2",
-        "gemorroj/archive7z": "^5.3",
-        "jangregor/phpstan-prophecy": "^1.0.2",
-        "mikey179/vfsstream": "^1.6.11",
-        "monolog/monolog": "^2.3|^3.0",
-        "phpstan/phpstan": "^1.12.15",
-        "phpstan/phpstan-phpunit": "^1.4.2",
-        "phpstan/phpstan-symfony": "^1.4.13",
-        "phpunit/phpunit": "^11.4",
+        "brainbits/phpcs-standard": "^7.0.1",
+        "brainbits/phpstan-rules": "^4.0",
+        "dama/doctrine-test-bundle": "^8.2",
+        "doctrine/dbal": "^3.9",
+        "ergebnis/phpstan-rules": "^2.6",
+        "gemorroj/archive7z": "^5.7",
+        "mikey179/vfsstream": "^1.6.12",
+        "monolog/monolog": "^2.0 || ^3.0",
+        "phpstan/phpstan": "^2.1.4",
+        "phpstan/phpstan-phpunit": "^2.0.4",
+        "phpstan/phpstan-symfony": "^2.0.2",
+        "phpunit/phpunit": "^12.0.2",
         "psr/http-message": "^2.0",
         "riverline/multipart-parser": "^2.1",
-        "slam/phpstan-extensions": "^6.5.0",
-        "squizlabs/php_codesniffer": "^3.10",
+        "slam/phpstan-extensions": "^6.6.0",
+        "squizlabs/php_codesniffer": "^3.11.3",
         "symfony/browser-kit": "^7.0",
         "symfony/console": "^7.0",
         "symfony/dependency-injection": "^7.0",
@@ -41,40 +40,30 @@
         "symfony/security-core": "^7.0",
         "symfony/security-csrf": "^7.0",
         "symfony/uid": "^7.0",
-        "thecodingmachine/phpstan-safe-rule": "^1.2",
-        "thecodingmachine/phpstan-strict-rules": "^1.0"
+        "thecodingmachine/phpstan-safe-rule": "^1.4"
     },
     "suggest": {
         "ext-dom": "For mocking xml requests",
         "ext-iconv": "For asserting zip files",
-        "ext-mbstring": "For asserting zip files",
         "ext-json": "For json snapshot tests",
+        "ext-mbstring": "For asserting zip files",
         "ext-simplexml": "For mocking xml requests",
         "ext-tidy": "For html snapshots",
+        "dama/doctrine-test-bundle": "For schema trait, when using DAMA Static Driver",
         "doctrine/dbal": "For schema trait",
         "doctrine/event-manager": "For schema trait",
-        "dama/doctrine-test-bundle": "For schema trait, when using DAMA Static Driver",
         "gemorroj/archive7z": "For 7z file support",
         "monolog/monolog": "For http client mock trait",
         "riverline/multipart-parser": "For multipart file uploads",
         "symfony/browser-kit": "For request trait",
         "symfony/console": "For console trait",
         "symfony/filesystem": "For request trait",
+        "symfony/framework-bundle": "For request trait, when using authLogin(). Requires version >= 7.0",
         "symfony/http-client": "For http client mock trait",
         "symfony/http-foundation": "For request trait",
-        "symfony/framework-bundle": "For request trait, when using authLogin(). Requires version >= 5.1",
         "symfony/security-core": "For request trait",
         "symfony/uid": "For uuid trait"
     },
-    "config": {
-        "preferred-install": {
-            "*": "dist"
-        },
-        "sort-packages": true,
-        "allow-plugins": {
-            "dealerdirect/phpcodesniffer-composer-installer": true
-        }
-    },
     "autoload": {
         "psr-4": {
             "Brainbits\\FunctionalTestHelpers\\": "src/"
@@ -84,5 +73,14 @@
         "psr-4": {
             "Brainbits\\FunctionalTestHelpers\\Tests\\": "tests/"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        },
+        "preferred-install": {
+            "*": "dist"
+        },
+        "sort-packages": true
     }
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,18 +1,13 @@
 parameters:
     level: 6
+    treatPhpDocTypesAsCertain: false
     paths:
         - src
         - tests
     excludePaths:
-        - src/Kernel.php
-        - tests/bootstrap.php
         - src/HttpClientMock/CallbackHandler.php # needed because of unknown classes when installed with monolog 2.x
-        - src/HttpClientMock/LegacyCallbackHandler.php # needed because of unknown classes when installed with monolog 2.x
     ignoreErrors:
         - '#Constructor in .* has parameter .* with default value#'
-        - '#In method "Brainbits\\FunctionalTestHelpers\\Snapshot\\IsXml::.*", caught "Throwable" must be rethrown. Either catch a more specific exception or add a "throw" clause in the "catch" block to propagate the exception.#'
-        - '#In method "Brainbits\\FunctionalTestHelpers\\Tests\\Uuid\\UuidTraitTest::.*", caught "Throwable" must be rethrown. Either catch a more specific exception or add a "throw" clause in the "catch" block to propagate the exception.#'
-        - '#Safe\\DateTimeImmutable#'
         - '#SchemaBuilder::foo\(\)#'
     ergebnis:
         noNullableReturnTypeDeclaration:
@@ -31,9 +26,8 @@ parameters:
 includes:
     - %rootDir%/../../brainbits/phpstan-rules/rules.neon
     - %rootDir%/../../ergebnis/phpstan-rules/rules.neon
-    - %rootDir%/../../jangregor/phpstan-prophecy/extension.neon
     - %rootDir%/../../phpstan/phpstan-phpunit/extension.neon
     - %rootDir%/../../phpstan/phpstan-phpunit/rules.neon
     - %rootDir%/../../phpstan/phpstan-symfony/extension.neon
-    - %rootDir%/../../thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
-    - %rootDir%/../../thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
+#    - %rootDir%/../../thecodingmachine/phpstan-safe-rule/phpstan-safe-rule.neon
+#    - %rootDir%/../../thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
diff --git a/src/HttpClientMock/Matcher/CatchAllMatcher.php b/src/HttpClientMock/Matcher/CatchAllMatcher.php
@@ -8,7 +8,7 @@
 
 final readonly class CatchAllMatcher implements Matcher
 {
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit
     {
         return Hit::catchAll();
     }
diff --git a/src/HttpClientMock/Matcher/ContentMatcher.php b/src/HttpClientMock/Matcher/ContentMatcher.php
@@ -18,7 +18,7 @@ public function __construct(string|callable $content)
         $this->content = $content;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         $expectedContent = $this->content;
         $realContent = $realRequest->getContent();
diff --git a/src/HttpClientMock/Matcher/JsonMatcher.php b/src/HttpClientMock/Matcher/JsonMatcher.php
@@ -21,7 +21,7 @@ public function __construct(array|callable $json)
         $this->json = $json;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         $expectedJson = $this->json;
         $realJson = $realRequest->getJson();
diff --git a/src/HttpClientMock/Matcher/MethodMatcher.php b/src/HttpClientMock/Matcher/MethodMatcher.php
@@ -19,7 +19,7 @@ public function __construct(string|callable $method)
         $this->method = $method;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         $expectedMethod = $this->method;
         $realMethod = $realRequest->getMethod();
diff --git a/src/HttpClientMock/Matcher/ThatMatcher.php b/src/HttpClientMock/Matcher/ThatMatcher.php
@@ -15,7 +15,7 @@ public function __construct(callable $that)
         $this->that = $that;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         if (($this->that)($realRequest) === false) {
             return Mismatch::mismatchingThat('returned false');
diff --git a/src/HttpClientMock/Matcher/UriMatcher.php b/src/HttpClientMock/Matcher/UriMatcher.php
@@ -24,7 +24,7 @@ public function __construct(string|callable $uri, private UriParams $uriParams)
         $this->uri = $uri;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         $realUri = $realRequest->getUri();
 
diff --git a/src/HttpClientMock/Matcher/XmlMatcher.php b/src/HttpClientMock/Matcher/XmlMatcher.php
@@ -28,7 +28,7 @@ public function __construct(string|callable $xml)
         $this->xml = $xml;
     }
 
-    public function __invoke(RealRequest $realRequest): Hit|Mismatch|Missing
+    public function __invoke(RealRequest $realRequest): Hit|Mismatch
     {
         $expectedXml = $this->xml;
         $realXml = $realRequest->getContent();
diff --git a/src/HttpClientMock/MockRequestBuilder.php b/src/HttpClientMock/MockRequestBuilder.php
@@ -306,7 +306,7 @@ public function hasResponse(): bool
         return !$this->responses->isEmpty();
     }
 
-    public function nextResponse(): MockResponseBuilder|Throwable|null
+    public function nextResponse(): MockResponseBuilder|Throwable
     {
         try {
             return $this->responses->next();
diff --git a/src/HttpClientMock/MockRequestBuilderCollection.php b/src/HttpClientMock/MockRequestBuilderCollection.php
@@ -36,7 +36,7 @@ public function __invoke(string $method, string $url, array $options): ResponseI
         $requestBuilder->assert($realRequest);
         $requestBuilder->called($realRequest);
 
-        if ($requestBuilder->onMatch && is_callable($requestBuilder->onMatch)) { // @phpstan-ignore-line
+        if ($requestBuilder->onMatch && is_callable($requestBuilder->onMatch)) {
             ($requestBuilder->onMatch)($realRequest);
         }
 
@@ -58,7 +58,7 @@ public function getCallStack(): CallStack
         return CallStack::fromCallStacks(...$callStacks);
     }
 
-    /** @return Traversable<MockRequestBuilder>|MockRequestBuilder[] */
+    /** @return Traversable<MockRequestBuilder> */
     public function getIterator(): Traversable
     {
         yield from $this->requestBuilders;
diff --git a/src/SevenZipContents/SevenZipArchive.php b/src/SevenZipContents/SevenZipArchive.php
@@ -31,7 +31,7 @@ private static function getBinary7zFromPath(): string
         $binary7z = null;
         foreach (self::EXECUTABLES as $executable) {
             $resultCode = 0;
-            $binary7z = exec('which ' . escapeshellarg($executable), result_code: $resultCode); // @phpstan-ignore-line
+            $binary7z = exec('which ' . escapeshellarg($executable), result_code: $resultCode);
 
             if ($resultCode === 0 && is_string($binary7z) && $binary7z !== '' && file_exists($binary7z)) {
                 break;
diff --git a/tests/Application/ApplicationTraitTest.php b/tests/Application/ApplicationTraitTest.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Brainbits\FunctionalTestHelpers\Tests\Application;
+
+use Brainbits\FunctionalTestHelpers\Console\ApplicationTrait;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+final class ApplicationTraitTest extends TestCase
+{
+    use ApplicationTrait;
+
+    private static KernelInterface|null $kernel = null;
+
+    public function testMockRequest(): void
+    {
+        $container = new Container();
+        $container->set('event_dispatcher', new EventDispatcher());
+
+        self::$kernel = $this->createMock(KernelInterface::class);
+        self::$kernel->expects($this->atLeastOnce())
+            ->method('getContainer')
+            ->willReturn($container);
+
+        $tester = $this->runApplication(['help']);
+
+        $this->assertApplicationOutputContains('help', $tester);
+
+        self::$kernel->shutdown();
+    }
+}
diff --git a/tests/Console/CommandTraitTest.php b/tests/Console/CommandTraitTest.php
@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Brainbits\FunctionalTestHelpers\Tests\Console;
+
+use Brainbits\FunctionalTestHelpers\Console\CommandTrait;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+final class CommandTraitTest extends TestCase
+{
+    use CommandTrait;
+
+    private static KernelInterface|null $kernel = null;
+
+    public function testMockRequest(): void
+    {
+        $container = new Container();
+
+        self::$kernel = $this->createMock(KernelInterface::class);
+        self::$kernel->expects($this->atLeastOnce())
+            ->method('getContainer')
+            ->willReturn($container);
+
+        $tester = $this->runCommand('help');
+
+        $this->assertCommandOutputContains('help', $tester);
+    }
+}
diff --git a/tests/HttpClientMock/Matcher/CatchAllMatcherTest.php b/tests/HttpClientMock/Matcher/CatchAllMatcherTest.php
@@ -5,7 +5,6 @@
 namespace Brainbits\FunctionalTestHelpers\Tests\HttpClientMock\Matcher;
 
 use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\CatchAllMatcher;
-use Brainbits\FunctionalTestHelpers\HttpClientMock\Matcher\Hit;
 use Brainbits\FunctionalTestHelpers\Tests\HttpClientMock\RealRequestTrait;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
@@ -24,7 +23,6 @@ public function testMatchContent(): void
 
         $result = $matcher($realRequest);
 
-        self::assertInstanceOf(Hit::class, $result);
         self::assertScore(1, $result);
         self::assertMatcher('catchAll', $result);
     }
diff --git a/tests/Request/RequestBuilderTest.php b/tests/Request/RequestBuilderTest.php
@@ -19,18 +19,6 @@
 #[CoversClass(RequestBuilder::class)]
 final class RequestBuilderTest extends TestCase
 {
-    public function testItCanBeCreated(): void
-    {
-        $builder = RequestBuilder::create(
-            static fn (...$params) => $params,
-            static fn (...$params) => $params,
-            'POST',
-            '/test',
-        );
-
-        $this->assertInstanceOf(RequestBuilder::class, $builder);
-    }
-
     public function testMethodIsReturned(): void
     {
         $builder = $this->createRequestBuilder('POST');
diff --git a/tests/Request/RequestTraitTest.php b/tests/Request/RequestTraitTest.php
@@ -4,7 +4,6 @@
 
 namespace Brainbits\FunctionalTestHelpers\Tests\Request;
 
-use Brainbits\FunctionalTestHelpers\Request\RequestBuilder;
 use Brainbits\FunctionalTestHelpers\Request\RequestTrait;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\BrowserKit\HttpBrowser;
@@ -19,7 +18,6 @@ public function testBuildCreatesBuilder(): void
     {
         $builder = $this->build('POST', 'http://foo');
 
-        $this->assertInstanceOf(RequestBuilder::class, $builder);
         $this->assertSame('POST', $builder->getMethod());
         $this->assertSame('http://foo', $builder->getUri());
     }

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`final readonly class CatchAllMatcher implements Matcher`
`10`	`10`	`{`
`11`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`11`	`+ public function __invoke(RealRequest $realRequest): Hit`
`12`	`12`	`{`
`13`	`13`	`return Hit::catchAll();`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ public function __construct(string\|callable $content)`
`18`	`18`	`$this->content = $content;`
`19`	`19`	`}`
`20`	`20`
`21`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`21`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`22`	`22`	`{`
`23`	`23`	`$expectedContent = $this->content;`
`24`	`24`	`$realContent = $realRequest->getContent();`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function __construct(array\|callable $json)`
`21`	`21`	`$this->json = $json;`
`22`	`22`	`}`
`23`	`23`
`24`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`24`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`25`	`25`	`{`
`26`	`26`	`$expectedJson = $this->json;`
`27`	`27`	`$realJson = $realRequest->getJson();`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ public function __construct(string\|callable $method)`
`19`	`19`	`$this->method = $method;`
`20`	`20`	`}`
`21`	`21`
`22`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`22`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`23`	`23`	`{`
`24`	`24`	`$expectedMethod = $this->method;`
`25`	`25`	`$realMethod = $realRequest->getMethod();`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public function __construct(callable $that)`
`15`	`15`	`$this->that = $that;`
`16`	`16`	`}`
`17`	`17`
`18`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`18`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`19`	`19`	`{`
`20`	`20`	`if (($this->that)($realRequest) === false) {`
`21`	`21`	`return Mismatch::mismatchingThat('returned false');`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function __construct(string\|callable $uri, private UriParams $uriParams)`
`24`	`24`	`$this->uri = $uri;`
`25`	`25`	`}`
`26`	`26`
`27`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`27`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`28`	`28`	`{`
`29`	`29`	`$realUri = $realRequest->getUri();`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public function __construct(string\|callable $xml)`
`28`	`28`	`$this->xml = $xml;`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function __invoke(RealRequest $realRequest): Hit\|Mismatch\|Missing`
	`31`	`+ public function __invoke(RealRequest $realRequest): Hit\|Mismatch`
`32`	`32`	`{`
`33`	`33`	`$expectedXml = $this->xml;`
`34`	`34`	`$realXml = $realRequest->getContent();`
Original file line number	Diff line number	Diff line change
`@@ -306,7 +306,7 @@ public function hasResponse(): bool`
`306`	`306`	`return !$this->responses->isEmpty();`
`307`	`307`	`}`
`308`	`308`
`309`		`- public function nextResponse(): MockResponseBuilder\|Throwable\|null`
	`309`	`+ public function nextResponse(): MockResponseBuilder\|Throwable`
`310`	`310`	`{`
`311`	`311`	`try {`
`312`	`312`	`return $this->responses->next();`