3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Test\src\Core;
25 use Friendica\Core\Config\IConfig;
26 use Friendica\Core\Config\PreloadConfig;
27 use Friendica\Core\Hook;
28 use Friendica\Core\L10n;
29 use Friendica\Core\Session\ISession;
30 use Friendica\Core\StorageManager;
31 use Friendica\Database\Database;
33 use Friendica\Factory\ConfigFactory;
34 use Friendica\Model\Config\Config;
35 use Friendica\Model\Storage;
36 use Friendica\Core\Session;
37 use Friendica\Network\HTTPClient;
38 use Friendica\Test\DatabaseTest;
39 use Friendica\Test\Util\Database\StaticDatabase;
40 use Friendica\Test\Util\VFSTrait;
41 use Friendica\Util\ConfigFileLoader;
42 use Friendica\Util\Profiler;
43 use Psr\Log\LoggerInterface;
44 use Psr\Log\NullLogger;
45 use Friendica\Test\Util\SampleStorageBackend;
47 class StorageManagerTest extends DatabaseTest
54 /** @var LoggerInterface */
58 /** @var HTTPClient */
61 protected function setUp(): void
67 $this->logger = new NullLogger();
69 $profiler = \Mockery::mock(Profiler::class);
70 $profiler->shouldReceive('startRecording');
71 $profiler->shouldReceive('stopRecording');
72 $profiler->shouldReceive('saveTimestamp')->withAnyArgs()->andReturn(true);
74 // load real config to avoid mocking every config-entry which is related to the Database class
75 $configFactory = new ConfigFactory();
76 $loader = $configFactory->createConfigFileLoader($this->root->url(), []);
77 $configCache = $configFactory->createCache($loader);
79 $this->dba = new StaticDatabase($configCache, $profiler, $this->logger);
81 $configModel = new Config($this->dba);
82 $this->config = new PreloadConfig($configCache, $configModel);
83 $this->config->set('storage', 'name', 'Database');
85 $this->l10n = \Mockery::mock(L10n::class);
87 $this->httpRequest = \Mockery::mock(HTTPClient::class);
91 * Test plain instancing first
93 public function testInstance()
95 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n, $this->httpRequest);
97 self::assertInstanceOf(StorageManager::class, $storageManager);
100 public function dataStorages()
106 'interface' => Storage\IStorage::class,
111 'name' => Storage\Database::NAME,
113 'interface' => Storage\IWritableStorage::class,
114 'assert' => Storage\Database::class,
115 'assertName' => Storage\Database::NAME,
118 'name' => Storage\Filesystem::NAME,
120 'interface' => Storage\IWritableStorage::class,
121 'assert' => Storage\Filesystem::class,
122 'assertName' => Storage\Filesystem::NAME,
124 'systemresource' => [
125 'name' => Storage\SystemResource::NAME,
127 'interface' => Storage\IStorage::class,
128 'assert' => Storage\SystemResource::class,
129 'assertName' => Storage\SystemResource::NAME,
137 'userBackend' => false,
143 * Test the getByName() method
145 * @dataProvider dataStorages
147 public function testGetByName($name, $valid, $interface, $assert, $assertName)
150 $this->expectException(Storage\InvalidClassStorageException::class);
153 if ($interface === Storage\IWritableStorage::class) {
154 $this->config->set('storage', 'name', $name);
157 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
159 if ($interface === Storage\IWritableStorage::class) {
160 $storage = $storageManager->getWritableStorageByName($name);
162 $storage = $storageManager->getByName($name);
165 self::assertInstanceOf($interface, $storage);
166 self::assertInstanceOf($assert, $storage);
167 self::assertEquals($assertName, $storage);
171 * Test the isValidBackend() method
173 * @dataProvider dataStorages
175 public function testIsValidBackend($name, $valid, $interface, $assert, $assertName)
177 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
179 // true in every of the backends
180 self::assertEquals(!empty($assertName), $storageManager->isValidBackend($name));
182 // if it's a IWritableStorage, the valid backend should return true, otherwise false
183 self::assertEquals($interface === Storage\IWritableStorage::class, $storageManager->isValidBackend($name, StorageManager::DEFAULT_BACKENDS));
187 * Test the method listBackends() with default setting
189 public function testListBackends()
191 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
193 self::assertEquals(StorageManager::DEFAULT_BACKENDS, $storageManager->listBackends());
197 * Test the method getBackend()
199 * @dataProvider dataStorages
201 public function testGetBackend($name, $valid, $interface, $assert, $assertName)
203 if ($interface !== Storage\IWritableStorage::class) {
204 static::markTestSkipped('only works for IWritableStorage');
207 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
209 $selBackend = $storageManager->getWritableStorageByName($name);
210 $storageManager->setBackend($selBackend);
212 self::assertInstanceOf($assert, $storageManager->getBackend());
216 * Test the method getBackend() with a pre-configured backend
218 * @dataProvider dataStorages
220 public function testPresetBackend($name, $valid, $interface, $assert, $assertName)
222 $this->config->set('storage', 'name', $name);
223 if ($interface !== Storage\IWritableStorage::class) {
224 $this->expectException(Storage\InvalidClassStorageException::class);
227 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
229 self::assertInstanceOf($assert, $storageManager->getBackend());
233 * Tests the register and unregister methods for a new backend storage class
235 * Uses a sample storage for testing
237 * @see SampleStorageBackend
239 public function testRegisterUnregisterBackends()
241 /// @todo Remove dice once "Hook" is dynamic and mockable
243 ->addRules(include __DIR__ . '/../../../static/dependencies.config.php')
244 ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true])
245 ->addRule(ISession::class, ['instanceOf' => Session\Memory::class, 'shared' => true, 'call' => null]);
248 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
250 self::assertTrue($storageManager->register(SampleStorageBackend::class));
252 self::assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
253 SampleStorageBackend::getName(),
254 ]), $storageManager->listBackends());
255 self::assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
256 SampleStorageBackend::getName()
257 ]), $this->config->get('storage', 'backends'));
259 self::assertTrue($storageManager->unregister(SampleStorageBackend::class));
260 self::assertEquals(StorageManager::DEFAULT_BACKENDS, $this->config->get('storage', 'backends'));
261 self::assertEquals(StorageManager::DEFAULT_BACKENDS, $storageManager->listBackends());
265 * tests that an active backend cannot get unregistered
267 public function testUnregisterActiveBackend()
269 /// @todo Remove dice once "Hook" is dynamic and mockable
271 ->addRules(include __DIR__ . '/../../../static/dependencies.config.php')
272 ->addRule(Database::class, ['instanceOf' => StaticDatabase::class, 'shared' => true])
273 ->addRule(ISession::class, ['instanceOf' => Session\Memory::class, 'shared' => true, 'call' => null]);
276 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
278 self::assertTrue($storageManager->register(SampleStorageBackend::class));
280 self::assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
281 SampleStorageBackend::getName(),
282 ]), $storageManager->listBackends());
283 self::assertEquals(array_merge(StorageManager::DEFAULT_BACKENDS, [
284 SampleStorageBackend::getName()
285 ]), $this->config->get('storage', 'backends'));
287 // inline call to register own class as hook (testing purpose only)
288 SampleStorageBackend::registerHook();
291 self::assertTrue($storageManager->setBackend($storageManager->getWritableStorageByName(SampleStorageBackend::NAME)));
292 self::assertEquals(SampleStorageBackend::NAME, $this->config->get('storage', 'name'));
294 self::assertInstanceOf(SampleStorageBackend::class, $storageManager->getBackend());
296 self::expectException(Storage\StorageException::class);
297 self::expectExceptionMessage('Cannot unregister Sample Storage, because it\'s currently active.');
299 $storageManager->unregister(SampleStorageBackend::class);
303 * Test moving data to a new storage (currently testing db & filesystem)
305 * @dataProvider dataStorages
307 public function testMoveStorage($name, $valid, $interface, $assert, $assertName)
309 if ($interface !== Storage\IWritableStorage::class) {
310 self::markTestSkipped("No user backend");
313 $this->loadFixture(__DIR__ . '/../../datasets/storage/database.fixture.php', $this->dba);
315 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
316 $storage = $storageManager->getWritableStorageByName($name);
317 $storageManager->move($storage);
319 $photos = $this->dba->select('photo', ['backend-ref', 'backend-class', 'id', 'data']);
321 while ($photo = $this->dba->fetch($photos)) {
322 self::assertEmpty($photo['data']);
324 $storage = $storageManager->getByName($photo['backend-class']);
325 $data = $storage->get($photo['backend-ref']);
327 self::assertNotEmpty($data);
332 * Test moving data to a WRONG storage
334 public function testWrongWritableStorage()
336 $this->expectException(Storage\InvalidClassStorageException::class);
337 $this->expectExceptionMessage('Backend SystemResource is not valid');
339 $storageManager = new StorageManager($this->dba, $this->config, $this->logger, $this->l10n);
340 $storage = $storageManager->getWritableStorageByName(Storage\SystemResource::getName());
341 $storageManager->move($storage);