refactor: improve testing API consistency

Author: innocenzi

docs/2-features/17-oauth.md

@@ -250,7 +250,7 @@ final class OAuthControllerTest extends IntegrationTestCase
         // that redirects to the provider
         $this->http
             ->get('/oauth/discord')
-            ->assertRedirect();
+            ->assertRedirect($oauth->lastAuthorizationUrl);
 
         // We check that the authorization URL was generated,
         // optionally specifying scopes and options
@@ -260,7 +260,7 @@ final class OAuthControllerTest extends IntegrationTestCase
         // with a fake code and the expected state
         $this->http
             ->get("/oauth/discord/callback?code=some-fake-code&state={$oauth->getState()}")
-            ->assertRedirect();
+            ->assertRedirect('/');
 
         // We assert that an access token was retrieved
         // with the same fake code we provided before

packages/auth/src/OAuth/OAuthClient.php

@@ -14,22 +14,22 @@ interface OAuthClient
     public function getAuthorizationUrl(array $scopes = [], array $options = []): string;
 
     /**
-     * Get the state parameter for CSRF protection.
+     * Gets the state parameter for CSRF protection.
      */
     public function getState(): ?string;
 
     /**
-     * Exchange an authorization code for an access token.
+     * Exchanges an authorization code for an access token.
      */
     public function getAccessToken(string $code): AccessToken;
 
     /**
-     * Get user information from an OAuth provider using an access token.
+     * Gets user information from an OAuth provider using an access token.
      */
     public function getUser(AccessToken $token): OAuthUser;
 
     /**
-     * Complete OAuth flow with code and get user information.
+     * Completes OAuth flow with code and get user information.
      */
     public function fetchUser(string $code): OAuthUser;
 }

packages/auth/src/OAuth/OAuthConfig.php

@@ -27,6 +27,13 @@ interface OAuthConfig extends HasTag
         get;
     }
 
+    /**
+     * The client ID for the OAuth provider.
+     */
+    public string $clientId {
+        get;
+    }
+
     /**
      * The application URI to redirect to after authorization.
      */

packages/auth/src/OAuth/Testing/OAuthTester.php

@@ -5,9 +5,10 @@
 namespace Tempest\Auth\OAuth\Testing;
 
 use Tempest\Auth\OAuth\OAuthClient;
+use Tempest\Auth\OAuth\OAuthConfig;
 use Tempest\Auth\OAuth\OAuthUser;
 use Tempest\Container\Container;
-use Tempest\Support\Str;
+use Tempest\Router\UriGenerator;
 use UnitEnum;
 
 final readonly class OAuthTester
@@ -21,13 +22,12 @@ public function __construct(
      */
     public function fake(OAuthUser $user, null|string|UnitEnum $tag = null): TestingOAuthClient
     {
+        $config = $this->container->get(OAuthConfig::class, $tag);
+        $uri = $this->container->get(UriGenerator::class);
+
         $this->container->singleton(
             className: OAuthClient::class,
-            definition: $client = new TestingOAuthClient($user, match (true) {
-                is_string($tag) => $tag,
-                $tag instanceof UnitEnum => Str\to_kebab_case($tag->name),
-                default => 'default',
-            }),
+            definition: $client = new TestingOAuthClient($user, $config, $uri),
             tag: $tag,
         );
 

packages/auth/src/OAuth/Testing/TestingOAuthClient.php

@@ -7,20 +7,36 @@
 use League\OAuth2\Client\Token\AccessToken;
 use PHPUnit\Framework\Assert;
 use Tempest\Auth\OAuth\OAuthClient;
+use Tempest\Auth\OAuth\OAuthConfig;
 use Tempest\Auth\OAuth\OAuthUser;
+use Tempest\Router\UriGenerator;
+use Tempest\Support\Arr;
 use Tempest\Support\Random;
 use Tempest\Support\Str;
-use UnitEnum;
 
 final class TestingOAuthClient implements OAuthClient
 {
     private ?string $state = null;
 
-    private ?string $baseUrl = null;
+    private(set) ?string $baseUrl = null;
 
-    private ?string $clientId = null;
+    public string $clientId {
+        get => $this->clientId ?? $this->config->clientId;
+    }
 
-    private ?string $redirectUri = null;
+    /**
+     * The application URI to redirect to after authorization.
+     */
+    public string $redirectUri {
+        get => $this->uri->createUri($this->redirectUri ?? $this->config->redirectUri);
+    }
+
+    /**
+     * The last authorization URL that was generated by the client.
+     */
+    public ?string $lastAuthorizationUrl {
+        get => Arr\last($this->authorizationUrls)['url'] ?? null;
+    }
 
     private array $authorizationUrls = [];
 
@@ -29,17 +45,21 @@ final class TestingOAuthClient implements OAuthClient
     private array $callbacks = [];
 
     public function __construct(
-        private OAuthUser $user,
-        private readonly null|UnitEnum|string $tag = null,
+        private(set) OAuthUser $user,
+        private(set) OAuthConfig $config,
+        private UriGenerator $uri,
     ) {}
 
     public function getAuthorizationUrl(array $scopes = [], array $options = []): string
     {
         $this->state = Random\secure_string(16);
 
+        $provider = $this->config->createProvider();
+        $provider->getBaseAuthorizationUrl();
+
         $url = sprintf(
             '%s/oauth/authorize?redirect_uri=%s&client_id=%s&state=%s',
-            $this->baseUrl,
+            $this->baseUrl ?? $provider->getBaseAuthorizationUrl(),
             $this->redirectUri,
             $this->clientId,
             $this->state,
@@ -143,7 +163,7 @@ public function assertAuthorizationUrlGenerated(?array $scopes = null, ?array $o
         Assert::assertNotEmpty($this->authorizationUrls, 'No authorization URL was generated.');
 
         if ($options !== null) {
-            $lastUrl = end($this->authorizationUrls);
+            $lastUrl = Arr\last($this->authorizationUrls);
 
             Assert::assertEquals(
                 expected: $options,
@@ -153,7 +173,7 @@ public function assertAuthorizationUrlGenerated(?array $scopes = null, ?array $o
         }
 
         if ($scopes !== null) {
-            $lastUrl = end($this->authorizationUrls);
+            $lastUrl = Arr\last($this->authorizationUrls);
 
             Assert::assertEquals(
                 expected: $scopes,

packages/auth/tests/OAuth/Testing/OAuthTestingTest.php

@@ -7,6 +7,7 @@
 use PHPUnit\Framework\Attributes\Test;
 use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
+use Tempest\Auth\OAuth\Config\GitHubOAuthConfig;
 use Tempest\Auth\OAuth\OAuthClient;
 use Tempest\Auth\OAuth\OAuthUser;
 use Tempest\Auth\OAuth\Testing\OAuthTester;
@@ -31,65 +32,6 @@ final class OAuthTestingTest extends TestCase
         );
     }
 
-    #[Test]
-    #[TestWith(['github'])]
-    #[TestWith([null])]
-    public function can_fake_oauth_client(?string $tag): void
-    {
-        $client = $this->oauth->fake($this->user, $tag);
-
-        $this->assertInstanceOf(TestingOAuthClient::class, $client);
-        $this->assertSame($client, $this->container->get(OAuthClient::class, $tag));
-    }
-
-    #[Test]
-    public function testing_oauth_client_generates_authorization_url(): void
-    {
-        $client = $this->oauth
-            ->fake($this->user)
-            ->withBaseUrl('https://provider.test')
-            ->withRedirectUri('https://tempest.test/oauth/callback')
-            ->withClientId('test');
-
-        $url = $client->getAuthorizationUrl(['scope' => 'user:email']);
-
-        $this->assertStringContainsString('https://tempest.test/oauth/callback', $url);
-        $this->assertStringContainsString('https://provider.test', $url);
-        $this->assertStringContainsString('client_id=test', $url);
-        $this->assertNotEmpty($client->getState());
-
-        $client->assertAuthorizationUrlGenerated(['scope' => 'user:email']);
-
-        $this->assertEquals(1, $client->getAuthorizationUrlCount());
-    }
-
-    #[Test]
-    public function testing_oauth_client_handles_callback(): void
-    {
-        $client = $this->oauth->fake(new OAuthUser(
-            id: 'jondoe-123',
-            email: '[email protected]',
-            name: 'Jon Doe',
-            nickname: 'jondoe',
-            avatar: 'https://avatars.githubusercontent.com/u/jondoe-123',
-            raw: [],
-        ));
-
-        $user = $client->fetchUser('jondoe-123');
-
-        $this->assertEquals('jondoe-123', $user->id);
-        $this->assertEquals('[email protected]', $user->email);
-        $this->assertEquals('Jon Doe', $user->name);
-        $this->assertEquals('jondoe', $user->nickname);
-        $this->assertEquals('default', $user->provider);
-
-        $client->assertUserFetched('jondoe-123');
-        $client->assertAccessTokenRetrieved('jondoe-123');
-
-        $this->assertEquals(1, $client->getCallbackCount());
-        $this->assertEquals(1, $client->getAccessTokenCount());
-    }
-
     #[Test]
     public function integration(): void
     {

tests/Integration/Auth/OAuth/OAuthClientTest.php

@@ -30,6 +30,8 @@ public function throws_exception_when_oauth_provider_is_missing(): void
 
             public string $redirectUri = '';
 
+            public string $clientId = '';
+
             public null|string|UnitEnum $tag = null;
 
             public function createProvider(): AbstractProvider