3 namespace Drupal\Tests\Component\FileCache;
5 use Drupal\Component\FileCache\FileCache;
6 use Drupal\Component\FileCache\NullFileCache;
7 use Drupal\Component\FileCache\FileCacheFactory;
8 use Drupal\Component\Utility\Random;
9 use PHPUnit\Framework\TestCase;
12 * @coversDefaultClass \Drupal\Component\FileCache\FileCacheFactory
15 class FileCacheFactoryTest extends TestCase {
20 protected function setUp() {
24 'test_foo_settings' => [
25 'collection' => 'test-23',
26 'cache_backend_class' => '\Drupal\Tests\Component\FileCache\StaticFileCacheBackend',
27 'cache_backend_configuration' => [
32 FileCacheFactory::setConfiguration($configuration);
33 FileCacheFactory::setPrefix('prefix');
39 public function testGet() {
40 $file_cache = FileCacheFactory::get('test_foo_settings', []);
42 // Ensure the right backend and configuration is used.
43 $filename = __DIR__ . '/Fixtures/llama-23.txt';
44 $realpath = realpath($filename);
45 $cid = 'prefix:test-23:' . $realpath;
47 $file_cache->set($filename, 23);
49 $static_cache = new StaticFileCacheBackend(['bin' => 'dog']);
50 $result = $static_cache->fetch([$cid]);
51 $this->assertNotEmpty($result);
53 // Cleanup static caches.
54 $file_cache->delete($filename);
60 public function testGetNoPrefix() {
61 FileCacheFactory::setPrefix(NULL);
62 $this->setExpectedException(\InvalidArgumentException::class, 'Required prefix configuration is missing');
63 FileCacheFactory::get('test_foo_settings', []);
69 public function testGetDisabledFileCache() {
70 // Ensure the returned FileCache is an instance of FileCache::class.
71 $file_cache = FileCacheFactory::get('test_foo_settings', []);
72 $this->assertInstanceOf(FileCache::class, $file_cache);
74 $configuration = FileCacheFactory::getConfiguration();
75 $configuration[FileCacheFactory::DISABLE_CACHE] = TRUE;
76 FileCacheFactory::setConfiguration($configuration);
78 // Ensure the returned FileCache is now an instance of NullFileCache::class.
79 $file_cache = FileCacheFactory::get('test_foo_settings', []);
80 $this->assertInstanceOf(NullFileCache::class, $file_cache);
86 * @dataProvider configurationDataProvider
88 public function testGetConfigurationOverrides($configuration, $arguments, $class) {
89 FileCacheFactory::setConfiguration($configuration);
91 $file_cache = FileCacheFactory::get('test_foo_settings', $arguments);
92 $this->assertInstanceOf($class, $file_cache);
96 * Data provider for testGetConfigurationOverrides().
98 public function configurationDataProvider() {
101 // Get a unique FileCache class.
102 $file_cache = $this->getMockBuilder(FileCache::class)
103 ->disableOriginalConstructor()
105 $class = get_class($file_cache);
107 // Test fallback configuration.
108 $data['fallback-configuration'] = [
114 // Test default configuration.
115 $data['default-configuration'] = [
116 ['default' => ['class' => $class]],
121 // Test specific per collection setting.
122 $data['collection-setting'] = [
123 ['test_foo_settings' => ['class' => $class]],
128 // Test default configuration plus specific per collection setting.
129 $data['default-plus-collection-setting'] = [
131 'default' => ['class' => '\stdClass'],
132 'test_foo_settings' => ['class' => $class],
138 // Test default configuration plus class specific override.
139 $data['default-plus-class-override'] = [
140 ['default' => ['class' => '\stdClass']],
145 // Test default configuration plus class specific override plus specific
146 // per collection setting.
147 $data['default-plus-class-plus-collection-setting'] = [
149 'default' => ['class' => '\stdClass'],
150 'test_foo_settings' => ['class' => $class],
152 ['class' => '\stdClass'],
160 * @covers ::getConfiguration
161 * @covers ::setConfiguration
163 public function testGetSetConfiguration() {
164 $configuration = FileCacheFactory::getConfiguration();
165 $configuration['test_foo_bar'] = ['bar' => 'llama'];
166 FileCacheFactory::setConfiguration($configuration);
167 $configuration = FileCacheFactory::getConfiguration();
168 $this->assertEquals(['bar' => 'llama'], $configuration['test_foo_bar']);
172 * @covers ::getPrefix
173 * @covers ::setPrefix
175 public function testGetSetPrefix() {
177 $random = new Random();
179 $prefix = $random->name(8, TRUE);
180 FileCacheFactory::setPrefix($prefix);
181 $this->assertEquals($prefix, FileCacheFactory::getPrefix());