mirror of https://github.com/friendica/friendica
536 lines
14 KiB
PHP
536 lines
14 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (C) 2010-2023, 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\Core\Config;
|
|
|
|
use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
|
|
use Friendica\Core\Config\Capability\IManageConfigValues;
|
|
use Friendica\Core\Config\Model\Config;
|
|
use Friendica\Core\Config\Util\ConfigFileManager;
|
|
use Friendica\Core\Config\Util\ConfigFileTransformer;
|
|
use Friendica\Core\Config\ValueObject\Cache;
|
|
use Friendica\Test\MockedTest;
|
|
use Friendica\Test\Util\VFSTrait;
|
|
use org\bovigo\vfs\vfsStream;
|
|
|
|
class ConfigTest extends MockedTest
|
|
{
|
|
use ArraySubsetAsserts;
|
|
use VFSTrait;
|
|
|
|
/** @var Cache */
|
|
protected $configCache;
|
|
|
|
/** @var ConfigFileManager */
|
|
protected $configFileManager;
|
|
|
|
/** @var IManageConfigValues */
|
|
protected $testedConfig;
|
|
|
|
/**
|
|
* Assert a config tree
|
|
*
|
|
* @param string $cat The category to assert
|
|
* @param array $data The result data array
|
|
*/
|
|
protected function assertConfig(string $cat, array $data)
|
|
{
|
|
$result = $this->testedConfig->getCache()->getAll();
|
|
|
|
self::assertNotEmpty($result);
|
|
self::assertArrayHasKey($cat, $result);
|
|
self::assertArraySubset($data, $result[$cat]);
|
|
}
|
|
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->setUpVfsDir();
|
|
|
|
parent::setUp();
|
|
|
|
$this->configCache = new Cache();
|
|
$this->configFileManager = new ConfigFileManager($this->root->url(), $this->root->url() . '/config/', $this->root->url() . '/static/');
|
|
}
|
|
|
|
/**
|
|
* @return IManageConfigValues
|
|
*/
|
|
public function getInstance()
|
|
{
|
|
$this->configFileManager->setupCache($this->configCache, []);
|
|
return new Config($this->configFileManager, $this->configCache);
|
|
}
|
|
|
|
public function dataTests()
|
|
{
|
|
return [
|
|
'string' => ['data' => 'it'],
|
|
'boolTrue' => ['data' => true],
|
|
'boolFalse' => ['data' => false],
|
|
'integer' => ['data' => 235],
|
|
'decimal' => ['data' => 2.456],
|
|
'array' => ['data' => ['1', 2, '3', true, false]],
|
|
'boolIntTrue' => ['data' => 1],
|
|
'boolIntFalse' => ['Data' => 0],
|
|
];
|
|
}
|
|
|
|
public function dataConfigLoad()
|
|
{
|
|
$data = [
|
|
'system' => [
|
|
'key1' => 'value1',
|
|
'key2' => 'value2',
|
|
'key3' => 'value3',
|
|
],
|
|
'config' => [
|
|
'key1' => 'value1a',
|
|
'key4' => 'value4',
|
|
],
|
|
'other' => [
|
|
'key5' => 'value5',
|
|
'key6' => 'value6',
|
|
],
|
|
];
|
|
|
|
return [
|
|
'system' => [
|
|
'data' => $data,
|
|
'possibleCats' => [
|
|
'system',
|
|
'config',
|
|
'other'
|
|
],
|
|
'load' => [
|
|
'system',
|
|
],
|
|
],
|
|
'other' => [
|
|
'data' => $data,
|
|
'possibleCats' => [
|
|
'system',
|
|
'config',
|
|
'other'
|
|
],
|
|
'load' => [
|
|
'other',
|
|
],
|
|
],
|
|
'config' => [
|
|
'data' => $data,
|
|
'possibleCats' => [
|
|
'system',
|
|
'config',
|
|
'other'
|
|
],
|
|
'load' => [
|
|
'config',
|
|
],
|
|
],
|
|
'all' => [
|
|
'data' => $data,
|
|
'possibleCats' => [
|
|
'system',
|
|
'config',
|
|
'other'
|
|
],
|
|
'load' => [
|
|
'system',
|
|
'config',
|
|
'other'
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test the configuration initialization
|
|
* @dataProvider dataConfigLoad
|
|
*/
|
|
public function testSetUp(array $data)
|
|
{
|
|
vfsStream::newFile(ConfigFileManager::CONFIG_DATA_FILE)
|
|
->at($this->root->getChild('config'))
|
|
->setContent(ConfigFileTransformer::encode($data));
|
|
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
// assert config is loaded everytime
|
|
self::assertConfig('config', $data['config']);
|
|
}
|
|
|
|
/**
|
|
* Test the configuration reload() method
|
|
*
|
|
* @param array $data
|
|
* @param array $load
|
|
*
|
|
* @dataProvider dataConfigLoad
|
|
*/
|
|
public function testReload(array $data, array $load)
|
|
{
|
|
vfsStream::newFile(ConfigFileManager::CONFIG_DATA_FILE)
|
|
->at($this->root->getChild('config'))
|
|
->setContent(ConfigFileTransformer::encode($data));
|
|
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
$this->testedConfig->reload();
|
|
|
|
// Assert at least loaded cats are loaded
|
|
foreach ($load as $loadedCats) {
|
|
self::assertConfig($loadedCats, $data[$loadedCats]);
|
|
}
|
|
}
|
|
|
|
public function dataDoubleLoad()
|
|
{
|
|
return [
|
|
'config' => [
|
|
'data1' => [
|
|
'config' => [
|
|
'key1' => 'value1',
|
|
'key2' => 'value2',
|
|
],
|
|
],
|
|
'data2' => [
|
|
'config' => [
|
|
'key1' => 'overwritten!',
|
|
'key3' => 'value3',
|
|
],
|
|
],
|
|
'expect' => [
|
|
'config' => [
|
|
// load should overwrite values everytime!
|
|
'key1' => 'overwritten!',
|
|
'key2' => 'value2',
|
|
'key3' => 'value3',
|
|
],
|
|
],
|
|
],
|
|
'other' => [
|
|
'data1' => [
|
|
'config' => [
|
|
'key12' => 'data4',
|
|
'key45' => 7,
|
|
],
|
|
'other' => [
|
|
'key1' => 'value1',
|
|
'key2' => 'value2',
|
|
],
|
|
],
|
|
'data2' => [
|
|
'other' => [
|
|
'key1' => 'overwritten!',
|
|
'key3' => 'value3',
|
|
],
|
|
'config' => [
|
|
'key45' => 45,
|
|
'key52' => true,
|
|
]
|
|
],
|
|
'expect' => [
|
|
'other' => [
|
|
// load should overwrite values everytime!
|
|
'key1' => 'overwritten!',
|
|
'key2' => 'value2',
|
|
'key3' => 'value3',
|
|
],
|
|
'config' => [
|
|
'key12' => 'data4',
|
|
'key45' => 45,
|
|
'key52' => true,
|
|
],
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Test the configuration load() method with overwrite
|
|
*
|
|
* @dataProvider dataDoubleLoad
|
|
*/
|
|
public function testCacheLoadDouble(array $data1, array $data2, array $expect = [])
|
|
{
|
|
vfsStream::newFile(ConfigFileManager::CONFIG_DATA_FILE)
|
|
->at($this->root->getChild('config'))
|
|
->setContent(ConfigFileTransformer::encode($data1));
|
|
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
// Assert at least loaded cats are loaded
|
|
foreach ($data1 as $cat => $data) {
|
|
self::assertConfig($cat, $data);
|
|
}
|
|
|
|
vfsStream::newFile(ConfigFileManager::CONFIG_DATA_FILE)
|
|
->at($this->root->getChild('config'))
|
|
->setContent(ConfigFileTransformer::encode($data2));
|
|
|
|
$this->testedConfig->reload();
|
|
|
|
foreach ($data2 as $cat => $data) {
|
|
self::assertConfig($cat, $data);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test the configuration load without result
|
|
*/
|
|
public function testLoadWrong()
|
|
{
|
|
$this->testedConfig = new Config($this->configFileManager, new Cache());
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
self::assertEmpty($this->testedConfig->getCache()->getAll());
|
|
}
|
|
|
|
/**
|
|
* Test the configuration get() and set() methods
|
|
*
|
|
* @dataProvider dataTests
|
|
*/
|
|
public function testSetGet($data)
|
|
{
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
self::assertTrue($this->testedConfig->set('test', 'it', $data));
|
|
|
|
self::assertEquals($data, $this->testedConfig->get('test', 'it'));
|
|
self::assertEquals($data, $this->testedConfig->getCache()->get('test', 'it'));
|
|
}
|
|
|
|
/**
|
|
* Test the configuration get() method with wrong value and no db
|
|
*/
|
|
public function testGetWrongWithoutDB()
|
|
{
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
// without refresh
|
|
self::assertNull($this->testedConfig->get('test', 'it'));
|
|
|
|
/// beware that the cache returns '!<unset>!' and not null for a non existing value
|
|
self::assertNull($this->testedConfig->getCache()->get('test', 'it'));
|
|
|
|
// with default value
|
|
self::assertEquals('default', $this->testedConfig->get('test', 'it', 'default'));
|
|
|
|
// with default value and refresh
|
|
self::assertEquals('default', $this->testedConfig->get('test', 'it', 'default', true));
|
|
}
|
|
|
|
/**
|
|
* Test the configuration delete() method without a model/db
|
|
*
|
|
* @dataProvider dataTests
|
|
*/
|
|
public function testDelete($data)
|
|
{
|
|
$this->configCache->load(['test' => ['it' => $data]], Cache::SOURCE_FILE);
|
|
|
|
$this->testedConfig = new Config($this->configFileManager, $this->configCache);
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
self::assertEquals($data, $this->testedConfig->get('test', 'it'));
|
|
self::assertEquals($data, $this->testedConfig->getCache()->get('test', 'it'));
|
|
|
|
self::assertTrue($this->testedConfig->delete('test', 'it'));
|
|
self::assertNull($this->testedConfig->get('test', 'it'));
|
|
self::assertNull($this->testedConfig->getCache()->get('test', 'it'));
|
|
|
|
self::assertEmpty($this->testedConfig->getCache()->getAll());
|
|
}
|
|
|
|
/**
|
|
* Test the configuration get() and set() method where the db value has a higher prio than the config file
|
|
*/
|
|
public function testSetGetHighPrio()
|
|
{
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
|
|
$this->testedConfig->getCache()->set('config', 'test', 'prio', Cache::SOURCE_FILE);
|
|
self::assertEquals('prio', $this->testedConfig->get('config', 'test'));
|
|
|
|
// now you have to get the new variable entry because of the new set the get refresh succeed as well
|
|
self::assertTrue($this->testedConfig->set('config', 'test', '123'));
|
|
self::assertEquals('123', $this->testedConfig->get('config', 'test', '', true));
|
|
}
|
|
|
|
/**
|
|
* Test the configuration get() and set() method where the db value has a lower prio than the env
|
|
*/
|
|
public function testSetGetLowPrio()
|
|
{
|
|
vfsStream::newFile(ConfigFileManager::CONFIG_DATA_FILE)
|
|
->at($this->root->getChild('config'))
|
|
->setContent(ConfigFileTransformer::encode([
|
|
'config' => ['test' => 'it'],
|
|
]));
|
|
|
|
$this->testedConfig = $this->getInstance();
|
|
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
|
|
self::assertEquals('it', $this->testedConfig->get('config', 'test'));
|
|
|
|
$this->testedConfig->getCache()->set('config', 'test', 'prio', Cache::SOURCE_ENV);
|
|
// now you have to get the env variable entry as output, even with a new set (which failed) and a get refresh
|
|
self::assertFalse($this->testedConfig->set('config', 'test', '123'));
|
|
self::assertEquals('prio', $this->testedConfig->get('config', 'test', '', true));
|
|
}
|
|
|
|
|
|
public function dataTestCat()
|
|
{
|
|
return [
|
|
'test_with_hashmap' => [
|
|
'data' => [
|
|
'test_with_hashmap' => [
|
|
'notifyall' => [
|
|
'last_update' => 1671051565,
|
|
'admin' => true,
|
|
],
|
|
'blockbot' => [
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
'config' => [
|
|
'register_policy' => 2,
|
|
'register_text' => '',
|
|
'sitename' => 'Friendica Social Network23',
|
|
'hostname' => 'friendica.local',
|
|
'private_addons' => false,
|
|
],
|
|
'system' => [
|
|
'dbclean_expire_conversation' => 90,
|
|
],
|
|
],
|
|
'cat' => 'test_with_hashmap',
|
|
'assertion' => [
|
|
'notifyall' => [
|
|
'last_update' => 1671051565,
|
|
'admin' => true,
|
|
],
|
|
'blockbot' => [
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
],
|
|
'test_with_keys' => [
|
|
'data' => [
|
|
'test_with_keys' => [
|
|
[
|
|
'last_update' => 1671051565,
|
|
'admin' => true,
|
|
],
|
|
[
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
'config' => [
|
|
'register_policy' => 2,
|
|
'register_text' => '',
|
|
'sitename' => 'Friendica Social Network23',
|
|
'hostname' => 'friendica.local',
|
|
'private_addons' => false,
|
|
],
|
|
'system' => [
|
|
'dbclean_expire_conversation' => 90,
|
|
],
|
|
],
|
|
'cat' => 'test_with_keys',
|
|
'assertion' => [
|
|
[
|
|
'last_update' => 1671051565,
|
|
'admin' => true,
|
|
],
|
|
[
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
],
|
|
'test_with_inner_array' => [
|
|
'data' => [
|
|
'test_with_inner_array' => [
|
|
'notifyall' => [
|
|
'last_update' => 1671051565,
|
|
'admin' => [
|
|
'yes' => true,
|
|
'no' => 1.5,
|
|
],
|
|
],
|
|
'blogbot' => [
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
'config' => [
|
|
'register_policy' => 2,
|
|
'register_text' => '',
|
|
'sitename' => 'Friendica Social Network23',
|
|
'hostname' => 'friendica.local',
|
|
'private_addons' => false,
|
|
],
|
|
'system' => [
|
|
'dbclean_expire_conversation' => 90,
|
|
],
|
|
],
|
|
'cat' => 'test_with_inner_array',
|
|
'assertion' => [
|
|
'notifyall' => [
|
|
'last_update' => 1671051565,
|
|
'admin' => [
|
|
'yes' => true,
|
|
'no' => 1.5,
|
|
],
|
|
],
|
|
'blogbot' => [
|
|
'last_update' => 1658952852,
|
|
'admin' => true,
|
|
],
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider dataTestCat
|
|
*/
|
|
public function testGetCategory(array $data, string $category, array $assertion)
|
|
{
|
|
$this->configCache = new Cache($data);
|
|
$config = new Config($this->configFileManager, $this->configCache);
|
|
|
|
self::assertEquals($assertion, $config->get($category));
|
|
}
|
|
}
|