6 namespace Friendica\Test\legacy;
9 use Friendica\Core\Config\IConfig;
10 use Friendica\Core\PConfig\IPConfig;
11 use Friendica\Core\Protocol;
13 use Friendica\Network\HTTPException;
14 use Friendica\Test\FixtureTest;
15 use Friendica\Util\DateTimeFormat;
16 use Friendica\Util\Temporal;
17 use Monolog\Handler\TestHandler;
19 require_once __DIR__ . '/../../include/api.php';
22 * Tests for the API functions.
24 * Functions that use header() need to be tested in a separate process.
25 * @see https://phpunit.de/manual/5.7/en/appendixes.annotations.html#appendixes.annotations.runTestsInSeparateProcesses
27 * @backupGlobals enabled
29 class ApiTest extends FixtureTest
32 * @var TestHandler Can handle log-outputs
39 protected $friendUser;
43 protected $wrongUserId;
52 * Create variables used by tests.
54 protected function setUp() : void
56 global $API, $called_api;
62 /** @var IConfig $config */
63 $this->config = $this->dice->create(IConfig::class);
65 $this->config->set('system', 'url', 'http://localhost');
66 $this->config->set('system', 'hostname', 'localhost');
67 $this->config->set('system', 'worker_dont_fork', true);
70 $this->config->set('config', 'hostname', 'localhost');
71 $this->config->set('system', 'throttle_limit_day', 100);
72 $this->config->set('system', 'throttle_limit_week', 100);
73 $this->config->set('system', 'throttle_limit_month', 100);
74 $this->config->set('system', 'theme', 'system_theme');
78 $this->app = DI::app();
80 DI::args()->setArgc(1);
82 // User data that the test database is populated with
85 'name' => 'Self contact',
86 'nick' => 'selfcontact',
87 'nurl' => 'http://localhost/profile/selfcontact'
91 'name' => 'Friend contact',
92 'nick' => 'friendcontact',
93 'nurl' => 'http://localhost/profile/friendcontact'
97 'name' => 'othercontact',
98 'nick' => 'othercontact',
99 'nurl' => 'http://localhost/profile/othercontact'
102 // User ID that we know is not in the database
103 $this->wrongUserId = 666;
105 DI::session()->start();
107 // Most API require login so we force the session
110 'authenticated' => true,
111 'uid' => $this->selfUser['id']
116 * Assert that an user array contains expected keys.
118 * @param array $user User array
122 private function assertSelfUser(array $user)
124 self::assertEquals($this->selfUser['id'], $user['uid']);
125 self::assertEquals($this->selfUser['id'], $user['cid']);
126 self::assertEquals(1, $user['self']);
127 self::assertEquals('DFRN', $user['location']);
128 self::assertEquals($this->selfUser['name'], $user['name']);
129 self::assertEquals($this->selfUser['nick'], $user['screen_name']);
130 self::assertEquals('dfrn', $user['network']);
131 self::assertTrue($user['verified']);
135 * Assert that an user array contains expected keys.
137 * @param array $user User array
141 private function assertOtherUser(array $user = [])
143 self::assertEquals($this->otherUser['id'], $user['id']);
144 self::assertEquals($this->otherUser['id'], $user['id_str']);
145 self::assertEquals(0, $user['self']);
146 self::assertEquals($this->otherUser['name'], $user['name']);
147 self::assertEquals($this->otherUser['nick'], $user['screen_name']);
148 self::assertFalse($user['verified']);
152 * Assert that a status array contains expected keys.
154 * @param array $status Status array
158 private function assertStatus(array $status = [])
160 self::assertIsString($status['text'] ?? '');
161 self::assertIsInt($status['id'] ?? '');
162 // We could probably do more checks here.
166 * Assert that a list array contains expected keys.
168 * @param array $list List array
172 private function assertList(array $list = [])
174 self::assertIsString($list['name']);
175 self::assertIsInt($list['id']);
176 self::assertIsString('string', $list['id_str']);
177 self::assertContains($list['mode'], ['public', 'private']);
178 // We could probably do more checks here.
182 * Assert that the string is XML and contain the root element.
184 * @param string $result XML string
185 * @param string $root_element Root element name
189 private function assertXml($result = '', $root_element = '')
191 self::assertStringStartsWith('<?xml version="1.0"?>', $result);
192 self::assertStringContainsString('<' . $root_element, $result);
193 // We could probably do more checks here.
197 * Get the path to a temporary empty PNG image.
199 * @return string Path
201 private function getTempImage()
203 $tmpFile = tempnam(sys_get_temp_dir(), 'tmp_file');
207 // Empty 1x1 px PNG image
208 'iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg=='
216 * Test the api_user() function.
220 public function testApiUser()
222 self::assertEquals($this->selfUser['id'], api_user());
226 * Test the api_user() function with an unallowed user.
230 public function testApiUserWithUnallowedUser()
232 $_SESSION = ['allow_api' => false];
233 self::assertEquals(false, api_user());
237 * Test the api_source() function.
241 public function testApiSource()
243 self::assertEquals('api', api_source());
247 * Test the api_source() function with a Twidere user agent.
251 public function testApiSourceWithTwidere()
253 $_SERVER['HTTP_USER_AGENT'] = 'Twidere';
254 self::assertEquals('Twidere', api_source());
258 * Test the api_source() function with a GET parameter.
262 public function testApiSourceWithGet()
264 $_GET['source'] = 'source_name';
265 self::assertEquals('source_name', api_source());
269 * Test the api_date() function.
273 public function testApiDate()
275 self::assertEquals('Wed Oct 10 00:00:00 +0000 1990', api_date('1990-10-10'));
279 * Test the api_register_func() function.
283 public function testApiRegisterFunc()
295 self::assertTrue($API['api_path']['auth']);
296 self::assertEquals('method', $API['api_path']['method']);
297 self::assertTrue(is_callable($API['api_path']['func']));
301 * Test the api_login() function without any login.
303 * @runInSeparateProcess
304 * @preserveGlobalState disabled
305 * @preserveGlobalState disabled
307 public function testApiLoginWithoutLogin()
309 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
310 api_login($this->app);
314 * Test the api_login() function with a bad login.
316 * @runInSeparateProcess
317 * @preserveGlobalState disabled
318 * @preserveGlobalState disabled
320 public function testApiLoginWithBadLogin()
322 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
323 $_SERVER['PHP_AUTH_USER'] = 'user@server';
324 api_login($this->app);
328 * Test the api_login() function with oAuth.
332 public function testApiLoginWithOauth()
334 $this->markTestIncomplete('Can we test this easily?');
338 * Test the api_login() function with authentication provided by an addon.
342 public function testApiLoginWithAddonAuth()
344 $this->markTestIncomplete('Can we test this easily?');
348 * Test the api_login() function with a correct login.
350 * @runInSeparateProcess
351 * @preserveGlobalState disabled
352 * @doesNotPerformAssertions
354 public function testApiLoginWithCorrectLogin()
356 $_SERVER['PHP_AUTH_USER'] = 'Test user';
357 $_SERVER['PHP_AUTH_PW'] = 'password';
358 api_login($this->app);
362 * Test the api_login() function with a remote user.
364 * @runInSeparateProcess
365 * @preserveGlobalState disabled
367 public function testApiLoginWithRemoteUser()
369 $this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
370 $_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
371 api_login($this->app);
375 * Test the api_check_method() function.
379 public function testApiCheckMethod()
381 self::assertFalse(api_check_method('method'));
385 * Test the api_check_method() function with a correct method.
389 public function testApiCheckMethodWithCorrectMethod()
391 $_SERVER['REQUEST_METHOD'] = 'method';
392 self::assertTrue(api_check_method('method'));
396 * Test the api_check_method() function with a wildcard.
400 public function testApiCheckMethodWithWildcard()
402 self::assertTrue(api_check_method('*'));
406 * Test the api_call() function.
408 * @runInSeparateProcess
409 * @preserveGlobalState disabled
411 public function testApiCall()
415 'method' => 'method',
416 'func' => function () {
417 return ['data' => ['some_data']];
420 $_SERVER['REQUEST_METHOD'] = 'method';
421 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
422 $_GET['callback'] = 'callback_name';
424 $args = DI::args()->determine($_SERVER, $_GET);
427 'callback_name(["some_data"])',
428 api_call($this->app, $args)
433 * Test the api_call() function with the profiled enabled.
435 * @runInSeparateProcess
436 * @preserveGlobalState disabled
438 public function testApiCallWithProfiler()
442 'method' => 'method',
443 'func' => function () {
444 return ['data' => ['some_data']];
448 $_SERVER['REQUEST_METHOD'] = 'method';
449 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
451 $args = DI::args()->determine($_SERVER, $_GET);
453 $this->config->set('system', 'profiler', true);
454 $this->config->set('rendertime', 'callstack', true);
455 $this->app->callstack = [
456 'database' => ['some_function' => 200],
457 'database_write' => ['some_function' => 200],
458 'cache' => ['some_function' => 200],
459 'cache_write' => ['some_function' => 200],
460 'network' => ['some_function' => 200]
465 api_call($this->app, $args)
470 * Test the api_call() function without any result.
472 * @runInSeparateProcess
473 * @preserveGlobalState disabled
475 public function testApiCallWithNoResult()
479 'method' => 'method',
480 'func' => function () {
484 $_SERVER['REQUEST_METHOD'] = 'method';
485 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
487 $args = DI::args()->determine($_SERVER, $_GET);
490 '{"status":{"error":"Internal Server Error","code":"500 Internal Server Error","request":"api_path"}}',
491 api_call($this->app, $args)
496 * Test the api_call() function with an unimplemented API.
498 * @runInSeparateProcess
499 * @preserveGlobalState disabled
501 public function testApiCallWithUninplementedApi()
504 '{"status":{"error":"Not Found","code":"404 Not Found","request":""}}',
510 * Test the api_call() function with a JSON result.
512 * @runInSeparateProcess
513 * @preserveGlobalState disabled
515 public function testApiCallWithJson()
519 'method' => 'method',
520 'func' => function () {
521 return ['data' => ['some_data']];
524 $_SERVER['REQUEST_METHOD'] = 'method';
525 $_SERVER['QUERY_STRING'] = 'pagename=api_path.json';
527 $args = DI::args()->determine($_SERVER, $_GET);
531 api_call($this->app, $args)
536 * Test the api_call() function with an XML result.
538 * @runInSeparateProcess
539 * @preserveGlobalState disabled
541 public function testApiCallWithXml()
545 'method' => 'method',
546 'func' => function () {
550 $_SERVER['REQUEST_METHOD'] = 'method';
551 $_SERVER['QUERY_STRING'] = 'pagename=api_path.xml';
553 $args = DI::args()->determine($_SERVER, $_GET);
557 api_call($this->app, $args)
562 * Test the api_call() function with an RSS result.
564 * @runInSeparateProcess
565 * @preserveGlobalState disabled
567 public function testApiCallWithRss()
571 'method' => 'method',
572 'func' => function () {
576 $_SERVER['REQUEST_METHOD'] = 'method';
577 $_SERVER['QUERY_STRING'] = 'pagename=api_path.rss';
579 $args = DI::args()->determine($_SERVER, $_GET);
582 '<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
584 api_call($this->app, $args)
589 * Test the api_call() function with an Atom result.
591 * @runInSeparateProcess
592 * @preserveGlobalState disabled
594 public function testApiCallWithAtom()
598 'method' => 'method',
599 'func' => function () {
603 $_SERVER['REQUEST_METHOD'] = 'method';
604 $_SERVER['QUERY_STRING'] = 'pagename=api_path.atom';
606 $args = DI::args()->determine($_SERVER, $_GET);
609 '<?xml version="1.0" encoding="UTF-8"?>' . "\n" .
611 api_call($this->app, $args)
616 * Test the api_call() function with an unallowed method.
618 * @runInSeparateProcess
619 * @preserveGlobalState disabled
621 public function testApiCallWithWrongMethod()
624 $API['api_path'] = ['method' => 'method'];
626 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
628 $args = DI::args()->determine($_SERVER, $_GET);
631 '{"status":{"error":"Method Not Allowed","code":"405 Method Not Allowed","request":"api_path"}}',
632 api_call($this->app, $args)
637 * Test the api_call() function with an unauthorized user.
639 * @runInSeparateProcess
640 * @preserveGlobalState disabled
642 public function testApiCallWithWrongAuth()
646 'method' => 'method',
649 $_SESSION['authenticated'] = false;
650 $_SERVER['REQUEST_METHOD'] = 'method';
651 $_SERVER['QUERY_STRING'] = 'pagename=api_path';
653 $args = DI::args()->determine($_SERVER, $_GET);
656 '{"status":{"error":"This API requires login","code":"401 Unauthorized","request":"api_path"}}',
657 api_call($this->app, $args)
662 * Test the api_error() function with a JSON result.
664 * @runInSeparateProcess
665 * @preserveGlobalState disabled
667 public function testApiErrorWithJson()
670 '{"status":{"error":"error_message","code":"200 OK","request":""}}',
671 api_error('json', new HTTPException\OKException('error_message'), DI::args())
676 * Test the api_error() function with an XML result.
678 * @runInSeparateProcess
679 * @preserveGlobalState disabled
681 public function testApiErrorWithXml()
684 '<?xml version="1.0"?>' . "\n" .
685 '<status xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
686 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
687 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
688 ' <error>error_message</error>' . "\n" .
689 ' <code>200 OK</code>' . "\n" .
690 ' <request/>' . "\n" .
692 api_error('xml', new HTTPException\OKException('error_message'), DI::args())
697 * Test the api_error() function with an RSS result.
699 * @runInSeparateProcess
700 * @preserveGlobalState disabled
702 public function testApiErrorWithRss()
705 '<?xml version="1.0"?>' . "\n" .
706 '<status xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
707 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
708 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
709 ' <error>error_message</error>' . "\n" .
710 ' <code>200 OK</code>' . "\n" .
711 ' <request/>' . "\n" .
713 api_error('rss', new HTTPException\OKException('error_message'), DI::args())
718 * Test the api_error() function with an Atom result.
720 * @runInSeparateProcess
721 * @preserveGlobalState disabled
723 public function testApiErrorWithAtom()
726 '<?xml version="1.0"?>' . "\n" .
727 '<status xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
728 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
729 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
730 ' <error>error_message</error>' . "\n" .
731 ' <code>200 OK</code>' . "\n" .
732 ' <request/>' . "\n" .
734 api_error('atom', new HTTPException\OKException('error_message'), DI::args())
739 * Test the api_rss_extra() function.
743 public function testApiRssExtra()
745 $user_info = ['url' => 'user_url', 'lang' => 'en'];
746 $result = api_rss_extra($this->app, [], $user_info);
747 self::assertEquals($user_info, $result['$user']);
748 self::assertEquals($user_info['url'], $result['$rss']['alternate']);
749 self::assertArrayHasKey('self', $result['$rss']);
750 self::assertArrayHasKey('base', $result['$rss']);
751 self::assertArrayHasKey('updated', $result['$rss']);
752 self::assertArrayHasKey('atom_updated', $result['$rss']);
753 self::assertArrayHasKey('language', $result['$rss']);
754 self::assertArrayHasKey('logo', $result['$rss']);
758 * Test the api_rss_extra() function without any user info.
762 public function testApiRssExtraWithoutUserInfo()
764 $result = api_rss_extra($this->app, [], null);
765 self::assertIsArray($result['$user']);
766 self::assertArrayHasKey('alternate', $result['$rss']);
767 self::assertArrayHasKey('self', $result['$rss']);
768 self::assertArrayHasKey('base', $result['$rss']);
769 self::assertArrayHasKey('updated', $result['$rss']);
770 self::assertArrayHasKey('atom_updated', $result['$rss']);
771 self::assertArrayHasKey('language', $result['$rss']);
772 self::assertArrayHasKey('logo', $result['$rss']);
776 * Test the api_unique_id_to_nurl() function.
780 public function testApiUniqueIdToNurl()
782 self::assertFalse(api_unique_id_to_nurl($this->wrongUserId));
786 * Test the api_unique_id_to_nurl() function with a correct ID.
790 public function testApiUniqueIdToNurlWithCorrectId()
792 self::assertEquals($this->otherUser['nurl'], api_unique_id_to_nurl($this->otherUser['id']));
796 * Test the api_get_user() function.
800 public function testApiGetUser()
802 $user = api_get_user($this->app);
803 self::assertSelfUser($user);
804 self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
805 self::assertEquals('6fdbe8', $user['profile_link_color']);
806 self::assertEquals('ededed', $user['profile_background_color']);
810 * Test the api_get_user() function with a Frio schema.
814 public function testApiGetUserWithFrioSchema()
816 $pConfig = $this->dice->create(IPConfig::class);
817 $pConfig->set($this->selfUser['id'], 'frio', 'schema', 'red');
818 $user = api_get_user($this->app);
819 self::assertSelfUser($user);
820 self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
821 self::assertEquals('6fdbe8', $user['profile_link_color']);
822 self::assertEquals('ededed', $user['profile_background_color']);
826 * Test the api_get_user() function with an empty Frio schema.
830 public function testApiGetUserWithEmptyFrioSchema()
832 $pConfig = $this->dice->create(IPConfig::class);
833 $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---');
834 $user = api_get_user($this->app);
835 self::assertSelfUser($user);
836 self::assertEquals('708fa0', $user['profile_sidebar_fill_color']);
837 self::assertEquals('6fdbe8', $user['profile_link_color']);
838 self::assertEquals('ededed', $user['profile_background_color']);
842 * Test the api_get_user() function with a custom Frio schema.
846 public function testApiGetUserWithCustomFrioSchema()
848 $pConfig = $this->dice->create(IPConfig::class);
849 $pConfig->set($this->selfUser['id'], 'frio', 'schema', '---');
850 $pConfig->set($this->selfUser['id'], 'frio', 'nav_bg', '#123456');
851 $pConfig->set($this->selfUser['id'], 'frio', 'link_color', '#123456');
852 $pConfig->set($this->selfUser['id'], 'frio', 'background_color', '#123456');
853 $user = api_get_user($this->app);
854 self::assertSelfUser($user);
855 self::assertEquals('123456', $user['profile_sidebar_fill_color']);
856 self::assertEquals('123456', $user['profile_link_color']);
857 self::assertEquals('123456', $user['profile_background_color']);
861 * Test the api_get_user() function with an user that is not allowed to use the API.
863 * @runInSeparateProcess
864 * @preserveGlobalState disabled
866 public function testApiGetUserWithoutApiUser()
868 $_SERVER['PHP_AUTH_USER'] = 'Test user';
869 $_SERVER['PHP_AUTH_PW'] = 'password';
870 $_SESSION['allow_api'] = false;
871 self::assertFalse(api_get_user($this->app));
875 * Test the api_get_user() function with an user ID in a GET parameter.
879 public function testApiGetUserWithGetId()
881 $_GET['user_id'] = $this->otherUser['id'];
882 self::assertOtherUser(api_get_user($this->app));
886 * Test the api_get_user() function with a wrong user ID in a GET parameter.
890 public function testApiGetUserWithWrongGetId()
892 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
893 $_GET['user_id'] = $this->wrongUserId;
894 self::assertOtherUser(api_get_user($this->app));
898 * Test the api_get_user() function with an user name in a GET parameter.
902 public function testApiGetUserWithGetName()
904 $_GET['screen_name'] = $this->selfUser['nick'];
905 self::assertSelfUser(api_get_user($this->app));
909 * Test the api_get_user() function with a profile URL in a GET parameter.
913 public function testApiGetUserWithGetUrl()
915 $_GET['profileurl'] = $this->selfUser['nurl'];
916 self::assertSelfUser(api_get_user($this->app));
920 * Test the api_get_user() function with an user ID in the API path.
924 public function testApiGetUserWithNumericCalledApi()
927 $called_api = ['api_path'];
928 DI::args()->setArgv(['', $this->otherUser['id'] . '.json']);
929 self::assertOtherUser(api_get_user($this->app));
933 * Test the api_get_user() function with the $called_api global variable.
937 public function testApiGetUserWithCalledApi()
940 $called_api = ['api', 'api_path'];
941 self::assertSelfUser(api_get_user($this->app));
945 * Test the api_get_user() function with a valid user.
949 public function testApiGetUserWithCorrectUser()
951 self::assertOtherUser(api_get_user($this->app, $this->otherUser['id']));
955 * Test the api_get_user() function with a wrong user ID.
959 public function testApiGetUserWithWrongUser()
961 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
962 self::assertOtherUser(api_get_user($this->app, $this->wrongUserId));
966 * Test the api_get_user() function with a 0 user ID.
970 public function testApiGetUserWithZeroUser()
972 self::assertSelfUser(api_get_user($this->app, 0));
976 * Test the api_item_get_user() function.
980 public function testApiItemGetUser()
982 $users = api_item_get_user($this->app, []);
983 self::assertSelfUser($users[0]);
987 * Test the api_item_get_user() function with a different item parent.
991 public function testApiItemGetUserWithDifferentParent()
993 $users = api_item_get_user($this->app, ['thr-parent' => 'item_parent', 'uri' => 'item_uri']);
994 self::assertSelfUser($users[0]);
995 self::assertEquals($users[0], $users[1]);
999 * Test the api_walk_recursive() function.
1003 public function testApiWalkRecursive()
1011 // Should we test this with a callback that actually does something?
1019 * Test the api_walk_recursive() function with an array.
1023 public function testApiWalkRecursiveWithArray()
1025 $array = [['item1'], ['item2']];
1031 // Should we test this with a callback that actually does something?
1039 * Test the api_reformat_xml() function.
1043 public function testApiReformatXml()
1047 self::assertTrue(api_reformat_xml($item, $key));
1048 self::assertEquals('true', $item);
1052 * Test the api_reformat_xml() function with a statusnet_api key.
1056 public function testApiReformatXmlWithStatusnetKey()
1059 $key = 'statusnet_api';
1060 self::assertTrue(api_reformat_xml($item, $key));
1061 self::assertEquals('statusnet:api', $key);
1065 * Test the api_reformat_xml() function with a friendica_api key.
1069 public function testApiReformatXmlWithFriendicaKey()
1072 $key = 'friendica_api';
1073 self::assertTrue(api_reformat_xml($item, $key));
1074 self::assertEquals('friendica:api', $key);
1078 * Test the api_create_xml() function.
1082 public function testApiCreateXml()
1085 '<?xml version="1.0"?>' . "\n" .
1086 '<root_element xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
1087 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
1088 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
1089 ' <data>some_data</data>' . "\n" .
1090 '</root_element>' . "\n",
1091 api_create_xml(['data' => ['some_data']], 'root_element')
1096 * Test the api_create_xml() function without any XML namespace.
1100 public function testApiCreateXmlWithoutNamespaces()
1103 '<?xml version="1.0"?>' . "\n" .
1105 ' <data>some_data</data>' . "\n" .
1107 api_create_xml(['data' => ['some_data']], 'ok')
1112 * Test the api_format_data() function.
1116 public function testApiFormatData()
1118 $data = ['some_data'];
1119 self::assertEquals($data, api_format_data('root_element', 'json', $data));
1123 * Test the api_format_data() function with an XML result.
1127 public function testApiFormatDataWithXml()
1130 '<?xml version="1.0"?>' . "\n" .
1131 '<root_element xmlns="http://api.twitter.com" xmlns:statusnet="http://status.net/schema/api/1/" ' .
1132 'xmlns:friendica="http://friendi.ca/schema/api/1/" ' .
1133 'xmlns:georss="http://www.georss.org/georss">' . "\n" .
1134 ' <data>some_data</data>' . "\n" .
1135 '</root_element>' . "\n",
1136 api_format_data('root_element', 'xml', ['data' => ['some_data']])
1141 * Test the api_account_verify_credentials() function.
1145 public function testApiAccountVerifyCredentials()
1147 self::assertArrayHasKey('user', api_account_verify_credentials('json'));
1151 * Test the api_account_verify_credentials() function without an authenticated user.
1155 public function testApiAccountVerifyCredentialsWithoutAuthenticatedUser()
1157 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1158 $_SESSION['authenticated'] = false;
1159 api_account_verify_credentials('json');
1163 * Test the requestdata() function.
1167 public function testRequestdata()
1169 self::assertNull(requestdata('variable_name'));
1173 * Test the requestdata() function with a POST parameter.
1177 public function testRequestdataWithPost()
1179 $_POST['variable_name'] = 'variable_value';
1180 self::assertEquals('variable_value', requestdata('variable_name'));
1184 * Test the requestdata() function with a GET parameter.
1188 public function testRequestdataWithGet()
1190 $_GET['variable_name'] = 'variable_value';
1191 self::assertEquals('variable_value', requestdata('variable_name'));
1195 * Test the api_statuses_mediap() function.
1199 public function testApiStatusesMediap()
1201 DI::args()->setArgc(2);
1209 'tmp_name' => $this->getTempImage(),
1210 'name' => 'spacer.png',
1211 'type' => 'image/png'
1214 $_GET['status'] = '<b>Status content</b>';
1216 $result = api_statuses_mediap('json');
1217 self::assertStatus($result['status']);
1221 * Test the api_statuses_mediap() function without an authenticated user.
1225 public function testApiStatusesMediapWithoutAuthenticatedUser()
1227 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1228 $_SESSION['authenticated'] = false;
1229 api_statuses_mediap('json');
1233 * Test the api_statuses_update() function.
1237 public function testApiStatusesUpdate()
1239 $_GET['status'] = 'Status content #friendica';
1240 $_GET['in_reply_to_status_id'] = -1;
1249 'tmp_name' => $this->getTempImage(),
1250 'name' => 'spacer.png',
1251 'type' => 'image/png'
1255 $result = api_statuses_update('json');
1256 self::assertStatus($result['status']);
1260 * Test the api_statuses_update() function with an HTML status.
1264 public function testApiStatusesUpdateWithHtml()
1266 $_GET['htmlstatus'] = '<b>Status content</b>';
1268 $result = api_statuses_update('json');
1269 self::assertStatus($result['status']);
1273 * Test the api_statuses_update() function without an authenticated user.
1277 public function testApiStatusesUpdateWithoutAuthenticatedUser()
1279 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1280 $_SESSION['authenticated'] = false;
1281 api_statuses_update('json');
1285 * Test the api_statuses_update() function with a parent status.
1289 public function testApiStatusesUpdateWithParent()
1291 $this->markTestIncomplete('This triggers an exit() somewhere and kills PHPUnit.');
1295 * Test the api_statuses_update() function with a media_ids parameter.
1299 public function testApiStatusesUpdateWithMediaIds()
1301 $this->markTestIncomplete();
1305 * Test the api_statuses_update() function with the throttle limit reached.
1309 public function testApiStatusesUpdateWithDayThrottleReached()
1311 $this->markTestIncomplete();
1315 * Test the api_media_upload() function.
1316 * @runInSeparateProcess
1317 * @preserveGlobalState disabled
1319 public function testApiMediaUpload()
1321 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1326 * Test the api_media_upload() function without an authenticated user.
1330 public function testApiMediaUploadWithoutAuthenticatedUser()
1332 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1333 $_SESSION['authenticated'] = false;
1338 * Test the api_media_upload() function with an invalid uploaded media.
1342 public function testApiMediaUploadWithMedia()
1344 $this->expectException(\Friendica\Network\HTTPException\InternalServerErrorException::class);
1348 'tmp_name' => 'tmp_name'
1355 * Test the api_media_upload() function with an valid uploaded media.
1359 public function testApiMediaUploadWithValidMedia()
1367 'tmp_name' => $this->getTempImage(),
1368 'name' => 'spacer.png',
1369 'type' => 'image/png'
1373 DI::args()->setArgc(2);
1375 $result = api_media_upload();
1376 self::assertEquals('image/png', $result['media']['image']['image_type']);
1377 self::assertEquals(1, $result['media']['image']['w']);
1378 self::assertEquals(1, $result['media']['image']['h']);
1379 self::assertNotEmpty($result['media']['image']['friendica_preview_url']);
1383 * Test the api_status_show() function.
1385 public function testApiStatusShowWithJson()
1387 $result = api_status_show('json', 1);
1388 self::assertStatus($result['status']);
1392 * Test the api_status_show() function with an XML result.
1394 public function testApiStatusShowWithXml()
1396 $result = api_status_show('xml', 1);
1397 self::assertXml($result, 'statuses');
1401 * Test the api_get_last_status() function
1403 public function testApiGetLastStatus()
1405 $item = api_get_last_status($this->selfUser['id'], $this->selfUser['id']);
1407 self::assertNotNull($item);
1411 * Test the api_users_show() function.
1415 public function testApiUsersShow()
1417 $result = api_users_show('json');
1418 // We can't use assertSelfUser() here because the user object is missing some properties.
1419 self::assertEquals($this->selfUser['id'], $result['user']['cid']);
1420 self::assertEquals('DFRN', $result['user']['location']);
1421 self::assertEquals($this->selfUser['name'], $result['user']['name']);
1422 self::assertEquals($this->selfUser['nick'], $result['user']['screen_name']);
1423 self::assertEquals('dfrn', $result['user']['network']);
1424 self::assertTrue($result['user']['verified']);
1428 * Test the api_users_show() function with an XML result.
1432 public function testApiUsersShowWithXml()
1434 $result = api_users_show('xml');
1435 self::assertXml($result, 'statuses');
1439 * Test the api_users_search() function.
1443 public function testApiUsersSearch()
1445 $_GET['q'] = 'othercontact';
1446 $result = api_users_search('json');
1447 self::assertOtherUser($result['users'][0]);
1451 * Test the api_users_search() function with an XML result.
1455 public function testApiUsersSearchWithXml()
1457 $_GET['q'] = 'othercontact';
1458 $result = api_users_search('xml');
1459 self::assertXml($result, 'users');
1463 * Test the api_users_search() function without a GET q parameter.
1467 public function testApiUsersSearchWithoutQuery()
1469 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1470 api_users_search('json');
1474 * Test the api_users_lookup() function.
1478 public function testApiUsersLookup()
1480 $this->expectException(\Friendica\Network\HTTPException\NotFoundException::class);
1481 api_users_lookup('json');
1485 * Test the api_users_lookup() function with an user ID.
1489 public function testApiUsersLookupWithUserId()
1491 $_REQUEST['user_id'] = $this->otherUser['id'];
1492 $result = api_users_lookup('json');
1493 self::assertOtherUser($result['users'][0]);
1497 * Test the api_search() function.
1501 public function testApiSearch()
1503 $_REQUEST['q'] = 'reply';
1504 $_REQUEST['max_id'] = 10;
1505 $result = api_search('json');
1506 foreach ($result['status'] as $status) {
1507 self::assertStatus($status);
1508 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1513 * Test the api_search() function a count parameter.
1517 public function testApiSearchWithCount()
1519 $_REQUEST['q'] = 'reply';
1520 $_REQUEST['count'] = 20;
1521 $result = api_search('json');
1522 foreach ($result['status'] as $status) {
1523 self::assertStatus($status);
1524 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1529 * Test the api_search() function with an rpp parameter.
1533 public function testApiSearchWithRpp()
1535 $_REQUEST['q'] = 'reply';
1536 $_REQUEST['rpp'] = 20;
1537 $result = api_search('json');
1538 foreach ($result['status'] as $status) {
1539 self::assertStatus($status);
1540 self::assertStringContainsStringIgnoringCase('reply', $status['text'], '', true);
1545 * Test the api_search() function with an q parameter contains hashtag.
1546 * @doesNotPerformAssertions
1548 public function testApiSearchWithHashtag()
1550 $_REQUEST['q'] = '%23friendica';
1551 $result = api_search('json');
1552 foreach ($result['status'] as $status) {
1553 self::assertStatus($status);
1554 self::assertStringContainsStringIgnoringCase('#friendica', $status['text'], '', true);
1559 * Test the api_search() function with an exclude_replies parameter.
1560 * @doesNotPerformAssertions
1562 public function testApiSearchWithExcludeReplies()
1564 $_REQUEST['max_id'] = 10;
1565 $_REQUEST['exclude_replies'] = true;
1566 $_REQUEST['q'] = 'friendica';
1567 $result = api_search('json');
1568 foreach ($result['status'] as $status) {
1569 self::assertStatus($status);
1574 * Test the api_search() function without an authenticated user.
1578 public function testApiSearchWithUnallowedUser()
1580 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1581 $_SESSION['allow_api'] = false;
1582 $_GET['screen_name'] = $this->selfUser['nick'];
1587 * Test the api_search() function without any GET query parameter.
1591 public function testApiSearchWithoutQuery()
1593 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1598 * Test the api_statuses_home_timeline() function.
1602 public function testApiStatusesHomeTimeline()
1604 $_REQUEST['max_id'] = 10;
1605 $_REQUEST['exclude_replies'] = true;
1606 $_REQUEST['conversation_id'] = 1;
1607 $result = api_statuses_home_timeline('json');
1608 self::assertNotEmpty($result['status']);
1609 foreach ($result['status'] as $status) {
1610 self::assertStatus($status);
1615 * Test the api_statuses_home_timeline() function with a negative page parameter.
1619 public function testApiStatusesHomeTimelineWithNegativePage()
1621 $_REQUEST['page'] = -2;
1622 $result = api_statuses_home_timeline('json');
1623 self::assertNotEmpty($result['status']);
1624 foreach ($result['status'] as $status) {
1625 self::assertStatus($status);
1630 * Test the api_statuses_home_timeline() with an unallowed user.
1634 public function testApiStatusesHomeTimelineWithUnallowedUser()
1636 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1637 $_SESSION['allow_api'] = false;
1638 $_GET['screen_name'] = $this->selfUser['nick'];
1639 api_statuses_home_timeline('json');
1643 * Test the api_statuses_home_timeline() function with an RSS result.
1647 public function testApiStatusesHomeTimelineWithRss()
1649 $result = api_statuses_home_timeline('rss');
1650 self::assertXml($result, 'statuses');
1654 * Test the api_statuses_public_timeline() function.
1658 public function testApiStatusesPublicTimeline()
1660 $_REQUEST['max_id'] = 10;
1661 $_REQUEST['conversation_id'] = 1;
1662 $result = api_statuses_public_timeline('json');
1663 self::assertNotEmpty($result['status']);
1664 foreach ($result['status'] as $status) {
1665 self::assertStatus($status);
1670 * Test the api_statuses_public_timeline() function with the exclude_replies parameter.
1674 public function testApiStatusesPublicTimelineWithExcludeReplies()
1676 $_REQUEST['max_id'] = 10;
1677 $_REQUEST['exclude_replies'] = true;
1678 $result = api_statuses_public_timeline('json');
1679 self::assertNotEmpty($result['status']);
1680 foreach ($result['status'] as $status) {
1681 self::assertStatus($status);
1686 * Test the api_statuses_public_timeline() function with a negative page parameter.
1690 public function testApiStatusesPublicTimelineWithNegativePage()
1692 $_REQUEST['page'] = -2;
1693 $result = api_statuses_public_timeline('json');
1694 self::assertNotEmpty($result['status']);
1695 foreach ($result['status'] as $status) {
1696 self::assertStatus($status);
1701 * Test the api_statuses_public_timeline() function with an unallowed user.
1705 public function testApiStatusesPublicTimelineWithUnallowedUser()
1707 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1708 $_SESSION['allow_api'] = false;
1709 $_GET['screen_name'] = $this->selfUser['nick'];
1710 api_statuses_public_timeline('json');
1714 * Test the api_statuses_public_timeline() function with an RSS result.
1718 public function testApiStatusesPublicTimelineWithRss()
1720 $result = api_statuses_public_timeline('rss');
1721 self::assertXml($result, 'statuses');
1725 * Test the api_statuses_networkpublic_timeline() function.
1729 public function testApiStatusesNetworkpublicTimeline()
1731 $_REQUEST['max_id'] = 10;
1732 $result = api_statuses_networkpublic_timeline('json');
1733 self::assertNotEmpty($result['status']);
1734 foreach ($result['status'] as $status) {
1735 self::assertStatus($status);
1740 * Test the api_statuses_networkpublic_timeline() function with a negative page parameter.
1744 public function testApiStatusesNetworkpublicTimelineWithNegativePage()
1746 $_REQUEST['page'] = -2;
1747 $result = api_statuses_networkpublic_timeline('json');
1748 self::assertNotEmpty($result['status']);
1749 foreach ($result['status'] as $status) {
1750 self::assertStatus($status);
1755 * Test the api_statuses_networkpublic_timeline() function with an unallowed user.
1759 public function testApiStatusesNetworkpublicTimelineWithUnallowedUser()
1761 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1762 $_SESSION['allow_api'] = false;
1763 $_GET['screen_name'] = $this->selfUser['nick'];
1764 api_statuses_networkpublic_timeline('json');
1768 * Test the api_statuses_networkpublic_timeline() function with an RSS result.
1772 public function testApiStatusesNetworkpublicTimelineWithRss()
1774 $result = api_statuses_networkpublic_timeline('rss');
1775 self::assertXml($result, 'statuses');
1779 * Test the api_statuses_show() function.
1783 public function testApiStatusesShow()
1785 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1786 api_statuses_show('json');
1790 * Test the api_statuses_show() function with an ID.
1794 public function testApiStatusesShowWithId()
1796 DI::args()->setArgv(['', '', '', 1]);
1797 $result = api_statuses_show('json');
1798 self::assertStatus($result['status']);
1802 * Test the api_statuses_show() function with the conversation parameter.
1806 public function testApiStatusesShowWithConversation()
1808 DI::args()->setArgv(['', '', '', 1]);
1809 $_REQUEST['conversation'] = 1;
1810 $result = api_statuses_show('json');
1811 self::assertNotEmpty($result['status']);
1812 foreach ($result['status'] as $status) {
1813 self::assertStatus($status);
1818 * Test the api_statuses_show() function with an unallowed user.
1822 public function testApiStatusesShowWithUnallowedUser()
1824 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1825 $_SESSION['allow_api'] = false;
1826 $_GET['screen_name'] = $this->selfUser['nick'];
1827 api_statuses_show('json');
1831 * Test the api_conversation_show() function.
1835 public function testApiConversationShow()
1837 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1838 api_conversation_show('json');
1842 * Test the api_conversation_show() function with an ID.
1846 public function testApiConversationShowWithId()
1848 DI::args()->setArgv(['', '', '', 1]);
1849 $_REQUEST['max_id'] = 10;
1850 $_REQUEST['page'] = -2;
1851 $result = api_conversation_show('json');
1852 self::assertNotEmpty($result['status']);
1853 foreach ($result['status'] as $status) {
1854 self::assertStatus($status);
1859 * Test the api_conversation_show() function with an unallowed user.
1863 public function testApiConversationShowWithUnallowedUser()
1865 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1866 $_SESSION['allow_api'] = false;
1867 $_GET['screen_name'] = $this->selfUser['nick'];
1868 api_conversation_show('json');
1872 * Test the api_statuses_repeat() function.
1876 public function testApiStatusesRepeat()
1878 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1879 api_statuses_repeat('json');
1883 * Test the api_statuses_repeat() function without an authenticated user.
1887 public function testApiStatusesRepeatWithoutAuthenticatedUser()
1889 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1890 $_SESSION['authenticated'] = false;
1891 api_statuses_repeat('json');
1895 * Test the api_statuses_repeat() function with an ID.
1899 public function testApiStatusesRepeatWithId()
1901 DI::args()->setArgv(['', '', '', 1]);
1902 $result = api_statuses_repeat('json');
1903 self::assertStatus($result['status']);
1905 // Also test with a shared status
1906 DI::args()->setArgv(['', '', '', 5]);
1907 $result = api_statuses_repeat('json');
1908 self::assertStatus($result['status']);
1912 * Test the api_statuses_destroy() function.
1916 public function testApiStatusesDestroy()
1918 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
1919 api_statuses_destroy('json');
1923 * Test the api_statuses_destroy() function without an authenticated user.
1927 public function testApiStatusesDestroyWithoutAuthenticatedUser()
1929 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1930 $_SESSION['authenticated'] = false;
1931 api_statuses_destroy('json');
1935 * Test the api_statuses_destroy() function with an ID.
1939 public function testApiStatusesDestroyWithId()
1941 DI::args()->setArgv(['', '', '', 1]);
1942 $result = api_statuses_destroy('json');
1943 self::assertStatus($result['status']);
1947 * Test the api_statuses_mentions() function.
1951 public function testApiStatusesMentions()
1953 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
1954 $_REQUEST['max_id'] = 10;
1955 $result = api_statuses_mentions('json');
1956 self::assertEmpty($result['status']);
1957 // We should test with mentions in the database.
1961 * Test the api_statuses_mentions() function with a negative page parameter.
1965 public function testApiStatusesMentionsWithNegativePage()
1967 $_REQUEST['page'] = -2;
1968 $result = api_statuses_mentions('json');
1969 self::assertEmpty($result['status']);
1973 * Test the api_statuses_mentions() function with an unallowed user.
1977 public function testApiStatusesMentionsWithUnallowedUser()
1979 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
1980 $_SESSION['allow_api'] = false;
1981 $_GET['screen_name'] = $this->selfUser['nick'];
1982 api_statuses_mentions('json');
1986 * Test the api_statuses_mentions() function with an RSS result.
1990 public function testApiStatusesMentionsWithRss()
1992 $result = api_statuses_mentions('rss');
1993 self::assertXml($result, 'statuses');
1997 * Test the api_statuses_user_timeline() function.
2001 public function testApiStatusesUserTimeline()
2003 $_REQUEST['max_id'] = 10;
2004 $_REQUEST['exclude_replies'] = true;
2005 $_REQUEST['conversation_id'] = 1;
2006 $result = api_statuses_user_timeline('json');
2007 self::assertNotEmpty($result['status']);
2008 foreach ($result['status'] as $status) {
2009 self::assertStatus($status);
2014 * Test the api_statuses_user_timeline() function with a negative page parameter.
2018 public function testApiStatusesUserTimelineWithNegativePage()
2020 $_REQUEST['page'] = -2;
2021 $result = api_statuses_user_timeline('json');
2022 self::assertNotEmpty($result['status']);
2023 foreach ($result['status'] as $status) {
2024 self::assertStatus($status);
2029 * Test the api_statuses_user_timeline() function with an RSS result.
2033 public function testApiStatusesUserTimelineWithRss()
2035 $result = api_statuses_user_timeline('rss');
2036 self::assertXml($result, 'statuses');
2040 * Test the api_statuses_user_timeline() function with an unallowed user.
2044 public function testApiStatusesUserTimelineWithUnallowedUser()
2046 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2047 $_SESSION['allow_api'] = false;
2048 $_GET['screen_name'] = $this->selfUser['nick'];
2049 api_statuses_user_timeline('json');
2053 * Test the api_favorites_create_destroy() function.
2057 public function testApiFavoritesCreateDestroy()
2059 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2060 DI::args()->setArgv(['api', '1.1', 'favorites', 'create']);
2061 api_favorites_create_destroy('json');
2065 * Test the api_favorites_create_destroy() function with an invalid ID.
2069 public function testApiFavoritesCreateDestroyWithInvalidId()
2071 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2072 DI::args()->setArgv(['api', '1.1', 'favorites', 'create', '12.json']);
2073 api_favorites_create_destroy('json');
2077 * Test the api_favorites_create_destroy() function with an invalid action.
2081 public function testApiFavoritesCreateDestroyWithInvalidAction()
2083 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2084 DI::args()->setArgv(['api', '1.1', 'favorites', 'change.json']);
2085 $_REQUEST['id'] = 1;
2086 api_favorites_create_destroy('json');
2090 * Test the api_favorites_create_destroy() function with the create action.
2094 public function testApiFavoritesCreateDestroyWithCreateAction()
2096 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.json']);
2097 $_REQUEST['id'] = 3;
2098 $result = api_favorites_create_destroy('json');
2099 self::assertStatus($result['status']);
2103 * Test the api_favorites_create_destroy() function with the create action and an RSS result.
2107 public function testApiFavoritesCreateDestroyWithCreateActionAndRss()
2109 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.rss']);
2110 $_REQUEST['id'] = 3;
2111 $result = api_favorites_create_destroy('rss');
2112 self::assertXml($result, 'status');
2116 * Test the api_favorites_create_destroy() function with the destroy action.
2120 public function testApiFavoritesCreateDestroyWithDestroyAction()
2122 DI::args()->setArgv(['api', '1.1', 'favorites', 'destroy.json']);
2123 $_REQUEST['id'] = 3;
2124 $result = api_favorites_create_destroy('json');
2125 self::assertStatus($result['status']);
2129 * Test the api_favorites_create_destroy() function without an authenticated user.
2133 public function testApiFavoritesCreateDestroyWithoutAuthenticatedUser()
2135 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2136 DI::args()->setArgv(['api', '1.1', 'favorites', 'create.json']);
2137 $_SESSION['authenticated'] = false;
2138 api_favorites_create_destroy('json');
2142 * Test the api_favorites() function.
2146 public function testApiFavorites()
2148 $_REQUEST['page'] = -1;
2149 $_REQUEST['max_id'] = 10;
2150 $result = api_favorites('json');
2151 foreach ($result['status'] as $status) {
2152 self::assertStatus($status);
2157 * Test the api_favorites() function with an RSS result.
2161 public function testApiFavoritesWithRss()
2163 $result = api_favorites('rss');
2164 self::assertXml($result, 'statuses');
2168 * Test the api_favorites() function with an unallowed user.
2172 public function testApiFavoritesWithUnallowedUser()
2174 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2175 $_SESSION['allow_api'] = false;
2176 $_GET['screen_name'] = $this->selfUser['nick'];
2177 api_favorites('json');
2181 * Test the api_format_messages() function.
2185 public function testApiFormatMessages()
2187 $result = api_format_messages(
2188 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
2189 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
2190 ['id' => 3, 'uri-id' => 2, 'screen_name' => 'sender_name']
2192 self::assertEquals('item_title' . "\n" . 'item_body', $result['text']);
2193 self::assertEquals(1, $result['id']);
2194 self::assertEquals(2, $result['recipient_id']);
2195 self::assertEquals(3, $result['sender_id']);
2196 self::assertEquals('recipient_name', $result['recipient_screen_name']);
2197 self::assertEquals('sender_name', $result['sender_screen_name']);
2201 * Test the api_format_messages() function with HTML.
2205 public function testApiFormatMessagesWithHtmlText()
2207 $_GET['getText'] = 'html';
2208 $result = api_format_messages(
2209 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
2210 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
2211 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
2213 self::assertEquals('item_title', $result['title']);
2214 self::assertEquals('<strong>item_body</strong>', $result['text']);
2218 * Test the api_format_messages() function with plain text.
2222 public function testApiFormatMessagesWithPlainText()
2224 $_GET['getText'] = 'plain';
2225 $result = api_format_messages(
2226 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
2227 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
2228 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
2230 self::assertEquals('item_title', $result['title']);
2231 self::assertEquals('item_body', $result['text']);
2235 * Test the api_format_messages() function with the getUserObjects GET parameter set to false.
2239 public function testApiFormatMessagesWithoutUserObjects()
2241 $_GET['getUserObjects'] = 'false';
2242 $result = api_format_messages(
2243 ['id' => 1, 'uri-id' => 1, 'title' => 'item_title', 'body' => '[b]item_body[/b]'],
2244 ['id' => 2, 'uri-id' => 2, 'screen_name' => 'recipient_name'],
2245 ['id' => 3, 'uri-id' => 3, 'screen_name' => 'sender_name']
2247 self::assertTrue(!isset($result['sender']));
2248 self::assertTrue(!isset($result['recipient']));
2252 * Test the api_convert_item() function.
2256 public function testApiConvertItem()
2258 $result = api_convert_item(
2260 'network' => 'feed',
2261 'title' => 'item_title',
2263 // We need a long string to test that it is correctly cut
2264 'body' => 'perspiciatis impedit voluptatem quis molestiae ea qui ' .
2265 'reiciendis dolorum aut ducimus sunt consequatur inventore dolor ' .
2266 'officiis pariatur doloremque nemo culpa aut quidem qui dolore ' .
2267 'laudantium atque commodi alias voluptatem non possimus aperiam ' .
2268 'ipsum rerum consequuntur aut amet fugit quia aliquid praesentium ' .
2269 'repellendus quibusdam et et inventore mollitia rerum sit autem ' .
2270 'pariatur maiores ipsum accusantium perferendis vel sit possimus ' .
2271 'veritatis nihil distinctio qui eum repellat officia illum quos ' .
2272 'impedit quam iste esse unde qui suscipit aut facilis ut inventore ' .
2273 'omnis exercitationem quo magnam consequatur maxime aut illum ' .
2274 'soluta quaerat natus unde aspernatur et sed beatae nihil ullam ' .
2275 'temporibus corporis ratione blanditiis perspiciatis impedit ' .
2276 'voluptatem quis molestiae ea qui reiciendis dolorum aut ducimus ' .
2277 'sunt consequatur inventore dolor officiis pariatur doloremque ' .
2278 'nemo culpa aut quidem qui dolore laudantium atque commodi alias ' .
2279 'voluptatem non possimus aperiam ipsum rerum consequuntur aut ' .
2280 'amet fugit quia aliquid praesentium repellendus quibusdam et et ' .
2281 'inventore mollitia rerum sit autem pariatur maiores ipsum accusantium ' .
2282 'perferendis vel sit possimus veritatis nihil distinctio qui eum ' .
2283 'repellat officia illum quos impedit quam iste esse unde qui ' .
2284 'suscipit aut facilis ut inventore omnis exercitationem quo magnam ' .
2285 'consequatur maxime aut illum soluta quaerat natus unde aspernatur ' .
2286 'et sed beatae nihil ullam temporibus corporis ratione blanditiis',
2287 'plink' => 'item_plink'
2290 self::assertStringStartsWith('item_title', $result['text']);
2291 self::assertStringStartsWith('<h4>item_title</h4><br>perspiciatis impedit voluptatem', $result['html']);
2295 * Test the api_convert_item() function with an empty item body.
2299 public function testApiConvertItemWithoutBody()
2301 $result = api_convert_item(
2303 'network' => 'feed',
2304 'title' => 'item_title',
2307 'plink' => 'item_plink'
2310 self::assertEquals("item_title", $result['text']);
2311 self::assertEquals('<h4>item_title</h4><br>item_plink', $result['html']);
2315 * Test the api_convert_item() function with the title in the body.
2319 public function testApiConvertItemWithTitleInBody()
2321 $result = api_convert_item(
2323 'title' => 'item_title',
2324 'body' => 'item_title item_body',
2328 self::assertEquals('item_title item_body', $result['text']);
2329 self::assertEquals('<h4>item_title</h4><br>item_title item_body', $result['html']);
2333 * Test the api_get_attachments() function.
2337 public function testApiGetAttachments()
2340 self::assertEmpty(api_get_attachments($body, 0));
2344 * Test the api_get_attachments() function with an img tag.
2348 public function testApiGetAttachmentsWithImage()
2350 $body = '[img]http://via.placeholder.com/1x1.png[/img]';
2351 self::assertIsArray(api_get_attachments($body, 0));
2355 * Test the api_get_attachments() function with an img tag and an AndStatus user agent.
2359 public function testApiGetAttachmentsWithImageAndAndStatus()
2361 $_SERVER['HTTP_USER_AGENT'] = 'AndStatus';
2362 $body = '[img]http://via.placeholder.com/1x1.png[/img]';
2363 self::assertIsArray(api_get_attachments($body, 0));
2367 * Test the api_get_entitities() function.
2371 public function testApiGetEntitities()
2374 self::assertIsArray(api_get_entitities($text, 'bbcode', 0));
2378 * Test the api_get_entitities() function with the include_entities parameter.
2382 public function testApiGetEntititiesWithIncludeEntities()
2384 $_REQUEST['include_entities'] = 'true';
2386 $result = api_get_entitities($text, 'bbcode', 0);
2387 self::assertIsArray($result['hashtags']);
2388 self::assertIsArray($result['symbols']);
2389 self::assertIsArray($result['urls']);
2390 self::assertIsArray($result['user_mentions']);
2394 * Test the api_format_items_embeded_images() function.
2398 public function testApiFormatItemsEmbededImages()
2401 'text ' . DI::baseUrl() . '/display/item_guid',
2402 api_format_items_embeded_images(['guid' => 'item_guid'], 'text data:image/foo')
2407 * Test the api_contactlink_to_array() function.
2411 public function testApiContactlinkToArray()
2418 api_contactlink_to_array('text')
2423 * Test the api_contactlink_to_array() function with an URL.
2427 public function testApiContactlinkToArrayWithUrl()
2431 'name' => ['link_text'],
2434 api_contactlink_to_array('text <a href="url">link_text</a>')
2439 * Test the api_format_items_activities() function.
2443 public function testApiFormatItemsActivities()
2445 $item = ['uid' => 0, 'uri' => ''];
2446 $result = api_format_items_activities($item);
2447 self::assertArrayHasKey('like', $result);
2448 self::assertArrayHasKey('dislike', $result);
2449 self::assertArrayHasKey('attendyes', $result);
2450 self::assertArrayHasKey('attendno', $result);
2451 self::assertArrayHasKey('attendmaybe', $result);
2455 * Test the api_format_items_activities() function with an XML result.
2459 public function testApiFormatItemsActivitiesWithXml()
2461 $item = ['uid' => 0, 'uri' => ''];
2462 $result = api_format_items_activities($item, 'xml');
2463 self::assertArrayHasKey('friendica:like', $result);
2464 self::assertArrayHasKey('friendica:dislike', $result);
2465 self::assertArrayHasKey('friendica:attendyes', $result);
2466 self::assertArrayHasKey('friendica:attendno', $result);
2467 self::assertArrayHasKey('friendica:attendmaybe', $result);
2471 * Test the api_format_items() function.
2472 * @doesNotPerformAssertions
2474 public function testApiFormatItems()
2478 'item_network' => 'item_network',
2484 'author-network' => Protocol::DFRN,
2485 'author-link' => 'http://localhost/profile/othercontact',
2489 $result = api_format_items($items, ['id' => 0], true);
2490 foreach ($result as $status) {
2491 self::assertStatus($status);
2496 * Test the api_format_items() function with an XML result.
2497 * @doesNotPerformAssertions
2499 public function testApiFormatItemsWithXml()
2507 'author-network' => Protocol::DFRN,
2508 'author-link' => 'http://localhost/profile/othercontact',
2512 $result = api_format_items($items, ['id' => 0], true, 'xml');
2513 foreach ($result as $status) {
2514 self::assertStatus($status);
2519 * Test the api_format_items() function.
2523 public function testApiAccountRateLimitStatus()
2525 $result = api_account_rate_limit_status('json');
2526 self::assertEquals(150, $result['hash']['remaining_hits']);
2527 self::assertEquals(150, $result['hash']['hourly_limit']);
2528 self::assertIsInt($result['hash']['reset_time_in_seconds']);
2532 * Test the api_format_items() function with an XML result.
2536 public function testApiAccountRateLimitStatusWithXml()
2538 $result = api_account_rate_limit_status('xml');
2539 self::assertXml($result, 'hash');
2543 * Test the api_help_test() function.
2547 public function testApiHelpTest()
2549 $result = api_help_test('json');
2550 self::assertEquals(['ok' => 'ok'], $result);
2554 * Test the api_help_test() function with an XML result.
2558 public function testApiHelpTestWithXml()
2560 $result = api_help_test('xml');
2561 self::assertXml($result, 'ok');
2565 * Test the api_lists_list() function.
2569 public function testApiListsList()
2571 $result = api_lists_list('json');
2572 self::assertEquals(['lists_list' => []], $result);
2576 * Test the api_lists_ownerships() function.
2580 public function testApiListsOwnerships()
2582 $result = api_lists_ownerships('json');
2583 foreach ($result['lists']['lists'] as $list) {
2584 self::assertList($list);
2589 * Test the api_lists_ownerships() function without an authenticated user.
2593 public function testApiListsOwnershipsWithoutAuthenticatedUser()
2595 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2596 $_SESSION['authenticated'] = false;
2597 api_lists_ownerships('json');
2601 * Test the api_lists_statuses() function.
2605 public function testApiListsStatuses()
2607 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2608 api_lists_statuses('json');
2612 * Test the api_lists_statuses() function with a list ID.
2613 * @doesNotPerformAssertions
2615 public function testApiListsStatusesWithListId()
2617 $_REQUEST['list_id'] = 1;
2618 $_REQUEST['page'] = -1;
2619 $_REQUEST['max_id'] = 10;
2620 $result = api_lists_statuses('json');
2621 foreach ($result['status'] as $status) {
2622 self::assertStatus($status);
2627 * Test the api_lists_statuses() function with a list ID and a RSS result.
2631 public function testApiListsStatusesWithListIdAndRss()
2633 $_REQUEST['list_id'] = 1;
2634 $result = api_lists_statuses('rss');
2635 self::assertXml($result, 'statuses');
2639 * Test the api_lists_statuses() function with an unallowed user.
2643 public function testApiListsStatusesWithUnallowedUser()
2645 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2646 $_SESSION['allow_api'] = false;
2647 $_GET['screen_name'] = $this->selfUser['nick'];
2648 api_lists_statuses('json');
2652 * Test the api_statuses_f() function.
2656 public function testApiStatusesFWithFriends()
2659 $result = api_statuses_f('friends');
2660 self::assertArrayHasKey('user', $result);
2664 * Test the api_statuses_f() function.
2668 public function testApiStatusesFWithFollowers()
2670 $result = api_statuses_f('followers');
2671 self::assertArrayHasKey('user', $result);
2675 * Test the api_statuses_f() function.
2679 public function testApiStatusesFWithBlocks()
2681 $result = api_statuses_f('blocks');
2682 self::assertArrayHasKey('user', $result);
2686 * Test the api_statuses_f() function.
2690 public function testApiStatusesFWithIncoming()
2692 $result = api_statuses_f('incoming');
2693 self::assertArrayHasKey('user', $result);
2697 * Test the api_statuses_f() function an undefined cursor GET variable.
2701 public function testApiStatusesFWithUndefinedCursor()
2703 $_GET['cursor'] = 'undefined';
2704 self::assertFalse(api_statuses_f('friends'));
2708 * Test the api_statuses_friends() function.
2712 public function testApiStatusesFriends()
2714 $result = api_statuses_friends('json');
2715 self::assertArrayHasKey('user', $result);
2719 * Test the api_statuses_friends() function an undefined cursor GET variable.
2723 public function testApiStatusesFriendsWithUndefinedCursor()
2725 $_GET['cursor'] = 'undefined';
2726 self::assertFalse(api_statuses_friends('json'));
2730 * Test the api_statuses_followers() function.
2734 public function testApiStatusesFollowers()
2736 $result = api_statuses_followers('json');
2737 self::assertArrayHasKey('user', $result);
2741 * Test the api_statuses_followers() function an undefined cursor GET variable.
2745 public function testApiStatusesFollowersWithUndefinedCursor()
2747 $_GET['cursor'] = 'undefined';
2748 self::assertFalse(api_statuses_followers('json'));
2752 * Test the api_blocks_list() function.
2756 public function testApiBlocksList()
2758 $result = api_blocks_list('json');
2759 self::assertArrayHasKey('user', $result);
2763 * Test the api_blocks_list() function an undefined cursor GET variable.
2767 public function testApiBlocksListWithUndefinedCursor()
2769 $_GET['cursor'] = 'undefined';
2770 self::assertFalse(api_blocks_list('json'));
2774 * Test the api_friendships_incoming() function.
2778 public function testApiFriendshipsIncoming()
2780 $result = api_friendships_incoming('json');
2781 self::assertArrayHasKey('id', $result);
2785 * Test the api_friendships_incoming() function an undefined cursor GET variable.
2789 public function testApiFriendshipsIncomingWithUndefinedCursor()
2791 $_GET['cursor'] = 'undefined';
2792 self::assertFalse(api_friendships_incoming('json'));
2796 * Test the api_statusnet_config() function.
2800 public function testApiStatusnetConfig()
2802 $result = api_statusnet_config('json');
2803 self::assertEquals('localhost', $result['config']['site']['server']);
2804 self::assertEquals('default', $result['config']['site']['theme']);
2805 self::assertEquals(DI::baseUrl() . '/images/friendica-64.png', $result['config']['site']['logo']);
2806 self::assertTrue($result['config']['site']['fancy']);
2807 self::assertEquals('en', $result['config']['site']['language']);
2808 self::assertEquals('UTC', $result['config']['site']['timezone']);
2809 self::assertEquals(200000, $result['config']['site']['textlimit']);
2810 self::assertEquals('false', $result['config']['site']['private']);
2811 self::assertEquals('false', $result['config']['site']['ssl']);
2812 self::assertEquals(30, $result['config']['site']['shorturllength']);
2816 * Test the api_statusnet_version() function.
2820 public function testApiStatusnetVersion()
2822 $result = api_statusnet_version('json');
2823 self::assertEquals('0.9.7', $result['version']);
2827 * Test the api_direct_messages_new() function.
2831 public function testApiDirectMessagesNew()
2833 $result = api_direct_messages_new('json');
2834 self::assertNull($result);
2838 * Test the api_direct_messages_new() function without an authenticated user.
2842 public function testApiDirectMessagesNewWithoutAuthenticatedUser()
2844 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2845 $_SESSION['authenticated'] = false;
2846 api_direct_messages_new('json');
2850 * Test the api_direct_messages_new() function with an user ID.
2854 public function testApiDirectMessagesNewWithUserId()
2856 $_POST['text'] = 'message_text';
2857 $_POST['user_id'] = $this->otherUser['id'];
2858 $result = api_direct_messages_new('json');
2859 self::assertEquals(['direct_message' => ['error' => -1]], $result);
2863 * Test the api_direct_messages_new() function with a screen name.
2867 public function testApiDirectMessagesNewWithScreenName()
2869 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2870 $_POST['text'] = 'message_text';
2871 $_POST['screen_name'] = $this->friendUser['nick'];
2872 $result = api_direct_messages_new('json');
2873 self::assertStringContainsString('message_text', $result['direct_message']['text']);
2874 self::assertEquals('selfcontact', $result['direct_message']['sender_screen_name']);
2875 self::assertEquals(1, $result['direct_message']['friendica_seen']);
2879 * Test the api_direct_messages_new() function with a title.
2883 public function testApiDirectMessagesNewWithTitle()
2885 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2886 $_POST['text'] = 'message_text';
2887 $_POST['screen_name'] = $this->friendUser['nick'];
2888 $_REQUEST['title'] = 'message_title';
2889 $result = api_direct_messages_new('json');
2890 self::assertStringContainsString('message_text', $result['direct_message']['text']);
2891 self::assertStringContainsString('message_title', $result['direct_message']['text']);
2892 self::assertEquals('selfcontact', $result['direct_message']['sender_screen_name']);
2893 self::assertEquals(1, $result['direct_message']['friendica_seen']);
2897 * Test the api_direct_messages_new() function with an RSS result.
2901 public function testApiDirectMessagesNewWithRss()
2903 $this->app->setLoggedInUserNickname($this->selfUser['nick']);
2904 $_POST['text'] = 'message_text';
2905 $_POST['screen_name'] = $this->friendUser['nick'];
2906 $result = api_direct_messages_new('rss');
2907 self::assertXml($result, 'direct-messages');
2911 * Test the api_direct_messages_destroy() function.
2915 public function testApiDirectMessagesDestroy()
2917 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2918 api_direct_messages_destroy('json');
2922 * Test the api_direct_messages_destroy() function with the friendica_verbose GET param.
2926 public function testApiDirectMessagesDestroyWithVerbose()
2928 $_GET['friendica_verbose'] = 'true';
2929 $result = api_direct_messages_destroy('json');
2933 'result' => 'error',
2934 'message' => 'message id or parenturi not specified'
2942 * Test the api_direct_messages_destroy() function without an authenticated user.
2946 public function testApiDirectMessagesDestroyWithoutAuthenticatedUser()
2948 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
2949 $_SESSION['authenticated'] = false;
2950 api_direct_messages_destroy('json');
2954 * Test the api_direct_messages_destroy() function with a non-zero ID.
2958 public function testApiDirectMessagesDestroyWithId()
2960 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
2961 $_REQUEST['id'] = 1;
2962 api_direct_messages_destroy('json');
2966 * Test the api_direct_messages_destroy() with a non-zero ID and the friendica_verbose GET param.
2970 public function testApiDirectMessagesDestroyWithIdAndVerbose()
2972 $_REQUEST['id'] = 1;
2973 $_REQUEST['friendica_parenturi'] = 'parent_uri';
2974 $_GET['friendica_verbose'] = 'true';
2975 $result = api_direct_messages_destroy('json');
2979 'result' => 'error',
2980 'message' => 'message id not in database'
2988 * Test the api_direct_messages_destroy() function with a non-zero ID.
2992 public function testApiDirectMessagesDestroyWithCorrectId()
2994 $this->markTestIncomplete('We need to add a dataset for this.');
2998 * Test the api_direct_messages_box() function.
3002 public function testApiDirectMessagesBoxWithSentbox()
3004 $_REQUEST['page'] = -1;
3005 $_REQUEST['max_id'] = 10;
3006 $result = api_direct_messages_box('json', 'sentbox', 'false');
3007 self::assertArrayHasKey('direct_message', $result);
3011 * Test the api_direct_messages_box() function.
3015 public function testApiDirectMessagesBoxWithConversation()
3017 $result = api_direct_messages_box('json', 'conversation', 'false');
3018 self::assertArrayHasKey('direct_message', $result);
3022 * Test the api_direct_messages_box() function.
3026 public function testApiDirectMessagesBoxWithAll()
3028 $result = api_direct_messages_box('json', 'all', 'false');
3029 self::assertArrayHasKey('direct_message', $result);
3033 * Test the api_direct_messages_box() function.
3037 public function testApiDirectMessagesBoxWithInbox()
3039 $result = api_direct_messages_box('json', 'inbox', 'false');
3040 self::assertArrayHasKey('direct_message', $result);
3044 * Test the api_direct_messages_box() function.
3048 public function testApiDirectMessagesBoxWithVerbose()
3050 $result = api_direct_messages_box('json', 'sentbox', 'true');
3054 'result' => 'error',
3055 'message' => 'no mails available'
3063 * Test the api_direct_messages_box() function with a RSS result.
3067 public function testApiDirectMessagesBoxWithRss()
3069 $result = api_direct_messages_box('rss', 'sentbox', 'false');
3070 self::assertXml($result, 'direct-messages');
3074 * Test the api_direct_messages_box() function without an authenticated user.
3078 public function testApiDirectMessagesBoxWithUnallowedUser()
3080 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3081 $_SESSION['allow_api'] = false;
3082 $_GET['screen_name'] = $this->selfUser['nick'];
3083 api_direct_messages_box('json', 'sentbox', 'false');
3087 * Test the api_direct_messages_sentbox() function.
3091 public function testApiDirectMessagesSentbox()
3093 $result = api_direct_messages_sentbox('json');
3094 self::assertArrayHasKey('direct_message', $result);
3098 * Test the api_direct_messages_inbox() function.
3102 public function testApiDirectMessagesInbox()
3104 $result = api_direct_messages_inbox('json');
3105 self::assertArrayHasKey('direct_message', $result);
3109 * Test the api_direct_messages_all() function.
3113 public function testApiDirectMessagesAll()
3115 $result = api_direct_messages_all('json');
3116 self::assertArrayHasKey('direct_message', $result);
3120 * Test the api_direct_messages_conversation() function.
3124 public function testApiDirectMessagesConversation()
3126 $result = api_direct_messages_conversation('json');
3127 self::assertArrayHasKey('direct_message', $result);
3131 * Test the api_oauth_request_token() function.
3135 public function testApiOauthRequestToken()
3137 $this->markTestIncomplete('exit() kills phpunit as well');
3141 * Test the api_oauth_access_token() function.
3145 public function testApiOauthAccessToken()
3147 $this->markTestIncomplete('exit() kills phpunit as well');
3151 * Test the api_fr_photoalbum_delete() function.
3155 public function testApiFrPhotoalbumDelete()
3157 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3158 api_fr_photoalbum_delete('json');
3162 * Test the api_fr_photoalbum_delete() function with an album name.
3166 public function testApiFrPhotoalbumDeleteWithAlbum()
3168 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3169 $_REQUEST['album'] = 'album_name';
3170 api_fr_photoalbum_delete('json');
3174 * Test the api_fr_photoalbum_delete() function with an album name.
3178 public function testApiFrPhotoalbumDeleteWithValidAlbum()
3180 $this->markTestIncomplete('We need to add a dataset for this.');
3184 * Test the api_fr_photoalbum_delete() function.
3188 public function testApiFrPhotoalbumUpdate()
3190 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3191 api_fr_photoalbum_update('json');
3195 * Test the api_fr_photoalbum_delete() function with an album name.
3199 public function testApiFrPhotoalbumUpdateWithAlbum()
3201 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3202 $_REQUEST['album'] = 'album_name';
3203 api_fr_photoalbum_update('json');
3207 * Test the api_fr_photoalbum_delete() function with an album name.
3211 public function testApiFrPhotoalbumUpdateWithAlbumAndNewAlbum()
3213 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3214 $_REQUEST['album'] = 'album_name';
3215 $_REQUEST['album_new'] = 'album_name';
3216 api_fr_photoalbum_update('json');
3220 * Test the api_fr_photoalbum_update() function without an authenticated user.
3224 public function testApiFrPhotoalbumUpdateWithoutAuthenticatedUser()
3226 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3227 $_SESSION['authenticated'] = false;
3228 api_fr_photoalbum_update('json');
3232 * Test the api_fr_photoalbum_delete() function with an album name.
3236 public function testApiFrPhotoalbumUpdateWithValidAlbum()
3238 $this->markTestIncomplete('We need to add a dataset for this.');
3242 * Test the api_fr_photos_list() function.
3246 public function testApiFrPhotosList()
3248 $result = api_fr_photos_list('json');
3249 self::assertArrayHasKey('photo', $result);
3253 * Test the api_fr_photos_list() function without an authenticated user.
3257 public function testApiFrPhotosListWithoutAuthenticatedUser()
3259 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3260 $_SESSION['authenticated'] = false;
3261 api_fr_photos_list('json');
3265 * Test the api_fr_photo_create_update() function.
3267 public function testApiFrPhotoCreateUpdate()
3269 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3270 api_fr_photo_create_update('json');
3274 * Test the api_fr_photo_create_update() function without an authenticated user.
3278 public function testApiFrPhotoCreateUpdateWithoutAuthenticatedUser()
3280 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3281 $_SESSION['authenticated'] = false;
3282 api_fr_photo_create_update('json');
3286 * Test the api_fr_photo_create_update() function with an album name.
3290 public function testApiFrPhotoCreateUpdateWithAlbum()
3292 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3293 $_REQUEST['album'] = 'album_name';
3294 api_fr_photo_create_update('json');
3298 * Test the api_fr_photo_create_update() function with the update mode.
3302 public function testApiFrPhotoCreateUpdateWithUpdate()
3304 $this->markTestIncomplete('We need to create a dataset for this');
3308 * Test the api_fr_photo_create_update() function with an uploaded file.
3312 public function testApiFrPhotoCreateUpdateWithFile()
3314 $this->markTestIncomplete();
3318 * Test the api_fr_photo_delete() function.
3322 public function testApiFrPhotoDelete()
3324 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3325 api_fr_photo_delete('json');
3329 * Test the api_fr_photo_delete() function without an authenticated user.
3333 public function testApiFrPhotoDeleteWithoutAuthenticatedUser()
3335 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3336 $_SESSION['authenticated'] = false;
3337 api_fr_photo_delete('json');
3341 * Test the api_fr_photo_delete() function with a photo ID.
3345 public function testApiFrPhotoDeleteWithPhotoId()
3347 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3348 $_REQUEST['photo_id'] = 1;
3349 api_fr_photo_delete('json');
3353 * Test the api_fr_photo_delete() function with a correct photo ID.
3357 public function testApiFrPhotoDeleteWithCorrectPhotoId()
3359 $this->markTestIncomplete('We need to create a dataset for this.');
3363 * Test the api_fr_photo_detail() function.
3367 public function testApiFrPhotoDetail()
3369 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3370 api_fr_photo_detail('json');
3374 * Test the api_fr_photo_detail() function without an authenticated user.
3378 public function testApiFrPhotoDetailWithoutAuthenticatedUser()
3380 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3381 $_SESSION['authenticated'] = false;
3382 api_fr_photo_detail('json');
3386 * Test the api_fr_photo_detail() function with a photo ID.
3390 public function testApiFrPhotoDetailWithPhotoId()
3392 $this->expectException(\Friendica\Network\HTTPException\NotFoundException::class);
3393 $_REQUEST['photo_id'] = 1;
3394 api_fr_photo_detail('json');
3398 * Test the api_fr_photo_detail() function with a correct photo ID.
3402 public function testApiFrPhotoDetailCorrectPhotoId()
3404 $this->markTestIncomplete('We need to create a dataset for this.');
3408 * Test the api_account_update_profile_image() function.
3412 public function testApiAccountUpdateProfileImage()
3414 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3415 api_account_update_profile_image('json');
3419 * Test the api_account_update_profile_image() function without an authenticated user.
3423 public function testApiAccountUpdateProfileImageWithoutAuthenticatedUser()
3425 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3426 $_SESSION['authenticated'] = false;
3427 api_account_update_profile_image('json');
3431 * Test the api_account_update_profile_image() function with an uploaded file.
3435 public function testApiAccountUpdateProfileImageWithUpload()
3437 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3438 $this->markTestIncomplete();
3443 * Test the api_account_update_profile() function.
3447 public function testApiAccountUpdateProfile()
3449 $_POST['name'] = 'new_name';
3450 $_POST['description'] = 'new_description';
3451 $result = api_account_update_profile('json');
3452 // We can't use assertSelfUser() here because the user object is missing some properties.
3453 self::assertEquals($this->selfUser['id'], $result['user']['cid']);
3454 self::assertEquals('DFRN', $result['user']['location']);
3455 self::assertEquals($this->selfUser['nick'], $result['user']['screen_name']);
3456 self::assertEquals('dfrn', $result['user']['network']);
3457 self::assertEquals('new_name', $result['user']['name']);
3458 self::assertEquals('new_description', $result['user']['description']);
3462 * Test the check_acl_input() function.
3466 public function testCheckAclInput()
3468 $result = check_acl_input('<aclstring>');
3469 // Where does this result come from?
3470 self::assertEquals(1, $result);
3474 * Test the check_acl_input() function with an empty ACL string.
3478 public function testCheckAclInputWithEmptyAclString()
3480 $result = check_acl_input(' ');
3481 self::assertFalse($result);
3485 * Test the save_media_to_database() function.
3489 public function testSaveMediaToDatabase()
3491 $this->markTestIncomplete();
3495 * Test the post_photo_item() function.
3499 public function testPostPhotoItem()
3501 $this->markTestIncomplete();
3505 * Test the prepare_photo_data() function.
3509 public function testPreparePhotoData()
3511 $this->markTestIncomplete();
3515 * Test the api_share_as_retweet() function with a valid item.
3519 public function testApiShareAsRetweetWithValidItem()
3521 $this->markTestIncomplete();
3525 * Test the api_in_reply_to() function.
3529 public function testApiInReplyTo()
3531 $result = api_in_reply_to(['id' => 0, 'parent' => 0, 'uri' => '', 'thr-parent' => '']);
3532 self::assertArrayHasKey('status_id', $result);
3533 self::assertArrayHasKey('user_id', $result);
3534 self::assertArrayHasKey('status_id_str', $result);
3535 self::assertArrayHasKey('user_id_str', $result);
3536 self::assertArrayHasKey('screen_name', $result);
3540 * Test the api_in_reply_to() function with a valid item.
3544 public function testApiInReplyToWithValidItem()
3546 $this->markTestIncomplete();
3550 * Test the api_clean_plain_items() function.
3554 public function testApiCleanPlainItems()
3556 $_REQUEST['include_entities'] = 'true';
3557 $result = api_clean_plain_items('some_text [url="some_url"]some_text[/url]');
3558 self::assertEquals('some_text [url="some_url"]"some_url"[/url]', $result);
3562 * Test the api_best_nickname() function.
3566 public function testApiBestNickname()
3569 $result = api_best_nickname($contacts);
3570 self::assertNull($result);
3574 * Test the api_best_nickname() function with contacts.
3578 public function testApiBestNicknameWithContacts()
3580 $this->markTestIncomplete();
3584 * Test the api_friendica_group_show() function.
3588 public function testApiFriendicaGroupShow()
3590 $this->markTestIncomplete();
3594 * Test the api_friendica_group_delete() function.
3598 public function testApiFriendicaGroupDelete()
3600 $this->markTestIncomplete();
3604 * Test the api_lists_destroy() function.
3608 public function testApiListsDestroy()
3610 $this->markTestIncomplete();
3614 * Test the group_create() function.
3618 public function testGroupCreate()
3620 $this->markTestIncomplete();
3624 * Test the api_friendica_group_create() function.
3628 public function testApiFriendicaGroupCreate()
3630 $this->markTestIncomplete();
3634 * Test the api_lists_create() function.
3638 public function testApiListsCreate()
3640 $this->markTestIncomplete();
3644 * Test the api_friendica_group_update() function.
3648 public function testApiFriendicaGroupUpdate()
3650 $this->markTestIncomplete();
3654 * Test the api_lists_update() function.
3658 public function testApiListsUpdate()
3660 $this->markTestIncomplete();
3664 * Test the api_friendica_activity() function.
3668 public function testApiFriendicaActivity()
3670 $this->markTestIncomplete();
3674 * Test the api_friendica_notification() function.
3678 public function testApiFriendicaNotification()
3680 $this->expectException(\Friendica\Network\HTTPException\BadRequestException::class);
3681 api_friendica_notification('json');
3685 * Test the api_friendica_notification() function without an authenticated user.
3689 public function testApiFriendicaNotificationWithoutAuthenticatedUser()
3691 $this->expectException(\Friendica\Network\HTTPException\ForbiddenException::class);
3692 $_SESSION['authenticated'] = false;
3693 api_friendica_notification('json');
3697 * Test the api_friendica_notification() function with empty result
3701 public function testApiFriendicaNotificationWithEmptyResult()
3703 DI::args()->setArgv(['api', 'friendica', 'notification']);
3704 $_SESSION['uid'] = 41;
3705 $result = api_friendica_notification('json');
3706 self::assertEquals(['note' => false], $result);
3710 * Test the api_friendica_notification() function with an XML result.
3714 public function testApiFriendicaNotificationWithXmlResult()
3716 DI::args()->setArgv(['api', 'friendica', 'notification']);
3717 $result = api_friendica_notification('xml');
3718 $date = DateTimeFormat::local('2020-01-01 12:12:02');
3719 $dateRel = Temporal::getRelativeDate('2020-01-01 07:12:02');
3722 <?xml version="1.0"?>
3724 <note date="$date" date_rel="$dateRel" id="1" iid="4" link="http://localhost/notification/1" msg="A test reply from an item" msg_cache="A test reply from an item" msg_html="A test reply from an item" msg_plain="A test reply from an item" name="Reply to" name_cache="Reply to" otype="item" parent="" photo="http://localhost/" seen="false" timestamp="1577880722" type="8" uid="42" url="http://localhost/display/1" verb="http://activitystrea.ms/schema/1.0/post"/>
3727 self::assertXmlStringEqualsXmlString($assertXml, $result);
3731 * Test the api_friendica_notification() function with an JSON result.
3735 public function testApiFriendicaNotificationWithJsonResult()
3737 DI::args()->setArgv(['api', 'friendica', 'notification']);
3738 $result = json_encode(api_friendica_notification('json'));
3739 self::assertJson($result);
3743 * Test the api_friendica_notification_seen() function.
3747 public function testApiFriendicaNotificationSeen()
3749 $this->markTestIncomplete();
3753 * Test the api_friendica_direct_messages_setseen() function.
3757 public function testApiFriendicaDirectMessagesSetseen()
3759 $this->markTestIncomplete();
3763 * Test the api_friendica_direct_messages_search() function.
3767 public function testApiFriendicaDirectMessagesSearch()
3769 $this->markTestIncomplete();
3773 * Test the api_saved_searches_list() function.
3777 public function testApiSavedSearchesList()
3779 $result = api_saved_searches_list('json');
3780 self::assertEquals(1, $result['terms'][0]['id']);
3781 self::assertEquals(1, $result['terms'][0]['id_str']);
3782 self::assertEquals('Saved search', $result['terms'][0]['name']);
3783 self::assertEquals('Saved search', $result['terms'][0]['query']);