1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
<?php
namespace Twig\Tests\Cache;
/*
* This file is part of Twig.
*
* (c) Fabien Potencier
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Twig\Cache\FilesystemCache;
use Twig\Tests\FilesystemHelper;
class FilesystemTest extends TestCase
{
private $className;
private $directory;
private $cache;
protected function setUp(): void
{
$nonce = hash(\PHP_VERSION_ID < 80100 ? 'sha256' : 'xxh128', random_bytes(32));
$this->className = '__Twig_Tests_Cache_FilesystemTest_Template_'.$nonce;
$this->directory = sys_get_temp_dir().'/twig-test';
$this->cache = new FilesystemCache($this->directory);
}
protected function tearDown(): void
{
if (file_exists($this->directory)) {
FilesystemHelper::removeDir($this->directory);
}
}
public function testLoad()
{
$key = $this->directory.'/cache/cachefile.php';
$dir = \dirname($key);
@mkdir($dir, 0777, true);
$this->assertDirectoryExists($dir);
$this->assertFalse(class_exists($this->className, false));
$content = $this->generateSource();
file_put_contents($key, $content);
$this->cache->load($key);
$this->assertTrue(class_exists($this->className, false));
}
public function testLoadMissing()
{
$key = $this->directory.'/cache/cachefile.php';
$this->assertFalse(class_exists($this->className, false));
$this->cache->load($key);
$this->assertFalse(class_exists($this->className, false));
}
public function testWrite()
{
$key = $this->directory.'/cache/cachefile.php';
$content = $this->generateSource();
$this->assertFileDoesNotExist($key);
$this->assertFileDoesNotExist($this->directory);
$this->cache->write($key, $content);
$this->assertFileExists($this->directory);
$this->assertFileExists($key);
$this->assertSame(file_get_contents($key), $content);
}
public function testWriteFailMkdir()
{
if (\defined('PHP_WINDOWS_VERSION_BUILD')) {
$this->markTestSkipped('Read-only directories not possible on Windows.');
}
$key = $this->directory.'/cache/cachefile.php';
$content = $this->generateSource();
$this->assertFileDoesNotExist($key);
// Create read-only root directory.
@mkdir($this->directory, 0555, true);
$this->assertDirectoryExists($this->directory);
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Unable to create the cache directory');
$this->cache->write($key, $content);
}
public function testWriteFailDirWritable()
{
if (\defined('PHP_WINDOWS_VERSION_BUILD')) {
$this->markTestSkipped('Read-only directories not possible on Windows.');
}
$key = $this->directory.'/cache/cachefile.php';
$content = $this->generateSource();
$this->assertFileDoesNotExist($key);
// Create root directory.
@mkdir($this->directory, 0777, true);
// Create read-only subdirectory.
@mkdir($this->directory.'/cache', 0555);
$this->assertDirectoryExists($this->directory.'/cache');
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Unable to write in the cache directory');
$this->cache->write($key, $content);
}
public function testWriteFailWriteFile()
{
$key = $this->directory.'/cache/cachefile.php';
$content = $this->generateSource();
$this->assertFileDoesNotExist($key);
// Create a directory in the place of the cache file.
@mkdir($key, 0777, true);
$this->assertDirectoryExists($key);
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Failed to write cache file');
$this->cache->write($key, $content);
}
public function testGetTimestamp()
{
$key = $this->directory.'/cache/cachefile.php';
$dir = \dirname($key);
@mkdir($dir, 0777, true);
$this->assertDirectoryExists($dir);
// Create the file with a specific modification time.
touch($key, 1234567890);
$this->assertSame(1234567890, $this->cache->getTimestamp($key));
}
public function testGetTimestampMissingFile()
{
$key = $this->directory.'/cache/cachefile.php';
$this->assertSame(0, $this->cache->getTimestamp($key));
}
/**
* Test file cache is tolerant towards trailing (back)slashes on the configured cache directory.
*/
#[DataProvider('provideDirectories')]
public function testGenerateKey($expected, $input)
{
$cache = new FilesystemCache($input);
$this->assertMatchesRegularExpression($expected, $cache->generateKey('_test_', static::class));
}
public static function provideDirectories()
{
$pattern = '#a/b/[a-zA-Z0-9]+/[a-zA-Z0-9]+.php$#';
return [
[$pattern, 'a/b'],
[$pattern, 'a/b/'],
[$pattern, 'a/b\\'],
[$pattern, 'a/b\\/'],
[$pattern, 'a/b\\//'],
['#/'.substr($pattern, 1), '/a/b'],
];
}
private function generateSource()
{
return strtr('<?php class {{class_name}} {}', [
'{{class_name}}' => $this->className,
]);
}
}
|