desc('Get Foo') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'foo') ->label('sdk.method', 'get') ->label('sdk.description', 'Mock a get request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($x, $y, $z) { }); App::post('/v1/mock/tests/foo') ->desc('Post Foo') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'foo') ->label('sdk.method', 'post') ->label('sdk.description', 'Mock a post request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($x, $y, $z) { }); App::patch('/v1/mock/tests/foo') ->desc('Patch Foo') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'foo') ->label('sdk.method', 'patch') ->label('sdk.description', 'Mock a patch request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($x, $y, $z) { }); App::put('/v1/mock/tests/foo') ->desc('Put Foo') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'foo') ->label('sdk.method', 'put') ->label('sdk.description', 'Mock a put request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($x, $y, $z) { }); App::delete('/v1/mock/tests/foo') ->desc('Delete Foo') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'foo') ->label('sdk.method', 'delete') ->label('sdk.description', 'Mock a delete request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($x, $y, $z) { }); App::get('/v1/mock/tests/bar') ->desc('Get Bar') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'bar') ->label('sdk.method', 'get') ->label('sdk.description', 'Mock a get request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('required', '', new Text(100), 'Sample string param') ->param('default', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($required, $default, $z) { }); App::post('/v1/mock/tests/bar') ->desc('Post Bar') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'bar') ->label('sdk.method', 'post') ->label('sdk.description', 'Mock a post request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('required', '', new Text(100), 'Sample string param') ->param('default', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($required, $default, $z) { }); App::patch('/v1/mock/tests/bar') ->desc('Patch Bar') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'bar') ->label('sdk.method', 'patch') ->label('sdk.description', 'Mock a patch request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('required', '', new Text(100), 'Sample string param') ->param('default', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($required, $default, $z) { }); App::put('/v1/mock/tests/bar') ->desc('Put Bar') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'bar') ->label('sdk.method', 'put') ->label('sdk.description', 'Mock a put request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('required', '', new Text(100), 'Sample string param') ->param('default', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($required, $default, $z) { }); App::delete('/v1/mock/tests/bar') ->desc('Delete Bar') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'bar') ->label('sdk.method', 'delete') ->label('sdk.description', 'Mock a delete request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('required', '', new Text(100), 'Sample string param') ->param('default', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->action(function ($required, $default, $z) { }); App::get('/v1/mock/tests/general/download') ->desc('Download File') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'download') ->label('sdk.methodType', 'location') ->label('sdk.description', 'Mock a file download request.') ->label('sdk.response.type', '*/*') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.mock', true) ->inject('response') ->action(function (Response $response) { $response ->setContentType('text/plain') ->addHeader('Content-Disposition', 'attachment; filename="test.txt"') ->addHeader('Expires', \date('D, d M Y H:i:s', \time() + (60 * 60 * 24 * 45)) . ' GMT') // 45 days cache ->addHeader('X-Peak', \memory_get_peak_usage()) ->send("Download test passed.") ; }); App::post('/v1/mock/tests/general/upload') ->desc('Upload File') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'upload') ->label('sdk.description', 'Mock a file upload request.') ->label('sdk.request.type', 'multipart/form-data') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->param('x', '', new Text(100), 'Sample string param') ->param('y', '', new Integer(true), 'Sample numeric param') ->param('z', null, new ArrayList(new Text(256), APP_LIMIT_ARRAY_PARAMS_SIZE), 'Sample array param') ->param('file', [], new File(), 'Sample file param', false) ->inject('request') ->inject('response') ->action(function (string $x, int $y, array $z, mixed $file, Request $request, Response $response) { $file = $request->getFiles('file'); $contentRange = $request->getHeader('content-range'); $chunkSize = 5 * 1024 * 1024; // 5MB if (!empty($contentRange)) { $start = $request->getContentRangeStart(); $end = $request->getContentRangeEnd(); $size = $request->getContentRangeSize(); $id = $request->getHeader('x-appwrite-id', ''); $file['size'] = (\is_array($file['size'])) ? $file['size'][0] : $file['size']; if (is_null($start) || is_null($end) || is_null($size)) { throw new Exception('Invalid content-range header', 400, Exception::GENERAL_MOCK); } if ($start > $end || $end > $size) { throw new Exception('Invalid content-range header', 400, Exception::GENERAL_MOCK); } if ($start === 0 && !empty($id)) { throw new Exception('First chunked request cannot have id header', 400, Exception::GENERAL_MOCK); } if ($start !== 0 && $id !== 'newfileid') { throw new Exception('All chunked request must have id header (except first)', 400, Exception::GENERAL_MOCK); } if ($end !== $size && $end - $start + 1 !== $chunkSize) { throw new Exception('Chunk size must be 5MB (except last chunk)', 400, Exception::GENERAL_MOCK); } if ($end !== $size && $file['size'] !== $chunkSize) { throw new Exception('Wrong chunk size', 400, Exception::GENERAL_MOCK); } if ($file['size'] > $chunkSize) { throw new Exception('Chunk size must be 5MB or less', 400, Exception::GENERAL_MOCK); } if ($end !== $size) { $response->json([ '$id' => 'newfileid', 'chunksTotal' => $file['size'] / $chunkSize, 'chunksUploaded' => $start / $chunkSize ]); } } else { $file['tmp_name'] = (\is_array($file['tmp_name'])) ? $file['tmp_name'][0] : $file['tmp_name']; $file['name'] = (\is_array($file['name'])) ? $file['name'][0] : $file['name']; $file['size'] = (\is_array($file['size'])) ? $file['size'][0] : $file['size']; if ($file['name'] !== 'file.png') { throw new Exception('Wrong file name', 400, Exception::GENERAL_MOCK); } if ($file['size'] !== 38756) { throw new Exception('Wrong file size', 400, Exception::GENERAL_MOCK); } if (\md5(\file_get_contents($file['tmp_name'])) !== 'd80e7e6999a3eb2ae0d631a96fe135a4') { throw new Exception('Wrong file uploaded', 400, Exception::GENERAL_MOCK); } } }); App::get('/v1/mock/tests/general/redirect') ->desc('Redirect') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'redirect') ->label('sdk.description', 'Mock a redirect request.') ->label('sdk.response.code', Response::STATUS_CODE_MOVED_PERMANENTLY) ->label('sdk.response.type', Response::CONTENT_TYPE_HTML) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->inject('response') ->action(function (Response $response) { $response->redirect('/v1/mock/tests/general/redirect/done'); }); App::get('/v1/mock/tests/general/redirect/done') ->desc('Redirected') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'redirected') ->label('sdk.description', 'Mock a redirected request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->action(function () { }); App::get('/v1/mock/tests/general/set-cookie') ->desc('Set Cookie') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'setCookie') ->label('sdk.description', 'Mock a set cookie request.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->inject('response') ->inject('request') ->action(function (Response $response, Request $request) { $response->addCookie('cookieName', 'cookieValue', \time() + 31536000, '/', $request->getHostname(), true, true); }); App::get('/v1/mock/tests/general/get-cookie') ->desc('Get Cookie') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'getCookie') ->label('sdk.description', 'Mock a cookie response.') ->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_MOCK) ->label('sdk.mock', true) ->inject('request') ->action(function (Request $request) { if ($request->getCookie('cookieName', '') !== 'cookieValue') { throw new Exception('Missing cookie value', 400, Exception::GENERAL_MOCK); } }); App::get('/v1/mock/tests/general/empty') ->desc('Empty Response') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'empty') ->label('sdk.description', 'Mock an empty response.') ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT) ->label('sdk.response.model', Response::MODEL_NONE) ->label('sdk.mock', true) ->inject('response') ->action(function (Response $response) { $response->noContent(); }); App::get('/v1/mock/tests/general/400-error') ->desc('400 Error') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'error400') ->label('sdk.description', 'Mock a 400 failed request.') ->label('sdk.response.code', Response::STATUS_CODE_BAD_REQUEST) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ERROR) ->label('sdk.mock', true) ->action(function () { throw new Exception('Mock 400 error', 400, Exception::GENERAL_MOCK); }); App::get('/v1/mock/tests/general/500-error') ->desc('500 Error') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'error500') ->label('sdk.description', 'Mock a 500 failed request.') ->label('sdk.response.code', Response::STATUS_CODE_INTERNAL_SERVER_ERROR) ->label('sdk.response.type', Response::CONTENT_TYPE_JSON) ->label('sdk.response.model', Response::MODEL_ERROR) ->label('sdk.mock', true) ->action(function () { throw new Exception('Mock 500 error', 500, Exception::GENERAL_MOCK); }); App::get('/v1/mock/tests/general/502-error') ->desc('502 Error') ->groups(['mock']) ->label('scope', 'public') ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'general') ->label('sdk.method', 'error502') ->label('sdk.description', 'Mock a 502 bad gateway.') ->label('sdk.response.code', Response::STATUS_CODE_BAD_GATEWAY) ->label('sdk.response.type', Response::CONTENT_TYPE_TEXT) ->label('sdk.response.model', Response::MODEL_ANY) ->label('sdk.mock', true) ->inject('response') ->action(function (Response $response) { $response ->setStatusCode(502) ->text('This is a text error') ; }); App::get('/v1/mock/tests/general/oauth2') ->desc('OAuth Login') ->groups(['mock']) ->label('scope', 'public') ->label('docs', false) ->label('sdk.mock', true) ->param('client_id', '', new Text(100), 'OAuth2 Client ID.') ->param('redirect_uri', '', new Host(['localhost']), 'OAuth2 Redirect URI.') // Important to deny an open redirect attack ->param('scope', '', new Text(100), 'OAuth2 scope list.') ->param('state', '', new Text(1024), 'OAuth2 state.') ->inject('response') ->action(function (string $client_id, string $redirectURI, string $scope, string $state, Response $response) { $response->redirect($redirectURI . '?' . \http_build_query(['code' => 'abcdef', 'state' => $state])); }); App::get('/v1/mock/tests/general/oauth2/token') ->desc('OAuth2 Token') ->groups(['mock']) ->label('scope', 'public') ->label('docs', false) ->label('sdk.mock', true) ->param('client_id', '', new Text(100), 'OAuth2 Client ID.') ->param('client_secret', '', new Text(100), 'OAuth2 scope list.') ->param('grant_type', 'authorization_code', new WhiteList(['refresh_token', 'authorization_code']), 'OAuth2 Grant Type.', true) ->param('redirect_uri', '', new Host(['localhost']), 'OAuth2 Redirect URI.', true) ->param('code', '', new Text(100), 'OAuth2 state.', true) ->param('refresh_token', '', new Text(100), 'OAuth2 refresh token.', true) ->inject('response') ->action(function (string $client_id, string $client_secret, string $grantType, string $redirectURI, string $code, string $refreshToken, Response $response) { if ($client_id != '1') { throw new Exception('Invalid client ID', 400, Exception::GENERAL_MOCK); } if ($client_secret != '123456') { throw new Exception('Invalid client secret', 400, Exception::GENERAL_MOCK); } $responseJson = [ 'access_token' => '123456', 'refresh_token' => 'tuvwxyz', 'expires_in' => 14400 ]; if ($grantType === 'authorization_code') { if ($code !== 'abcdef') { throw new Exception('Invalid token', 400, Exception::GENERAL_MOCK); } $response->json($responseJson); } elseif ($grantType === 'refresh_token') { if ($refreshToken !== 'tuvwxyz') { throw new Exception('Invalid refresh token', 400, Exception::GENERAL_MOCK); } $response->json($responseJson); } else { throw new Exception('Invalid grant type', 400, Exception::GENERAL_MOCK); } }); App::get('/v1/mock/tests/general/oauth2/user') ->desc('OAuth2 User') ->groups(['mock']) ->label('scope', 'public') ->label('docs', false) ->param('token', '', new Text(100), 'OAuth2 Access Token.') ->inject('response') ->action(function (string $token, Response $response) { if ($token != '123456') { throw new Exception('Invalid token', 400, Exception::GENERAL_MOCK); } $response->json([ 'id' => 1, 'name' => 'User Name', 'email' => 'useroauth@localhost.test', ]); }); App::get('/v1/mock/tests/general/oauth2/success') ->desc('OAuth2 Success') ->groups(['mock']) ->label('scope', 'public') ->label('docs', false) ->inject('response') ->action(function (Response $response) { $response->json([ 'result' => 'success', ]); }); App::get('/v1/mock/tests/general/oauth2/failure') ->desc('OAuth2 Failure') ->groups(['mock']) ->label('scope', 'public') ->label('docs', false) ->inject('response') ->action(function (Response $response) { $response ->setStatusCode(Response::STATUS_CODE_BAD_REQUEST) ->json([ 'result' => 'failure', ]); }); App::shutdown(function (App $utopia, Response $response, Request $request) { $result = []; $route = $utopia->match($request); $path = APP_STORAGE_CACHE . '/tests.json'; $tests = (\file_exists($path)) ? \json_decode(\file_get_contents($path), true) : []; if (!\is_array($tests)) { throw new Exception('Failed to read results', 500, Exception::GENERAL_MOCK); } $result[$route->getMethod() . ':' . $route->getPath()] = true; $tests = \array_merge($tests, $result); if (!\file_put_contents($path, \json_encode($tests), LOCK_EX)) { throw new Exception('Failed to save results', 500, Exception::GENERAL_MOCK); } $response->dynamic(new Document(['result' => $route->getMethod() . ':' . $route->getPath() . ':passed']), Response::MODEL_MOCK); }, ['utopia', 'response', 'request'], 'mock');