Merge branch 'phpstan' into lti-lib-v6

packbackbooks · Dec 15, 2023 · d344c34 · d344c34
2 parents 6bfa83a + 901bd91
commit d344c34
Show file tree

Hide file tree

Showing 13 changed files with 83 additions and 58 deletions.
diff --git a/composer.json b/composer.json
@@ -30,7 +30,8 @@
         "jubeki/laravel-code-style": "^2.0",
         "mockery/mockery": "^1.4",
         "nesbot/carbon": "^2.43",
-        "phpunit/phpunit": "^9.5"
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^1.10"
     },
     "autoload": {
         "psr-4": {
@@ -44,7 +45,10 @@
     },
     "scripts": {
         "test": "phpunit",
-        "lint": "php-cs-fixer fix -v --dry-run",
+        "lint": [
+            "php-cs-fixer fix -v --dry-run",
+            "phpstan analyse src --level 5"
+        ],
         "lint-fix": "php-cs-fixer fix -v"
     }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,16 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Call to an undefined method Packback\\\\Lti1p3\\\\Interfaces\\\\IDatabase\\:\\:findLti1p1Keys\\(\\)\\.$#"
+			count: 1
+			path: src/LtiMessageLaunch.php
+
+		-
+			message: "#^Call to an undefined method Packback\\\\Lti1p3\\\\Interfaces\\\\IDatabase\\:\\:migrateFromLti1p1\\(\\)\\.$#"
+			count: 1
+			path: src/LtiMessageLaunch.php
+
+		-
+			message: "#^Call to an undefined method Packback\\\\Lti1p3\\\\Interfaces\\\\IDatabase\\:\\:shouldMigrate\\(\\)\\.$#"
+			count: 1
+			path: src/LtiMessageLaunch.php
diff --git a/src/Interfaces/IServiceRequest.php b/src/Interfaces/IServiceRequest.php
@@ -22,4 +22,8 @@ public function setAccept(string $accept): self;
     public function setContentType(string $contentType): self;
 
     public function getErrorPrefix(): string;
+
+    public function getMaskResponseLogs(): bool;
+
+    public function setMaskResponseLogs(bool $shouldMask): self;
 }
diff --git a/src/LtiAssignmentsGradesService.php b/src/LtiAssignmentsGradesService.php
@@ -59,7 +59,7 @@ public function findLineItem(LtiLineitem $newLineItem): ?LtiLineitem
         return null;
     }
 
-    public function updateLineitem(LtiLineItem $lineitemToUpdate): LtiLineitem
+    public function updateLineitem(LtiLineitem $lineitemToUpdate): LtiLineitem
     {
         $request = new ServiceRequest(
             ServiceRequest::METHOD_PUT,

diff --git a/src/LtiLineitem.php b/src/LtiLineitem.php
@@ -46,7 +46,7 @@ public function __toString(): string
     /**
      * Static function to allow for method chaining without having to assign to a variable first.
      */
-    public static function new(?array $lineItem = null): LtiLineItem
+    public static function new(?array $lineItem = null): LtiLineitem
     {
         return new LtiLineitem($lineItem);
     }
@@ -56,7 +56,7 @@ public function getId()
         return $this->id;
     }
 
-    public function setId($value): LtiLineItem
+    public function setId($value): LtiLineitem
     {
         $this->id = $value;
 
@@ -68,7 +68,7 @@ public function getLabel()
         return $this->label;
     }
 
-    public function setLabel($value): LtiLineItem
+    public function setLabel($value): LtiLineitem
     {
         $this->label = $value;
 
@@ -80,7 +80,7 @@ public function getScoreMaximum()
         return $this->score_maximum;
     }
 
-    public function setScoreMaximum($value): LtiLineItem
+    public function setScoreMaximum($value): LtiLineitem
     {
         $this->score_maximum = $value;
 
@@ -92,7 +92,7 @@ public function getResourceId()
         return $this->resource_id;
     }
 
-    public function setResourceId($value): LtiLineItem
+    public function setResourceId($value): LtiLineitem
     {
         $this->resource_id = $value;
 
@@ -104,7 +104,7 @@ public function getResourceLinkId()
         return $this->resource_link_id;
     }
 
-    public function setResourceLinkId($value): LtiLineItem
+    public function setResourceLinkId($value): LtiLineitem
     {
         $this->resource_link_id = $value;
 
@@ -116,7 +116,7 @@ public function getTag()
         return $this->tag;
     }
 
-    public function setTag($value): LtiLineItem
+    public function setTag($value): LtiLineitem
     {
         $this->tag = $value;
 
@@ -128,7 +128,7 @@ public function getStartDateTime()
         return $this->start_date_time;
     }
 
-    public function setStartDateTime($value): LtiLineItem
+    public function setStartDateTime($value): LtiLineitem
     {
         $this->start_date_time = $value;
 
@@ -140,7 +140,7 @@ public function getEndDateTime()
         return $this->end_date_time;
     }
 
-    public function setEndDateTime($value): LtiLineItem
+    public function setEndDateTime($value): LtiLineitem
     {
         $this->end_date_time = $value;
 
@@ -152,7 +152,7 @@ public function getGradesReleased(): ?bool
         return $this->grades_released;
     }
 
-    public function setGradesReleased(?bool $value): LtiLineItem
+    public function setGradesReleased(?bool $value): LtiLineitem
     {
         $this->grades_released = $value;
 

diff --git a/src/LtiMessageLaunch.php b/src/LtiMessageLaunch.php
@@ -11,6 +11,7 @@
 use Packback\Lti1p3\Interfaces\ICache;
 use Packback\Lti1p3\Interfaces\ICookie;
 use Packback\Lti1p3\Interfaces\IDatabase;
+use Packback\Lti1p3\Interfaces\ILtiDeployment;
 use Packback\Lti1p3\Interfaces\ILtiRegistration;
 use Packback\Lti1p3\Interfaces\ILtiServiceConnector;
 use Packback\Lti1p3\Interfaces\IMigrationDatabase;
@@ -53,7 +54,7 @@ class LtiMessageLaunch
     private array $request;
     private array $jwt;
     private ?ILtiRegistration $registration;
-    private ?LtiDeployment $deployment;
+    private ?ILtiDeployment $deployment;
     private string $launch_id;
 
     // See https://www.imsglobal.org/spec/security/v1p1#approved-jwt-signing-algorithms.
@@ -362,8 +363,8 @@ private function jwtAlgMatchesJwkKty(array $key): bool
     {
         $jwtAlg = $this->jwt['header']['alg'];
 
-        return isset(static::$ltiSupportedAlgs[$jwtAlg]) &&
-            static::$ltiSupportedAlgs[$jwtAlg] === $key['kty'];
+        return isset(self::$ltiSupportedAlgs[$jwtAlg]) &&
+            self::$ltiSupportedAlgs[$jwtAlg] === $key['kty'];
     }
 
     protected function validateState(): self
@@ -549,7 +550,7 @@ private function matchingLti1p1KeyExists(): bool
         return false;
     }
 
-    private function oauthConsumerKeySignMatches(Lti1p1Key $key): string
+    private function oauthConsumerKeySignMatches(Lti1p1Key $key): bool
     {
         return $this->jwt['body'][LtiConstants::LTI1P1]['oauth_consumer_key_sign'] === $this->getOauthSignature($key);
     }

diff --git a/src/LtiServiceConnector.php b/src/LtiServiceConnector.php
@@ -6,11 +6,11 @@
 use Firebase\JWT\JWT;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
-use GuzzleHttp\Psr7\Response;
 use Packback\Lti1p3\Interfaces\ICache;
 use Packback\Lti1p3\Interfaces\ILtiRegistration;
 use Packback\Lti1p3\Interfaces\ILtiServiceConnector;
 use Packback\Lti1p3\Interfaces\IServiceRequest;
+use Psr\Http\Message\ResponseInterface;
 
 class LtiServiceConnector implements ILtiServiceConnector
 {
@@ -80,7 +80,7 @@ public function getAccessToken(ILtiRegistration $registration, array $scopes): s
         return $tokenData['access_token'];
     }
 
-    public function makeRequest(IServiceRequest $request): Response
+    public function makeRequest(IServiceRequest $request): ResponseInterface
     {
         $response = $this->client->request(
             $request->getMethod(),
@@ -99,7 +99,7 @@ public function makeRequest(IServiceRequest $request): Response
         return $response;
     }
 
-    public function getResponseHeaders(Response $response): ?array
+    public function getResponseHeaders(ResponseInterface $response): ?array
     {
         $responseHeaders = $response->getHeaders();
         array_walk($responseHeaders, function (&$value) {
@@ -109,7 +109,7 @@ public function getResponseHeaders(Response $response): ?array
         return $responseHeaders;
     }
 
-    public function getResponseBody(Response $response): ?array
+    public function getResponseBody(ResponseInterface $response): ?array
     {
         $responseBody = (string) $response->getBody();
 
@@ -182,8 +182,8 @@ public static function getLogMessage(
         ?array $responseBody
     ): string {
         if ($request->getMaskResponseLogs()) {
-            $responseHeaders = static::maskValues($responseHeaders);
-            $responseBody = static::maskValues($responseBody);
+            $responseHeaders = self::maskValues($responseHeaders);
+            $responseBody = self::maskValues($responseBody);
         }
 
         $contextArray = [

diff --git a/src/ServiceRequest.php b/src/ServiceRequest.php
@@ -46,7 +46,7 @@ class ServiceRequest implements IServiceRequest
     public function __construct(
         private string $method,
         private string $url,
-        private string $type = self::UNSUPPORTED)
+        private string $type = self::TYPE_UNSUPPORTED)
     {
     }
 

diff --git a/tests/Certification/Lti13CertificationTest.php b/tests/Certification/Lti13CertificationTest.php
@@ -276,7 +276,7 @@ public function buildJWT($data, $header)
             return \implode('.', $segments);
         }
 
-        return JWT::encode($data, $this->issuer['tool_private_key'], $alg, $this->issuer['kid']);
+        return JWT::encode($data, $this->issuer['tool_private_key'], $this->issuer['alg'], $this->issuer['kid']);
     }
 
     // tests
@@ -376,7 +376,7 @@ public function testLti1p1MigrationSuccessfullyMakesDeployment()
         $db->shouldMigrate = true;
         $db->createdDeployment = LtiDeployment::new($payload[LtiConstants::DEPLOYMENT_ID]);
 
-        $payload['exp'] = 3272987750; // To ensure signature matches
+        $payload['exp'] = '3272987750'; // To ensure signature matches
         $payload[LtiConstants::LTI1P1] = [
             'oauth_consumer_key' => $key->getKey(),
             'oauth_consumer_key_sign' => $key->sign(
@@ -504,7 +504,7 @@ public function testInvalidCertificationCases()
             // I couldn't find a better output function
             echo PHP_EOL."--> TESTING INVALID TEST CASE: {$testCase}";
 
-            $jwt = $this->buildJWT($payload, $this->issuer, $jwtHeader);
+            $jwt = $this->buildJWT($payload, $this->issuer);
             if (isset($payload['nonce'])) {
                 $this->cache->cacheNonce($payload['nonce'], static::STATE);
             }

diff --git a/tests/LtiMessageLaunchTest.php b/tests/LtiMessageLaunchTest.php
@@ -852,7 +852,7 @@ public function testALaunchIsNotAResource()
 
     public function tesGetLaunchDataForALaunch()
     {
-        $launch = $this->getLaunchData($this->payload);
+        $launch = $this->fakeLaunch($this->payload);
 
         $actual = $launch->getLaunchData();
 
@@ -891,6 +891,6 @@ private function buildJWT($data, $header)
             return \implode('.', $segments);
         }
 
-        return JWT::encode($data, $this->issuer['tool_private_key'], $alg, $this->issuer['kid']);
+        return JWT::encode($data, $this->issuer['tool_private_key'], $this->issuer['alg'], $this->issuer['kid']);
     }
 }
diff --git a/tests/MessageValidators/DeepLinkMessageValidatorTest.php b/tests/MessageValidators/DeepLinkMessageValidatorTest.php
@@ -11,25 +11,25 @@ class DeepLinkMessageValidatorTest extends TestCase
 {
     public function testItCanValidate()
     {
-        $this->assertTrue(DeepLinkMessageValidator::canValidate(static::validJwtBody()));
+        $this->assertTrue(DeepLinkMessageValidator::canValidate(self::validJwtBody()));
     }
 
     public function testItCannotValidate()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         $jwtBody[LtiConstants::MESSAGE_TYPE] = 'some other type';
 
         $this->assertFalse(DeepLinkMessageValidator::canValidate($jwtBody));
     }
 
     public function testJwtBodyIsValid()
     {
-        $this->assertNull(DeepLinkMessageValidator::validate(static::validJwtBody()));
+        $this->assertNull(DeepLinkMessageValidator::validate(self::validJwtBody()));
     }
 
     public function testJwtBodyIsInvalidMissingSub()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         $jwtBody['sub'] = '';
 
         $this->expectException(LtiException::class);
@@ -39,7 +39,7 @@ public function testJwtBodyIsInvalidMissingSub()
 
     public function testJwtBodyIsInvalidMissingLtiVersion()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::VERSION]);
 
         $this->expectException(LtiException::class);
@@ -49,7 +49,7 @@ public function testJwtBodyIsInvalidMissingLtiVersion()
 
     public function testJwtBodyIsInvalidWrongLtiVersion()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         $jwtBody[LtiConstants::VERSION] = '1.2.0';
 
         $this->expectException(LtiException::class);
@@ -59,7 +59,7 @@ public function testJwtBodyIsInvalidWrongLtiVersion()
 
     public function testJwtBodyIsInvalidMissingRoles()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::ROLES]);
 
         $this->expectException(LtiException::class);
@@ -69,7 +69,7 @@ public function testJwtBodyIsInvalidMissingRoles()
 
     public function testJwtBodyIsInvalidMissingDeepLinkSetting()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::DL_DEEP_LINK_SETTINGS]);
 
         $this->expectException(LtiException::class);
@@ -79,7 +79,7 @@ public function testJwtBodyIsInvalidMissingDeepLinkSetting()
 
     public function testJwtBodyIsInvalidMissingDeepLinkReturnUrl()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::DL_DEEP_LINK_SETTINGS]['deep_link_return_url']);
 
         $this->expectException(LtiException::class);
@@ -89,7 +89,7 @@ public function testJwtBodyIsInvalidMissingDeepLinkReturnUrl()
 
     public function testJwtBodyIsInvalidMissingAcceptType()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::DL_DEEP_LINK_SETTINGS]['accept_types']);
 
         $this->expectException(LtiException::class);
@@ -99,7 +99,7 @@ public function testJwtBodyIsInvalidMissingAcceptType()
 
     public function testJwtBodyIsInvalidAcceptTypeIsInvalid()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         $jwtBody[LtiConstants::DL_DEEP_LINK_SETTINGS]['accept_types'] = [];
 
         $this->expectException(LtiException::class);
@@ -109,7 +109,7 @@ public function testJwtBodyIsInvalidAcceptTypeIsInvalid()
 
     public function testJwtBodyIsInvalidMissingPresentation()
     {
-        $jwtBody = static::validJwtBody();
+        $jwtBody = self::validJwtBody();
         unset($jwtBody[LtiConstants::DL_DEEP_LINK_SETTINGS]['accept_presentation_document_targets']);
 
         $this->expectException(LtiException::class);