Newer
Older
* @author call-me-matt <nextcloud@matthiasheinisch.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
* @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/>
use OCA\DAV\CardDAV\AddressBook;
use OCA\DAV\CardDAV\AddressBookImpl;
use OCA\DAV\CardDAV\CardDavBackend;
use Sabre\VObject\Component\VCard;
use Sabre\VObject\Property\Text;
use Test\TestCase;
class AddressBookImplTest extends TestCase {
/** @var AddressBookImpl */
private $addressBookImpl;
/** @var array */
private $addressBookInfo;
/** @var AddressBook | \PHPUnit\Framework\MockObject\MockObject */
private $addressBook;
/** @var IURLGenerator | \PHPUnit\Framework\MockObject\MockObject */
private $urlGenerator;
/** @var CardDavBackend | \PHPUnit\Framework\MockObject\MockObject */
private $backend;
/** @var VCard | \PHPUnit\Framework\MockObject\MockObject */
private $vCard;
parent::setUp();
$this->addressBookInfo = [
'id' => 42,
'uri' => 'system',
'principaluri' => 'principals/system/system',
'{DAV:}displayname' => 'display name',
$this->addressBook = $this->getMockBuilder(AddressBook::class)
->disableOriginalConstructor()->getMock();
$this->backend = $this->getMockBuilder(CardDavBackend::class)
->disableOriginalConstructor()->getMock();
$this->vCard = $this->createMock(VCard::class);
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->addressBookImpl = new AddressBookImpl(
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator
);
}
public function testGetKey() {
$this->assertSame($this->addressBookInfo['id'],
$this->addressBookImpl->getKey());
}
public function testGetDisplayName() {
$this->assertSame($this->addressBookInfo['{DAV:}displayname'],
$this->addressBookImpl->getDisplayName());
}
public function testSearch() {
/** @var \PHPUnit\Framework\MockObject\MockObject | AddressBookImpl $addressBookImpl */
$addressBookImpl = $this->getMockBuilder(AddressBookImpl::class)
->setConstructorArgs(
[
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator,
]
)
->setMethods(['vCard2Array', 'readCard'])
->getMock();
$pattern = 'pattern';
$searchProperties = 'properties';
$this->backend->expects($this->once())->method('search')
->with($this->addressBookInfo['id'], $pattern, $searchProperties)
->willReturn(
[
['uri' => 'foo.vcf', 'carddata' => 'cardData1'],
['uri' => 'bar.vcf', 'carddata' => 'cardData2']
]
);
$addressBookImpl->expects($this->exactly(2))->method('readCard')
->willReturn($this->vCard);
$addressBookImpl->expects($this->exactly(2))->method('vCard2Array')
->withConsecutive(
['foo.vcf', $this->vCard],
['bar.vcf', $this->vCard]
)->willReturn('vCard');
$result = $addressBookImpl->search($pattern, $searchProperties, []);
$this->assertTrue((is_array($result)));
$this->assertSame(2, count($result));
}
/**
* @dataProvider dataTestCreate
*
* @param array $properties
*/
public function testCreate($properties) {
$uid = 'uid';
/** @var \PHPUnit\Framework\MockObject\MockObject | AddressBookImpl $addressBookImpl */
$addressBookImpl = $this->getMockBuilder(AddressBookImpl::class)
->setConstructorArgs(
[
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator,
]
)
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard'])
->getMock();
$expectedProperties = 0;
foreach ($properties as $data) {
if (is_string($data)) {
$expectedProperties++;
} else {
$expectedProperties += count($data);
}
}
$addressBookImpl->expects($this->once())->method('createUid')
->willReturn($uid);
$addressBookImpl->expects($this->once())->method('createEmptyVCard')
->with($uid)->willReturn($this->vCard);
$this->vCard->expects($this->exactly($expectedProperties))
->method('createProperty');
$this->backend->expects($this->once())->method('createCard');
$this->backend->expects($this->never())->method('updateCard');
$this->backend->expects($this->never())->method('getCard');
$addressBookImpl->expects($this->once())->method('vCard2Array')
->with('uid.vcf', $this->vCard)->willReturn(true);
$this->assertTrue($addressBookImpl->createOrUpdate($properties));
}
public function dataTestCreate() {
return [
[[]],
[['FN' => 'John Doe']],
[['FN' => 'John Doe', 'EMAIL' => ['john@doe.cloud', 'john.doe@example.org']]],
];
}
public function testUpdate() {
$uid = 'uid';
$uri = 'bla.vcf';
$properties = ['URI' => $uri, 'UID' => $uid, 'FN' => 'John Doe'];
/** @var \PHPUnit\Framework\MockObject\MockObject | AddressBookImpl $addressBookImpl */
$addressBookImpl = $this->getMockBuilder(AddressBookImpl::class)
->setConstructorArgs(
[
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator,
]
)
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard'])
->getMock();
$addressBookImpl->expects($this->never())->method('createUid');
$addressBookImpl->expects($this->never())->method('createEmptyVCard');
$this->backend->expects($this->once())->method('getCard')
->with($this->addressBookInfo['id'], $uri)
->willReturn(['carddata' => 'data']);
$addressBookImpl->expects($this->once())->method('readCard')
->with('data')->willReturn($this->vCard);
$this->vCard->expects($this->exactly(count($properties)-1))
->method('createProperty');
$this->backend->expects($this->never())->method('createCard');
$this->backend->expects($this->once())->method('updateCard');
$addressBookImpl->expects($this->once())->method('vCard2Array')
->with($uri, $this->vCard)->willReturn(true);
$this->assertTrue($addressBookImpl->createOrUpdate($properties));
}
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
public function testUpdateWithTypes() {
$uid = 'uid';
$uri = 'bla.vcf';
$properties = ['URI' => $uri, 'UID' => $uid, 'FN' => 'John Doe', 'ADR' => [['type' => 'HOME', 'value' => ';;street;city;;;country']]];
$vCard = new vCard;
$textProperty = $vCard->createProperty('KEY','value');
/** @var \PHPUnit\Framework\MockObject\MockObject | AddressBookImpl $addressBookImpl */
$addressBookImpl = $this->getMockBuilder(AddressBookImpl::class)
->setConstructorArgs(
[
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator,
]
)
->setMethods(['vCard2Array', 'createUid', 'createEmptyVCard', 'readCard'])
->getMock();
$this->backend->expects($this->once())->method('getCard')
->with($this->addressBookInfo['id'], $uri)
->willReturn(['carddata' => 'data']);
$addressBookImpl->expects($this->once())->method('readCard')
->with('data')->willReturn($this->vCard);
$this->vCard->method('createProperty')->willReturn($textProperty);
$this->vCard->expects($this->exactly(count($properties)-1))
->method('createProperty');
$this->vCard->expects($this->once())->method('remove')
->with('ADR');
$this->vCard->expects($this->once())->method('add');
$addressBookImpl->createOrUpdate($properties);
}
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/**
* @dataProvider dataTestGetPermissions
*
* @param array $permissions
* @param int $expected
*/
public function testGetPermissions($permissions, $expected) {
$this->addressBook->expects($this->once())->method('getACL')
->willReturn($permissions);
$this->assertSame($expected,
$this->addressBookImpl->getPermissions()
);
}
public function dataTestGetPermissions() {
return [
[[], 0],
[[['privilege' => '{DAV:}read']], 1],
[[['privilege' => '{DAV:}write']], 6],
[[['privilege' => '{DAV:}all']], 31],
[[['privilege' => '{DAV:}read'],['privilege' => '{DAV:}write']], 7],
[[['privilege' => '{DAV:}read'],['privilege' => '{DAV:}all']], 31],
[[['privilege' => '{DAV:}all'],['privilege' => '{DAV:}write']], 31],
[[['privilege' => '{DAV:}read'],['privilege' => '{DAV:}write'],['privilege' => '{DAV:}all']], 31],
[[['privilege' => '{DAV:}all'],['privilege' => '{DAV:}read'],['privilege' => '{DAV:}write']], 31],
];
}
public function testDelete() {
$cardId = 1;
$cardUri = 'cardUri';
$this->backend->expects($this->once())->method('getCardUri')
->with($cardId)->willReturn($cardUri);
$this->backend->expects($this->once())->method('deleteCard')
->with($this->addressBookInfo['id'], $cardUri)
->willReturn(true);
$this->assertTrue($this->addressBookImpl->delete($cardId));
}
public function testReadCard() {
$vCard = new VCard();
$vCard->add(new Text($vCard, 'UID', 'uid'));
$vCardSerialized = $vCard->serialize();
$result = $this->invokePrivate($this->addressBookImpl, 'readCard', [$vCardSerialized]);
$resultSerialized = $result->serialize();
$this->assertSame($vCardSerialized, $resultSerialized);
}
public function testCreateUid() {
/** @var \PHPUnit\Framework\MockObject\MockObject | AddressBookImpl $addressBookImpl */
$addressBookImpl = $this->getMockBuilder(AddressBookImpl::class)
->setConstructorArgs(
[
$this->addressBook,
$this->addressBookInfo,
$this->backend,
$this->urlGenerator,
]
)
->setMethods(['getUid'])
->getMock();
$addressBookImpl->expects($this->at(0))->method('getUid')->willReturn('uid0');
$addressBookImpl->expects($this->at(1))->method('getUid')->willReturn('uid1');
// simulate that 'uid0' already exists, so the second uid will be returned
$this->backend->expects($this->exactly(2))->method('getContact')
->willReturnCallback(
return ($uid === 'uid0.vcf');
}
);
$this->assertSame('uid1',
$this->invokePrivate($addressBookImpl, 'createUid', [])
);
}
public function testCreateEmptyVCard() {
$uid = 'uid';
$expectedVCard = new VCard();
$expectedVCardSerialized = $expectedVCard->serialize();
$result = $this->invokePrivate($this->addressBookImpl, 'createEmptyVCard', [$uid]);
$resultSerialized = $result->serialize();
$this->assertSame($expectedVCardSerialized, $resultSerialized);
}
public function testVCard2Array() {
$vCard = new VCard();
$vCard->add($vCard->createProperty('FN', 'Full Name'));
// Multi-value properties
$vCard->add($vCard->createProperty('CLOUD', 'cloud-user1@localhost'));
$vCard->add($vCard->createProperty('CLOUD', 'cloud-user2@example.tld'));
$vCard->add($vCard->createProperty('EMAIL', 'email-user1@localhost'));
$vCard->add($vCard->createProperty('EMAIL', 'email-user2@example.tld'));
$vCard->add($vCard->createProperty('IMPP', 'impp-user1@localhost'));
$vCard->add($vCard->createProperty('IMPP', 'impp-user2@example.tld'));
$vCard->add($vCard->createProperty('TEL', '+49 123456789'));
$vCard->add($vCard->createProperty('TEL', '+1 555 123456789'));
$vCard->add($vCard->createProperty('URL', 'https://localhost'));
$vCard->add($vCard->createProperty('URL', 'https://example.tld'));
// Type depending properties
$property = $vCard->createProperty('X-SOCIALPROFILE', 'tw-example');
$property->add('TYPE', 'twitter');
$vCard->add($property);
$property = $vCard->createProperty('X-SOCIALPROFILE', 'tw-example-2');
$property->add('TYPE', 'twitter');
$vCard->add($property);
$property = $vCard->createProperty('X-SOCIALPROFILE', 'fb-example');
$property->add('TYPE', 'facebook');
$vCard->add($property);
$array = $this->invokePrivate($this->addressBookImpl, 'vCard2Array', ['uri', $vCard]);
unset($array['PRODID']);
$this->assertEquals([
'URI' => 'uri',
'FN' => 'Full Name',
'CLOUD' => [
'cloud-user1@localhost',
'cloud-user2@example.tld',
],
'EMAIL' => [
'email-user1@localhost',
'email-user2@example.tld',
],
'IMPP' => [
'impp-user1@localhost',
'impp-user2@example.tld',
],
'TEL' => [
'+49 123456789',
'+1 555 123456789',
],
'URL' => [
'https://localhost',
'https://example.tld',
],
'X-SOCIALPROFILE' => [
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
'tw-example',
'tw-example-2',
'fb-example',
],
'isLocalSystemBook' => true,
], $array);
}
public function testVCard2ArrayWithTypes() {
$vCard = new VCard();
$vCard->add($vCard->createProperty('FN', 'Full Name'));
// Multi-value properties
$vCard->add($vCard->createProperty('CLOUD', 'cloud-user1@localhost'));
$vCard->add($vCard->createProperty('CLOUD', 'cloud-user2@example.tld'));
$property = $vCard->createProperty('EMAIL', 'email-user1@localhost');
$property->add('TYPE', 'HOME');
$vCard->add($property);
$property = $vCard->createProperty('EMAIL', 'email-user2@example.tld');
$property->add('TYPE', 'WORK');
$vCard->add($property);
$vCard->add($vCard->createProperty('IMPP', 'impp-user1@localhost'));
$vCard->add($vCard->createProperty('IMPP', 'impp-user2@example.tld'));
$property = $vCard->createProperty('TEL', '+49 123456789');
$property->add('TYPE', 'HOME,VOICE');
$vCard->add($property);
$property = $vCard->createProperty('TEL', '+1 555 123456789');
$property->add('TYPE', 'WORK');
$vCard->add($property);
$vCard->add($vCard->createProperty('URL', 'https://localhost'));
$vCard->add($vCard->createProperty('URL', 'https://example.tld'));
// Type depending properties
$property = $vCard->createProperty('X-SOCIALPROFILE', 'tw-example');
$property->add('TYPE', 'twitter');
$vCard->add($property);
$property = $vCard->createProperty('X-SOCIALPROFILE', 'tw-example-2');
$property->add('TYPE', 'twitter');
$vCard->add($property);
$property = $vCard->createProperty('X-SOCIALPROFILE', 'fb-example');
$property->add('TYPE', 'facebook');
$vCard->add($property);
$array = $this->invokePrivate($this->addressBookImpl, 'vCard2Array', ['uri', $vCard, true]);
unset($array['PRODID']);
unset($array['UID']);
$this->assertEquals([
'URI' => 'uri',
'VERSION' => '4.0',
'FN' => 'Full Name',
'CLOUD' => [
['type' => '', 'value' => 'cloud-user1@localhost'],
['type' => '', 'value' => 'cloud-user2@example.tld'],
],
'EMAIL' => [
['type' => 'HOME', 'value' => 'email-user1@localhost'],
['type' => 'WORK', 'value' => 'email-user2@example.tld'],
],
'IMPP' => [
['type' => '', 'value' => 'impp-user1@localhost'],
['type' => '', 'value' => 'impp-user2@example.tld'],
],
'TEL' => [
['type' => 'HOME,VOICE', 'value' => '+49 123456789'],
['type' => 'WORK', 'value' => '+1 555 123456789'],
],
'URL' => [
['type' => '', 'value' => 'https://localhost'],
['type' => '', 'value' => 'https://example.tld'],
],
'X-SOCIALPROFILE' => [
['type' => 'twitter', 'value' => 'tw-example'],
['type' => 'twitter', 'value' => 'tw-example-2'],
['type' => 'facebook', 'value' => 'fb-example'],
],
'isLocalSystemBook' => true,
], $array);
}
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
public function testIsSystemAddressBook(): void {
$addressBookInfo = [
'{http://owncloud.org/ns}owner-principal' => 'principals/system/system',
'principaluri' => 'principals/system/system',
'{DAV:}displayname' => 'display name',
'id' => 666,
'uri' => 'system',
];
$addressBookImpl = new AddressBookImpl(
$this->addressBook,
$addressBookInfo,
$this->backend,
$this->urlGenerator
);
$this->assertTrue($addressBookImpl->isSystemAddressBook());
}
public function testIsShared(): void {
$addressBookInfo = [
'{http://owncloud.org/ns}owner-principal' => 'user1',
'{DAV:}displayname' => 'Test address book',
'principaluri' => 'user2',
'id' => 666,
'uri' => 'default',
];
$addressBookImpl = new AddressBookImpl(
$this->addressBook,
$addressBookInfo,
$this->backend,
$this->urlGenerator
);
$this->assertFalse($addressBookImpl->isSystemAddressBook());
$this->assertTrue($addressBookImpl->isShared());
}
public function testIsNotShared(): void {
$addressBookInfo = [
'{http://owncloud.org/ns}owner-principal' => 'user1',
'{DAV:}displayname' => 'Test address book',
'principaluri' => 'user1',
'id' => 666,
'uri' => 'default',
];
$addressBookImpl = new AddressBookImpl(
$this->addressBook,
$addressBookInfo,
$this->backend,
$this->urlGenerator
);
$this->assertFalse($addressBookImpl->isSystemAddressBook());
$this->assertFalse($addressBookImpl->isShared());
}