Friendica/friendica-github
1
0
Fork 0
mirror of https://github.com/friendica/friendica synced 2024-12-22 08:00:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
friendica-github/tests/PConfigTestCase.php
Art4 75fee6784e Rename PConfigTest to PConfigTestCase
2024-12-15 16:13:53 +00:00

481 lines
12 KiB
PHP
Raw Permalink Blame History

<?php
// Copyright (C) 2010-2024, the Friendica project
// SPDX-FileCopyrightText: 2010-2024 the Friendica project
//
// SPDX-License-Identifier: AGPL-3.0-or-later
namespace Friendica\Test;
use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
use Friendica\Core\PConfig\Type\AbstractPConfigValues;
use Friendica\Core\PConfig\Repository\PConfig as PConfigModel;
use Friendica\Core\PConfig\ValueObject\Cache;
use Mockery;
use Mockery\MockInterface;
abstract class PConfigTestCase extends MockedTestCase
{
use ArraySubsetAsserts;
/** @var PConfigModel|MockInterface */
protected $configModel;
/** @var Cache */
protected $configCache;
/** @var AbstractPConfigValues */
protected $testedConfig;
/**
* Assert a config tree
*
* @param int $uid The uid to assert
* @param string $cat The category to assert
* @param array $data The result data array
*/
protected function assertConfig(int $uid, string $cat, array $data)
{
$result = $this->testedConfig->getCache()->getAll();
self::assertNotEmpty($result);
self::assertArrayHasKey($uid, $result);
self::assertArrayHasKey($cat, $result[$uid]);
self::assertArraySubset($data, $result[$uid][$cat]);
}
protected function setUp(): void
{
parent::setUp();
// Create the config model
$this->configModel = Mockery::mock(PConfigModel::class);
$this->configCache = new Cache();
}
/**
* @return \Friendica\Core\PConfig\Type\AbstractPConfigValues
*/
abstract public function getInstance();
public function dataTests()
{
return [
'string' => ['uid' => 1, 'data' => 'it'],
'boolTrue' => ['uid' => 2, 'data' => true],
'boolFalse' => ['uid' => 3, 'data' => false],
'integer' => ['uid' => 4, 'data' => 235],
'decimal' => ['uid' => 5, 'data' => 2.456],
'array' => ['uid' => 6, 'data' => ['1', 2, '3', true, false]],
'boolIntTrue' => ['uid' => 7, 'data' => 1],
'boolIntFalse' => ['uid' => 8, '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' => [
'uid' => 1,
'data' => $data,
'possibleCats' => [
'system',
'config',
'other'
],
'load' => [
'system',
],
],
'other' => [
'uid' => 2,
'data' => $data,
'possibleCats' => [
'system',
'config',
'other'
],
'load' => [
'other',
],
],
'config' => [
'uid' => 3,
'data' => $data,
'possibleCats' => [
'system',
'config',
'other'
],
'load' => [
'config',
],
],
'all' => [
'uid' => 4,
'data' => $data,
'possibleCats' => [
'system',
'config',
'other'
],
'load' => [
'system',
'config',
'other'
],
],
];
}
/**
* Test the configuration initialization
*/
public function testSetUp()
{
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
self::assertEmpty($this->testedConfig->getCache()->getAll());
}
/**
* Test the configuration load() method
*/
public function testLoad(int $uid, array $data, array $possibleCats, array $load)
{
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
foreach ($load as $loadedCats) {
$this->testedConfig->load($uid, $loadedCats);
}
// Assert at least loaded cats are loaded
foreach ($load as $loadedCats) {
self::assertConfig($uid, $loadedCats, $data[$loadedCats]);
}
}
public function dataDoubleLoad()
{
return [
'config' => [
'uid' => 1,
'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' => [
'uid' => 1,
'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
*/
public function testCacheLoadDouble(int $uid, array $data1, array $data2, array $expect)
{
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
foreach ($data1 as $cat => $data) {
$this->testedConfig->load($uid, $cat);
}
// Assert at least loaded cats are loaded
foreach ($data1 as $cat => $data) {
self::assertConfig($uid, $cat, $data);
}
foreach ($data2 as $cat => $data) {
$this->testedConfig->load($uid, $cat);
}
}
/**
* Test the configuration get() and set() methods without adapter
*
* @dataProvider dataTests
*/
public function testSetGetWithoutDB(int $uid, $data)
{
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
self::assertTrue($this->testedConfig->set($uid, 'test', 'it', $data));
self::assertEquals($data, $this->testedConfig->get($uid, 'test', 'it'));
self::assertEquals($data, $this->testedConfig->getCache()->get($uid, 'test', 'it'));
}
/**
* Test the configuration get() and set() methods with a model/db
*
* @dataProvider dataTests
*/
public function testSetGetWithDB(int $uid, $data)
{
$this->configModel->shouldReceive('set')
->with($uid, 'test', 'it', $data)
->andReturn(true)
->once();
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
self::assertTrue($this->testedConfig->set($uid, 'test', 'it', $data));
self::assertEquals($data, $this->testedConfig->get($uid, 'test', 'it'));
self::assertEquals($data, $this->testedConfig->getCache()->get($uid, '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(0, 'test', 'it'));
/// beware that the cache returns '!<unset>!' and not null for a nonexistent value
self::assertNull($this->testedConfig->getCache()->get(0, 'test', 'it'));
// with default value
self::assertEquals('default', $this->testedConfig->get(0, 'test', 'it', 'default'));
// with default value and refresh
self::assertEquals('default', $this->testedConfig->get(0, 'test', 'it', 'default', true));
}
/**
* Test the configuration get() method with refresh
*
* @dataProvider dataTests
*/
public function testGetWithRefresh(int $uid, $data)
{
$this->configCache->load($uid, ['test' => ['it' => 'now']]);
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
// without refresh
self::assertEquals('now', $this->testedConfig->get($uid, 'test', 'it'));
self::assertEquals('now', $this->testedConfig->getCache()->get($uid, 'test', 'it'));
// with refresh
self::assertEquals($data, $this->testedConfig->get($uid, 'test', 'it', null, true));
self::assertEquals($data, $this->testedConfig->getCache()->get($uid, 'test', 'it'));
// without refresh and wrong value and default
self::assertEquals('default', $this->testedConfig->get($uid, 'test', 'not', 'default'));
self::assertNull($this->testedConfig->getCache()->get($uid, 'test', 'not'));
}
/**
* Test the configuration delete() method without a model/db
*
* @dataProvider dataTests
*/
public function testDeleteWithoutDB(int $uid, $data)
{
$this->configCache->load($uid, ['test' => ['it' => $data]]);
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
self::assertEquals($data, $this->testedConfig->get($uid, 'test', 'it'));
self::assertEquals($data, $this->testedConfig->getCache()->get($uid, 'test', 'it'));
self::assertTrue($this->testedConfig->delete($uid, 'test', 'it'));
self::assertNull($this->testedConfig->get($uid, 'test', 'it'));
self::assertNull($this->testedConfig->getCache()->get($uid, 'test', 'it'));
self::assertEmpty($this->testedConfig->getCache()->getAll());
}
/**
* Test the configuration delete() method with a model/db
*/
public function testDeleteWithDB()
{
$uid = 42;
$this->configCache->load($uid, ['test' => ['it' => 'now', 'quarter' => 'true']]);
$this->configModel->shouldReceive('delete')
->with($uid, 'test', 'it')
->andReturn(false)
->once();
$this->configModel->shouldReceive('delete')
->with($uid, 'test', 'second')
->andReturn(true)
->once();
$this->configModel->shouldReceive('delete')
->with($uid, 'test', 'third')
->andReturn(false)
->once();
$this->configModel->shouldReceive('delete')
->with($uid, 'test', 'quarter')
->andReturn(true)
->once();
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
// directly set the value to the cache
$this->testedConfig->getCache()->set($uid, 'test', 'it', 'now');
self::assertEquals('now', $this->testedConfig->get($uid, 'test', 'it'));
self::assertEquals('now', $this->testedConfig->getCache()->get($uid, 'test', 'it'));
// delete from cache only
self::assertTrue($this->testedConfig->delete($uid, 'test', 'it'));
// delete from db only
self::assertTrue($this->testedConfig->delete($uid, 'test', 'second'));
// no delete
self::assertFalse($this->testedConfig->delete($uid, 'test', 'third'));
// delete both
self::assertTrue($this->testedConfig->delete($uid, 'test', 'quarter'));
self::assertEmpty($this->testedConfig->getCache()->getAll());
}
public function dataMultiUid()
{
return [
'normal' => [
'data1' => [
'uid' => 1,
'data' => [
'cat1' => [
'key1' => 'value1',
],
'cat2' => [
'key2' => 'value2',
]
],
],
'data2' => [
'uid' => 2,
'data' => [
'cat1' => [
'key1' => 'value1a',
],
'cat2' => [
'key2' => 'value2',
],
],
],
],
];
}
/**
* Test if multiple uids for caching are usable without errors
* @dataProvider dataMultiUid
*/
public function testMultipleUidsWithCache(array $data1, array $data2)
{
$this->configCache->load($data1['uid'], $data1['data']);
$this->configCache->load($data2['uid'], $data2['data']);
$this->testedConfig = $this->getInstance();
self::assertInstanceOf(Cache::class, $this->testedConfig->getCache());
self::assertConfig($data1['uid'], 'cat1', $data1['data']['cat1']);
self::assertConfig($data1['uid'], 'cat2', $data1['data']['cat2']);
self::assertConfig($data2['uid'], 'cat1', $data2['data']['cat1']);
self::assertConfig($data2['uid'], 'cat2', $data2['data']['cat2']);
}
/**
* Test when using an invalid UID
* @todo check it the clean way before using the config class
*/
public function testInvalidUid()
{
// bad UID!
$uid = 0;
$this->testedConfig = $this->getInstance();
self::assertNull($this->testedConfig->get($uid, 'cat1', 'cat2'));
self::assertEquals('fallback!', $this->testedConfig->get($uid, 'cat1', 'cat2', 'fallback!'));
self::assertFalse($this->testedConfig->set($uid, 'cat1', 'key1', 'doesn\'t matter!'));
self::assertFalse($this->testedConfig->delete($uid, 'cat1', 'key1'));
}
}
Reference in a new issue View git blame Copy permalink