appwrite/tests/e2e/Services/Console/ConsoleConsoleClientTest.php

<?php

namespace Tests\E2E\Services\Console;

use Tests\E2E\Client;
use Tests\E2E\Scopes\ProjectConsole;
use Tests\E2E\Scopes\Scope;
use Tests\E2E\Scopes\SideClient;

class ConsoleConsoleClientTest extends Scope
{
    use ConsoleBase;
    use ProjectConsole;
    use SideClient;

    public function testGetVariables(): void
    {
        /**
         * Test for SUCCESS
         */
        $response = $this->client->call(Client::METHOD_GET, '/console/variables', array_merge([
            'content-type' => 'application/json',
            'x-appwrite-project' => $this->getProject()['$id'],
        ], $this->getHeaders()));

        $this->assertEquals(200, $response['headers']['status-code']);
        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET_CNAME']);
        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET_A']);
        $this->assertIsInt($response['body']['_APP_COMPUTE_BUILD_TIMEOUT']);
        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET_AAAA']);
        $this->assertIsString($response['body']['_APP_DOMAIN_TARGET_CAA']);
        $this->assertIsInt($response['body']['_APP_STORAGE_LIMIT']);
        $this->assertIsInt($response['body']['_APP_COMPUTE_SIZE_LIMIT']);
        $this->assertIsBool($response['body']['_APP_DOMAIN_ENABLED']);
        $this->assertIsBool($response['body']['_APP_VCS_ENABLED']);
        $this->assertIsBool($response['body']['_APP_ASSISTANT_ENABLED']);
        $this->assertIsString($response['body']['_APP_DOMAIN_SITES']);
        $this->assertIsString($response['body']['_APP_DOMAIN_FUNCTIONS']);
        $this->assertIsString($response['body']['_APP_OPTIONS_FORCE_HTTPS']);
        $this->assertIsString($response['body']['_APP_DOMAINS_NAMESERVERS']);
        $this->assertIsString($response['body']['_APP_DB_ADAPTER']);
        // When adding new keys, dont forget to update count a few lines above
    }

    public function testListOAuth2Providers(): void
    {
        $response = $this->client->call(Client::METHOD_GET, '/console/oauth2-providers', array_merge([
            'content-type' => 'application/json',
            'x-appwrite-project' => $this->getProject()['$id'],
        ], $this->getHeaders()));

        $this->assertEquals(200, $response['headers']['status-code']);
        $this->assertIsInt($response['body']['total']);
        $this->assertIsArray($response['body']['oAuth2Providers']);
        $this->assertGreaterThan(0, $response['body']['total']);
        $this->assertEquals($response['body']['total'], \count($response['body']['oAuth2Providers']));

        $providerIds = \array_column($response['body']['oAuth2Providers'], '$id');

        // Well-known providers must be present
        $this->assertContains('github', $providerIds);
        $this->assertContains('google', $providerIds);

        // Mock providers must be excluded
        $this->assertNotContains('mock', $providerIds);
        $this->assertNotContains('mock-unverified', $providerIds);

        // Every provider has the expected shape
        foreach ($response['body']['oAuth2Providers'] as $provider) {
            $this->assertArrayHasKey('$id', $provider);
            $this->assertIsString($provider['$id']);
            $this->assertArrayHasKey('parameters', $provider);
            $this->assertIsArray($provider['parameters']);
            $this->assertGreaterThan(0, \count($provider['parameters']));

            foreach ($provider['parameters'] as $parameter) {
                $this->assertArrayHasKey('$id', $parameter);
                $this->assertIsString($parameter['$id']);
                $this->assertNotEmpty($parameter['$id']);
                $this->assertArrayHasKey('name', $parameter);
                $this->assertIsString($parameter['name']);
                $this->assertNotEmpty($parameter['name']);
                $this->assertArrayHasKey('example', $parameter);
                $this->assertIsString($parameter['example']);
                $this->assertArrayHasKey('hint', $parameter);
                $this->assertIsString($parameter['hint']);
            }
        }

        // GitHub provider has the expected metadata for clientId, including the hint
        $github = null;
        foreach ($response['body']['oAuth2Providers'] as $provider) {
            if ($provider['$id'] === 'github') {
                $github = $provider;
                break;
            }
        }
        $this->assertNotNull($github);
        $this->assertCount(2, $github['parameters']);
        $clientId = $github['parameters'][0];
        $this->assertEquals('clientId', $clientId['$id']);
        $this->assertEquals('OAuth 2 app Client ID, or App ID', $clientId['name']);
        $this->assertEquals('e4d87900000000540733', $clientId['example']);
        $this->assertEquals('Example of wrong value: 370006', $clientId['hint']);
        $clientSecret = $github['parameters'][1];
        $this->assertEquals('clientSecret', $clientSecret['$id']);
        $this->assertEquals('Client Secret', $clientSecret['name']);
        $this->assertNotEmpty($clientSecret['example']);
        $this->assertEquals('', $clientSecret['hint']);

        // Multi-parameter provider (Apple) exposes its non-clientSecret fields
        $apple = null;
        foreach ($response['body']['oAuth2Providers'] as $provider) {
            if ($provider['$id'] === 'apple') {
                $apple = $provider;
                break;
            }
        }
        $this->assertNotNull($apple);
        $appleParamIds = \array_column($apple['parameters'], '$id');
        $this->assertContains('serviceId', $appleParamIds);
        $this->assertContains('keyId', $appleParamIds);
        $this->assertContains('teamId', $appleParamIds);
        $this->assertContains('p8File', $appleParamIds);
        // Apple does not expose a single clientSecret param
        $this->assertNotContains('clientSecret', $appleParamIds);

        // Sandbox providers (e.g. paypalSandbox) are included
        $this->assertContains('paypalSandbox', $providerIds);
    }
}