phpmyadmin/test/classes/ConfigTest.php
William Desportes 49a6d6e8d0
Use AbstractTestCase instead of PmaTestCase for all tests not needing mockResponse
Signed-off-by: William Desportes <williamdes@wdes.fr>
2020-05-22 01:45:50 +02:00

1212 lines
31 KiB
PHP

<?php
/**
* Test for PhpMyAdmin\Config class
*
* @group current
*/
declare(strict_types=1);
namespace PhpMyAdmin\Tests;
use PhpMyAdmin\Config;
use PHPUnit\Framework\Exception;
use const DIRECTORY_SEPARATOR;
use const INFO_MODULES;
use const PHP_OS;
use function array_merge;
use function array_replace_recursive;
use function constant;
use function define;
use function defined;
use function filemtime;
use function fileperms;
use function function_exists;
use function gd_info;
use function mb_strstr;
use function ob_end_clean;
use function ob_get_contents;
use function ob_start;
use function phpinfo;
use function preg_match;
use function realpath;
use function strip_tags;
use function stristr;
use function sys_get_temp_dir;
/**
* Tests behaviour of PhpMyAdmin\Config class
*/
class ConfigTest extends AbstractTestCase
{
/**
* Turn off backup globals
*/
protected $backupGlobals = false;
/** @var Config */
protected $object;
/** @var Config to test file permission */
protected $permTestObj;
/**
* Sets up the fixture, for example, opens a network connection.
* This method is called before a test is executed.
*/
protected function setUp(): void
{
parent::setUp();
parent::defineVersionConstants();
parent::setTheme();
$_SERVER['HTTP_USER_AGENT'] = '';
$this->object = new Config();
$GLOBALS['server'] = 0;
$_SESSION['git_location'] = '.git';
$_SESSION['is_git_revision'] = true;
$GLOBALS['PMA_Config'] = new Config(CONFIG_FILE);
$GLOBALS['cfg']['ProxyUrl'] = '';
//for testing file permissions
$this->permTestObj = new Config(ROOT_PATH . 'config.sample.inc.php');
}
/**
* Tears down the fixture, for example, closes a network connection.
* This method is called after a test is executed.
*/
protected function tearDown(): void
{
parent::tearDown();
unset($this->object);
unset($this->permTestObj);
}
/**
* Test for CheckSystem
*
* @return void
*
* @group medium
*/
public function testCheckSystem()
{
$this->object->checkSystem();
$this->assertNotEmpty($this->object->get('PMA_VERSION'));
$this->assertNotEmpty($this->object->get('PMA_MAJOR_VERSION'));
}
/**
* Test for checkOutputCompression
*
* @return void
*/
public function testCheckOutputCompression()
{
$this->object->set('OBGzip', 'auto');
$this->object->set('PMA_USR_BROWSER_AGENT', 'IE');
$this->object->set('PMA_USR_BROWSER_VER', 6);
$this->object->checkOutputCompression();
$this->assertTrue($this->object->get('OBGzip'));
$this->object->set('OBGzip', 'auto');
$this->object->set('PMA_USR_BROWSER_AGENT', 'MOZILLA');
$this->object->set('PMA_USR_BROWSER_VER', 5);
$this->object->checkOutputCompression();
$this->assertTrue($this->object->get('OBGzip'));
}
/**
* Tests client parsing code.
*
* @param string $agent User agent string
* @param string $os Expected parsed OS (or null if none)
* @param string $browser Expected parsed browser (or null if none)
* @param string $version Expected browser version (or null if none)
*
* @dataProvider userAgentProvider
*/
public function testCheckClient($agent, $os, $browser = null, $version = null): void
{
$_SERVER['HTTP_USER_AGENT'] = $agent;
$this->object->checkClient();
$this->assertEquals($os, $this->object->get('PMA_USR_OS'));
if ($os != null) {
$this->assertEquals(
$browser,
$this->object->get('PMA_USR_BROWSER_AGENT')
);
}
if ($version != null) {
$this->assertEquals(
$version,
$this->object->get('PMA_USR_BROWSER_VER')
);
}
}
/**
* user Agent Provider
*
* @return array
*/
public function userAgentProvider()
{
return [
[
'Opera/9.80 (X11; Linux x86_64; U; pl) Presto/2.7.62 Version/11.00',
'Linux',
'OPERA',
'9.80',
],
[
'Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US) AppleWebKit/'
. '528.16 OmniWeb/622.8.0.112941',
'Mac',
'OMNIWEB',
'622',
],
[
'Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 5.1)',
'Win',
'IE',
'8.0',
],
[
'Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; Trident/5.0)',
'Win',
'IE',
'9.0',
],
[
'Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; Win64; x64; '
. 'Trident/6.0)',
'Win',
'IE',
'10.0',
],
[
'Mozilla/5.0 (IE 11.0; Windows NT 6.3; Trident/7.0; .NET4.0E; '
. '.NET4.0C; rv:11.0) like Gecko',
'Win',
'IE',
'11.0',
],
[
'Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; .NET4.0E; '
. '.NET4.0C; .NET CLR 3.5.30729; .NET CLR 2.0.50727; '
. '.NET CLR 3.0.30729; InfoPath.3; rv:11.0) like Gecko',
'Win',
'IE',
'11.0',
],
[
'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.22 (KHTML, '
. 'like Gecko) Chrome/25.0.1364.172 Safari/537.22',
'Win',
'CHROME',
'25.0.1364.172',
],
[
'Mozilla/5.0 (Unknown; U; Unix BSD/SYSV system; C -) '
. 'AppleWebKit/527+ (KHTML, like Gecko, Safari/419.3) Arora/0.10.2',
'Unix',
'SAFARI',
'5.0.419',
],
[
'Mozilla/5.0 (Windows; U; Win95; en-US; rv:1.9b) Gecko/20031208',
'Win',
'GECKO',
'1.9',
],
[
'Mozilla/5.0 (compatible; Konqueror/4.5; NetBSD 5.0.2; X11; '
. 'amd64; en_US) KHTML/4.5.4 (like Gecko)',
'Other',
'KONQUEROR',
],
[
'Mozilla/5.0 (X11; Linux x86_64; rv:5.0) Gecko/20100101 Firefox/5.0',
'Linux',
'FIREFOX',
'5.0',
],
[
'Mozilla/5.0 (X11; Linux x86_64; rv:12.0) Gecko/20100101 '
. 'Firefox/12.0',
'Linux',
'FIREFOX',
'12.0',
],
/**
* @todo Is this version really expected?
*/
[
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/535.4+ (KHTML, like G'
. 'ecko) Version/5.0 Safari/535.4+ SUSE/12.1 (3.2.1) Epiphany/3.2.1',
'Linux',
'SAFARI',
'5.0',
],
];
}
/**
* test for CheckGd2
*
* @return void
*/
public function testCheckGd2()
{
$prevIsGb2Val = $this->object->get('PMA_IS_GD2');
$this->object->set('GD2Available', 'yes');
$this->object->checkGd2();
$this->assertEquals(1, $this->object->get('PMA_IS_GD2'));
$this->object->set('GD2Available', 'no');
$this->object->checkGd2();
$this->assertEquals(0, $this->object->get('PMA_IS_GD2'));
$this->object->set('GD2Available', 'auto');
if (! function_exists('imagecreatetruecolor')) {
$this->object->checkGd2();
$this->assertEquals(
0,
$this->object->get('PMA_IS_GD2'),
'imagecreatetruecolor does not exist, PMA_IS_GD2 should be 0'
);
}
if (function_exists('gd_info')) {
$this->object->checkGd2();
$gd_nfo = gd_info();
if (mb_strstr($gd_nfo['GD Version'], '2.')) {
$this->assertEquals(
1,
$this->object->get('PMA_IS_GD2'),
'GD Version >= 2, PMA_IS_GD2 should be 1'
);
} else {
$this->assertEquals(
0,
$this->object->get('PMA_IS_GD2'),
'GD Version < 2, PMA_IS_GD2 should be 0'
);
}
}
/* Get GD version string from phpinfo output */
ob_start();
phpinfo(INFO_MODULES); /* Only modules */
$a = strip_tags(ob_get_contents());
ob_end_clean();
if (preg_match('@GD Version[[:space:]]*\(.*\)@', $a, $v)) {
if (mb_strstr($v, '2.')) {
$this->assertEquals(
1,
$this->object->get('PMA_IS_GD2'),
'PMA_IS_GD2 should be 1'
);
} else {
$this->assertEquals(
0,
$this->object->get('PMA_IS_GD2'),
'PMA_IS_GD2 should be 0'
);
}
}
}
/**
* Web server detection test
*
* @param string $server Server identification
* @param bool $iis Whether server should be detected as IIS
*
* @dataProvider serverNames
*/
public function testCheckWebServer($server, $iis): void
{
$_SERVER['SERVER_SOFTWARE'] = $server;
$this->object->checkWebServer();
$this->assertEquals($iis, $this->object->get('PMA_IS_IIS'));
unset($_SERVER['SERVER_SOFTWARE']);
}
/**
* return server names
*
* @return array
*/
public function serverNames()
{
return [
[
'Microsoft-IIS 7.0',
1,
],
[
'Apache/2.2.17',
0,
],
];
}
/**
* test for CheckWebServerOs
*
* @return void
*/
public function testCheckWebServerOs()
{
$this->object->checkWebServerOs();
if (defined('PHP_OS')) {
if (stristr(PHP_OS, 'darwin')) {
$this->assertEquals(false, $this->object->get('PMA_IS_WINDOWS'));
} elseif (stristr(PHP_OS, 'win')) {
$this->assertEquals(true, $this->object->get('PMA_IS_WINDOWS'));
} elseif (stristr(PHP_OS, 'OS/2')) {
$this->assertEquals(true, $this->object->get('PMA_IS_WINDOWS'));
} elseif (stristr(PHP_OS, 'Linux')) {
$this->assertEquals(false, $this->object->get('PMA_IS_WINDOWS'));
} else {
$this->markTestIncomplete('Not known PHP_OS: ' . PHP_OS);
}
} else {
$this->assertEquals(0, $this->object->get('PMA_IS_WINDOWS'));
define('PHP_OS', 'Windows');
$this->assertEquals(true, $this->object->get('PMA_IS_WINDOWS'));
}
}
/**
* Tests loading of default values
*
* @return void
*
* @group large
*/
public function testLoadDefaults()
{
$prevDefaultSource = $this->object->default_source;
$this->object->default_source = 'unexisted.file.php';
$this->assertFalse($this->object->loadDefaults());
$this->object->default_source = $prevDefaultSource;
/** @var array<string,mixed> $cfg */
$cfg = [];
include $this->object->default_source;
$loadedConf = $cfg;
unset($cfg);
$this->assertTrue($this->object->loadDefaults());
$this->assertEquals(
$this->object->default_source_mtime,
filemtime($prevDefaultSource)
);
$this->assertEquals(
$loadedConf['Servers'][1],
$this->object->default_server
);
unset($loadedConf['Servers']);
$this->assertEquals($loadedConf, $this->object->default);
$expectedSettings = array_replace_recursive(
$this->object->settings,
$loadedConf
);
$this->assertEquals(
$expectedSettings,
$this->object->settings,
'Settings loaded wrong'
);
$this->assertFalse($this->object->error_config_default_file);
}
/**
* test for CheckConfigSource
*
* @return void
*/
public function testCheckConfigSource()
{
$this->object->setSource('unexisted.config.php');
$this->assertFalse($this->object->checkConfigSource());
$this->assertEquals(0, $this->object->source_mtime);
$this->object->setSource(ROOT_PATH . 'libraries/config.default.php');
$this->assertNotEmpty($this->object->getSource());
$this->assertTrue($this->object->checkConfigSource());
}
/**
* Test getting and setting config values
*
* @return void
*/
public function testGetAndSet()
{
$this->assertNull($this->object->get('unresisting_setting'));
$this->object->set('test_setting', 'test_value');
$this->assertEquals('test_value', $this->object->get('test_setting'));
}
/**
* Tests setting configuration source
*
* @return void
*/
public function testGetSetSource()
{
echo $this->object->getSource();
$this->assertEmpty($this->object->getSource(), 'Source is null by default');
$this->object->setSource(ROOT_PATH . 'config.sample.inc.php');
$this->assertEquals(
ROOT_PATH . 'config.sample.inc.php',
$this->object->getSource(),
'Cant set new source'
);
}
/**
* test for IsHttp
*
* @param string $scheme http scheme
* @param string $https https
* @param string $forwarded forwarded header
* @param string $uri request uri
* @param string $lb http https from lb
* @param string $front http front end https
* @param string $proto http x forwarded proto
* @param string $protoCloudFront http cloudfront forwarded proto
* @param string $pmaAbsoluteUri phpMyAdmin absolute URI
* @param int $port server port
* @param bool $expected expected result
*
* @dataProvider httpsParams
*/
public function testIsHttps(
$scheme,
$https,
string $forwarded,
$uri,
$lb,
$front,
$proto,
$protoCloudFront,
$pmaAbsoluteUri,
$port,
$expected
): void {
$_SERVER['HTTP_SCHEME'] = $scheme;
$_SERVER['HTTPS'] = $https;
$_SERVER['HTTP_FORWARDED'] = $forwarded;
$_SERVER['REQUEST_URI'] = $uri;
$_SERVER['HTTP_HTTPS_FROM_LB'] = $lb;
$_SERVER['HTTP_FRONT_END_HTTPS'] = $front;
$_SERVER['HTTP_X_FORWARDED_PROTO'] = $proto;
$_SERVER['HTTP_CLOUDFRONT_FORWARDED_PROTO'] = $protoCloudFront;
$_SERVER['SERVER_PORT'] = $port;
$this->object->set('is_https', null);
$this->object->set('PmaAbsoluteUri', $pmaAbsoluteUri);
$this->assertEquals($expected, $this->object->isHttps());
}
/**
* Data provider for https detection
*
* @return array
*/
public function httpsParams()
{
return [
[
'http',
'',
'',
'',
'',
'',
'http',
'',
'',
80,
false,
],
[
'http',
'',
'',
'http://',
'',
'',
'http',
'',
'',
80,
false,
],
[
'http',
'',
'',
'',
'',
'',
'http',
'',
'',
443,
true,
],
[
'http',
'',
'',
'',
'',
'',
'https',
'',
'',
80,
true,
],
[
'http',
'',
'',
'',
'',
'on',
'http',
'',
'',
80,
true,
],
[
'http',
'',
'',
'',
'on',
'',
'http',
'',
'',
80,
true,
],
[
'http',
'',
'',
'https://',
'',
'',
'http',
'',
'',
80,
true,
],
[
'http',
'on',
'',
'',
'',
'',
'http',
'',
'',
80,
true,
],
[
'https',
'',
'',
'',
'',
'',
'http',
'',
'',
80,
true,
],
[
'http',
'',
'',
'',
'',
'',
'',
'https',
'',
80,
true,
],
[
'http',
'',
'',
'',
'',
'',
'https',
'http',
'',
80,
true,
],
[
'https',
'',
'',
'',
'',
'',
'',
'',
'',
80,
true,
],
[
'http',
'',
'',
'',
'',
'',
'',
'',
'',
8080,
false,
],
[
'',
'',
'',
'',
'',
'',
'',
'',
'https://127.0.0.1',
80,
true,
],
[
'',
'',
'',
'',
'',
'',
'',
'',
'http://127.0.0.1',
80,
false,
],
[
'',
'',
'for=12.34.56.78;host=example.com;proto=https, for=23.45.67.89',
'',
'',
'',
'',
'',
'http://127.0.0.1',
80,
true,
],
];
}
/**
* Test for backward compatibility globals
*
* @return void
*
* @depends testCheckSystem
* @depends testCheckWebServer
* @depends testLoadDefaults
*
* @group large
*/
public function testEnableBc()
{
$this->object->enableBc();
$defines = [
'PMA_VERSION',
'PMA_MAJOR_VERSION',
'PMA_IS_WINDOWS',
'PMA_IS_GD2',
'PMA_USR_OS',
'PMA_USR_BROWSER_VER',
'PMA_USR_BROWSER_AGENT',
];
foreach ($defines as $define) {
$this->assertTrue(defined($define));
$this->assertEquals(constant($define), $this->object->get($define));
}
}
/**
* Test for getting root path
*
* @param string $request The request URL used for phpMyAdmin
* @param string $absolute The absolute URL used for phpMyAdmin
* @param string $expected Expected root path
*
* @dataProvider rootUris
*/
public function testGetRootPath($request, $absolute, $expected): void
{
$GLOBALS['PMA_PHP_SELF'] = $request;
$this->object->set('PmaAbsoluteUri', $absolute);
$this->assertEquals($expected, $this->object->getRootPath());
}
/**
* Data provider for testGetRootPath
*
* @return array data for testGetRootPath
*/
public function rootUris()
{
return [
[
'',
'',
'/',
],
[
'/',
'',
'/',
],
[
'/index.php',
'',
'/',
],
[
'\\index.php',
'',
'/',
],
[
'\\',
'',
'/',
],
[
'\\path\\to\\index.php',
'',
'/path/to/',
],
[
'/foo/bar/phpmyadmin/index.php',
'',
'/foo/bar/phpmyadmin/',
],
[
'/foo/bar/phpmyadmin/',
'',
'/foo/bar/phpmyadmin/',
],
[
'https://example.net/baz/phpmyadmin/',
'',
'/baz/phpmyadmin/',
],
[
'http://example.net/baz/phpmyadmin/',
'',
'/baz/phpmyadmin/',
],
[
'http://example.net/phpmyadmin/',
'',
'/phpmyadmin/',
],
[
'http://example.net/',
'',
'/',
],
[
'http://example.net/',
'http://example.net/phpmyadmin/',
'/phpmyadmin/',
],
[
'http://example.net/',
'http://example.net/phpmyadmin',
'/phpmyadmin/',
],
[
'http://example.net/',
'/phpmyadmin2',
'/phpmyadmin2/',
],
[
'http://example.net/',
'/phpmyadmin3/',
'/phpmyadmin3/',
],
];
}
/**
* Tests loading of config file
*
* @param string $source File name of config to load
* @param bool $result Expected result of loading
*
* @dataProvider configPaths
*/
public function testLoad($source, $result): void
{
if ($result) {
$this->assertTrue($this->object->load($source));
} else {
$this->assertFalse($this->object->load($source));
}
}
/**
* return of config Paths
*
* @return array
*/
public function configPaths()
{
return [
[
ROOT_PATH . 'test/test_data/config.inc.php',
true,
],
[
ROOT_PATH . 'test/test_data/config-nonexisting.inc.php',
false,
],
[
ROOT_PATH . 'libraries/config.default.php',
true,
],
];
}
/**
* Test for loading user preferences
*
* @return void
*
* @todo Test actually preferences loading
* @doesNotPerformAssertions
*/
public function testLoadUserPreferences()
{
$this->object->loadUserPreferences();
}
/**
* Test for setting user config value
*
* @return void
*/
public function testSetUserValue()
{
$this->object->setUserValue(null, 'lang', 'cs', 'en');
$this->object->setUserValue('TEST_COOKIE_USER_VAL', '', 'cfg_val_1');
$this->assertEquals(
$this->object->getUserValue('TEST_COOKIE_USER_VAL', 'fail'),
'cfg_val_1'
);
}
/**
* Test for getting user config value
*
* @return void
*/
public function testGetUserValue()
{
$this->assertEquals($this->object->getUserValue('test_val', 'val'), 'val');
}
/**
* Should test getting unique value for theme
*
* @return void
*/
public function testGetThemeUniqueValue()
{
$partial_sum = $this->object->source_mtime +
$this->object->default_source_mtime +
$this->object->get('user_preferences_mtime') +
$GLOBALS['PMA_Theme']->mtime_info +
$GLOBALS['PMA_Theme']->filesize_info;
$this->assertEquals($partial_sum, $this->object->getThemeUniqueValue());
}
/**
* Should test checking of config permissions
*
* @return void
*/
public function testCheckPermissions()
{
//load file permissions for the current permissions file
$perms = @fileperms($this->object->getSource());
//testing for permissions for no configuration file
$this->assertFalse(! ($perms === false) && ($perms & 2));
//load file permissions for the current permissions file
$perms = @fileperms($this->permTestObj->getSource());
if (! ($perms === false) && ($perms & 2)) {
$this->assertTrue((bool) $this->permTestObj->get('PMA_IS_WINDOWS'));
} else {
$this->assertFalse((bool) $this->permTestObj->get('PMA_IS_WINDOWS'));
}
}
/**
* Test for setting cookies
*
* @return void
*/
public function testSetCookie()
{
$this->object->set('is_https', false);
$this->assertFalse(
$this->object->setCookie(
'TEST_DEF_COOKIE',
'test_def_123',
'test_def_123'
)
);
$this->assertTrue(
$this->object->setCookie(
'TEST_CONFIG_COOKIE',
'test_val_123',
null,
3600
)
);
$this->assertTrue(
$this->object->setCookie(
'TEST_CONFIG_COOKIE',
'',
'default_val'
)
);
$_COOKIE['TEST_MANUAL_COOKIE'] = 'some_test_val';
$this->assertTrue(
$this->object->setCookie(
'TEST_MANUAL_COOKIE',
'other',
'other'
)
);
}
/**
* Test for getTempDir
*
* @group file-system
*/
public function testGetTempDir(): void
{
$this->object->set('TempDir', sys_get_temp_dir() . DIRECTORY_SEPARATOR);
// Check no double slash is here
$this->assertEquals(
sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'upload',
$this->object->getTempDir('upload')
);
}
/**
* Test for getUploadTempDir
*
* @group file-system
*/
public function testGetUploadTempDir(): void
{
$this->object->set('TempDir', realpath(sys_get_temp_dir()) . DIRECTORY_SEPARATOR);
$this->assertEquals(
$this->object->getTempDir('upload'),
$this->object->getUploadTempDir()
);
}
/**
* Test for checkServers
*
* @param array $settings settings array
* @param array $expected expected result
* @param bool $error error
*
* @dataProvider serverSettingsProvider
*/
public function testCheckServers($settings, $expected, $error = false): void
{
if ($error) {
$this->expectException(Exception::class);
}
$this->object->settings['Servers'] = $settings;
$this->object->checkServers();
if ($expected === null) {
$expected = $this->object->default_server;
} else {
$expected = array_merge($this->object->default_server, $expected);
}
$this->assertEquals($expected, $this->object->settings['Servers'][1]);
}
/**
* Data provider for checkServers test
*
* @return array
*/
public function serverSettingsProvider()
{
return [
'empty' => [
[],
[],
],
'only_host' => [
[1 => ['host' => '127.0.0.1']],
['host' => '127.0.0.1'],
],
'empty_host' => [
[1 => ['host' => '']],
[
'verbose' => 'Server 1',
'host' => '',
],
],
'invalid' => [
['invalid' => ['host' => '127.0.0.1']],
['host' => '127.0.0.1'],
true,
],
];
}
/**
* Test for selectServer
*
* @param array $settings settings array
* @param string $request request
* @param int $expected expected result
*
* @dataProvider selectServerProvider
* @depends testCheckServers
*/
public function testSelectServer($settings, $request, $expected): void
{
$this->object->settings['Servers'] = $settings;
$this->object->checkServers();
$_REQUEST['server'] = $request;
$this->assertEquals($expected, $this->object->selectServer());
}
/**
* Data provider for selectServer test
*
* @return array
*/
public function selectServerProvider()
{
return [
'zero' => [
[],
'0',
1,
],
'number' => [
[1 => []],
'1',
1,
],
'host' => [
[2 => ['host' => '127.0.0.1']],
'127.0.0.1',
2,
],
'verbose' => [
[
1 => [
'verbose' => 'Server 1',
'host' => '',
],
],
'Server 1',
1,
],
'md5' => [
[
66 => [
'verbose' => 'Server 1',
'host' => '',
],
],
'753f173bd4ac8a45eae0fe9a4fbe0fc0',
66,
],
'nonexisting_string' => [
[1 => []],
'invalid',
1,
],
'nonexisting' => [
[1 => []],
'100',
1,
],
];
}
}