Merge pull request #72 from minkphp/add_phpstan

stof · web-flow · commit 3bee79433f88 · 2023-06-12T23:12:16.000+02:00
Add static analysis with phpstan
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+tab_width = 4
+trim_trailing_whitespace = true
+
+[.github/workflows/*.yml]
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,5 @@
+/.github export-ignore
+/.editorconfig export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/phpstan*.neon export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,35 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  check_composer:
+    name: Check composer.json
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          php-version: '8.2'
+      - run: composer validate --strict --no-check-lock
+
+  static_analysis:
+      name: Static analysis
+      runs-on: ubuntu-latest
+      steps:
+          - uses: actions/checkout@v3
+          - uses: shivammathur/setup-php@v2
+            with:
+                coverage: none
+                php-version: '8.2'
+          - name: Install dependencies
+            run: composer update --ansi --no-progress --prefer-dist --no-interaction
+          - run: vendor/bin/phpstan analyze
diff --git a/composer.json b/composer.json
@@ -27,6 +27,9 @@
         "yoast/phpunit-polyfills": "^1.0"
     },
     "require-dev": {
+        "phpstan/phpstan": "^1.10",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-symfony": "^1.3",
         "symfony/http-kernel": "^4.4 || ^5.0 || ^6.0"
     },
     "conflict": {
diff --git a/http-kernel-fixtures/advanced_form_post.php b/http-kernel-fixtures/advanced_form_post.php
@@ -8,6 +8,7 @@
 <pre>
 <?php
 error_reporting(0);
+/** @var \Symfony\Component\HttpFoundation\Request $request */
 
 $POST = $request->request->all();
 $FILES = $request->files->all();
@@ -19,7 +20,7 @@
 echo html_escape_value(mink_dump($POST)) . "\n";
 if (isset($FILES['about']) && file_exists($FILES['about']->getPathname())) {
     echo html_escape_value($FILES['about']->getClientOriginalName()) . "\n";
-    echo html_escape_value(file_get_contents($FILES['about']->getPathname()));
+    echo html_escape_value(file_get_contents($FILES['about']->getPathname()) ?: '');
 } else {
     echo "no file";
 }
diff --git a/http-kernel-fixtures/basic_auth.php b/http-kernel-fixtures/basic_auth.php
@@ -1,4 +1,5 @@
 <?php
+/** @var \Symfony\Component\HttpFoundation\Request $request */
 $SERVER = $request->server->all();
 
 $username = isset($SERVER['PHP_AUTH_USER']) ? $SERVER['PHP_AUTH_USER'] : false;
diff --git a/http-kernel-fixtures/basic_form_post.php b/http-kernel-fixtures/basic_form_post.php
@@ -1,14 +1,14 @@
-<?php  ?>
+<?php /** @var \Symfony\Component\HttpFoundation\Request $request */ ?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ru">
 <head>
     <title>Basic Form Saving</title>
     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
 </head>
 <body>
-    <h1>Anket for <?php echo html_escape_value($request->request->get('first_name')) ?></h1>
+    <h1>Anket for <?php echo html_escape_value((string) $request->request->get('first_name')) ?></h1>
 
-    <span id="first">Firstname: <?php echo html_escape_value($request->request->get('first_name')) ?></span>
-    <span id="last">Lastname: <?php echo html_escape_value($request->request->get('last_name')) ?></span>
+    <span id="first">Firstname: <?php echo html_escape_value((string) $request->request->get('first_name')) ?></span>
+    <span id="last">Lastname: <?php echo html_escape_value((string) $request->request->get('last_name')) ?></span>
 </body>
 </html>
diff --git a/http-kernel-fixtures/basic_get_form.php b/http-kernel-fixtures/basic_get_form.php
@@ -9,8 +9,9 @@
 
     <div id="serach">
         <?php
+        /** @var \Symfony\Component\HttpFoundation\Request $request */
         $GET = $request->query->all();
-        echo isset($GET['q']) && $GET['q'] ? html_escape_value($GET['q']) : 'No search query'
+        echo isset($GET['q']) && $GET['q'] && \is_string($GET['q']) ? html_escape_value($GET['q']) : 'No search query'
         ?>
     </div>
 
diff --git a/http-kernel-fixtures/cookie_page1.php b/http-kernel-fixtures/cookie_page1.php
@@ -1,4 +1,5 @@
 <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     $resp = new Symfony\Component\HttpFoundation\Response();
     $cook = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set', 0, '/');
     $resp->headers->setCookie($cook);
diff --git a/http-kernel-fixtures/cookie_page2.php b/http-kernel-fixtures/cookie_page2.php
@@ -8,6 +8,7 @@
 </head>
 <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';
     ?>
 </body>
diff --git a/http-kernel-fixtures/cookie_page3.php b/http-kernel-fixtures/cookie_page3.php
@@ -1,4 +1,5 @@
 <?php
+/** @var \Symfony\Component\HttpFoundation\Request $request */
 
 $hasCookie = $request->cookies->has('foo');
 $resp = new Symfony\Component\HttpFoundation\Response();
diff --git a/http-kernel-fixtures/headers.php b/http-kernel-fixtures/headers.php
@@ -6,7 +6,10 @@
 </head>
 <body>
 <pre>
-    <?php echo html_escape_value(mink_dump($request->server->all())); ?>
+    <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
+    echo html_escape_value(mink_dump($request->server->all()));
+    ?>
 </pre>
 </body>
 </html>
diff --git a/http-kernel-fixtures/issue130.php b/http-kernel-fixtures/issue130.php
@@ -5,10 +5,11 @@
 <html>
 <body>
     <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     if ('1' === $request->query->get('p')) {
         echo '<a href="/issue130.php?p=2">Go to 2</a>';
     } else {
-        echo '<strong>'.html_escape_value($request->headers->get('referer')).'</strong>';
+        echo '<strong>'.html_escape_value($request->headers->get('referer') ?? '').'</strong>';
     }
     ?>
 </body>
diff --git a/http-kernel-fixtures/issue140.php b/http-kernel-fixtures/issue140.php
@@ -5,12 +5,13 @@
 <html>
 <body>
 <?php
+/** @var \Symfony\Component\HttpFoundation\Request $request */
 if ($request->isMethod('POST')) {
     $resp = new Symfony\Component\HttpFoundation\Response();
-    $cook = Symfony\Component\HttpFoundation\Cookie::create('tc', $request->request->get('cookie_value'));
+    $cook = Symfony\Component\HttpFoundation\Cookie::create('tc', (string) $request->request->get('cookie_value'));
     $resp->headers->setCookie($cook);
 } elseif ($request->query->has('show_value')) {
-    echo html_escape_value($request->cookies->get('tc'));
+    echo html_escape_value($request->cookies->get('tc') ?? '');
     return;
 }
 ?>
diff --git a/http-kernel-fixtures/print_cookies.php b/http-kernel-fixtures/print_cookies.php
@@ -7,6 +7,7 @@
 <body>
 <pre>
     <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     $cookies = $request->cookies->all();
     unset($cookies['MOCKSESSID']);
 
diff --git a/http-kernel-fixtures/session_test.php b/http-kernel-fixtures/session_test.php
@@ -1,4 +1,5 @@
 <?php
+/** @var \Symfony\Component\HttpFoundation\Request $request */
 $session = $request->getSession();
 
 if ($request->query->has('login')) {
diff --git a/http-kernel-fixtures/sub-folder/cookie_page1.php b/http-kernel-fixtures/sub-folder/cookie_page1.php
@@ -1,4 +1,5 @@
 <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     $requestUri = $request->server->get('REQUEST_URI');
     $resp = new Symfony\Component\HttpFoundation\Response();
     $cook = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set_sub_folder', 0, dirname($requestUri));
diff --git a/http-kernel-fixtures/sub-folder/cookie_page2.php b/http-kernel-fixtures/sub-folder/cookie_page2.php
@@ -8,6 +8,7 @@
 </head>
 <body>
     Previous cookie: <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     if ($request->cookies->has('srvr_cookie')) {
         echo $request->cookies->get('srvr_cookie');
     } else {
diff --git a/http-kernel-fixtures/sub-folder/cookie_page4.php b/http-kernel-fixtures/sub-folder/cookie_page4.php
@@ -1,4 +1,5 @@
 <?php
+    /** @var \Symfony\Component\HttpFoundation\Request $request */
     $resp = new Symfony\Component\HttpFoundation\Response();
     $cookiePath = dirname($request->server->get('REQUEST_URI')) . '/';
     $cookie = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set', 0, $cookiePath);
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
@@ -0,0 +1,17 @@
+parameters:
+    level: 8
+    paths:
+        - src
+        - tests
+        - http-kernel-fixtures
+        - web-fixtures
+    checkMissingIterableValueType: false
+    ignoreErrors:
+        - '#^Method Behat\\Mink\\Tests\\Driver\\[^:]+Test(Case)?\:\:test\w*\(\) has no return type specified\.$#'
+        - '#^Method Behat\\Mink\\Tests\\Driver\\[^:]+Test(Case)?\:\:provide\w*\(\) has no return type specified\.$#'
+        - '#^Method Behat\\Mink\\Tests\\Driver\\[^:]+Test(Case)?\:\:\w*DataProvider\(\) has no return type specified\.$#'
+
+includes:
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
diff --git a/src/FixturesKernel.php b/src/FixturesKernel.php
@@ -34,11 +34,13 @@ private function handleFixtureRequest(Request $request): Response
 
         $path = file_exists($overwriteDir.$file) ? $overwriteDir.$file : $fixturesDir.$file;
 
+        /** @var Response|null $resp */
         $resp = null;
 
         ob_start();
         require $path;
         $content = ob_get_clean();
+        \assert($content !== false);
 
         if ($resp instanceof Response) {
             if ('' === $resp->getContent()) {
@@ -51,7 +53,7 @@ private function handleFixtureRequest(Request $request): Response
         return new Response($content);
     }
 
-    private function prepareSession(Request $request)
+    private function prepareSession(Request $request): void
     {
         $session = new Session(new MockFileSessionStorage());
         $request->setSession($session);
@@ -65,7 +67,7 @@ private function prepareSession(Request $request)
         }
     }
 
-    private function saveSession(Request $request, Response $response)
+    private function saveSession(Request $request, Response $response): void
     {
         if (!$request->hasSession()) {
             return;
diff --git a/tests/AbstractConfig.php b/tests/AbstractConfig.php
@@ -29,7 +29,7 @@ public function mapRemoteFilePath($file)
         $pattern = '/^'.preg_quote($_SERVER['TEST_MACHINE_BASE_PATH'], '/').'/';
         $basePath = $_SERVER['DRIVER_MACHINE_BASE_PATH'];
 
-        return preg_replace($pattern, $basePath, $file, 1);
+        return preg_replace($pattern, $basePath, $file, 1) ?? $file;
     }
 
     /**
diff --git a/tests/Basic/BasicAuthTest.php b/tests/Basic/BasicAuthTest.php
@@ -9,7 +9,7 @@ final class BasicAuthTest extends TestCase
     /**
      * @dataProvider setBasicAuthDataProvider
      */
-    public function testSetBasicAuth($user, $pass, $pageText)
+    public function testSetBasicAuth(string $user, string $pass, string $pageText)
     {
         $session = $this->getSession();
 
diff --git a/tests/Basic/BestPracticesTest.php b/tests/Basic/BestPracticesTest.php
@@ -33,7 +33,7 @@ public function testImplementFindXpath()
     /**
      * @dataProvider provideRequiredMethods
      */
-    public function testImplementBasicApi($method)
+    public function testImplementBasicApi(string $method)
     {
         $driver = $this->createDriver();
 
@@ -54,7 +54,7 @@ public static function provideRequiredMethods()
         );
     }
 
-    private function assertImplementMethod($method, $object, $reason = '')
+    private function assertImplementMethod(string $method, object $object, string $reason = ''): void
     {
         $ref = new \ReflectionClass(get_class($object));
         $refMethod = $ref->getMethod($method);
@@ -68,7 +68,7 @@ private function assertImplementMethod($method, $object, $reason = '')
         $this->assertNotSame('Behat\Mink\Driver\CoreDriver', $refMethod->getDeclaringClass()->name, $message);
     }
 
-    private function assertNotImplementMethod($method, $object, $reason = '')
+    private function assertNotImplementMethod(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
@@ -36,7 +36,7 @@ public function testDumpingEmptyElements()
     /**
      * @dataProvider getAttributeDataProvider
      */
-    public function testGetAttribute($attributeName, $attributeValue)
+    public function testGetAttribute(string $attributeName, ?string $attributeValue)
     {
         $this->getSession()->visit($this->pathTo('/index.html'));
 
diff --git a/tests/Basic/CookieTest.php b/tests/Basic/CookieTest.php
@@ -59,7 +59,7 @@ public function testCookieWithSemicolon()
     /**
      * @dataProvider cookieWithPathsDataProvider
      */
-    public function testCookieWithPaths($cookieRemovalMode)
+    public function testCookieWithPaths(string $cookieRemovalMode)
     {
         // start clean
         $session = $this->getSession();
@@ -98,7 +98,7 @@ public static function cookieWithPathsDataProvider()
     /**
      * @dataProvider cookieWithPathsDataProvider
      */
-    public function testCookieInSubPath($cookieRemovalMode)
+    public function testCookieInSubPath(string $cookieRemovalMode)
     {
         // Start clean.
         // The cookie is set when viewing the page.
diff --git a/tests/Basic/NavigationTest.php b/tests/Basic/NavigationTest.php
@@ -44,7 +44,9 @@ public function testLinks()
         $link = $page->findLink('Redirect me to');
 
         $this->assertNotNull($link);
-        $this->assertMatchesRegularExpression('/redirector\.php$/', $link->getAttribute('href'));
+        $href = $link->getAttribute('href');
+        $this->assertNotNull($href);
+        $this->assertMatchesRegularExpression('/redirector\.php$/', $href);
         $link->click();
 
         $this->assertEquals($this->pathTo('/redirect_destination.html'), $this->getSession()->getCurrentUrl());
@@ -54,7 +56,9 @@ public function testLinks()
         $link = $page->findLink('basic form image');
 
         $this->assertNotNull($link);
-        $this->assertMatchesRegularExpression('/basic_form\.html$/', $link->getAttribute('href'));
+        $href = $link->getAttribute('href');
+        $this->assertNotNull($href);
+        $this->assertMatchesRegularExpression('/basic_form\.html$/', $href);
         $link->click();
 
         $this->assertEquals($this->pathTo('/basic_form.html'), $this->getSession()->getCurrentUrl());
@@ -64,7 +68,9 @@ public function testLinks()
         $link = $page->findLink('Link with a ');
 
         $this->assertNotNull($link);
-        $this->assertMatchesRegularExpression('/links\.html\?quoted$/', $link->getAttribute('href'));
+        $href = $link->getAttribute('href');
+        $this->assertNotNull($href);
+        $this->assertMatchesRegularExpression('/links\.html\?quoted$/', $href);
         $link->click();
 
         $this->assertEquals($this->pathTo('/links.html?quoted'), $this->getSession()->getCurrentUrl());
diff --git a/tests/Basic/TraversingTest.php b/tests/Basic/TraversingTest.php
@@ -125,13 +125,17 @@ public function testDeepTraversing()
         $subUrl = $subDivs[2]->findLink('some deep url');
         $this->assertNotNull($subUrl);
 
-        $this->assertMatchesRegularExpression('/some_url$/', $subUrl->getAttribute('href'));
+        $href = $subUrl->getAttribute('href');
+        $this->assertNotNull($href);
+        $this->assertMatchesRegularExpression('/some_url$/', $href);
         $this->assertEquals('some deep url', $subUrl->getText());
         $this->assertEquals('some <strong>deep</strong> url', $subUrl->getHtml());
 
         $this->assertTrue($subUrl->has('css', 'strong'));
         $this->assertFalse($subUrl->has('css', 'em'));
-        $this->assertEquals('deep', $subUrl->find('css', 'strong')->getText());
+        $strong = $subUrl->find('css', 'strong');
+        $this->assertNotNull($strong);
+        $this->assertEquals('deep', $strong->getText());
     }
 
     public function testFindingChild()
diff --git a/tests/Css/HoverTest.php b/tests/Css/HoverTest.php
@@ -65,7 +65,7 @@ public function testRightClickHover()
         $this->assertActionSquareHeight(200);
     }
 
-    private function assertActionSquareHeight($expected)
+    private function assertActionSquareHeight(int $expected): void
     {
         $this->assertEquals(
             $expected,
diff --git a/tests/Form/GeneralTest.php b/tests/Form/GeneralTest.php
diff --git a/tests/Form/RadioTest.php b/tests/Form/RadioTest.php
diff --git a/tests/Form/SelectTest.php b/tests/Form/SelectTest.php
diff --git a/tests/Js/ChangeEventTest.php b/tests/Js/ChangeEventTest.php
diff --git a/tests/Js/EventsTest.php b/tests/Js/EventsTest.php
diff --git a/tests/Js/JavascriptEvaluationTest.php b/tests/Js/JavascriptEvaluationTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php
diff --git a/web-fixtures/advanced_form_post.php b/web-fixtures/advanced_form_post.php
diff --git a/web-fixtures/basic_get_form.php b/web-fixtures/basic_get_form.php
diff --git a/web-fixtures/issue130.php b/web-fixtures/issue130.php
diff --git a/web-fixtures/utils.php b/web-fixtures/utils.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+/** @var \Symfony\Component\HttpFoundation\Request $request */`
`2`	`3`	`$SERVER = $request->server->all();`
`3`	`4`
`4`	`5`	`$username = isset($SERVER['PHP_AUTH_USER']) ? $SERVER['PHP_AUTH_USER'] : false;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`<?php`
	`2`	`+ /** @var \Symfony\Component\HttpFoundation\Request $request */`
`2`	`3`	`$resp = new Symfony\Component\HttpFoundation\Response();`
`3`	`4`	`$cook = Symfony\Component\HttpFoundation\Cookie::create('srvr_cookie', 'srv_var_is_set', 0, '/');`
`4`	`5`	`$resp->headers->setCookie($cook);`