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

@@ -163,9 +163,8 @@ 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
-          extensions: ctype, date, dom, fileinfo, filter, hash, intl, mbstring, opcache, openssl, pcre, spl, xml
+          tools: composer, composer-require-checker, composer-unused
+          extensions: ctype, date, dom, fileinfo, filter, hash, intl, mbstring, openssl, pcre, spl, xml
 
       - name: Setup problem matchers for PHP
         run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
@@ -197,27 +196,13 @@ jobs:
       - name: PHP Code Sniffer
         run: vendor/bin/phpcs
 
-      - name: Psalm
-        continue-on-error: true
-        run: |
-          psalm -c psalm.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
-
-      - name: Psalm (testsuite)
+      - name: PHPStan
         run: |
-          psalm -c psalm-dev.xml \
-          --show-info=true \
-          --shepherd \
-          --php-version=${{ steps.setup-php.outputs.php-version }}
+          vendor/bin/phpstan analyze -c phpstan.neon --debug
 
-      - name: Psalter
+      - name: PHPStan (testsuite)
         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

@@ -26,12 +26,16 @@ class ARP
      * Constructor
      *
      * @param array $metadata
-     * @param string $attributemap_filename
+     * @param string|null $attributemap_filename
      * @param string $prefix
      * @param string $suffix
      */
-    public function __construct(array $metadata, string $attributemap_filename, string $prefix, string $suffix)
-    {
+    public function __construct(
+        array $metadata,
+        ?string $attributemap_filename = null,
+        ?string $prefix = '',
+        ?string $suffix = '',
+    ) {
         $this->metadata = $metadata;
         $this->prefix = $prefix;
         $this->suffix = $suffix;
@@ -50,11 +54,10 @@ private function loadAttributeMap(string $attributemap_filename): void
     {
         $config = \SimpleSAML\Configuration::getInstance();
 
-        /** @psalm-suppress PossiblyNullOperand */
         include($config->getPathValue('attributemap', 'attributemap/') . $attributemap_filename . '.php');
 
         // Note that $attributemap is defined in the included attributemap-file!
-        /** @psalm-var array $attributemap */
+        // @phpstan-ignore variable.undefined
         $this->attributes = $attributemap;
     }
 

psalm.xml

@@ -107,6 +107,7 @@ public function loadSource(array $source): void
             $context = $this->createContext($source);
 
             $httpUtils = new Utils\HTTP();
+            $data = null;
             // GET!
             try {
                 /** @var array $response  We know this because we set the third parameter to `true` */
@@ -198,7 +199,7 @@ public function loadSource(array $source): void
                 if (count($attributeAuthorities) && !empty($attributeAuthorities[0])) {
                     $this->addMetadata(
                         $source['src'],
-                        $attributeAuthorities[0],
+                        $attributeAuthorities,
                         'attributeauthority-remote',
                         $template,
                     );

src/ARP.php

@@ -86,7 +86,7 @@ public function requireAdmin(): void
 
     /**
      */
-    public function testMetaRefresh()
+    public function testMetaRefresh(): void
     {
         $_SERVER['REQUEST_URI'] = '/module.php/metarefresh/';
         $_SERVER['REQUEST_METHOD'] = 'GET';

src/MetaLoader.php

@@ -7,19 +7,20 @@
 use Exception;
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Configuration;
+use SimpleSAML\Module\metarefresh\MetaLoader;
 
 final class MetaLoaderTest extends TestCase
 {
     /** \SimpleSAML\Module\metarefresh\MetaLoader */
-    private $metaloader;
+    private MetaLoader $metaloader;
 
     /** @var \SimpleSAML\Configuration */
-    private $config;
+    private Configuration $config;
 
     /** @var string */
     private $tmpdir;
 
-    /** @var array */
+    /** @var array<mixed> */
     private $source = [
         'outputFormat' => 'flatfile',
         'conditionalGET' => false,
@@ -30,7 +31,7 @@ final class MetaLoaderTest extends TestCase
         ],
     ];
 
-    /** @var array */
+    /** @var array<mixed> */
     private $expected = [
         'entityid' => 'https://idp.example.com/idp/shibboleth',
         'description' => ['en' => 'OrganizationName',],
@@ -110,9 +111,12 @@ public function testMetaLoader(): void
         } catch (Exception $e) {
             $this->fail('Metarefresh does not produce syntactially valid code');
         }
+
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('https://idp.example.com/idp/shibboleth', $metadata);
 
         $this->assertTrue(
+            // @phpstan-ignore variable.undefined
             empty(array_diff_key($this->expected, $metadata['https://idp.example.com/idp/shibboleth'])),
         );
     }
@@ -135,12 +139,12 @@ public function testWriteMetadataFiles(): void
         $this->metaloader->writeMetadataFiles($this->tmpdir);
         $this->assertFileExists($this->tmpdir . '/saml20-idp-remote.php');
 
-        /** @psalm-suppress UnresolvableInclude */
         @include_once($this->tmpdir . '/saml20-idp-remote.php');
-        /** @psalm-suppress UndefinedVariable */
+
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('https://idp.example.com/idp/shibboleth', $metadata);
         $this->assertTrue(
-            /** @psalm-suppress UndefinedVariable */
+            // @phpstan-ignore variable.undefined
             empty(array_diff_key($this->expected, $metadata['https://idp.example.com/idp/shibboleth'])),
         );
     }
@@ -162,8 +166,12 @@ public function testMetaLoaderSetExpiryWhenNotPresent(): void
         } catch (Exception $e) {
             $this->fail('Metarefresh does not produce syntactially valid code');
         }
+
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('https://idp.example.com/idp/shibboleth', $metadata);
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('expire', $metadata['https://idp.example.com/idp/shibboleth']);
+        // @phpstan-ignore variable.undefined
         $this->assertEquals(1000, $metadata['https://idp.example.com/idp/shibboleth']['expire']);
     }
 
@@ -194,9 +202,11 @@ public function testAttributewhitelist1(): void
             $this->fail('Metarefresh does not produce syntactially valid code');
         }
         /* Check we matched the IdP */
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('https://idp.example.com/idp/shibboleth', $metadata);
 
         $this->assertTrue(
+            // @phpstan-ignore variable.undefined
             empty(array_diff_key($this->expected, $metadata['https://idp.example.com/idp/shibboleth'])),
         );
     }
@@ -263,9 +273,11 @@ public function testAttributewhitelist3(): void
         }
 
         /* Check we matched the IdP */
+        // @phpstan-ignore variable.undefined
         $this->assertArrayHasKey('https://idp.example.com/idp/shibboleth', $metadata);
 
         $this->assertTrue(
+            // @phpstan-ignore variable.undefined
             empty(array_diff_key($this->expected, $metadata['https://idp.example.com/idp/shibboleth'])),
         );
     }