Merge pull request #73 from oat-sa/develop

Develop

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+3.3.0
+-----
+
+* Added OidcTestingTrait to ease OIDC based testing flows 
+
 3.2.2
 -----
 

tests/Integration/Message/Launch/Validator/ToolLaunchValidatorTest.php

@@ -38,15 +38,13 @@
 use OAT\Library\Lti1p3Core\Security\Nonce\NonceRepositoryInterface;
 use OAT\Library\Lti1p3Core\Security\Oidc\OidcAuthenticator;
 use OAT\Library\Lti1p3Core\Security\Oidc\OidcInitiator;
-use OAT\Library\Lti1p3Core\Tests\Traits\DomainTestingTrait;
-use OAT\Library\Lti1p3Core\Tests\Traits\NetworkTestingTrait;
+use OAT\Library\Lti1p3Core\Tests\Traits\OidcTestingTrait;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
 class ToolLaunchValidatorTest extends TestCase
 {
-    use DomainTestingTrait;
-    use NetworkTestingTrait;
+    use OidcTestingTrait;
 
     /** @var RegistrationRepositoryInterface */
     private $registrationRepository;
@@ -109,7 +107,7 @@ public function testValidatePlatformOriginatingLaunchForLtiResourceLinkSuccess()
             ]
         );
 
-        $result = $this->subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result = $this->subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
         $this->assertFalse($result->hasError());
@@ -152,7 +150,7 @@ public function testValidatePlatformOriginatingLaunchForDeepLinkingSuccess(): vo
             ]
         );
 
-        $result = $this->subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result = $this->subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
         $this->assertFalse($result->hasError());
@@ -201,7 +199,7 @@ public function testValidatePlatformOriginatingLaunchForStartProctoringSuccess()
             ]
         );
 
-        $result = $this->subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result = $this->subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
         $this->assertFalse($result->hasError());
@@ -261,7 +259,7 @@ public function testValidatePlatformOriginatingLaunchFallbackOnJwks(): void
             ]
         );
 
-        $result =$subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result =$subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
         $this->assertFalse($result->hasError());
@@ -288,7 +286,7 @@ public function testValidatePlatformOriginatingLaunchFailureOnMissingToolKey():
             ]
         );
 
-        $result =$subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result =$subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
         $this->assertTrue($result->hasError());
@@ -305,7 +303,7 @@ public function testValidatePlatformOriginatingLaunchFailureWithExpiredPayload()
         );
 
         Carbon::setTestNow(Carbon::now()->subSeconds(MessagePayloadInterface::TTL + 1));
-        $result = $this->subject->validatePlatformOriginatingLaunch($this->performOidcFlow($message));
+        $result = $this->subject->validatePlatformOriginatingLaunch($this->buildOidcFlowRequest($message));
         Carbon::setTestNow();
 
         $this->assertInstanceOf(LaunchValidationResult::class, $result);
@@ -698,12 +696,8 @@ public function provideValidationFailureContexts(): array
         ];
     }
 
-    private function performOidcFlow(LtiMessageInterface $message): ServerRequestInterface
+    private function buildOidcFlowRequest(LtiMessageInterface $message): ServerRequestInterface
     {
-        $initMessage = $this->oidcInitiator->initiate($this->createServerRequest('GET', $message->toUrl()));
-
-        $authMessage = $this->oidcAuthenticator->authenticate($this->createServerRequest('GET', $initMessage->toUrl()));
-
-        return $this->createServerRequest('GET', $authMessage->toUrl());
+        return $this->createServerRequest('GET', $this->performOidcFlow($message)->toUrl());
     }
 }

tests/Traits/OidcTestingTrait.php

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2020 (original work) Open Assessment Technologies SA;
+ */
+
+declare(strict_types=1);
+
+namespace OAT\Library\Lti1p3Core\Tests\Traits;
+
+use OAT\Library\Lti1p3Core\Message\LtiMessageInterface;
+use OAT\Library\Lti1p3Core\Registration\RegistrationRepositoryInterface;
+use OAT\Library\Lti1p3Core\Security\Oidc\OidcAuthenticator;
+use OAT\Library\Lti1p3Core\Security\Oidc\OidcInitiator;
+use OAT\Library\Lti1p3Core\Security\User\UserAuthenticatorInterface;
+
+trait OidcTestingTrait
+{
+    use DomainTestingTrait;
+    use NetworkTestingTrait;
+
+    private function performOidcFlow(
+        LtiMessageInterface $message,
+        RegistrationRepositoryInterface $repository = null,
+        UserAuthenticatorInterface $authenticator = null
+    ): LtiMessageInterface {
+        $repository = $repository ?? $this->createTestRegistrationRepository();
+        $authenticator = $authenticator ?? $this->createTestUserAuthenticator();
+
+        $oidcInitiator = new OidcInitiator($repository);
+        $oidcAuthenticator = new OidcAuthenticator($repository, $authenticator);
+
+        $oidcInitMessage = $oidcInitiator->initiate($this->createServerRequest('GET', $message->toUrl()));
+
+        return $oidcAuthenticator->authenticate($this->createServerRequest('GET', $oidcInitMessage->toUrl()));
+    }
+}