mexon/friendica
1
0
Fork 0
Code Pull requests Activity

Merge pull request #11173 from nupplaphil/feat/api_cleanup

Browse source 
Move last legacy API tests
This commit is contained in:
Michael Vogel 2022-01-22 21:48:55 +01:00 committed by GitHub
parent e6d940f7a3 7dd8f7102f
commit 0476a82f4d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 173 additions and 362 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
tests/Util/DateTimeFormatMockTrait.php
View file

@ -1,58 +0,0 @@
<?php
/**
* @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/>.
*
*/
namespace Friendica\Test\Util;
use Friendica\Util\DateTimeFormat;
use Mockery\MockInterface;
trait DateTimeFormatMockTrait
{
/**
* @var MockInterface The mocking interface of Friendica\Database\DBA
*/
private $dtfMock;
public function mockUtcNow($time, $times = null)
{
if (!isset($this->dtfMock)) {
$this->dtfMock = \Mockery::mock('alias:'. DateTimeFormat::class);
}
$this->dtfMock
->shouldReceive('utcNow')
->andReturn($time)
->times($times);
}
public function mockUtc($input, $time, $times = null)
{
if (!isset($this->dtfMock)) {
$this->dtfMock = \Mockery::mock('alias:' . DateTimeFormat::class);
}
$this->dtfMock
->shouldReceive('utc')
->with($input)
->andReturn($time)
->times($times);
}
}

300
tests/legacy/ApiTest.php
View file

@ -1,300 +0,0 @@
<?php
/**
* @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/>.
*
* ApiTest class.
*/
namespace Friendica\Test\legacy;
use Friendica\App;
use Friendica\Core\Config\Capability\IManageConfigValues;
use Friendica\DI;
use Friendica\Module\BaseApi;
use Friendica\Security\BasicAuth;
use Friendica\Test\FixtureTest;
use Friendica\Util\Arrays;
use Friendica\Util\DateTimeFormat;
use Monolog\Handler\TestHandler;
/**
* 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
*
* @backupGlobals enabled
*/
class ApiTest extends FixtureTest
{
/**
* @var TestHandler Can handle log-outputs
*/
protected $logOutput;
/** @var array */
protected $selfUser;
/** @var array */
protected $friendUser;
/** @var array */
protected $otherUser;
protected $wrongUserId;
/** @var App */
protected $app;
/** @var IManageConfigValues */
protected $config;
/**
* Create variables used by tests.
*/
protected function setUp() : void
{
global $API, $called_api;
$API = [];
$called_api = [];
parent::setUp();
/** @var IManageConfigValues $config */
$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();
DI::args()->setArgc(1);
// User data that the test database is populated with
$this->selfUser = [
'id' => 42,
'name' => 'Self contact',
'nick' => 'selfcontact',
'nurl' => 'http://localhost/profile/selfcontact'
];
$this->friendUser = [
'id' => 44,
'name' => 'Friend contact',
'nick' => 'friendcontact',
'nurl' => 'http://localhost/profile/friendcontact'
];
$this->otherUser = [
'id' => 43,
'name' => 'othercontact',
'nick' => 'othercontact',
'nurl' => 'http://localhost/profile/othercontact'
];
// User ID that we know is not in the database
$this->wrongUserId = 666;
DI::session()->start();
// Most API require login so we force the session
$_SESSION = [
'authenticated' => true,
'uid' => $this->selfUser['id']
];
BasicAuth::setCurrentUserID($this->selfUser['id']);
}
/**
* Test the api_user() function.
*
* @return void
*/
public function testApiUser()
{
self::assertEquals($this->selfUser['id'], BaseApi::getCurrentUserID());
}
/**
* Test the api_source() function.
*
* @return void
*/
public function testApiSource()
{
self::assertEquals('api', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the api_source() function with a Twidere user agent.
*
* @return void
*/
public function testApiSourceWithTwidere()
{
$_SERVER['HTTP_USER_AGENT'] = 'Twidere';
self::assertEquals('Twidere', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the api_source() function with a GET parameter.
*
* @return void
*/
public function testApiSourceWithGet()
{
$_REQUEST['source'] = 'source_name';
self::assertEquals('source_name', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the api_date() function.
*
* @return void
*/
public function testApiDate()
{
self::assertEquals('Wed Oct 10 00:00:00 +0000 1990', DateTimeFormat::utc('1990-10-10', DateTimeFormat::API));
}
/**
* Test the BasicAuth::getCurrentUserID() function without any login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
* @preserveGlobalState disabled
*/
public function testApiLoginWithoutLogin()
{
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
BasicAuth::getCurrentUserID(true);
}
/**
* Test the BasicAuth::getCurrentUserID() function with a bad login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
* @preserveGlobalState disabled
*/
public function testApiLoginWithBadLogin()
{
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['PHP_AUTH_USER'] = 'user@server';
BasicAuth::getCurrentUserID(true);
}
/**
* Test the BasicAuth::getCurrentUserID() function with oAuth.
*
* @return void
*/
public function testApiLoginWithOauth()
{
$this->markTestIncomplete('Can we test this easily?');
}
/**
* Test the BasicAuth::getCurrentUserID() function with authentication provided by an addon.
*
* @return void
*/
public function testApiLoginWithAddonAuth()
{
$this->markTestIncomplete('Can we test this easily?');
}
/**
* Test the BasicAuth::getCurrentUserID() function with a correct login.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
* @doesNotPerformAssertions
*/
public function testApiLoginWithCorrectLogin()
{
BasicAuth::setCurrentUserID();
$_SERVER['PHP_AUTH_USER'] = 'Test user';
$_SERVER['PHP_AUTH_PW'] = 'password';
BasicAuth::getCurrentUserID(true);
}
/**
* Test the BasicAuth::getCurrentUserID() function with a remote user.
*
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function testApiLoginWithRemoteUser()
{
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
BasicAuth::getCurrentUserID(true);
}
/**
* Test the Arrays::walkRecursive() function.
*
* @return void
*/
public function testApiWalkRecursive()
{
$array = ['item1'];
self::assertEquals(
$array,
Arrays::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
/**
* Test the Arrays::walkRecursive() function with an array.
*
* @return void
*/
public function testApiWalkRecursiveWithArray()
{
$array = [['item1'], ['item2']];
self::assertEquals(
$array,
Arrays::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
}

1
tests/phpunit.xml
View file

@ -9,7 +9,6 @@
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
<testsuite name="friendica">
<directory suffix=".php">functional/</directory>
<directory suffix=".php">legacy/</directory>
<directory suffix=".php">src/</directory>
</testsuite>
<!-- Filters for Code Coverage -->

5
tests/src/Core/ACLTest.php
View file

@ -22,7 +22,6 @@
namespace Friendica\Test\src\Core;
use Friendica\Core\ACL;
use Friendica\Module\BaseApi;
use Friendica\Test\FixtureTest;
class ACLTest extends FixtureTest
@ -34,7 +33,7 @@ class ACLTest extends FixtureTest
*/
public function testCheckAclInput()
{
$result = ACL::isValidContact('<aclstring>', BaseApi::getCurrentUserID());
$result = ACL::isValidContact('<aclstring>', '42');
self::assertFalse($result);
}
@ -45,7 +44,7 @@ class ACLTest extends FixtureTest
*/
public function testCheckAclInputWithEmptyAclString()
{
$result = ACL::isValidContact('', BaseApi::getCurrentUserID());
$result = ACL::isValidContact('', '42');
self::assertTrue($result);
}
}

11
tests/src/Module/BaseApiTest.php
View file

@ -21,6 +21,7 @@
namespace Friendica\Test\src\Module;
use Friendica\Module\BaseApi;
use Friendica\Test\src\Module\Api\ApiTest;
class BaseApiTest extends ApiTest
@ -47,4 +48,14 @@ class BaseApiTest extends ApiTest
);
*/
}
/**
* Test the BaseApi::getCurrentUserID() function.
*
* @return void
*/
public function testApiUser()
{
self::assertEquals(parent::SELF_USER['id'], BaseApi::getCurrentUserID());
}
}

112
tests/src/Security/BasicAuthTest.php Normal file
View file

@ -0,0 +1,112 @@
<?php
/**
* @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/>.
*
*/
namespace Friendica\Test\src\Security;
use Friendica\Security\BasicAuth;
use Friendica\Test\src\Module\Api\ApiTest;
class BasicAuthTest extends ApiTest
{
/**
* Test the api_source() function.
*
* @return void
*/
public function testApiSource()
{
self::assertEquals('api', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the api_source() function with a Twidere user agent.
*
* @return void
*/
public function testApiSourceWithTwidere()
{
$_SERVER['HTTP_USER_AGENT'] = 'Twidere';
self::assertEquals('Twidere', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the api_source() function with a GET parameter.
*
* @return void
*/
public function testApiSourceWithGet()
{
$_REQUEST['source'] = 'source_name';
self::assertEquals('source_name', BasicAuth::getCurrentApplicationToken()['name']);
}
/**
* Test the BasicAuth::getCurrentUserID() function without any login.
*/
public function testApiLoginWithoutLogin()
{
self::markTestIncomplete('Needs Refactoring of BasicAuth first.');
/*
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
BasicAuth::getCurrentUserID(true);
*/
}
/**
* Test the BasicAuth::getCurrentUserID() function with a bad login.
*/
public function testApiLoginWithBadLogin()
{
self::markTestIncomplete('Needs Refactoring of BasicAuth first.');
/*
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['PHP_AUTH_USER'] = 'user@server';
BasicAuth::getCurrentUserID(true);
*/
}
/**
* Test the BasicAuth::getCurrentUserID() function with a correct login.
*/
public function testApiLoginWithCorrectLogin()
{
BasicAuth::setCurrentUserID();
$_SERVER['PHP_AUTH_USER'] = 'Test user';
$_SERVER['PHP_AUTH_PW'] = 'password';
self::assertEquals(parent::SELF_USER['id'], BasicAuth::getCurrentUserID(true));
}
/**
* Test the BasicAuth::getCurrentUserID() function with a remote user.
*/
public function testApiLoginWithRemoteUser()
{
self::markTestIncomplete('Needs Refactoring of BasicAuth first.');
/*
BasicAuth::setCurrentUserID();
$this->expectException(\Friendica\Network\HTTPException\UnauthorizedException::class);
$_SERVER['REDIRECT_REMOTE_USER'] = '123456dXNlcjpwYXNzd29yZA==';
BasicAuth::getCurrentUserID(true);
*/
}
}

38
tests/src/Util/ArraysTest.php
View file

@ -127,4 +127,42 @@ class ArraysTest extends TestCase
$str = Arrays::recursiveImplode([[1], [2, [3]]], ',');
self::assertSame($str, '{1},{2,{3}}');
}
/**
* Test the Arrays::walkRecursive() function.
*/
public function testApiWalkRecursive()
{
$array = ['item1'];
self::assertEquals(
$array,
Arrays::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
/**
* Test the Arrays::walkRecursive() function with an array.
*
* @return void
*/
public function testApiWalkRecursiveWithArray()
{
$array = [['item1'], ['item2']];
self::assertEquals(
$array,
Arrays::walkRecursive(
$array,
function () {
// Should we test this with a callback that actually does something?
return true;
}
)
);
}
}

10
tests/src/Util/DateTimeFormatTest.php
View file

@ -77,4 +77,14 @@ class DateTimeFormatTest extends MockedTest
self::assertEquals($assert, $dtFormat->isYearMonth($input));
}
/**
* Test the DateTimeFormat::API output.
*
* @return void
*/
public function testApiDate()
{
self::assertEquals('Wed Oct 10 00:00:00 +0000 1990', DateTimeFormat::utc('1990-10-10', DateTimeFormat::API));
}
}