Replace Psalm with PHPStan

Author: tvdijen

.gitattributes

@@ -5,8 +5,10 @@ codecov.yml export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-psalm.xml export-ignore
-psalm-dev.xml export-ignore
+phpstan.neon export-ignore
+phpstan-dev.neon export-ignore
+phpstan-baseline.neon export-ignore
+phpstan-baseline-dev.neon export-ignore
 phpcs.xml export-ignore
 phpunit.xml export-ignore
 .php_cs.dist export-ignore

.github/workflows/php.yml

@@ -165,8 +165,7 @@ jobs:
         with:
           # Should be the higest supported version, so we can use the newest tools
           php-version: '8.5'
-          tools: composer, composer-require-checker, composer-unused, psalm
-          # optional performance gain for psalm: opcache
+          tools: composer, composer-require-checker, composer-unused
           extensions: ctype, date, dom, fileinfo, filter, hash, intl, ldap, mbstring, opcache, openssl, pcre, spl, xml
 
       - name: Setup problem matchers for PHP
@@ -199,27 +198,13 @@ jobs:
       - name: PHP Code Sniffer
         run: vendor/bin/phpcs
 
-      - name: Psalm
-        continue-on-error: true
+      - name: PHPStan
         run: |
-          psalm -c psalm.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
+          vendor/bin/phpstan analyze -c phpstan.neon --debug
 
-      - name: Psalm (testsuite)
+      - name: PHPStan (testsuite)
         run: |
-          psalm -c psalm-dev.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
-
-      - name: Psalter
-        run: |
-          psalm --alter \
-          --issues=UnnecessaryVarAnnotation \
-          --dry-run \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
+          vendor/bin/phpstan analyze -c phpstan-dev.neon --debug
 
   security:
     name: Security checks

phpstan-dev.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 9
+  paths:
+    - tests

phpstan.neon

@@ -0,0 +1,4 @@
+parameters:
+  level: 5
+  paths:
+    - src

psalm-dev.xml

@@ -67,7 +67,7 @@ public function __construct(array $info, array $config)
      *
      * @param array &$state Information about the current authentication.
      */
-    public function authenticate(array &$state): void
+    public function authenticate(array &$state): never
     {
         // set the default backend to config
         $state['LogoutState'] = [
@@ -95,14 +95,10 @@ public function authenticate(array &$state): void
         ) {
             Logger::debug('Negotiate - session disabled. falling back');
             $this->fallBack($state);
-            // never executed
-            assert(false);
         }
 
         if (!$this->checkMask()) {
             $this->fallBack($state);
-            // never executed
-            assert(false);
         }
 
         // No auth token. Send it.
@@ -235,17 +231,13 @@ public function externalAuth(array &$state): void
             ];
             Logger::info('Negotiate - authenticate(): ' . $user . ' authorized.');
             Auth\Source::completeAuth($state);
-            // Never reached.
-            assert(false);
         }
     }
 
 
     /**
      * Passes control of the login process to a different module.
      *
-     * @param string $state Information about the current authentication.
-     *
      * @throws \SimpleSAML\Error\BadRequest If couldn't determine the auth source.
      * @throws \SimpleSAML\Error\NoState
      * @throws \SimpleSAML\Error\Exception
@@ -265,7 +257,6 @@ public static function external(): void
             }
             $httpUtils = new Utils\HTTP();
             $httpUtils->redirectUntrustedURL($sid['url'], ['negotiateext.auth' => 'false']);
-            assert(false);
         }
 
         Assert::isArray($state);
@@ -294,7 +285,6 @@ public static function external(): void
         }
 
         self::fallBack($state);
-        assert(false);
     }
 
 

psalm.xml

@@ -130,12 +130,14 @@ public function testEnable(): void
 
         // Validate cookie
         $cookies = $response->headers->getCookies();
+        $cookie = null;
         foreach ($cookies as $cookie) {
             if ($cookie->getName() === 'NEGOTIATE_AUTOLOGIN_DISABLE_PERMANENT') {
                 break;
             }
         }
 
+        $this->assertNotNull($cookie);
         $this->assertEquals($cookie->getValue(), null);
         $this->assertEquals($cookie->getDomain(), null);
         $this->assertEquals($cookie->getPath(), '/');
@@ -160,12 +162,14 @@ public function testDisable(): void
 
         // Validate cookie
         $cookies = $response->headers->getCookies();
+        $cookie = null;
         foreach ($cookies as $cookie) {
             if ($cookie->getName() === 'NEGOTIATE_AUTOLOGIN_DISABLE_PERMANENT') {
                 break;
             }
         }
 
+        $this->assertNotNull($cookie);
         $this->assertEquals($cookie->getValue(), 'true');
         $this->assertEquals($cookie->getDomain(), null);
         $this->assertEquals($cookie->getPath(), '/');