Files
yii2/tests/framework/caching/CacheTestCase.php
2023-10-23 11:26:59 -03:00

304 lines
8.5 KiB
PHP

<?php
/**
* @link https://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/
namespace yii\caching;
/**
* Mock for the time() function for caching classes.
* @return int
*/
function time()
{
return \yiiunit\framework\caching\CacheTestCase::$time ?: \time();
}
/**
* Mock for the microtime() function for caching classes.
* @param bool $float
* @return float
*/
function microtime($float = false)
{
return \yiiunit\framework\caching\CacheTestCase::$microtime ?: \microtime($float);
}
namespace yiiunit\framework\caching;
use yii\caching\CacheInterface;
use yii\caching\TagDependency;
use yiiunit\TestCase;
/**
* Base class for testing cache backends.
*/
abstract class CacheTestCase extends TestCase
{
/**
* @var int virtual time to be returned by mocked time() function.
* Null means normal time() behavior.
*/
public static $time;
/**
* @var float virtual time to be returned by mocked microtime() function.
* Null means normal microtime() behavior.
*/
public static $microtime;
/**
* @return CacheInterface
*/
abstract protected function getCacheInstance();
protected function setUp(): void
{
parent::setUp();
$this->mockApplication();
}
protected function tearDown(): void
{
static::$time = null;
static::$microtime = null;
}
/**
* @return CacheInterface
*/
public function prepare()
{
$cache = $this->getCacheInstance();
$cache->flush();
$cache->set('string_test', 'string_test');
$cache->set('number_test', 42);
$cache->set('array_test', ['array_test' => 'array_test']);
$cache['arrayaccess_test'] = new \stdClass();
return $cache;
}
public function testSet(): void
{
$cache = $this->getCacheInstance();
$this->assertTrue($cache->set('string_test', 'string_test'));
$this->assertTrue($cache->set('number_test', 42));
$this->assertTrue($cache->set('array_test', ['array_test' => 'array_test']));
}
public function testGet(): void
{
$cache = $this->prepare();
$this->assertEquals('string_test', $cache->get('string_test'));
$this->assertEquals(42, $cache->get('number_test'));
$array = $cache->get('array_test');
$this->assertArrayHasKey('array_test', $array);
$this->assertEquals('array_test', $array['array_test']);
}
/**
* @return array testing multiSet with and without expiry
*/
public static function multiSetExpiry(): array
{
return [[0], [2]];
}
/**
* @dataProvider multiSetExpiry
*
* @param int $expiry Expiry in seconds.
*/
public function testMultiset(int $expiry): void
{
$cache = $this->getCacheInstance();
$cache->flush();
$cache->multiSet([
'string_test' => 'string_test',
'number_test' => 42,
'array_test' => ['array_test' => 'array_test'],
], $expiry);
$this->assertEquals('string_test', $cache->get('string_test'));
$this->assertEquals(42, $cache->get('number_test'));
$array = $cache->get('array_test');
$this->assertArrayHasKey('array_test', $array);
$this->assertEquals('array_test', $array['array_test']);
}
public function testExists(): void
{
$cache = $this->prepare();
$this->assertTrue($cache->exists('string_test'));
// check whether exists affects the value
$this->assertEquals('string_test', $cache->get('string_test'));
$this->assertTrue($cache->exists('number_test'));
$this->assertFalse($cache->exists('not_exists'));
}
public function testArrayAccess(): void
{
$cache = $this->getCacheInstance();
$cache['arrayaccess_test'] = new \stdClass();
$this->assertInstanceOf('stdClass', $cache['arrayaccess_test']);
}
public function testGetValueNonExistent(): void
{
$cache = $this->getCacheInstance();
$this->assertFalse($this->invokeMethod($cache, 'getValue', ['non_existent_key']));
}
public function testGetNonExistent(): void
{
$cache = $this->getCacheInstance();
$this->assertFalse($cache->get('non_existent_key'));
}
public function testStoreSpecialValues(): void
{
$cache = $this->getCacheInstance();
$this->assertTrue($cache->set('null_value', null));
$this->assertNull($cache->get('null_value'));
$this->assertTrue($cache->set('bool_value', true));
$this->assertTrue($cache->get('bool_value'));
}
public function testMultiGet(): void
{
$cache = $this->prepare();
$this->assertEquals(['string_test' => 'string_test', 'number_test' => 42], $cache->multiGet(['string_test', 'number_test']));
// ensure that order does not matter
$this->assertEquals(['number_test' => 42, 'string_test' => 'string_test'], $cache->multiGet(['number_test', 'string_test']));
$this->assertSame(['number_test' => 42, 'non_existent_key' => false], $cache->multiGet(['number_test', 'non_existent_key']));
}
public function testDefaultTtl(): void
{
$cache = $this->getCacheInstance();
$this->assertSame(0, $cache->defaultDuration);
}
public function testExpire(): void
{
$cache = $this->getCacheInstance();
$this->assertTrue($cache->set('expire_test', 'expire_test', 2));
usleep(500000);
$this->assertEquals('expire_test', $cache->get('expire_test'));
usleep(2_500_000);
$this->assertFalse($cache->get('expire_test'));
}
public function testExpireAdd(): void
{
$cache = $this->getCacheInstance();
$this->assertTrue($cache->add('expire_testa', 'expire_testa', 2));
usleep(500000);
$this->assertEquals('expire_testa', $cache->get('expire_testa'));
usleep(2_500_000);
$this->assertFalse($cache->get('expire_testa'));
}
public function testAdd(): void
{
$cache = $this->prepare();
// should not change existing keys
$this->assertFalse($cache->add('number_test', 13));
$this->assertEquals(42, $cache->get('number_test'));
// should store data if it's not there yet
$this->assertFalse($cache->get('add_test'));
$this->assertTrue($cache->add('add_test', 13));
$this->assertEquals(13, $cache->get('add_test'));
}
public function testMultiAdd(): void
{
$cache = $this->prepare();
$this->assertFalse($cache->get('add_test'));
$cache->multiAdd([
'number_test' => 13,
'add_test' => 13,
]);
$this->assertEquals(42, $cache->get('number_test'));
$this->assertEquals(13, $cache->get('add_test'));
}
public function testDelete(): void
{
$cache = $this->prepare();
$this->assertEquals(42, $cache->get('number_test'));
$this->assertTrue($cache->delete('number_test'));
$this->assertFalse($cache->get('number_test'));
}
public function testFlush(): void
{
$cache = $this->prepare();
$this->assertTrue($cache->flush());
$this->assertFalse($cache->get('number_test'));
}
public function testGetOrSet(): void
{
$cache = $this->prepare();
$expected = $this->getOrSetCallable($cache);
$callable = $this->getOrSetCallable(...);
$this->assertFalse($cache->get('something'));
$this->assertEquals($expected, $cache->getOrSet('something', $callable));
$this->assertEquals($expected, $cache->get('something'));
}
public function getOrSetCallable($cache)
{
return $cache::class;
}
public function testGetOrSetWithDependencies(): void
{
$cache = $this->prepare();
$dependency = new TagDependency(['tags' => 'test']);
$expected = 'SilverFire';
$loginClosure = fn($cache) => 'SilverFire';
$this->assertEquals($expected, $cache->getOrSet('some-login', $loginClosure, null, $dependency));
// Call again with another login to make sure that value is cached
$loginClosure = fn($cache) => 'SamDark';
$this->assertEquals($expected, $cache->getOrSet('some-login', $loginClosure, null, $dependency));
$dependency->invalidate($cache, 'test');
$expected = 'SamDark';
$this->assertEquals($expected, $cache->getOrSet('some-login', $loginClosure, null, $dependency));
}
}