nextcloud/apps/dav/tests/unit/CalDAV/ResourceBooking/AbstractPrincipalBackendTes...

490 lines
16 KiB
PHP

<?php
/**
* @copyright Copyright (c) 2018, Georg Ehrke
*
* @author Georg Ehrke <oc.list@georgehrke.com>
*
* @license AGPL-3.0
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* 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/>
*
*/
namespace OCA\DAV\Tests\unit\CalDAV\ResourceBooking;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IGroupManager;
use OCP\ILogger;
use OCP\IUser;
use OCP\IUserSession;
use Sabre\DAV\PropPatch;
use Test\TestCase;
abstract class AbstractPrincipalBackendTest extends TestCase {
/** @var \OCA\DAV\CalDAV\ResourceBooking\ResourcePrincipalBackend|\OCA\DAV\CalDAV\ResourceBooking\RoomPrincipalBackend */
protected $principalBackend;
/** @var IUserSession|\PHPUnit_Framework_MockObject_MockObject */
protected $userSession;
/** @var IGroupManager|\PHPUnit_Framework_MockObject_MockObject */
protected $groupManager;
/** @var ILogger|\PHPUnit_Framework_MockObject_MockObject */
protected $logger;
/** @var string */
protected $mainDbTable;
/** @var string */
protected $metadataDbTable;
/** @var string */
protected $foreignKey;
/** @var string */
protected $principalPrefix;
/** @var string */
protected $expectedCUType;
public function setUp() {
parent::setUp();
$this->userSession = $this->createMock(IUserSession::class);
$this->groupManager = $this->createMock(IGroupManager::class);
$this->logger = $this->createMock(ILogger::class);
}
protected function tearDown() {
$query = self::$realDatabase->getQueryBuilder();
$query->delete('calendar_resources')->execute();
$query->delete('calendar_resources_md')->execute();
$query->delete('calendar_rooms')->execute();
$query->delete('calendar_rooms_md')->execute();
}
public function testGetPrincipalsByPrefix() {
$actual = $this->principalBackend->getPrincipalsByPrefix($this->principalPrefix);
$this->assertEquals([
[
'uri' => $this->principalPrefix . '/backend1-res1',
'{DAV:}displayname' => 'Beamer1',
'{http://sabredav.org/ns}email-address' => 'res1@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
],
[
'uri' => $this->principalPrefix . '/backend1-res2',
'{DAV:}displayname' => 'TV1',
'{http://sabredav.org/ns}email-address' => 'res2@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
],
[
'uri' => $this->principalPrefix . '/backend2-res3',
'{DAV:}displayname' => 'Beamer2',
'{http://sabredav.org/ns}email-address' => 'res3@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
'{http://nextcloud.com/ns}foo' => 'value1',
'{http://nextcloud.com/ns}meta2' => 'value2',
],
[
'uri' => $this->principalPrefix . '/backend2-res4',
'{DAV:}displayname' => 'TV2',
'{http://sabredav.org/ns}email-address' => 'res4@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
'{http://nextcloud.com/ns}meta1' => 'value1',
'{http://nextcloud.com/ns}meta3' => 'value3-old',
],
[
'uri' => $this->principalPrefix . '/backend3-res5',
'{DAV:}displayname' => 'Beamer3',
'{http://sabredav.org/ns}email-address' => 'res5@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
],
[
'uri' => $this->principalPrefix . '/backend3-res6',
'{DAV:}displayname' => 'Pointer',
'{http://sabredav.org/ns}email-address' => 'res6@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
'{http://nextcloud.com/ns}meta99' => 'value99'
]
], $actual);
}
public function testGetNoPrincipalsByPrefixForWrongPrincipalPrefix() {
$actual = $this->principalBackend->getPrincipalsByPrefix('principals/users');
$this->assertEquals([], $actual);
}
public function testGetPrincipalByPath() {
$actual = $this->principalBackend->getPrincipalByPath($this->principalPrefix . '/backend2-res3');
$this->assertEquals([
'uri' => $this->principalPrefix . '/backend2-res3',
'{DAV:}displayname' => 'Beamer2',
'{http://sabredav.org/ns}email-address' => 'res3@foo.bar',
'{urn:ietf:params:xml:ns:caldav}calendar-user-type' => $this->expectedCUType,
'{http://nextcloud.com/ns}foo' => 'value1',
'{http://nextcloud.com/ns}meta2' => 'value2',
], $actual);
}
public function testGetPrincipalByPathNotFound() {
$actual = $this->principalBackend->getPrincipalByPath($this->principalPrefix . '/db-123');
$this->assertEquals(null, $actual);
}
public function testGetPrincipalByPathWrongPrefix() {
$actual = $this->principalBackend->getPrincipalByPath('principals/users/foo-bar');
$this->assertEquals(null, $actual);
}
public function testGetGroupMemberSet() {
$actual = $this->principalBackend->getGroupMemberSet($this->principalPrefix . '/foo-bar');
$this->assertEquals([], $actual);
}
public function testGetGroupMembership() {
$actual = $this->principalBackend->getGroupMembership($this->principalPrefix . '/foo-bar');
$this->assertEquals([], $actual);
}
/**
* @expectedException \Sabre\DAV\Exception
* @expectedExceptionMessage Setting members of the group is not supported yet
*/
public function testSetGroupMemberSet() {
$this->principalBackend->setGroupMemberSet($this->principalPrefix . '/foo-bar', ['foo', 'bar']);
}
public function testUpdatePrincipal() {
$propPatch = $this->createMock(PropPatch::class);
$actual = $this->principalBackend->updatePrincipal($this->principalPrefix . '/foo-bar', $propPatch);
$this->assertEquals(0, $actual);
}
/**
* @dataProvider dataSearchPrincipals
*/
public function testSearchPrincipals($expected, $test) {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->searchPrincipals($this->principalPrefix, [
'{http://sabredav.org/ns}email-address' => 'foo',
'{DAV:}displayname' => 'Beamer',
], $test);
$this->assertEquals(
str_replace('%prefix%', $this->principalPrefix, $expected),
$actual);
}
public function dataSearchPrincipals() {
// data providers are called before we subclass
// this class, $this->principalPrefix is null
// at that point, so we need this hack
return [
[[
'%prefix%/backend1-res1',
'%prefix%/backend2-res3',
], 'allof'],
[[
'%prefix%/backend1-res1',
'%prefix%/backend1-res2',
'%prefix%/backend2-res3',
'%prefix%/backend2-res4',
'%prefix%/backend3-res6',
], 'anyof'],
];
}
public function testSearchPrincipalsByMetadataKey() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->searchPrincipals($this->principalPrefix, [
'{http://nextcloud.com/ns}meta3' => 'value',
]);
$this->assertEquals([
$this->principalPrefix . '/backend2-res4',
], $actual);
}
public function testSearchPrincipalsByCalendarUserAddressSet() {
$user = $this->createMock(IUser::class);
$this->userSession->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->searchPrincipals($this->principalPrefix, [
'{urn:ietf:params:xml:ns:caldav}calendar-user-address-set' => 'res2@foo.bar',
]);
$this->assertEquals(
str_replace('%prefix%', $this->principalPrefix, [
'%prefix%/backend1-res2',
]),
$actual);
}
public function testSearchPrincipalsEmptySearchProperties() {
$this->userSession->expects($this->never())
->method('getUser');
$this->groupManager->expects($this->never())
->method('getUserGroupIds');
$this->principalBackend->searchPrincipals($this->principalPrefix, []);
}
public function testSearchPrincipalsWrongPrincipalPrefix() {
$this->userSession->expects($this->never())
->method('getUser');
$this->groupManager->expects($this->never())
->method('getUserGroupIds');
$this->principalBackend->searchPrincipals('principals/users', [
'{http://sabredav.org/ns}email-address' => 'foo'
]);
}
public function testFindByUriByEmail() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('mailto:res1@foo.bar', $this->principalPrefix);
$this->assertEquals($this->principalPrefix . '/backend1-res1', $actual);
}
public function testFindByUriByEmailForbiddenResource() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('mailto:res5@foo.bar', $this->principalPrefix);
$this->assertEquals(null, $actual);
}
public function testFindByUriByEmailNotFound() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('mailto:res99@foo.bar', $this->principalPrefix);
$this->assertEquals(null, $actual);
}
public function testFindByUriByPrincipal() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('mailto:res6@foo.bar', $this->principalPrefix);
$this->assertEquals($this->principalPrefix . '/backend3-res6', $actual);
}
public function testFindByUriByPrincipalForbiddenResource() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('principal:' . $this->principalPrefix . '/backend3-res5', $this->principalPrefix);
$this->assertEquals(null, $actual);
}
public function testFindByUriByPrincipalNotFound() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('principal:' . $this->principalPrefix . '/db-123', $this->principalPrefix);
$this->assertEquals(null, $actual);
}
public function testFindByUriByUnknownUri() {
$user = $this->createMock(IUser::class);
$this->userSession->expects($this->once())
->method('getUser')
->with()
->will($this->returnValue($user));
$this->groupManager->expects($this->once())
->method('getUserGroupIds')
->with($user)
->will($this->returnValue(['group1', 'group2']));
$actual = $this->principalBackend->findByUri('foobar:blub', $this->principalPrefix);
$this->assertEquals(null, $actual);
}
protected function createTestDatasetInDb() {
$query = self::$realDatabase->getQueryBuilder();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend1'),
'resource_id' => $query->createNamedParameter('res1'),
'email' => $query->createNamedParameter('res1@foo.bar'),
'displayname' => $query->createNamedParameter('Beamer1'),
'group_restrictions' => $query->createNamedParameter('[]'),
])
->execute();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend1'),
'resource_id' => $query->createNamedParameter('res2'),
'email' => $query->createNamedParameter('res2@foo.bar'),
'displayname' => $query->createNamedParameter('TV1'),
'group_restrictions' => $query->createNamedParameter('[]'),
])
->execute();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend2'),
'resource_id' => $query->createNamedParameter('res3'),
'email' => $query->createNamedParameter('res3@foo.bar'),
'displayname' => $query->createNamedParameter('Beamer2'),
'group_restrictions' => $query->createNamedParameter('[]'),
])
->execute();
$id3 = $query->getLastInsertId();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend2'),
'resource_id' => $query->createNamedParameter('res4'),
'email' => $query->createNamedParameter('res4@foo.bar'),
'displayname' => $query->createNamedParameter('TV2'),
'group_restrictions' => $query->createNamedParameter('[]'),
])
->execute();
$id4 = $query->getLastInsertId();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend3'),
'resource_id' => $query->createNamedParameter('res5'),
'email' => $query->createNamedParameter('res5@foo.bar'),
'displayname' => $query->createNamedParameter('Beamer3'),
'group_restrictions' => $query->createNamedParameter('["foo", "bar"]'),
])
->execute();
$query->insert($this->mainDbTable)
->values([
'backend_id' => $query->createNamedParameter('backend3'),
'resource_id' => $query->createNamedParameter('res6'),
'email' => $query->createNamedParameter('res6@foo.bar'),
'displayname' => $query->createNamedParameter('Pointer'),
'group_restrictions' => $query->createNamedParameter('["group1", "bar"]'),
])
->execute();
$id6 = $query->getLastInsertId();
$query->insert($this->metadataDbTable)
->values([
$this->foreignKey => $query->createNamedParameter($id3),
'key' => $query->createNamedParameter('{http://nextcloud.com/ns}foo'),
'value' => $query->createNamedParameter('value1')
])
->execute();
$query->insert($this->metadataDbTable)
->values([
$this->foreignKey => $query->createNamedParameter($id3),
'key' => $query->createNamedParameter('{http://nextcloud.com/ns}meta2'),
'value' => $query->createNamedParameter('value2')
])
->execute();
$query->insert($this->metadataDbTable)
->values([
$this->foreignKey => $query->createNamedParameter($id4),
'key' => $query->createNamedParameter('{http://nextcloud.com/ns}meta1'),
'value' => $query->createNamedParameter('value1')
])
->execute();
$query->insert($this->metadataDbTable)
->values([
$this->foreignKey => $query->createNamedParameter($id4),
'key' => $query->createNamedParameter('{http://nextcloud.com/ns}meta3'),
'value' => $query->createNamedParameter('value3-old')
])
->execute();
$query->insert($this->metadataDbTable)
->values([
$this->foreignKey => $query->createNamedParameter($id6),
'key' => $query->createNamedParameter('{http://nextcloud.com/ns}meta99'),
'value' => $query->createNamedParameter('value99')
])
->execute();
}
}