2014-10-31 11:41:07 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 16:49:16 +02:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2016-05-26 19:56:05 +02:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2016-01-12 15:02:16 +01:00
|
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
2015-03-26 11:44:34 +01:00
|
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
2014-10-31 11:41:07 +01:00
|
|
|
*
|
2015-03-26 11:44:34 +01:00
|
|
|
* @license AGPL-3.0
|
2014-10-31 11:41:07 +01:00
|
|
|
*
|
2015-03-26 11:44:34 +01: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.
|
2014-10-31 11:41:07 +01:00
|
|
|
*
|
2015-03-26 11:44:34 +01:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2014-10-31 11:41:07 +01:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 11:44:34 +01:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2014-10-31 11:41:07 +01:00
|
|
|
*
|
2015-03-26 11:44:34 +01: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/>
|
2014-10-31 11:41:07 +01:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2016-05-13 11:56:47 +02:00
|
|
|
namespace OCA\Files_External\Tests;
|
2014-10-31 11:41:07 +01:00
|
|
|
|
2016-05-13 11:56:47 +02:00
|
|
|
use OCA\Files_External\Lib\StorageConfig;
|
2014-10-31 11:41:07 +01:00
|
|
|
|
|
|
|
class StorageConfigTest extends \Test\TestCase {
|
|
|
|
|
|
|
|
public function testJsonSerialization() {
|
2015-08-11 19:45:07 +02:00
|
|
|
$backend = $this->getMockBuilder('\OCA\Files_External\Lib\Backend\Backend')
|
|
|
|
->disableOriginalConstructor()
|
|
|
|
->getMock();
|
2016-02-24 19:49:03 +01:00
|
|
|
$parameter = $this->getMockBuilder('\OCA\Files_External\Lib\DefinitionParameter')
|
|
|
|
->disableOriginalConstructor()
|
|
|
|
->getMock();
|
|
|
|
$parameter
|
|
|
|
->expects($this->once())
|
|
|
|
->method('getType')
|
|
|
|
->willReturn(1);
|
|
|
|
$backend
|
|
|
|
->expects($this->once())
|
|
|
|
->method('getParameters')
|
|
|
|
->willReturn(['secure' => $parameter]);
|
2015-08-12 21:03:11 +02:00
|
|
|
$backend->method('getIdentifier')
|
|
|
|
->willReturn('storage::identifier');
|
2015-08-11 19:45:07 +02:00
|
|
|
|
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 11:54:03 +02:00
|
|
|
$authMech = $this->getMockBuilder('\OCA\Files_External\Lib\Auth\AuthMechanism')
|
|
|
|
->disableOriginalConstructor()
|
|
|
|
->getMock();
|
2015-08-12 21:03:11 +02:00
|
|
|
$authMech->method('getIdentifier')
|
|
|
|
->willReturn('auth::identifier');
|
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 11:54:03 +02:00
|
|
|
|
2014-10-31 11:41:07 +01:00
|
|
|
$storageConfig = new StorageConfig(1);
|
|
|
|
$storageConfig->setMountPoint('test');
|
2015-08-11 19:45:07 +02:00
|
|
|
$storageConfig->setBackend($backend);
|
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 11:54:03 +02:00
|
|
|
$storageConfig->setAuthMechanism($authMech);
|
2016-02-24 19:49:03 +01:00
|
|
|
$storageConfig->setBackendOptions(['user' => 'test', 'password' => 'password123', 'secure' => '1']);
|
2014-10-31 11:41:07 +01:00
|
|
|
$storageConfig->setPriority(128);
|
|
|
|
$storageConfig->setApplicableUsers(['user1', 'user2']);
|
|
|
|
$storageConfig->setApplicableGroups(['group1', 'group2']);
|
2015-03-13 12:49:11 +01:00
|
|
|
$storageConfig->setMountOptions(['preview' => false]);
|
2014-10-31 11:41:07 +01:00
|
|
|
|
|
|
|
$json = $storageConfig->jsonSerialize();
|
|
|
|
|
2016-02-24 19:49:03 +01:00
|
|
|
$this->assertSame(1, $json['id']);
|
|
|
|
$this->assertSame('/test', $json['mountPoint']);
|
|
|
|
$this->assertSame('storage::identifier', $json['backend']);
|
|
|
|
$this->assertSame('auth::identifier', $json['authMechanism']);
|
|
|
|
$this->assertSame('test', $json['backendOptions']['user']);
|
|
|
|
$this->assertSame('password123', $json['backendOptions']['password']);
|
|
|
|
$this->assertSame(true, $json['backendOptions']['secure']);
|
|
|
|
$this->assertSame(128, $json['priority']);
|
|
|
|
$this->assertSame(['user1', 'user2'], $json['applicableUsers']);
|
|
|
|
$this->assertSame(['group1', 'group2'], $json['applicableGroups']);
|
|
|
|
$this->assertSame(['preview' => false], $json['mountOptions']);
|
2014-10-31 11:41:07 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
}
|