nextcloud/apps/files_external/tests/Service/UserStoragesServiceTest.php

213 lines
6.4 KiB
PHP
Raw Normal View History

<?php
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @author Vincent Petry <pvince81@owncloud.com>
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
2016-05-13 12:22:28 +03:00
namespace OCA\Files_External\Tests\Service;
use OC\Files\Filesystem;
use OCA\Files_External\Lib\StorageConfig;
2016-05-13 12:22:28 +03:00
use OCA\Files_External\Service\GlobalStoragesService;
use OCA\Files_External\Service\StoragesService;
use OCA\Files_External\Service\UserStoragesService;
2016-09-02 11:37:20 +03:00
use OCP\IUserSession;
2015-11-02 15:13:06 +03:00
use Test\Traits\UserTrait;
2015-11-02 15:13:06 +03:00
/**
* @group DB
*/
class UserStoragesServiceTest extends StoragesServiceTest {
2015-11-02 15:13:06 +03:00
use UserTrait;
private $user;
private $userId;
/**
* @var StoragesService
*/
protected $globalStoragesService;
protected function setUp(): void {
parent::setUp();
$this->globalStoragesService = new GlobalStoragesService($this->backendService, $this->dbConfig, $this->mountCache);
$this->userId = $this->getUniqueID('user_');
2015-11-02 15:13:06 +03:00
$this->createUser($this->userId, $this->userId);
$this->user = \OC::$server->getUserManager()->get($this->userId);
2015-11-02 15:13:06 +03:00
/** @var \OCP\IUserSession|\PHPUnit_Framework_MockObject_MockObject $userSession */
2016-09-02 11:37:20 +03:00
$userSession = $this->createMock(IUserSession::class);
$userSession
->expects($this->any())
->method('getUser')
->will($this->returnValue($this->user));
$this->service = new UserStoragesService($this->backendService, $this->dbConfig, $userSession, $this->mountCache);
}
private function makeTestStorageData() {
return $this->makeStorageConfig([
'mountPoint' => 'mountpoint',
'backendIdentifier' => 'identifier:\OCA\Files_External\Lib\Backend\SMB',
'authMechanismIdentifier' => 'identifier:\Auth\Mechanism',
'backendOptions' => [
'option1' => 'value1',
'option2' => 'value2',
'password' => 'testPassword',
],
'mountOptions' => [
'preview' => false,
]
]);
}
public function testAddStorage() {
$storage = $this->makeTestStorageData();
$newStorage = $this->service->addStorage($storage);
2015-11-02 15:13:06 +03:00
$id = $newStorage->getId();
2015-11-02 15:13:06 +03:00
$newStorage = $this->service->getStorage($id);
$this->assertEquals($storage->getMountPoint(), $newStorage->getMountPoint());
$this->assertEquals($storage->getBackend(), $newStorage->getBackend());
Authentication mechanisms for external storage backends A backend can now specify generic authentication schemes that it supports, instead of specifying the parameters for its authentication method directly. This allows multiple authentication mechanisms to be implemented for a single scheme, providing altered functionality. This commit introduces the backend framework for this feature, and so at this point the UI will be broken as the frontend does not specify the required information. Terminology: - authentication scheme Parameter interface for the authentication method. A backend supporting the 'password' scheme accepts two parameters, 'user' and 'password'. - authentication mechanism Specific mechanism implementing a scheme. Basic mechanisms may forward configuration options directly to the backend, more advanced ones may lookup parameters or retrieve them from the session New dropdown selector for external storage configurations to select the authentication mechanism to be used. Authentication mechanisms can have visibilities, just like backends. The API was extended too to make it easier to add/remove visibilities. In addition, the concept of 'allowed visibility' has been introduced, so a backend/auth mechanism can force a maximum visibility level (e.g. Local storage type) that cannot be overridden by configuration in the web UI. An authentication mechanism is a fully instantiated implementation. This allows an implementation to have dependencies injected into it, e.g. an \OCP\IDB for database operations. When a StorageConfig is being prepared for mounting, the authentication mechanism implementation has manipulateStorage() called, which inserts the relevant authentication method options into the storage ready for mounting.
2015-08-12 12:54:03 +03:00
$this->assertEquals($storage->getAuthMechanism(), $newStorage->getAuthMechanism());
$this->assertEquals($storage->getBackendOptions(), $newStorage->getBackendOptions());
$this->assertEquals(0, $newStorage->getStatus());
// hook called once for user
$this->assertHookCall(
current(self::$hookCalls),
Filesystem::signal_create_mount,
$storage->getMountPoint(),
\OC_Mount_Config::MOUNT_TYPE_USER,
$this->userId
);
$nextStorage = $this->service->addStorage($storage);
2015-11-02 15:13:06 +03:00
$this->assertEquals($id + 1, $nextStorage->getId());
}
public function testUpdateStorage() {
$storage = $this->makeStorageConfig([
'mountPoint' => 'mountpoint',
'backendIdentifier' => 'identifier:\OCA\Files_External\Lib\Backend\SMB',
'authMechanismIdentifier' => 'identifier:\Auth\Mechanism',
'backendOptions' => [
'option1' => 'value1',
'option2' => 'value2',
'password' => 'testPassword',
],
]);
$newStorage = $this->service->addStorage($storage);
$backendOptions = $newStorage->getBackendOptions();
$backendOptions['password'] = 'anotherPassword';
$newStorage->setBackendOptions($backendOptions);
self::$hookCalls = [];
$newStorage = $this->service->updateStorage($newStorage);
$this->assertEquals('anotherPassword', $newStorage->getBackendOptions()['password']);
2015-12-22 16:22:10 +03:00
$this->assertEquals([$this->userId], $newStorage->getApplicableUsers());
// these attributes are unused for user storages
$this->assertEmpty($newStorage->getApplicableGroups());
$this->assertEquals(0, $newStorage->getStatus());
// no hook calls
$this->assertEmpty(self::$hookCalls);
}
/**
* @dataProvider deleteStorageDataProvider
*/
public function testDeleteStorage($backendOptions, $rustyStorageId, $expectedCountAfterDeletion) {
parent::testDeleteStorage($backendOptions, $rustyStorageId, $expectedCountAfterDeletion);
// hook called once for user (first one was during test creation)
$this->assertHookCall(
self::$hookCalls[1],
Filesystem::signal_delete_mount,
'/mountpoint',
\OC_Mount_Config::MOUNT_TYPE_USER,
$this->userId
);
}
public function testHooksRenameMountPoint() {
$storage = $this->makeTestStorageData();
$storage = $this->service->addStorage($storage);
$storage->setMountPoint('renamedMountpoint');
// reset calls
self::$hookCalls = [];
$this->service->updateStorage($storage);
// hook called twice
$this->assertHookCall(
self::$hookCalls[0],
Filesystem::signal_delete_mount,
'/mountpoint',
\OC_Mount_Config::MOUNT_TYPE_USER,
$this->userId
);
$this->assertHookCall(
self::$hookCalls[1],
Filesystem::signal_create_mount,
'/renamedMountpoint',
\OC_Mount_Config::MOUNT_TYPE_USER,
$this->userId
);
}
public function testGetAdminStorage() {
$this->expectException(\OCA\Files_External\NotFoundException::class);
$backend = $this->backendService->getBackend('identifier:\OCA\Files_External\Lib\Backend\SMB');
$authMechanism = $this->backendService->getAuthMechanism('identifier:\Auth\Mechanism');
$storage = new StorageConfig();
$storage->setMountPoint('mountpoint');
$storage->setBackend($backend);
$storage->setAuthMechanism($authMechanism);
$storage->setBackendOptions(['password' => 'testPassword']);
$storage->setApplicableUsers([$this->userId]);
$newStorage = $this->globalStoragesService->addStorage($storage);
2016-05-13 12:56:47 +03:00
$this->assertInstanceOf('\OCA\Files_External\Lib\StorageConfig', $this->globalStoragesService->getStorage($newStorage->getId()));
$this->service->getStorage($newStorage->getId());
}
}