friendica/tests/legacy/ApiTest.php

301 lines
7.2 KiB
PHP
Raw Normal View History

2018-04-09 21:23:41 +02:00
<?php
/**
2022-01-07 00:30:59 +01:00
* @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
2018-04-09 21:23:41 +02:00
* ApiTest class.
*/
2020-09-11 19:38:41 +02:00
namespace Friendica\Test\legacy;
2018-04-09 21:23:41 +02:00
2019-02-05 22:03:07 +01:00
use Friendica\App;
2021-10-26 21:44:29 +02:00
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Security\BasicAuth;
2020-09-11 19:38:41 +02:00
use Friendica\Test\FixtureTest;
2021-11-08 23:10:07 +01:00
use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat;
2018-12-30 21:42:56 +01:00
use Monolog\Handler\TestHandler;
2018-04-09 21:23:41 +02:00
/**
* Tests for the API functions.
*
* Functions that use header() need to be tested in a separate process.
* @see https://phpunit.de/manual/5.7/en/appendixes.annotations.html#appendixes.annotations.runTestsInSeparateProcesses
2021-04-01 21:19:45 +02:00
*
* @backupGlobals enabled
2018-04-09 21:23:41 +02:00
*/
class ApiTest extends FixtureTest
2018-04-09 21:23:41 +02:00
{
2018-12-30 21:42:56 +01:00
/**
* @var TestHandler Can handle log-outputs
*/
protected $logOutput;
/** @var array */
protected $selfUser;
/** @var array */
protected $friendUser;
/** @var array */
protected $otherUser;
protected $wrongUserId;
2019-07-26 15:54:14 +02:00
/** @var App */
protected $app;
2021-10-26 21:44:29 +02:00
/** @var IManageConfigValues */
2019-08-04 18:50:24 +02:00
protected $config;
2018-04-09 21:23:41 +02:00
/**
* Create variables used by tests.
*/
protected function setUp() : void
2018-04-09 21:23:41 +02:00
{
2020-09-11 20:14:47 +02:00
global $API, $called_api;
$API = [];
$called_api = [];
parent::setUp();
2021-10-26 22:09:11 +02:00
/** @var IManageConfigValues $config */
2021-10-26 21:44:29 +02:00
$this->config = $this->dice->create(IManageConfigValues::class);
$this->config->set('system', 'url', 'http://localhost');
$this->config->set('system', 'hostname', 'localhost');
$this->config->set('system', 'worker_dont_fork', true);
// Default config
$this->config->set('config', 'hostname', 'localhost');
$this->config->set('system', 'throttle_limit_day', 100);
$this->config->set('system', 'throttle_limit_week', 100);
$this->config->set('system', 'throttle_limit_month', 100);
$this->config->set('system', 'theme', 'system_theme');
/** @var App app */
$this->app = DI::app();
2021-07-25 16:27:13 +02:00
DI::args()->setArgc(1);
2019-07-26 15:54:14 +02:00
2018-04-09 21:23:41 +02:00
// User data that the test database is populated with
$this->selfUser = [
'id' => 42,
2018-04-09 21:23:41 +02:00
'name' => 'Self contact',
'nick' => 'selfcontact',
'nurl' => 'http://localhost/profile/selfcontact'
];
$this->friendUser = [
'id' => 44,
'name' => 'Friend contact',
'nick' => 'friendcontact',
'nurl' => 'http://localhost/profile/friendcontact'
2018-04-09 21:23:41 +02:00
];
$this->otherUser = [
'id' => 43,
2018-04-09 21:23:41 +02:00
'name' => 'othercontact',
'nick' => 'othercontact',
'nurl' => 'http://localhost/profile/othercontact'
2018-04-09 21:23:41 +02:00
];
// User ID that we know is not in the database
$this->wrongUserId = 666;
DI::session()->start();
2018-04-09 21:23:41 +02:00
// Most API require login so we force the session
$_SESSION = [
'authenticated' => true,
'uid' => $this->selfUser['id']
2018-04-09 21:23:41 +02:00
];
2021-11-17 23:12:21 +01:00
BasicAuth::setCurrentUserID($this->selfUser['id']);
2018-04-09 21:23:41 +02:00
}
/**
* Test the api_user() function.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiUser()
{
2021-11-18 07:58:43 +01:00
self::assertEquals($this->selfUser['id'], BaseApi::getCurrentUserID());
2018-04-09 21:23:41 +02:00
}
2021-12-30 20:51:21 +01:00
2018-04-09 21:23:41 +02:00
/**
* Test the api_source() function.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiSource()
{
2021-11-24 08:26:22 +01:00
self::assertEquals('api', BasicAuth::getCurrentApplicationToken()['name']);
2018-04-09 21:23:41 +02:00
}
/**
* Test the api_source() function with a Twidere user agent.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiSourceWithTwidere()
{
$_SERVER['HTTP_USER_AGENT'] = 'Twidere';
2021-11-24 08:26:22 +01:00
self::assertEquals('Twidere', BasicAuth::getCurrentApplicationToken()['name']);
2018-04-09 21:23:41 +02:00
}
/**
* Test the api_source() function with a GET parameter.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiSourceWithGet()
{
2021-11-24 08:11:33 +01:00
$_REQUEST['source'] = 'source_name';
2021-11-24 08:26:22 +01:00
self::assertEquals('source_name', BasicAuth::getCurrentApplicationToken()['name']);
2018-04-09 21:23:41 +02:00
}
/**
* Test the api_date() function.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiDate()
{
2021-11-18 22:43:13 +01:00
self::assertEquals('Wed Oct 10 00:00:00 +0000 1990', DateTimeFormat::utc('1990-10-10', DateTimeFormat::API));
2018-04-09 21:23:41 +02:00
}
/**
* Test the BasicAuth::getCurrentUserID() function without any login.
*
2018-04-09 21:23:41 +02:00
* @runInSeparateProcess
2021-04-01 21:19:45 +02:00
* @preserveGlobalState disabled
2021-04-01 22:16:16 +02:00
* @preserveGlobalState disabled
2018-04-09 21:23:41 +02:00
*/
public function testApiLoginWithoutLogin()
{
2021-11-18 07:03:21 +01:00
BasicAuth::setCurrentUserID();
2021-05-16 23:49:40 +02:00
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
BasicAuth::getCurrentUserID(true);
2018-04-09 21:23:41 +02:00
}
/**
* Test the BasicAuth::getCurrentUserID() function with a bad login.
*
2018-04-09 21:23:41 +02:00
* @runInSeparateProcess
2021-04-01 21:19:45 +02:00
* @preserveGlobalState disabled
2021-04-01 22:16:16 +02:00
* @preserveGlobalState disabled
2018-04-09 21:23:41 +02:00
*/
public function testApiLoginWithBadLogin()
{
2021-11-18 07:03:21 +01:00
BasicAuth::setCurrentUserID();
2021-05-16 23:49:40 +02:00
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2018-04-09 21:23:41 +02:00
$_SERVER['PHP_AUTH_USER'] = 'user@server';
BasicAuth::getCurrentUserID(true);
2018-04-09 21:23:41 +02:00
}
/**
* Test the BasicAuth::getCurrentUserID() function with oAuth.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiLoginWithOauth()
{
$this->markTestIncomplete('Can we test this easily?');
}
/**
* Test the BasicAuth::getCurrentUserID() function with authentication provided by an addon.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiLoginWithAddonAuth()
{
$this->markTestIncomplete('Can we test this easily?');
}
/**
* Test the BasicAuth::getCurrentUserID() function with a correct login.
*
2018-04-09 21:23:41 +02:00
* @runInSeparateProcess
2021-04-01 22:16:16 +02:00
* @preserveGlobalState disabled
2021-04-01 21:19:45 +02:00
* @doesNotPerformAssertions
2018-04-09 21:23:41 +02:00
*/
public function testApiLoginWithCorrectLogin()
{
2021-11-18 07:03:21 +01:00
BasicAuth::setCurrentUserID();
2018-04-09 21:23:41 +02:00
$_SERVER['PHP_AUTH_USER'] = 'Test user';
$_SERVER['PHP_AUTH_PW'] = 'password';
BasicAuth::getCurrentUserID(true);
2018-04-09 21:23:41 +02:00
}
/**
* Test the BasicAuth::getCurrentUserID() function with a remote user.
*
2018-04-09 21:23:41 +02:00
* @runInSeparateProcess
2021-04-01 22:16:16 +02:00
* @preserveGlobalState disabled
2018-04-09 21:23:41 +02:00
*/
public function testApiLoginWithRemoteUser()
{
2021-11-18 07:03:21 +01:00
BasicAuth::setCurrentUserID();
2021-05-16 23:49:40 +02:00
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
2018-04-09 21:23:41 +02:00
$_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
BasicAuth::getCurrentUserID(true);
2018-04-09 21:23:41 +02:00
}
/**
2021-11-08 23:10:07 +01:00
* Test the Arrays::walkRecursive() function.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiWalkRecursive()
{
$array = ['item1'];
self::assertEquals(
2018-04-09 21:23:41 +02:00
$array,
2021-11-08 23:10:07 +01:00
Arrays::walkRecursive(
2018-04-09 21:23:41 +02:00
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
/**
2021-11-08 23:10:07 +01:00
* Test the Arrays::walkRecursive() function with an array.
*
2018-04-09 21:23:41 +02:00
* @return void
*/
public function testApiWalkRecursiveWithArray()
{
$array = [['item1'], ['item2']];
self::assertEquals(
2018-04-09 21:23:41 +02:00
$array,
2021-11-08 23:10:07 +01:00
Arrays::walkRecursive(
2018-04-09 21:23:41 +02:00
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
}