Base.php

<?php

declare(strict_types=1);

namespace Tests\E2E;

use Exception;
use RecursiveIteratorIterator;
use RecursiveDirectoryIterator;
use FilesystemIterator;
use Throwable;
use Appwrite\SDK\Language;
use Appwrite\SDK\SDK;
use Appwrite\Spec\OpenAPI3;
use PHPUnit\Framework\TestCase;
use Twig\Error\LoaderError;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;

ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);

abstract class Base extends TestCase
{
    protected const PING_RESPONSE = [
        'GET:/v1/ping:passed',
    ];

    protected const FOO_RESPONSES = [
        'GET:/v1/mock/tests/foo:passed',
        'POST:/v1/mock/tests/foo:passed',
        'PUT:/v1/mock/tests/foo:passed',
        'PATCH:/v1/mock/tests/foo:passed',
        'DELETE:/v1/mock/tests/foo:passed',
    ];

    protected const BAR_RESPONSES = [
        'GET:/v1/mock/tests/bar:passed',
        'POST:/v1/mock/tests/bar:passed',
        'PUT:/v1/mock/tests/bar:passed',
        'PATCH:/v1/mock/tests/bar:passed',
        'DELETE:/v1/mock/tests/bar:passed',
    ];

    protected const GENERAL_RESPONSES = [
        'GET:/v1/mock/tests/general/redirect/done:passed',
    ];

    protected const PATH_PARAM_RESPONSES = [
        'GET:/v1/mock/tests/general/path/grant%2Fspecial%26id:passed',
    ];

    protected const OAUTH_RESPONSES = [
        'https://localhost?code=abcdef&state=123456',
    ];

    protected const DOWNLOAD_RESPONSES = [
        'GET:/v1/mock/tests/general/download:passed',
    ];

    protected const COOKIE_RESPONSES = [
        'GET:/v1/mock/tests/general/set-cookie:passed',
        'GET:/v1/mock/tests/general/get-cookie:passed',
    ];

    protected const ENUM_RESPONSES = [
        'POST:/v1/mock/tests/general/enum:passed',
    ];

    protected const MODEL_RESPONSES = [
        'POST:/v1/mock/tests/general/models:passed',
        'POST:/v1/mock/tests/general/models/array:passed',
    ];

    protected const UNION_RESPONSES = [
        'GET:/v1/mock/tests/union:passed',
        'test-data',
        'stub',
    ];

    protected const UPLOAD_RESPONSE = [
        'POST:/v1/mock/tests/general/upload:passed',
    ];

    protected const UPLOAD_RESPONSES = [
        'POST:/v1/mock/tests/general/upload:passed',
        'POST:/v1/mock/tests/general/upload:passed',
        'POST:/v1/mock/tests/general/upload:passed',
        'POST:/v1/mock/tests/general/upload:passed',
    ];

    protected const LARGE_FILE_RESPONSES = [
        'POST:/v1/mock/tests/general/upload:passed',
    ];

    protected const EXCLUDED_FIXTURE_TOKENS = [
        'zzexcludedservice',
        'zzexcludedpayload',
        'zzexcludedresult',
        'zzexcludedstatus',
        'zzexcludedchild',
        'zzexcludedchildstatus',
        'zzexcludedmethodpayload',
        'zzexcludedmethodresult',
        'zzexcludedmethodstatus',
    ];

    /**
     * 'Mock 400 error'                              -> message
     * '{"message":"Mock 400 error","code":400}'     -> response
     */
    protected const EXCEPTION_RESPONSES = [
        'Mock 400 error',
        '{"message":"Mock 400 error","code":400}',
        'Mock 500 error',
        '{"message":"Mock 500 error","code":500}',
        'This is a text error',
        'This is a text error',
        'Invalid endpoint URL: htp://cloud.appwrite.io/v1',
    ];

    protected const REALTIME_RESPONSES = [
        'WS:/v1/realtime:passed',
        'WS:/v1/realtime:passed',
        'Realtime failed!',
        'Realtime unsubscribe:passed',
        'Realtime update:passed',
        'Realtime presence:passed',
        'Realtime disconnect:passed',
    ];

    protected const QUERY_HELPER_RESPONSES = [
        '{"method":"equal","attribute":"released","values":[true]}',
        '{"method":"equal","attribute":"title","values":["Spiderman","Dr. Strange"]}',
        '{"method":"notEqual","attribute":"title","values":["Spiderman"]}',
        '{"method":"lessThan","attribute":"releasedYear","values":[1990]}',
        '{"method":"greaterThan","attribute":"releasedYear","values":[1990]}',
        '{"method":"search","attribute":"name","values":["john"]}',
        '{"method":"isNull","attribute":"name"}',
        '{"method":"isNotNull","attribute":"name"}',
        '{"method":"between","attribute":"age","values":[50,100]}',
        '{"method":"between","attribute":"age","values":[50.5,100.5]}',
        '{"method":"between","attribute":"name","values":["Anna","Brad"]}',
        '{"method":"startsWith","attribute":"name","values":["Ann"]}',
        '{"method":"endsWith","attribute":"name","values":["nne"]}',
        '{"method":"select","values":["name","age"]}',
        '{"method":"orderAsc","attribute":"title"}',
        '{"method":"orderDesc","attribute":"title"}',
        '{"method":"orderRandom"}',
        '{"method":"cursorAfter","values":["my_movie_id"]}',
        '{"method":"cursorBefore","values":["my_movie_id"]}',
        '{"method":"limit","values":[50]}',
        '{"method":"offset","values":[20]}',
        '{"method":"contains","attribute":"title","values":["Spider"]}',
        '{"method":"contains","attribute":"labels","values":["first"]}',
        '{"method":"containsAny","attribute":"labels","values":["first","second"]}',
        '{"method":"containsAll","attribute":"labels","values":["first","second"]}',
        '{"method":"notContains","attribute":"title","values":["Spider"]}',
        '{"method":"notSearch","attribute":"name","values":["john"]}',
        '{"method":"notBetween","attribute":"age","values":[50,100]}',
        '{"method":"notStartsWith","attribute":"name","values":["Ann"]}',
        '{"method":"notEndsWith","attribute":"name","values":["nne"]}',
        '{"method":"lessThan","attribute":"$createdAt","values":["2023-01-01"]}',
        '{"method":"greaterThan","attribute":"$createdAt","values":["2023-01-01"]}',
        '{"method":"between","attribute":"$createdAt","values":["2023-01-01","2023-12-31"]}',
        '{"method":"lessThan","attribute":"$updatedAt","values":["2023-01-01"]}',
        '{"method":"greaterThan","attribute":"$updatedAt","values":["2023-01-01"]}',
        '{"method":"between","attribute":"$updatedAt","values":["2023-01-01","2023-12-31"]}',
        '{"method":"distanceEqual","attribute":"location","values":[[[[40.7128,-74],[40.7128,-74]],1000,true]]}',
        '{"method":"distanceEqual","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceNotEqual","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceNotEqual","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceGreaterThan","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceGreaterThan","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceLessThan","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"distanceLessThan","attribute":"location","values":[[[40.7128,-74],1000,true]]}',
        '{"method":"intersects","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"notIntersects","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"crosses","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"notCrosses","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"overlaps","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"notOverlaps","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"touches","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"notTouches","attribute":"location","values":[[40.7128,-74]]}',
        '{"method":"contains","attribute":"location","values":[[40.7128,-74],[40.7128,-74]]}',
        '{"method":"notContains","attribute":"location","values":[[40.7128,-74],[40.7128,-74]]}',
        '{"method":"equal","attribute":"location","values":[[40.7128,-74],[40.7128,-74]]}',
        '{"method":"notEqual","attribute":"location","values":[[40.7128,-74],[40.7128,-74]]}',
        '{"method":"or","values":[{"method":"equal","attribute":"released","values":[true]},{"method":"lessThan","attribute":"releasedYear","values":[1990]}]}',
        '{"method":"and","values":[{"method":"equal","attribute":"released","values":[false]},{"method":"greaterThan","attribute":"releasedYear","values":[2015]}]}',
        '{"method":"regex","attribute":"name","values":["pattern.*"]}',
        '{"method":"exists","values":["attr1","attr2"]}',
        '{"method":"notExists","values":["attr1","attr2"]}',
        '{"method":"elemMatch","attribute":"friends","values":[{"method":"equal","attribute":"name","values":["Alice"]},{"method":"greaterThan","attribute":"age","values":[18]}]}',
    ];

    protected const PERMISSION_HELPER_RESPONSES = [
        'read("any")',
        'write("user:userid")',
        'create("users")',
        'update("guests")',
        'delete("team:teamId/owner")',
        'delete("team:teamId")',
        'create("member:memberId")',
        'update("users/verified")',
        'update("user:userid/unverified")',
        'create("label:admin")',
    ];

    protected const ID_HELPER_RESPONSES = [
        'unique()',
        'custom_id'
    ];

    protected const ADDITIONAL_PROPERTIES_RESPONSES = [
        '{"theme":"dark","timezone":"UTC"}',
        '{"$id":"row1","custom":"value","nested":{"enabled":true}}',
        '{"data":{"enabled":true},"status":"ok","extra":"kept"}',
    ];

    protected const CLI_CONSOLE_URL_RESPONSES = [
        'https://cloud.appwrite.io/console/project-sgp-chirag-project-prod/sites/site-chirag-profile-website/deployments/deployment-123',
        'https://cloud.appwrite.io/console/project-sgp-chirag-project-prod/functions/function-sample-function/deployment-123',
        'https://abc.example.com/console/project-self-hosted-project/sites/site-docs/deployments/deployment-456',
    ];

    protected const CLI_HEADERS_RESPONSES = [
        'x-sdk-name: cli; x-sdk-platform: server; x-sdk-language: cli; '
            . 'x-sdk-version: 0.0.1; accept: application/json, text/plain',
    ];

    protected const CLI_FUNCTION_RESPONSES = [
        'POST:/v1/functions/{functionId}/executions:passed',
    ];

    protected const CLI_COMPLETION_RESPONSES = [
        'compdef _appwrite appwrite',
        'complete -F _appwrite_completion appwrite',
        'complete -c \'appwrite\' -f -n \'__appwrite_using_command\' -a \'bar client completion foo functions general\'',
        '\'foo:get\') context=\'foo get\' ;;',
    ];

    protected const CLI_TYPEGEN_RESPONSES = [
        'CLI_TYPEGEN:passed',
    ];

    protected const AUTH_LOGIC_RESPONSES = [
        'auth:endpoint-cloud-hostname:passed',
        'auth:endpoint-regional:passed',
        'auth:endpoint-localhost:passed',
        'auth:endpoint-cloud-login:passed',
        'auth:endpoint-dev-override:passed',
        'auth:endpoint-normalize:passed',
        'auth:console-slug-region:passed',
        'auth:decode-id-token:passed',
        'auth:authorization-pending-error:passed',
        'auth:session-account-key:passed',
        'auth:session-local-only:passed',
        'auth:session-legacy:passed',
        'auth:session-has-auth:passed',
        'auth:plan-session-logout:passed',
        'auth:logout-question-choices:passed',
        'auth:restore-current-session-fallback:passed',
        'auth:poll-device-token-success:passed',
        'auth:poll-device-token-retry:passed',
        'auth:poll-device-token-error:passed',
        'auth:poll-device-token-timeout:passed',
        'auth:poll-device-token-slow-down:passed',
        'auth:poll-device-token-empty-error:passed',
        'auth:poll-device-token-default-interval:passed',
        'auth:valid-access-token-cached:passed',
        'auth:valid-access-token-missing-expiry:passed',
        'auth:oauth-login-flag:passed',
        'auth:open-browser:passed',
    ];

    protected const CLI_LOCAL_FUNCTION_EMULATION_RESPONSES = [
        'CLI_LOCAL_FUNCTION_RUNNER_CONFIG:passed',
        'CLI_LOCAL_SOURCE_PREFLIGHT:passed',
    ];

    protected const HEADERS_RESPONSE = '__HEADERS_RESPONSE__';

    protected const CLI_RUNTIME_RENDERING_RESPONSES = [
        'CLI_RUNTIME_RENDERING:passed',
    ];

    protected const CLI_QUERY_HELPER_RESPONSES = [
        '[' .
        '"{\"method\":\"orderDesc\",\"attribute\":\"rawName\"}",' .
        '"{\"method\":\"equal\",\"attribute\":\"published\",\"values\":[true]}",' .
        '"{\"method\":\"greaterThanEqual\",\"attribute\":\"score\",\"values\":[10]}",' .
        '"{\"method\":\"equal\",\"attribute\":\"legacy\",\"values\":[true]}",' .
        '"{\"method\":\"equal\",\"attribute\":\"status\",\"values\":[\"draft\",\"published\"]}",' .
        '"{\"method\":\"orderAsc\",\"attribute\":\"title\"}",' .
        '"{\"method\":\"orderDesc\",\"attribute\":\"$createdAt\"}",' .
        '"{\"method\":\"limit\",\"values\":[25]}",' .
        '"{\"method\":\"offset\",\"values\":[50]}",' .
        '"{\"method\":\"cursorAfter\",\"values\":[\"row-before\"]}",' .
        '"{\"method\":\"cursorBefore\",\"values\":[\"row-after\"]}",' .
        '"{\"method\":\"select\",\"values\":[\"$id\",\"title\"]}"' .
        ']',
        'CLI_QUERY_HELPERS:passed',
    ];

    protected const CHANNEL_HELPER_RESPONSES = [
        'databases.db1.collections.col1.documents',
        'databases.db1.collections.col1.documents.doc1',
        'databases.db1.collections.col1.documents.doc1.create',
        'databases.db1.collections.col1.documents.doc1.upsert',
        'tablesdb.db1.tables.table1.rows',
        'tablesdb.db1.tables.table1.rows.row1',
        'tablesdb.db1.tables.table1.rows.row1.update',
        'account',
        'buckets.bucket1.files',
        'buckets.bucket1.files.file1',
        'buckets.bucket1.files.file1.delete',
        'functions.func2',
        'functions.func1',
        'executions.exec2',
        'executions.exec1',
        'documents',
        'rows',
        'files',
        'executions',
        'teams',
        'teams.team2',
        'teams.team1',
        'teams.team1.create',
        'memberships',
        'memberships.membership2',
        'memberships.membership1',
        'memberships.membership1.update',
        'presences',
        'presences.presence2',
        'presences.presence1',
        'presences.presence1.upsert',
        'presences.presence1.update',
        'presences.presence1.delete',
    ];

    protected const OPERATOR_HELPER_RESPONSES = [
        '{"method":"increment","values":[1]}',
        '{"method":"increment","values":[5,100]}',
        '{"method":"decrement","values":[1]}',
        '{"method":"decrement","values":[3,0]}',
        '{"method":"multiply","values":[2]}',
        '{"method":"multiply","values":[3,1000]}',
        '{"method":"divide","values":[2]}',
        '{"method":"divide","values":[4,1]}',
        '{"method":"modulo","values":[5]}',
        '{"method":"power","values":[2]}',
        '{"method":"power","values":[3,100]}',
        '{"method":"arrayAppend","values":["item1","item2"]}',
        '{"method":"arrayPrepend","values":["first","second"]}',
        '{"method":"arrayInsert","values":[0,"newItem"]}',
        '{"method":"arrayRemove","values":["oldItem"]}',
        '{"method":"arrayUnique","values":[]}',
        '{"method":"arrayIntersect","values":["a","b","c"]}',
        '{"method":"arrayDiff","values":["x","y"]}',
        '{"method":"arrayFilter","values":["equal","test"]}',
        '{"method":"stringConcat","values":["suffix"]}',
        '{"method":"stringReplace","values":["old","new"]}',
        '{"method":"toggle","values":[]}',
        '{"method":"dateAddDays","values":[7]}',
        '{"method":"dateSubDays","values":[3]}',
        '{"method":"dateSetNow","values":[]}',
        self::HEADERS_RESPONSE,
    ];

    protected string $class = '';
    protected string $language = '';
    protected array $build = [];
    protected string $command = '';
    protected array $expectedOutput = [];
    protected string $sdkName;
    protected string $sdkPlatform;
    protected string $sdkLanguage;
    protected string $version;

    public function setUp(): void
    {
        \array_unshift($this->expectedOutput, $this->getExpectedSdkHeaders());

        \exec('
            cd ./mock-server && \
            docker compose build && \
            docker compose up -d --force-recreate
        ');
    }

    protected function getExpectedSdkHeaders(): string
    {
        return "x-sdk-name: {$this->sdkName}; x-sdk-platform: {$this->sdkPlatform}; x-sdk-language: {$this->sdkLanguage}; x-sdk-version: {$this->version}";
    }

    public function tearDown(): void
    {
        // Remove the mock server so local test runs don't leave containers behind
        \exec('
            cd ./mock-server && \
            docker compose down
        ');
    }

    /**
     * @throws SyntaxError
     * @throws Throwable
     * @throws RuntimeError
     * @throws LoaderError
     */
    public function testHTTPSuccess(): void
    {
        $spec = file_get_contents(realpath(__DIR__ . '/../resources/spec-openapi3.json'));

        if (empty($spec)) {
            throw new Exception('Failed to parse spec.');
        }

        $sdk = new SDK($this->getLanguage(), new OpenAPI3($spec));

        $sdk
            ->setName($this->sdkName)
            ->setVersion($this->version)
            ->setPlatform($this->sdkPlatform)
            ->setDescription('Repo description goes here')
            ->setShortDescription('Repo short description goes here')
            ->setCoverImage('https://github.com/appwrite/appwrite/raw/main/public/images/github.png')
            ->setWarning('**WORK IN PROGRESS - THIS IS JUST A TEST SDK**')
            ->setExamples('**EXAMPLES** <HTML>')
            ->setGitUserName('repoowner')
            ->setGitRepoName('reponame')
            ->setLicense('BSD-3-Clause')
            ->setLicenseContent('demo license')
            ->setChangelog('--changelog--')
            ->setDefaultHeaders([
                'X-Appwrite-Response-Format' => '0.8.0',
            ])
            ->setExclude([
                'services' => [
                    ['name' => 'zzexcludedservice'],
                ],
                'methods' => [
                    ['name' => 'createExcludedGeneralFixture'],
                ],
            ])
            ->setTest("true");

        if ($this->language === 'android' || $this->language === 'kotlin') {
            $sdk->setNamespace("io.appwrite");
        } else {
            $sdk->setNamespace("appwrite");
        }

        $dir = __DIR__ . '/sdks/' . $this->language;

        $this->rmdirRecursive($dir);

        $sdk->generate(__DIR__ . '/sdks/' . $this->language);
        $this->assertExcludedFixtureWasRemoved($dir);

        /**
         * Build SDK
         */
        foreach ($this->build as $command) {
            echo "Build Executing: {$command}\n";

            exec($command);
        }

        $output = [];

        echo "Env Executing: {$this->command}\n";

        exec($this->command, $output);

        $this->assertIsArray($output);

        do {
            $removed = \array_shift($output);
        } while ($removed != 'Test Started' && count($output) !== 0);

        echo \implode("\n", $output);

        foreach ($this->expectedOutput as $index => $expected) {
            if ($expected === self::HEADERS_RESPONSE) {
                $expected = $this->getExpectedSdkHeaders() . '; accept: application/json, text/plain';
            }

            // HACK: Swift does not guarantee the order of the JSON parameters
            if (\str_starts_with((string) $expected, '{')) {
                $this->assertEquals(
                    \json_decode((string) $expected, true),
                    \json_decode($output[$index], true)
                );
            } elseif ($expected == 'unique()') {
                $this->assertNotEmpty($output[$index]);
                $this->assertIsString($output[$index]);
                $this->assertSame(20, strlen($output[$index]));
                $this->assertNotSame('unique()', $output[$index]);
            } else {
                $this->assertEquals($expected, $output[$index]);
            }
        }
    }

    private function rmdirRecursive(string $dir): void
    {
        if (!\is_dir($dir)) {
            return;
        }
        foreach (\scandir($dir) as $file) {
            if ('.' === $file || '..' === $file) {
                continue;
            }
            if (\is_dir("$dir/$file")) {
                $this->rmdirRecursive("$dir/$file");
            } else {
                \unlink("$dir/$file");
            }
        }
        \rmdir($dir);
    }

    private function assertExcludedFixtureWasRemoved(string $dir): void
    {
        $iterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($dir, FilesystemIterator::SKIP_DOTS)
        );

        foreach ($iterator as $file) {
            $path = \strtolower((string) $file->getPathname());

            foreach (self::EXCLUDED_FIXTURE_TOKENS as $token) {
                $this->assertStringNotContainsString($token, $path, "Excluded fixture leaked into generated path: {$path}");
            }

            if (!$file->isFile()) {
                continue;
            }

            $contents = \file_get_contents($file->getPathname());

            if ($contents === false) {
                continue;
            }

            $contents = \strtolower($contents);

            foreach (self::EXCLUDED_FIXTURE_TOKENS as $token) {
                $this->assertStringNotContainsString(
                    $token,
                    $contents,
                    "Excluded fixture leaked into generated file: {$file->getPathname()}"
                );
            }
        }
    }

    public function getLanguage(): Language
    {
        return new $this->class();
    }
}