@ -8,6 +8,7 @@
* @author Morris Jobke < hey @ morrisjobke . de >
* @author Robin Appelman < robin @ icewind . nl >
* @author Roeland Jago Douma < roeland @ famdouma . nl >
* @author Richard Steinmetz < richard @ steinmetz . cloud >
*
* @license GNU AGPL version 3 or any later version
*
@ -28,17 +29,29 @@
namespace OCA\DAV\Tests\DAV;
use OCA\DAV\DAV\CustomPropertiesBackend;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IDBConnection;
use OCP\IUser;
use Sabre\CalDAV\ICalendar;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\PropFind;
use Sabre\DAV\PropPatch;
use Sabre\DAV\Server;
use Sabre\DAV\Tree;
use Sabre\DAV\Xml\Property\Href;
use Sabre\DAVACL\IACL;
use Sabre\DAVACL\IPrincipal;
use Test\TestCase;
/**
* @group DB
*/
class CustomPropertiesBackendTest extends TestCase {
private const BASE_URI = '/remote.php/dav/';
/** @var Server | \PHPUnit\Framework\MockObject\MockObject */
private $server;
/** @var Tree | \PHPUnit\Framework\MockObject\MockObject */
private $tree;
@ -54,6 +67,9 @@ class CustomPropertiesBackendTest extends TestCase {
protected function setUp(): void {
parent::setUp();
$this->server = $this->createMock(Server::class);
$this->server->method('getBaseUri')
->willReturn(self::BASE_URI);
$this->tree = $this->createMock(Tree::class);
$this->user = $this->createMock(IUser::class);
$this->user->method('getUID')
@ -62,9 +78,10 @@ class CustomPropertiesBackendTest extends TestCase {
$this->dbConnection = \OC::$server->getDatabaseConnection();
$this->backend = new CustomPropertiesBackend(
$this->server,
$this->tree,
$this->dbConnection,
$this->user
$this->user,
);
}
@ -90,7 +107,13 @@ class CustomPropertiesBackendTest extends TestCase {
}
}
protected function insertProp(string $user, string $path, string $name, string $value) {
protected function insertProp(string $user, string $path, string $name, mixed $value) {
$type = CustomPropertiesBackend::PROPERTY_TYPE_STRING;
if ($value instanceof Href) {
$value = $value->getHref();
$type = CustomPropertiesBackend::PROPERTY_TYPE_HREF;
}
$query = $this->dbConnection->getQueryBuilder();
$query->insert('properties')
->values([
@ -98,13 +121,14 @@ class CustomPropertiesBackendTest extends TestCase {
'propertypath' => $query->createNamedParameter($this->formatPath($path)),
'propertyname' => $query->createNamedParameter($name),
'propertyvalue' => $query->createNamedParameter($value),
'valuetype' => $query->createNamedParameter($type, IQueryBuilder::PARAM_INT)
]);
$query->execute();
}
protected function getProps(string $user, string $path) {
$query = $this->dbConnection->getQueryBuilder();
$query->select('propertyname', 'propertyvalue')
$query->select('propertyname', 'propertyvalue', 'valuetype' )
->from('properties')
->where($query->expr()->eq('userid', $query->createNamedParameter($user)))
->andWhere($query->expr()->eq('propertypath', $query->createNamedParameter($this->formatPath($path))));
@ -112,7 +136,11 @@ class CustomPropertiesBackendTest extends TestCase {
$result = $query->execute();
$data = [];
while ($row = $result->fetch()) {
$data[$row['propertyname']] = $row['propertyvalue'];
$value = $row['propertyvalue'];
if ((int)$row['valuetype'] === CustomPropertiesBackend::PROPERTY_TYPE_HREF) {
$value = new Href($value);
}
$data[$row['propertyname']] = $value;
}
$result->closeCursor();
@ -122,9 +150,10 @@ class CustomPropertiesBackendTest extends TestCase {
public function testPropFindNoDbCalls(): void {
$db = $this->createMock(IDBConnection::class);
$backend = new CustomPropertiesBackend(
$this->server,
$this->tree,
$db,
$this->user
$this->user,
);
$propFind = $this->createMock(PropFind::class);
@ -186,10 +215,169 @@ class CustomPropertiesBackendTest extends TestCase {
$this->assertEquals($props, $setProps);
}
public function testPropFindPrincipalCall(): void {
$this->tree->method('getNodeForPath')
->willReturnCallback(function ($uri) {
$node = $this->createMock(ICalendar::class);
$node->method('getOwner')
->willReturn('principals/users/dummy_user_42');
return $node;
});
$propFind = $this->createMock(PropFind::class);
$propFind->method('get404Properties')
->with()
->willReturn([
'{DAV:}getcontentlength',
'{DAV:}getcontenttype',
'{DAV:}getetag',
'{abc}def',
]);
$propFind->method('getRequestedProperties')
->with()
->willReturn([
'{DAV:}getcontentlength',
'{DAV:}getcontenttype',
'{DAV:}getetag',
'{abc}def',
'{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL',
]);
$props = [
'{abc}def' => 'a',
'{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('calendars/admin/personal'),
];
$this->insertProps('dummy_user_42', 'principals/users/dummy_user_42', $props);
$setProps = [];
$propFind->method('set')
->willReturnCallback(function ($name, $value, $status) use (& $setProps): void {
$setProps[$name] = $value;
});
$this->backend->propFind('principals/users/dummy_user_42', $propFind);
$this->assertEquals($props, $setProps);
}
public function propFindPrincipalScheduleDefaultCalendarProviderUrlProvider(): array {
// [ user, nodes, existingProps, requestedProps, returnedProps ]
return [
[ // Exists
'dummy_user_42',
['calendars/dummy_user_42/foo/' => ICalendar::class],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('calendars/dummy_user_42/foo/')],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL'],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('calendars/dummy_user_42/foo/')],
],
[ // Doesn't exist
'dummy_user_42',
['calendars/dummy_user_42/foo/' => ICalendar::class],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('calendars/dummy_user_42/bar/')],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL'],
[],
],
[ // No privilege
'dummy_user_42',
['calendars/user2/baz/' => ICalendar::class],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('calendars/user2/baz/')],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL'],
[],
],
[ // Not a calendar
'dummy_user_42',
['foo/dummy_user_42/bar/' => IACL::class],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('foo/dummy_user_42/bar/')],
['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL'],
[],
],
];
}
/**
* @dataProvider propFindPrincipalScheduleDefaultCalendarProviderUrlProvider
*/
public function testPropFindPrincipalScheduleDefaultCalendarUrl(
string $user,
array $nodes,
array $existingProps,
array $requestedProps,
array $returnedProps,
): void {
$propFind = $this->createMock(PropFind::class);
$propFind->method('get404Properties')
->with()
->willReturn([
'{DAV:}getcontentlength',
'{DAV:}getcontenttype',
'{DAV:}getetag',
]);
$propFind->method('getRequestedProperties')
->with()
->willReturn(array_merge([
'{DAV:}getcontentlength',
'{DAV:}getcontenttype',
'{DAV:}getetag',
'{abc}def',
],
$requestedProps,
));
$this->server->method('calculateUri')
->willReturnCallback(function ($uri) {
if (!str_starts_with($uri, self::BASE_URI)) {
return trim(substr($uri, strlen(self::BASE_URI)), '/');
}
return null;
});
$this->tree->method('getNodeForPath')
->willReturnCallback(function ($uri) use ($nodes) {
if (str_starts_with($uri, 'principals/')) {
return $this->createMock(IPrincipal::class);
}
if (array_key_exists($uri, $nodes)) {
$owner = explode('/', $uri)[1];
$node = $this->createMock($nodes[$uri]);
$node->method('getOwner')
->willReturn("principals/users/$owner");
return $node;
}
throw new NotFound('Node not found');
});
$this->insertProps($user, "principals/users/$user", $existingProps);
$setProps = [];
$propFind->method('set')
->willReturnCallback(function ($name, $value, $status) use (& $setProps): void {
$setProps[$name] = $value;
});
$this->backend->propFind("principals/users/$user", $propFind);
$this->assertEquals($returnedProps, $setProps);
}
/**
* @dataProvider propPatchProvider
*/
public function testPropPatch(string $path, array $existing, array $props, array $result): void {
$this->server->method('calculateUri')
->willReturnCallback(function ($uri) {
if (str_starts_with($uri, self::BASE_URI)) {
return trim(substr($uri, strlen(self::BASE_URI)), '/');
}
return null;
});
$this->tree->method('getNodeForPath')
->willReturnCallback(function ($uri) {
$node = $this->createMock(ICalendar::class);
$node->method('getOwner')
->willReturn('principals/users/' . $this->user->getUID());
return $node;
});
$this->insertProps($this->user->getUID(), $path, $existing);
$propPatch = new PropPatch($props);
@ -207,6 +395,8 @@ class CustomPropertiesBackendTest extends TestCase {
['foo_bar_path_1337', ['{DAV:}displayname' => 'foo'], ['{DAV:}displayname' => 'anything'], ['{DAV:}displayname' => 'anything']],
['foo_bar_path_1337', ['{DAV:}displayname' => 'foo'], ['{DAV:}displayname' => null], []],
[$longPath, [], ['{DAV:}displayname' => 'anything'], ['{DAV:}displayname' => 'anything']],
['principals/users/dummy_user_42', [], ['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('foo/bar/')], ['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('foo/bar/')]],
['principals/users/dummy_user_42', [], ['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href(self::BASE_URI . 'foo/bar/')], ['{urn:ietf:params:xml:ns:caldav}schedule-default-calendar-URL' => new Href('foo/bar/')]],
];
}