Merge pull request #100 from uuf6429/chore/phpstan-improvements

uuf6429 · web-flow · commit d5495529120c · 2025-01-13T13:18:16.000+02:00
PHPStan improvements
diff --git a/http-kernel-fixtures/cookie_page2.php b/http-kernel-fixtures/cookie_page2.php
@@ -9,7 +9,7 @@
 <body>
     Previous cookie: <?php
         /** @var \Symfony\Component\HttpFoundation\Request $request */
-        echo $request->cookies->has('srvr_cookie') ? html_escape_value($request->cookies->get('srvr_cookie')) : 'NO';
+        echo $request->cookies->has('srvr_cookie') ? html_escape_value($request->cookies->get('srvr_cookie') ?? '') : 'NO';
     ?>
 </body>
 </html>
diff --git a/http-kernel-fixtures/sub-folder/cookie_page1.php b/http-kernel-fixtures/sub-folder/cookie_page1.php
@@ -1,6 +1,7 @@
 <?php
     /** @var \Symfony\Component\HttpFoundation\Request $request */
     $requestUri = $request->server->get('REQUEST_URI');
+    assert(is_string($requestUri));
     $resp = new Symfony\Component\HttpFoundation\Response();
     $cook = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set_sub_folder', 0, dirname($requestUri));
     $resp->headers->setCookie($cook);
diff --git a/http-kernel-fixtures/sub-folder/cookie_page4.php b/http-kernel-fixtures/sub-folder/cookie_page4.php
@@ -1,7 +1,9 @@
 <?php
     /** @var \Symfony\Component\HttpFoundation\Request $request */
     $resp = new Symfony\Component\HttpFoundation\Response();
-    $cookiePath = dirname($request->server->get('REQUEST_URI')) . '/';
+    $requestUri = $request->server->get('REQUEST_URI');
+    assert(is_string($requestUri));
+    $cookiePath = dirname($requestUri) . '/';
     $cookie = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set', 0, $cookiePath);
     $resp->headers->setCookie($cookie);
 ?>
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -1,11 +1,10 @@
 parameters:
-    level: 8
+    level: 9
     paths:
         - src
         - tests
         - http-kernel-fixtures
         - web-fixtures
-    checkMissingIterableValueType: false
 
 includes:
     - vendor/phpstan/phpstan-phpunit/extension.neon
diff --git a/src/FixturesKernel.php b/src/FixturesKernel.php
@@ -2,6 +2,7 @@
 
 namespace Behat\Mink\Tests\Driver\Util;
 
+use Behat\Mink\Tests\Driver\TestCase;
 use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -25,8 +26,8 @@ public function handle(Request $request, $type = 1 /* self::MAIN_REQUEST */ , $c
 
     private function handleFixtureRequest(Request $request): Response
     {
-        $fixturesDir = realpath(__DIR__ . '/../web-fixtures');
-        $overwriteDir = realpath(__DIR__ . '/../http-kernel-fixtures');
+        $fixturesDir = realpath(TestCase::WEB_FIXTURES_DIR);
+        $overwriteDir = realpath(TestCase::KERNEL_FIXTURES_DIR);
 
         require_once $fixturesDir . '/utils.php';
 
@@ -61,7 +62,7 @@ private function prepareSession(Request $request): void
         $cookies = $request->cookies;
 
         if ($cookies->has($session->getName())) {
-            $session->setId($cookies->get($session->getName()));
+            $session->setId((string) $cookies->get($session->getName()));
         } else {
             $session->migrate(false);
         }
diff --git a/tests/AbstractConfig.php b/tests/AbstractConfig.php
@@ -22,7 +22,7 @@ abstract public function createDriver();
      */
     public function mapRemoteFilePath($file)
     {
-        if (!isset($_SERVER['TEST_MACHINE_BASE_PATH']) || !isset($_SERVER['DRIVER_MACHINE_BASE_PATH'])) {
+        if (!isset($_SERVER['TEST_MACHINE_BASE_PATH'], $_SERVER['DRIVER_MACHINE_BASE_PATH'])) {
             return $file;
         }
 
diff --git a/tests/Basic/BasicAuthTest.php b/tests/Basic/BasicAuthTest.php
@@ -20,12 +20,13 @@ public function testSetBasicAuth(string $user, string $pass, string $pageText):
         $this->assertStringContainsString($pageText, $session->getPage()->getContent());
     }
 
+    /**
+     * @return iterable<string, array{string, string, string}>
+     */
     public static function setBasicAuthDataProvider(): iterable
     {
-        return [
-            ['mink-user', 'mink-password', 'is authenticated'],
-            ['', '', 'is not authenticated'],
-        ];
+        yield 'valid credentials' => ['mink-user', 'mink-password', 'is authenticated'];
+        yield 'no credentials' => ['', '', 'is not authenticated'];
     }
 
     public function testBasicAuthInUrl(): void
diff --git a/tests/Basic/BestPracticesTest.php b/tests/Basic/BestPracticesTest.php
@@ -24,9 +24,9 @@ public function testImplementFindXpath(): void
     {
         $driver = $this->createDriver();
 
-        $this->assertNotImplementMethod('find', $driver, 'The driver should overwrite `findElementXpaths` rather than `find` for forward compatibility with Mink 2.');
-        $this->assertImplementMethod('findElementXpaths', $driver, 'The driver must be able to find elements.');
-        $this->assertNotImplementMethod('setSession', $driver, 'The driver should not deal with the Session directly for forward compatibility with Mink 2.');
+        $this->assertMethodIsNotImplemented('find', $driver, 'The driver should overwrite `findElementXpaths` rather than `find` for forward compatibility with Mink 2.');
+        $this->assertMethodIsImplemented('findElementXpaths', $driver, 'The driver must be able to find elements.');
+        $this->assertMethodIsNotImplemented('setSession', $driver, 'The driver should not deal with the Session directly for forward compatibility with Mink 2.');
     }
 
     /**
@@ -36,9 +36,12 @@ public function testImplementBasicApi(string $method): void
     {
         $driver = $this->createDriver();
 
-        $this->assertImplementMethod($method, $driver, 'The driver is unusable when this method is not implemented.');
+        $this->assertMethodIsImplemented($method, $driver, 'The driver is unusable when this method is not implemented.');
     }
 
+    /**
+     * @return iterable<array{string}>
+     */
     public static function provideRequiredMethods(): iterable
     {
         return [
@@ -53,7 +56,7 @@ public static function provideRequiredMethods(): iterable
         ];
     }
 
-    private function assertImplementMethod(string $method, object $object, string $reason = ''): void
+    private function assertMethodIsImplemented(string $method, object $object, string $reason = ''): void
     {
         $ref = new \ReflectionClass(get_class($object));
         $refMethod = $ref->getMethod($method);
@@ -67,7 +70,7 @@ private function assertImplementMethod(string $method, object $object, string $r
         $this->assertNotSame(CoreDriver::class, $refMethod->getDeclaringClass()->name, $message);
     }
 
-    private function assertNotImplementMethod(string $method, object $object, string $reason = ''): void
+    private function assertMethodIsNotImplemented(string $method, object $object, string $reason = ''): void
     {
         $ref = new \ReflectionClass(get_class($object));
         $refMethod = $ref->getMethod($method);
diff --git a/tests/Basic/ContentTest.php b/tests/Basic/ContentTest.php
@@ -61,6 +61,9 @@ public function testGetAttribute(string $attributeName, ?string $attributeValue)
         $this->assertSame($attributeValue, $element->getAttribute($attributeName));
     }
 
+    /**
+     * @return iterable<array{string, mixed}>
+     */
     public static function getAttributeDataProvider(): iterable
     {
         return [
diff --git a/tests/Basic/CookieTest.php b/tests/Basic/CookieTest.php
@@ -4,6 +4,9 @@
 
 use Behat\Mink\Tests\Driver\TestCase;
 
+/**
+ * @phpstan-type TCookieRemovalMode 'session_reset'|'cookie_delete'
+ */
 final class CookieTest extends TestCase
 {
     /**
@@ -87,6 +90,9 @@ public function testCookieWithPaths(string $cookieRemovalMode): void
         $this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());
     }
 
+    /**
+     * @phpstan-return iterable<array{TCookieRemovalMode}>
+     */
     public static function cookieWithPathsDataProvider(): iterable
     {
         return [
@@ -96,6 +102,7 @@ public static function cookieWithPathsDataProvider(): iterable
     }
 
     /**
+     * @phpstan-param TCookieRemovalMode $cookieRemovalMode
      * @dataProvider cookieWithPathsDataProvider
      */
     public function testCookieInSubPath(string $cookieRemovalMode): void
diff --git a/tests/Basic/IFrameTest.php b/tests/Basic/IFrameTest.php
@@ -29,13 +29,11 @@ public function testIFrame(string $iframeIdentifier, string $elementSelector, st
     }
 
     /**
-     * @return array
+     * @return iterable<string, array{string, string, string}>
      */
-    public static function iFrameDataProvider()
+    public static function iFrameDataProvider(): iterable
     {
-        return array(
-            'by name' => array('subframe_by_name', '#text', 'iFrame div text'),
-            'by id' => array('subframe_by_id', '#foobar', 'Some accentués characters'),
-        );
+        yield 'by name' => ['subframe_by_name', '#text', 'iFrame div text'];
+        yield 'by id' => ['subframe_by_id', '#foobar', 'Some accentués characters'];
     }
 }
diff --git a/tests/Form/GeneralTest.php b/tests/Form/GeneralTest.php
@@ -77,14 +77,15 @@ public function testFormSubmitWays(string $submitVia): void
         }
     }
 
+    /**
+     * @return iterable<array{string}>
+     */
     public static function formSubmitWaysDataProvider(): iterable
     {
-        return [
-            ['Save'],
-            ['input-type-image'],
-            ['button-without-type'],
-            ['button-type-submit'],
-        ];
+        yield ['Save'];
+        yield ['input-type-image'];
+        yield ['button-without-type'];
+        yield ['button-type-submit'];
     }
 
     public function testFormSubmit(): void
@@ -189,7 +190,7 @@ public function testAdvancedForm(): void
         $notes->setValue('new notes');
         $this->assertEquals('new notes', $notes->getValue());
 
-        $about->attachFile($this->mapRemoteFilePath(__DIR__ . '/../../web-fixtures/some_file.txt'));
+        $about->attachFile($this->mapRemoteFilePath(self::WEB_FIXTURES_DIR . '/some_file.txt'));
 
         $button = $page->findButton('Register');
         $this->assertNotNull($button);
@@ -352,7 +353,7 @@ public function testSubmitEmptyTextarea(): void
     /**
      * @dataProvider provideInvalidValues
      *
-     * @param mixed $value
+     * @param array<array-key, mixed>|bool|string $value
      */
     public function testSetInvalidValueInField(string $field, $value): void
     {
@@ -366,6 +367,9 @@ public function testSetInvalidValueInField(string $field, $value): void
         $color->setValue($value);
     }
 
+    /**
+     * @return iterable<string, array{string, mixed}>
+     */
     public static function provideInvalidValues(): iterable
     {
         $trueValue = ['true', true];
diff --git a/tests/Form/Html5Test.php b/tests/Form/Html5Test.php
@@ -163,7 +163,7 @@ public function testHtml5FormMethod(): void
     /**
      * @dataProvider provideInvalidValues
      *
-     * @param mixed $value
+     * @param array<array-key, mixed>|bool|string $value
      */
     public function testSetInvalidValueInField(string $field, $value): void
     {
@@ -177,6 +177,9 @@ public function testSetInvalidValueInField(string $field, $value): void
         $color->setValue($value);
     }
 
+    /**
+     * @return iterable<string, array{string, mixed}>
+     */
     public static function provideInvalidValues(): iterable
     {
         $trueValue = ['true', true];
diff --git a/tests/Form/RadioTest.php b/tests/Form/RadioTest.php
@@ -112,6 +112,9 @@ public function testSetBooleanValue(bool $value): void
         $option->setValue($value);
     }
 
+    /**
+     * @return iterable<array{bool}>
+     */
     public static function provideBooleanValues(): iterable
     {
         yield [true];
diff --git a/tests/Form/SelectTest.php b/tests/Form/SelectTest.php
@@ -78,6 +78,9 @@ public function testElementSelectedStateCheck(string $selectName, string $option
         $this->assertTrue($option->isSelected());
     }
 
+    /**
+     * @return iterable<array{string, string, string}>
+     */
     public static function elementSelectedStateCheckDataProvider(): iterable
     {
         return [
@@ -119,6 +122,9 @@ public function testSetBooleanValue(bool $value): void
         $select->setValue($value);
     }
 
+    /**
+     * @return iterable<array{bool}>
+     */
     public static function provideBooleanValues(): iterable
     {
         yield [true];
diff --git a/tests/Js/ChangeEventTest.php b/tests/Js/ChangeEventTest.php
@@ -63,20 +63,18 @@ public function testSetValueChangeEvent(string $elementId, string $valueForEmpty
         }
     }
 
+    /**
+     * @return iterable<string, array{string, string, string}>
+     */
     public static function setValueChangeEventDataProvider(): iterable
     {
-        $file1 = __DIR__ . '/../../web-fixtures/file1.txt';
-        $file2 = __DIR__ . '/../../web-fixtures/file2.txt';
-
-        return [
-            'input default' => ['the-input-default', 'from empty', 'from existing'],
-            'input text' => ['the-input-text', 'from empty', 'from existing'],
-            'input email' => ['the-email', 'from empty', 'from existing'],
-            'textarea' => ['the-textarea', 'from empty', 'from existing'],
-            'file' => ['the-file', $file1, $file2],
-            'select' => ['the-select', '30'],
-            'radio' => ['the-radio-m', 'm'],
-        ];
+        yield 'input default' => ['the-input-default', 'from empty', 'from existing'];
+        yield 'input text' => ['the-input-text', 'from empty', 'from existing'];
+        yield 'input email' => ['the-email', 'from empty', 'from existing'];
+        yield 'textarea' => ['the-textarea', 'from empty', 'from existing'];
+        yield 'file' => ['the-file', self::WEB_FIXTURES_DIR . '/file1.txt', self::WEB_FIXTURES_DIR . '/file2.txt'];
+        yield 'select' => ['the-select', '30', ''];
+        yield 'radio' => ['the-radio-m', 'm', ''];
     }
 
     /**
@@ -95,12 +93,13 @@ public function testSelectOptionChangeEvent(string $elementId, string $elementVa
         $this->assertElementChangeCount($elementId);
     }
 
+    /**
+     * @return iterable<string, array{string, string}>
+     */
     public static function selectOptionChangeEventDataProvider(): iterable
     {
-        return [
-            'select' => ['the-select', '30'],
-            'radio' => ['the-radio-m', 'm'],
-        ];
+        yield 'select' => ['the-select', '30'];
+        yield 'radio' => ['the-radio-m', 'm'];
     }
 
     /**
@@ -145,12 +144,13 @@ public function testUncheckChangeEvent(bool $useSetValue): void
         $this->assertElementChangeCount('the-checked-checkbox');
     }
 
+    /**
+     * @return iterable<array{mixed}>
+     */
     public static function checkboxTestWayDataProvider(): iterable
     {
-        return [
-            [true],
-            [false],
-        ];
+        yield [true];
+        yield [false];
     }
 
     private function assertElementChangeCount(string $elementId, string $message = ''): void
diff --git a/tests/Js/EventsTest.php b/tests/Js/EventsTest.php
@@ -118,15 +118,16 @@ public function testKeyboardEvents(?string $modifier, string $eventProperties):
         $this->assertEquals('key upped:78 / ' . $eventProperties, $event->getText());
     }
 
+    /**
+     * @return iterable<string, array{KeyModifier::*|null, string}>
+     */
     public static function provideKeyboardEventsModifiers(): iterable
     {
-        return [
-            'none' => [null, '0 / 0 / 0 / 0'],
-            'alt' => [KeyModifier::ALT, '1 / 0 / 0 / 0'],
-            // jQuery considers ctrl as being a metaKey in the normalized event
-            'ctrl' => [KeyModifier::CTRL, '0 / 1 / 0 / 1'],
-            'shift' => [KeyModifier::SHIFT, '0 / 0 / 1 / 0'],
-            'meta' => [KeyModifier::META, '0 / 0 / 0 / 1'],
-        ];
+        yield 'none' => [null, '0 / 0 / 0 / 0'];
+        yield 'alt' => [KeyModifier::ALT, '1 / 0 / 0 / 0'];
+        // jQuery considers ctrl as being a metaKey in the normalized event
+        yield 'ctrl' => [KeyModifier::CTRL, '0 / 1 / 0 / 1'];
+        yield 'shift' => [KeyModifier::SHIFT, '0 / 0 / 1 / 0'];
+        yield 'meta' => [KeyModifier::META, '0 / 0 / 0 / 1'];
     }
 }
diff --git a/tests/Js/JavascriptEvaluationTest.php b/tests/Js/JavascriptEvaluationTest.php
diff --git a/tests/Js/SessionResetTest.php b/tests/Js/SessionResetTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ abstract public function createDriver();`
`22`	`22`	`*/`
`23`	`23`	`public function mapRemoteFilePath($file)`
`24`	`24`	`{`
`25`		`- if (!isset($_SERVER['TEST_MACHINE_BASE_PATH']) \|\| !isset($_SERVER['DRIVER_MACHINE_BASE_PATH'])) {`
	`25`	`+ if (!isset($_SERVER['TEST_MACHINE_BASE_PATH'], $_SERVER['DRIVER_MACHINE_BASE_PATH'])) {`
`26`	`26`	`return $file;`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -20,12 +20,13 @@ public function testSetBasicAuth(string $user, string $pass, string $pageText):`
`20`	`20`	`$this->assertStringContainsString($pageText, $session->getPage()->getContent());`
`21`	`21`	`}`
`22`	`22`
	`23`	`+ /**`
	`24`	`+ * @return iterable<string, array{string, string, string}>`
	`25`	`+ */`
`23`	`26`	`public static function setBasicAuthDataProvider(): iterable`
`24`	`27`	`{`
`25`		`- return [`
`26`		`- ['mink-user', 'mink-password', 'is authenticated'],`
`27`		`- ['', '', 'is not authenticated'],`
`28`		`- ];`
	`28`	`+ yield 'valid credentials' => ['mink-user', 'mink-password', 'is authenticated'];`
	`29`	`+ yield 'no credentials' => ['', '', 'is not authenticated'];`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`public function testBasicAuthInUrl(): void`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@ public function testImplementFindXpath(): void`
`24`	`24`	`{`
`25`	`25`	`$driver = $this->createDriver();`
`26`	`26`
`27`		- $this->assertNotImplementMethod('find', $driver, 'The driver should overwrite `findElementXpaths` rather than `find` for forward compatibility with Mink 2.');
`28`		`- $this->assertImplementMethod('findElementXpaths', $driver, 'The driver must be able to find elements.');`
`29`		`- $this->assertNotImplementMethod('setSession', $driver, 'The driver should not deal with the Session directly for forward compatibility with Mink 2.');`
	`27`	+ $this->assertMethodIsNotImplemented('find', $driver, 'The driver should overwrite `findElementXpaths` rather than `find` for forward compatibility with Mink 2.');
	`28`	`+ $this->assertMethodIsImplemented('findElementXpaths', $driver, 'The driver must be able to find elements.');`
	`29`	`+ $this->assertMethodIsNotImplemented('setSession', $driver, 'The driver should not deal with the Session directly for forward compatibility with Mink 2.');`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`/**`
`@@ -36,9 +36,12 @@ public function testImplementBasicApi(string $method): void`
`36`	`36`	`{`
`37`	`37`	`$driver = $this->createDriver();`
`38`	`38`
`39`		`- $this->assertImplementMethod($method, $driver, 'The driver is unusable when this method is not implemented.');`
	`39`	`+ $this->assertMethodIsImplemented($method, $driver, 'The driver is unusable when this method is not implemented.');`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ /**`
	`43`	`+ * @return iterable<array{string}>`
	`44`	`+ */`
`42`	`45`	`public static function provideRequiredMethods(): iterable`
`43`	`46`	`{`
`44`	`47`	`return [`
`@@ -53,7 +56,7 @@ public static function provideRequiredMethods(): iterable`
`53`	`56`	`];`
`54`	`57`	`}`
`55`	`58`
`56`		`- private function assertImplementMethod(string $method, object $object, string $reason = ''): void`
	`59`	`+ private function assertMethodIsImplemented(string $method, object $object, string $reason = ''): void`
`57`	`60`	`{`
`58`	`61`	`$ref = new \ReflectionClass(get_class($object));`
`59`	`62`	`$refMethod = $ref->getMethod($method);`
`@@ -67,7 +70,7 @@ private function assertImplementMethod(string $method, object $object, string $r`
`67`	`70`	`$this->assertNotSame(CoreDriver::class, $refMethod->getDeclaringClass()->name, $message);`
`68`	`71`	`}`
`69`	`72`
`70`		`- private function assertNotImplementMethod(string $method, object $object, string $reason = ''): void`
	`73`	`+ private function assertMethodIsNotImplemented(string $method, object $object, string $reason = ''): void`
`71`	`74`	`{`
`72`	`75`	`$ref = new \ReflectionClass(get_class($object));`
`73`	`76`	`$refMethod = $ref->getMethod($method);`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@ public function testGetAttribute(string $attributeName, ?string $attributeValue)`
`61`	`61`	`$this->assertSame($attributeValue, $element->getAttribute($attributeName));`
`62`	`62`	`}`
`63`	`63`
	`64`	`+ /**`
	`65`	`+ * @return iterable<array{string, mixed}>`
	`66`	`+ */`
`64`	`67`	`public static function getAttributeDataProvider(): iterable`
`65`	`68`	`{`
`66`	`69`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,9 @@`
`4`	`4`
`5`	`5`	`use Behat\Mink\Tests\Driver\TestCase;`
`6`	`6`
	`7`	`+/**`
	`8`	`+ * @phpstan-type TCookieRemovalMode 'session_reset'\|'cookie_delete'`
	`9`	`+ */`
`7`	`10`	`final class CookieTest extends TestCase`
`8`	`11`	`{`
`9`	`12`	`/**`
`@@ -87,6 +90,9 @@ public function testCookieWithPaths(string $cookieRemovalMode): void`
`87`	`90`	`$this->assertStringContainsString('Previous cookie: NO', $session->getPage()->getText());`
`88`	`91`	`}`
`89`	`92`
	`93`	`+ /**`
	`94`	`+ * @phpstan-return iterable<array{TCookieRemovalMode}>`
	`95`	`+ */`
`90`	`96`	`public static function cookieWithPathsDataProvider(): iterable`
`91`	`97`	`{`
`92`	`98`	`return [`
`@@ -96,6 +102,7 @@ public static function cookieWithPathsDataProvider(): iterable`
`96`	`102`	`}`
`97`	`103`
`98`	`104`	`/**`
	`105`	`+ * @phpstan-param TCookieRemovalMode $cookieRemovalMode`
`99`	`106`	`* @dataProvider cookieWithPathsDataProvider`
`100`	`107`	`*/`
`101`	`108`	`public function testCookieInSubPath(string $cookieRemovalMode): void`