gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor loadAndCheck()

Browse Source 
Signed-off-by: Kamil Tekiela <tekiela246@gmail.com>
This commit is contained in:
Kamil Tekiela 2025-01-03 01:36:42 +00:00
parent 1c5249ab59
commit a25527ef8d
8 changed files with 25 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/console
View File

@ -28,7 +28,7 @@ if (! class_exists(Application::class)) {
$containerBuilder = ContainerBuilder::getContainer();
$cfg['environment'] = 'production';
$config = new Config();
$config->loadAndCheck(CONFIG_FILE);
$config->loadFromFile(CONFIG_FILE);
$config->set('environment', $cfg['environment']);
$dbi = DatabaseInterface::getInstanceForTest(new DbiDummy());

6
phpstan-baseline.neon
View File

@ -355,7 +355,7 @@ parameters:
path: src/Command/CacheWarmupCommand.php
-
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadAndCheck\(\) expects string\|null, mixed given\.$#'
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadFromFile\(\) expects string\|null, mixed given\.$#'
identifier: argument.type
count: 1
path: src/Command/CacheWarmupCommand.php
@ -8470,7 +8470,7 @@ parameters:
path: src/Http/Middleware/Authentication.php
-
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadAndCheck\(\) expects string\|null, mixed given\.$#'
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadFromFile\(\) expects string\|null, mixed given\.$#'
identifier: argument.type
count: 1
path: src/Http/Middleware/ConfigLoading.php
@ -17740,7 +17740,7 @@ parameters:
path: tests/unit/ConfigTest.php
-
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadAndCheck\(\) expects string\|null, mixed given\.$#'
message: '#^Parameter \#1 \$source of method PhpMyAdmin\\Config\:\:loadFromFile\(\) expects string\|null, mixed given\.$#'
identifier: argument.type
count: 1
path: tests/unit/ConfigTest.php

2
src/Command/CacheWarmupCommand.php
View File

@ -119,7 +119,7 @@ final class CacheWarmupCommand extends Command
): int {
$output->writeln('Warming up the twig cache', OutputInterface::VERBOSITY_VERBOSE);
$config = Config::getInstance();
$config->loadAndCheck(CONFIG_FILE);
$config->loadFromFile(CONFIG_FILE);
$config->settings['environment'] = $environment;
$config->set('environment', $config->settings['environment']);
DatabaseInterface::$instance = DatabaseInterface::getInstanceForTest(new DbiDummy(), $config);

30
src/Config.php
View File

@ -140,27 +140,19 @@ class Config
*
* @throws ConfigException
*/
public function loadAndCheck(string|null $source = null): void
public function loadFromFile(string|null $source = null): void
{
if ($source !== null) {
$this->setSource($source);
}
$this->load();
// other settings, independent of config file, comes in
$this->checkSystem();
if ($this->configFileExists()) {
$this->load();
}
$this->baseSettings = $this->settings;
}
/**
* sets system and application settings
*/
public function checkSystem(): void
{
}
public function isGd2Available(): bool
{
if ($this->config->GD2Available === 'yes') {
@ -201,12 +193,8 @@ class Config
*
* @throws ConfigException
*/
public function load(): bool
private function load(): void
{
if (! $this->configFileExists()) {
return false;
}
/** @var mixed $cfg */
$cfg = [];
@ -226,12 +214,12 @@ class Config
$this->sourceMtime = (int) filemtime($this->source);
if (is_array($cfg)) {
$this->config = new Settings($cfg);
$this->settings = array_replace_recursive($this->settings, $this->config->asArray());
if (! is_array($cfg)) {
return;
}
return true;
$this->config = new Settings($cfg);
$this->settings = array_replace_recursive($this->settings, $this->config->asArray());
}
/**

2
src/Http/Middleware/ConfigLoading.php
View File

@ -28,7 +28,7 @@ final class ConfigLoading implements MiddlewareInterface
public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
{
try {
$this->config->loadAndCheck(CONFIG_FILE);
$this->config->loadFromFile(CONFIG_FILE);
} catch (ConfigException $exception) {
// Disables template caching because the cache directory is not known yet.
$this->template->disableCache();

4
tests/unit/AbstractTestCase.php
View File

@ -86,7 +86,7 @@ abstract class AbstractTestCase extends TestCase
protected function createConfig(): Config
{
$config = new Config();
$config->loadAndCheck();
$config->loadFromFile();
return $config;
}
@ -95,7 +95,7 @@ abstract class AbstractTestCase extends TestCase
{
Config::$instance = null;
$config = Config::getInstance();
$config->loadAndCheck();
$config->loadFromFile();
$config->set('environment', 'development');
}

2
tests/unit/ApplicationTest.php
View File

@ -30,7 +30,7 @@ final class ApplicationTest extends AbstractTestCase
$errorHandler = self::createStub(ErrorHandler::class);
$config = self::createMock(Config::class);
$config->expects(self::once())->method('loadAndCheck')
$config->expects(self::once())->method('loadFromFile')
->willThrowException(new ConfigException('Failed to load phpMyAdmin configuration.'));
$config->config = new Config\Settings([]);

36
tests/unit/ConfigTest.php
View File

@ -62,12 +62,12 @@ class ConfigTest extends AbstractTestCase
$_SESSION['is_git_revision'] = true;
Config::$instance = null;
$config = Config::getInstance();
$config->loadAndCheck(CONFIG_FILE);
$config->loadFromFile(CONFIG_FILE);
$config->settings['ProxyUrl'] = '';
//for testing file permissions
$this->permTestObj = new Config();
$this->permTestObj->loadAndCheck(ROOT_PATH . 'config.sample.inc.php');
$this->permTestObj->loadFromFile(ROOT_PATH . 'config.sample.inc.php');
}
/**
@ -96,7 +96,7 @@ class ConfigTest extends AbstractTestCase
// Test loading an empty file does not change the default config
$config = new Config();
$config->loadAndCheck($tmpConfig);
$config->loadFromFile($tmpConfig);
self::assertSame($defaultConfig->settings, $config->settings);
self::assertEquals($defaultConfig->getSettings(), $config->getSettings());
@ -109,7 +109,7 @@ PHP;
// Test loading a config changes the setup
$config = new Config();
$config->loadAndCheck($tmpConfig);
$config->loadFromFile($tmpConfig);
$defaultConfig->set('environment', 'development');
self::assertSame($defaultConfig->settings, $config->settings);
self::assertArrayHasKey('environment', $config->settings);
@ -200,18 +200,6 @@ PHP;
self::assertSame($config, $object->baseSettings);
}
/**
* test for CheckConfigSource
*/
public function testConfigFileExists(): void
{
$this->object->setSource('unexisted.config.php');
self::assertFalse($this->object->configFileExists());
$this->object->setSource(__DIR__ . '/../test_data/config.inc.php');
self::assertTrue($this->object->configFileExists());
}
/**
* Test getting and setting config values
*/
@ -360,24 +348,14 @@ PHP;
];
}
/**
* 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(string $source, bool $result): void
public function testConfigFileExists(string $source, bool $result): void
{
$this->object->setSource($source);
self::assertSame($result, $this->object->load());
self::assertSame($result, $this->object->configFileExists());
}
/**
* return of config Paths
*
* @return array<array{string, bool}>
*/
/** @return array<array{string, bool}> */
public static function configPaths(): array
{
return [