chore: fix tests, upgrade phpunit, raise phpstan level

Author: Ninerian

composer.json

@@ -23,7 +23,7 @@
 		"phpseclib/phpseclib": "^2.0",
 		"phpstan/extension-installer": "^1.4",
 		"phpstan/phpstan-phpunit": "^2.0",
-		"phpunit/phpunit": "^9.0"
+		"phpunit/phpunit": "^10.0"
 	},
 	"autoload": {
 		"psr-4": {

composer.lock

@@ -1,5 +1,5 @@
 parameters:
-    level: 0
+    level: 2
     paths:
         - ./src
         - ./test

phpstan.neon.dist

@@ -1,13 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" bootstrap="vendor/autoload.php" stderr="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage processUncoveredFiles="true">
-    <include>
-      <directory suffix=".php">src</directory>
-    </include>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd" cacheDirectory=".phpunit.cache"
+         bootstrap="vendor/autoload.php"
+>
+  <coverage />
+
   <testsuites>
     <testsuite name="Plugins SDK unit test suite">
       <directory>test</directory>
     </testsuite>
   </testsuites>
+
+  <source>
+    <include>
+      <directory>./src</directory>
+    </include>
+  </source>
+
 </phpunit>

phpunit.xml

@@ -10,7 +10,7 @@
 use Lcobucci\JWT\Signer;
 use Lcobucci\JWT\Signer\Key;
 use Lcobucci\JWT\Signer\Key\InMemory;
-use Lcobucci\JWT\Token;
+use Lcobucci\JWT\Token\Plain;
 use Lcobucci\JWT\Validation\Constraint;
 use Lcobucci\JWT\Validation\Constraint\SignedWith;
 use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
@@ -19,7 +19,7 @@
 
 abstract class AbstractToken
 {
-    private Token $token;
+    private Plain $token;
 
     private Key $signerKey;
 
@@ -31,7 +31,7 @@ abstract class AbstractToken
      * Constructor
      *
      * @param string $appSecret Either a PEM key or a file:// URL.
-     * @param string $tokenData The token text.
+     * @param non-empty-string $tokenData The token text.
      * @param Signer $signer The algorithm which is used to sign the token
      * @param Constraint[] $constrains constrains
      *

src/AbstractToken.php

@@ -14,6 +14,7 @@
 namespace Staffbase\plugins\sdk\Validation;
 
 use Lcobucci\JWT\Token;
+use Lcobucci\JWT\Token\Plain;
 use Lcobucci\JWT\UnencryptedToken;
 use Lcobucci\JWT\Validation\Constraint;
 use Lcobucci\JWT\Validation\ConstraintViolation;
@@ -35,7 +36,7 @@ public function assert(Token $token): void
         }
     }
 
-    private function hasInstanceId(Token $token): bool
+    private function hasInstanceId(Plain $token): bool
     {
         return (bool) $token->claims()->get(SSODataClaimsInterface::CLAIM_INSTANCE_ID);
     }

src/Validation/HasInstanceId.php

@@ -14,6 +14,7 @@
 
 namespace Staffbase\plugins\test;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionClass;
 use phpseclib\Crypt\RSA;
 use PHPUnit\Framework\TestCase;
@@ -248,7 +249,7 @@ public function testConstructorUpdatesInfoOnJwt()
             ->onlyMethods(['openSession', 'closeSession'])
             ->getMock();
 
-        /** @var PluginSession $session */
+        /** @var PluginSession&MockObject $session */
         $session = new $mock($this->pluginId, $this->publicKey);
 
         $this->assertEquals($this->tokenData[SharedClaimsInterface::CLAIM_USER_ROLE], $session->getRole());
@@ -259,7 +260,7 @@ public function testConstructorUpdatesInfoOnJwt()
 
         $this->setupEnvironment(null, $newToken, false);
 
-        /** @var PluginSession $newSession */
+        /** @var PluginSession&MockObject $newSession */
         $newSession = new $mock($this->pluginId, $this->publicKey);
 
         $this->assertEquals($newSession->getRole(), $tokenData[SharedClaimsInterface::CLAIM_USER_ROLE]);
@@ -284,7 +285,7 @@ public function testConstructorSupportMultipleInstances()
             ->onlyMethods(['openSession', 'closeSession'])
             ->getMock();
 
-        /** @var PluginSession $session */
+        /** @var PluginSession&MockObject $session */
         $session = new $mock($this->pluginId, $this->publicKey);
 
 
@@ -295,7 +296,7 @@ public function testConstructorSupportMultipleInstances()
 
         $this->setupEnvironment(null, $newToken, false);
 
-        /** @var PluginSession $newSession */
+        /** @var PluginSession&MockObject $newSession */
         $newSession = new $mock($this->pluginId, $this->publicKey);
 
         $this->assertEquals($tokenData[SharedClaimsInterface::CLAIM_USER_ROLE], $newSession->getRole());
@@ -330,7 +331,7 @@ public function testGetSessionData()
             ->onlyMethods(['openSession', 'closeSession'])
             ->getMock();
 
-        /** @var PluginSession $session */
+        /** @var PluginSession&MockObject $session */
         $session = new $mock($this->pluginId, $this->publicKey);
 
         $sessionData = [

test/PluginSessionTest.php

@@ -14,9 +14,7 @@
 
 namespace Staffbase\plugins\test\SSOData;
 
-use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use Staffbase\plugins\sdk\SSOData\SharedDataTrait;
 use Staffbase\plugins\sdk\SSOData\SSODataTrait;
 use Staffbase\plugins\test\SSOTestData;
 
@@ -33,26 +31,12 @@ public function testAccessorsGiveCorrectValues(): void
         $tokenData = SSOTestData::getTokenData();
         $accessors = SSOTestData::getTokenAccessors();
 
-        $ssoData = $this->getMockForTrait(SSODataTrait::class);
-
-        $ssoData
-            ->expects($this->exactly(count($accessors)))
-            ->method('hasClaim')
-            ->willReturnCallback(function ($key) use ($tokenData) {
-                return isset($tokenData[$key]);
-            });
-
-        $ssoData
-            ->expects($this->exactly(count($accessors)))
-            ->method('getClaim')
-            ->willReturnCallback(function ($key) use ($tokenData) {
-                return $tokenData[$key];
-            });
+        $ssoData = new SSODataMock($tokenData);
 
         foreach ($accessors as $key => $fn) {
             $this->assertEquals(
-                $ssoData->$fn(),
                 $tokenData[$key],
+                $ssoData->$fn(),
                 "called $fn expected " .
                 is_array($tokenData[$key]) ? print_r($tokenData[$key], true) : $tokenData[$key],
             );
@@ -79,20 +63,7 @@ public function testIsEditorReturnsCorrectValues(): void
             $tokenData = SSOTestData::getTokenData();
             $tokenData[SSOTestData::CLAIM_USER_ROLE] = $arg;
 
-            $ssoData = $this->getMockForTrait(SSODataTrait::class);
-
-            $ssoData
-                ->method('hasClaim')
-                ->willReturnCallback(function ($key) use ($tokenData) {
-                    return isset($tokenData[$key]);
-                });
-
-            $ssoData
-                ->method('getClaim')
-                ->willReturnCallback(function ($key) use ($tokenData) {
-                    return $tokenData[$key];
-                });
-
+            $ssoData = new SSODataMock($tokenData);
             $this->assertEquals(
                 $ssoData->isEditor(),
                 $expect,
@@ -110,14 +81,31 @@ public function testGetDataReturnsCorrectValues(): void
 
         $tokenData = SSOTestData::getTokenData();
 
-        $ssoData = $this->getMockForTrait(SharedDataTrait::class);
+        $ssoData = new SSODataMock($tokenData);
 
-        $ssoData
-            ->method('getAllClaims')
-            ->willReturnCallback(function () use ($tokenData) {
-                return $tokenData;
-            });
 
         $this->assertEquals($ssoData->getData(), $tokenData, "comparing data array to token");
     }
 }
+
+class SSODataMock
+{
+    use SSODataTrait;
+    private $claims;
+    public function __construct(array $claims = [])
+    {
+        $this->claims = $claims;
+    }
+    public function hasClaim(string $claim): bool
+    {
+        return isset($this->claims[$claim]);
+    }
+    public function getClaim(string $claim)
+    {
+        return $this->claims[$claim];
+    }
+    public function getAllClaims(): array
+    {
+        return $this->claims;
+    }
+}