owncloud / contacts

tests/unit/lib/addressbookTest.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 16 and the first side effect is on line 14.

/**
 * Copyright (c) 2013 Thomas Tanghus (thomas@tanghus.net)
 * This file is licensed under the Affero General Public License version 3 or
 * later.
 * See the COPYING-README file.
 */

namespace OCA\Contacts;

use Sabre\VObject\Reader;
use Test\TestCase;

require_once __DIR__ . '/backend/mock.php';

class AddressBookTest extends TestCase {

	/**
	* @var array
	*/
	protected $abinfo;
	/**
	* @var \OCA\Contacts\Addressbook
	*/
	protected $ab;
	/**
	* @var \OCA\Contacts\Backend\AbstractBackend
	*/
	protected $backend;

	public function setUp() {
		parent::setUp();

		$this->backend = new Backend\Mock('foobar');
		$this->abinfo = $this->backend->getAddressBook('foo');

It seems like $this->backend->getAddressBook('foo') can be null. However, the property $abinfo is declared as array. Maybe change the type of the property to array|null or add a type check?

		$this->ab = new AddressBook($this->backend, $this->abinfo);

It seems like $this->abinfo can also be of type null; however, OCA\Contacts\Addressbook::__construct() does only seem to accept array, maybe add an additional type check?

	}

	public function tearDown() {
		unset($this->backend);
		unset($this->ab);

		parent::tearDown();
	}

	public function testGetDisplayName() {

		$this->assertEquals('d-name', $this->ab->getDisplayName());

	}

	public function testGetPermissions() {

		$this->assertEquals(\OCP\PERMISSION_ALL, $this->ab->getPermissions());

	}

	public function testGetBackend() {

		$this->assertEquals($this->backend, $this->ab->getBackend());

	}

	public function testGetChild() {

		$contact = $this->ab->getChild('123');
		$this->assertInstanceOf('OCA\\Contacts\\Contact', $contact);
		$this->assertEquals('Max Mustermann', $contact->getDisplayName());

	}

	public function testChildExists() {

		$this->assertFalse($this->ab->childExists('12'));
		$this->assertTrue($this->ab->childExists('123'));

	}

	public function testAddChild() {

This method seems to be duplicated in your project.

		$carddata = file_get_contents(__DIR__ . '/../data/test2.vcf');
		$vcard = Reader::read($carddata);
		$id = $this->ab->addChild($vcard);

It seems like $vcard defined by \Sabre\VObject\Reader::read($carddata) on line 83 can also be of type object<Sabre\VObject\Component> or object<Sabre\VObject\Property>; however, OCA\Contacts\Addressbook::addChild() does only seem to accept array|object<OCA\Contacts\VObject\VCard>|null, maybe add an additional type check?

		$this->assertNotEquals(false, $id);

		return $this->ab;
	}

	public function testDeleteChild() {

		$this->assertTrue($this->ab->deleteChild('123'));
		$this->assertEquals(array(), $this->ab->getChildren());

	}

	public function testGetChildNotFound() {

		try {
			$contact = $this->ab->getChild('Nowhere');

$contact is not used, you could remove the assignment.

		} catch(\Exception $e) {
			$this->assertEquals('Contact not found', $e->getMessage());
			$this->assertEquals(404, $e->getCode());
			return;
		}

		$this->fail('Expected Exception 404.');

	}

	/**
	* @depends testAddChild
	 * @param $ab
	 */
	public function testGetChildren($ab) {

		$contacts = $ab->getChildren();

		$this->assertCount(2, $contacts);

		$this->assertEquals('Max Mustermann', $contacts[0]->getDisplayName());
		$this->assertEquals('John Q. Public', $contacts[1]->getDisplayName());

	}

	public function testDelete() {

		$this->assertTrue($this->ab->delete());
		$this->assertEquals(array(), $this->backend->addressBooks);

The property addressBooks does not seem to exist in OCA\Contacts\Backend\AbstractBackend.

	}

	public function testGetLastModified() {

		$this->assertNull($this->ab->lastModified());

	}

	public function testUpdate() {

This method seems to be duplicated in your project.

		$this->assertTrue(
			$this->ab->update(array('displayname' => 'bar'))
		);

		$this->assertEquals('bar', $this->backend->addressBooks[0]['displayname']);

The property addressBooks does not seem to exist in OCA\Contacts\Backend\AbstractBackend.

		$props = $this->ab->getMetaData();

$props is not used, you could remove the assignment.

		return $this->ab;

	}

	/**
	* @depends testUpdate
	*/
	public function testGetMetaData($ab) {

		$props = $ab->getMetaData();
		$this->assertEquals('bar', $props['displayname']);

	}

	public function testArrayAccess() {

		$carddata = file_get_contents(__DIR__ . '/../data/test2.vcf');
		$vcard = Reader::read($carddata);

		$contact = $this->ab['123'];

		// Test get
		$this->assertTrue(isset($this->ab['123']));
		$this->assertInstanceOf('OCA\\Contacts\\Contact', $contact);
		$this->assertEquals('Max Mustermann', $contact->getDisplayName());

		// Test unset
		unset($this->ab['123']);

		$this->assertTrue(!isset($this->ab['123']));

		// Test set
		try {
			$this->ab[] = $vcard;
		} catch(\Exception $e) {
			return;
		}

		$this->fail('Expected Exception');

	}

	/**
	* @depends testAddChild
	*/
	public function testIterator($ab) {

		$count = 0;

		foreach($ab as $contact) {
			$this->assertInstanceOf('OCA\\Contacts\\Contact', $contact);
			$count += 1;
		}

		$this->assertEquals(2, $count);
	}

	/**
	* @depends testAddChild
	*/
	public function testCountable($ab) {

		$this->assertEquals(2, count($ab));

	}

}