3 namespace Friendica\Test\src\Core;
6 use Friendica\Core\Config\IConfiguration;
7 use Friendica\Core\Config\PreloadConfiguration;
8 use Friendica\Core\Hook;
9 use Friendica\Core\L10n\L10n;
10 use Friendica\Core\Session\ISession;
11 use Friendica\Core\StorageManager;
12 use Friendica\Database\Database;
14 use Friendica\Factory\ConfigFactory;
15 use Friendica\Model\Config\Config;
16 use Friendica\Model\Storage;
17 use Friendica\Core\Session;
18 use Friendica\Test\DatabaseTest;
19 use Friendica\Test\Util\Database\StaticDatabase;
20 use Friendica\Test\Util\VFSTrait;
21 use Friendica\Util\ConfigFileLoader;
22 use Friendica\Util\Profiler;
23 use Psr\Log\LoggerInterface;
24 use Psr\Log\NullLogger;
25 use Friendica\Test\Util\SampleStorageBackend;
28 * @todo Rework Hook:: methods to dynamic to remove the separated process annotation
30 * @runTestsInSeparateProcesses
32 class StorageManagerTest extends DatabaseTest
36 /** @var IConfiguration */
38 /** @var LoggerInterface */
45 public function setUp()
51 $this->logger = new NullLogger();
53 $profiler = \Mockery::mock(Profiler::class);
54 $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true);
56 // load real config to avoid mocking every config-entry which is related to the Database class
57 $configFactory = new ConfigFactory();
58 $loader = new ConfigFileLoader($this->root->url());
59 $configCache = $configFactory->createCache($loader);
61 $this->dba = new StaticDatabase($configCache, $profiler, $this->logger);
63 $configModel = new Config($this->dba);
64 $this->config = new PreloadConfiguration($configCache, $configModel);
66 $this->l10n = \Mockery::mock(L10n::class);
70 * Test plain instancing first
72 public function testInstance()
74 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
76 $this->assertInstanceOf(StorageManager::class, $storageManager);
79 public function dataStorages()
86 'userBackend' => false,
89 'name' => Storage\Database::NAME,
90 'assert' => Storage\Database::class,
91 'assertName' => Storage\Database::NAME,
92 'userBackend' => true,
95 'name' => Storage\Filesystem::NAME,
96 'assert' => Storage\Filesystem::class,
97 'assertName' => Storage\Filesystem::NAME,
98 'userBackend' => true,
100 'systemresource' => [
101 'name' => Storage\SystemResource::NAME,
102 'assert' => Storage\SystemResource::class,
103 'assertName' => Storage\SystemResource::NAME,
104 // false here, because SystemResource isn't meant to be a user backend,
105 // it's for system resources only
106 'userBackend' => false,
112 'userBackend' => false,
118 * Test the getByName() method
120 * @dataProvider dataStorages
122 public function testGetByName($name, $assert, $assertName, $userBackend)
124 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
126 $storage = $storageManager->getByName($name, $userBackend);
128 if (!empty($assert)) {
129 $this->assertInstanceOf(Storage\IStorage::class, $storage);
130 $this->assertInstanceOf($assert, $storage);
131 $this->assertEquals($name, $storage::getName());
133 $this->assertNull($storage);
135 $this->assertEquals($assertName, $storage);
139 * Test the isValidBackend() method
141 * @dataProvider dataStorages
143 public function testIsValidBackend($name, $assert, $assertName, $userBackend)
145 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
147 $this->assertEquals($userBackend, $storageManager->isValidBackend($name));
151 * Test the method listBackends() with default setting
153 public function testListBackends()
155 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
157 $this->assertEquals(StorageManager::DEFAULT_BACKENDS, $storageManager->listBackends());
161 * Test the method getBackend()
163 * @dataProvider dataStorages
165 public function testGetBackend($name, $assert, $assertName, $userBackend)
167 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
169 $this->assertNull($storageManager->getBackend());
172 $storageManager->setBackend($name);
174 $this->assertInstanceOf($assert, $storageManager->getBackend());
179 * Test the method getBackend() with a pre-configured backend
181 * @dataProvider dataStorages
183 public function testPresetBackend($name, $assert, $assertName, $userBackend)
185 $this->config->set('storage', 'name', $name);
187 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
190 $this->assertInstanceOf($assert, $storageManager->getBackend());
192 $this->assertNull($storageManager->getBackend());
197 * Tests the register and unregister methods for a new backend storage class
199 * Uses a sample storage for testing
201 * @see SampleStorageBackend
203 public function testRegisterUnregisterBackends()
205 /// @todo Remove dice once "Hook" is dynamic and mockable
207 ->addRules(include __DIR__ . '/../../../static/dependencies.config.php')
208 ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true])
209 ->addRule(ISession::class, ['instanceOf' => Session\Memory::class, 'shared' => true, 'call' => null]);
212 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
214 $this->assertTrue($storageManager->register(SampleStorageBackend::class));
216 $this->assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
217 SampleStorageBackend::getName() => SampleStorageBackend::class,
218 ]), $storageManager->listBackends());
219 $this->assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
220 SampleStorageBackend::getName() => SampleStorageBackend::class,
221 ]), $this->config->get('storage', 'backends'));
223 // inline call to register own class as hook (testing purpose only)
224 SampleStorageBackend::registerHook();
227 $this->assertTrue($storageManager->setBackend(SampleStorageBackend::NAME));
228 $this->assertEquals(SampleStorageBackend::NAME, $this->config->get('storage', 'name'));
230 $this->assertInstanceOf(SampleStorageBackend::class, $storageManager->getBackend());
232 $this->assertTrue($storageManager->unregister(SampleStorageBackend::class));
233 $this->assertEquals(StorageManager::DEFAULT_BACKENDS, $this->config->get('storage', 'backends'));
234 $this->assertEquals(StorageManager::DEFAULT_BACKENDS, $storageManager->listBackends());
236 $this->assertNull($storageManager->getBackend());
237 $this->assertNull($this->config->get('storage', 'name'));
241 * Test moving data to a new storage (currently testing db & filesystem)
243 * @dataProvider dataStorages
245 public function testMoveStorage($name, $assert, $assertName, $userBackend)
251 $this->loadFixture(__DIR__ . '/../../datasets/storage/database.fixture.php', $this->dba);
253 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
254 $storage = $storageManager->getByName($name);
255 $storageManager->move($storage);
257 $photos = $this->dba->select('photo', ['backend-ref', 'backend-class', 'id', 'data']);
259 while ($photo = $this->dba->fetch($photos)) {
261 $this->assertEmpty($photo['data']);
263 $storage = $storageManager->getByName($photo['backend-class']);
264 $data = $storage->get($photo['backend-ref']);
266 $this->assertNotEmpty($data);