port database layer from appframework to core

3 files changed, 647 insertions, 0 deletions

diff --git a/tests/lib/appframework/db/EntityTest.php b/tests/lib/appframework/db/EntityTest.php
new file mode 100644
index 00000000000..170bd04b7b9
--- /dev/null
+++ b/tests/lib/appframework/db/EntityTest.php
@@ -0,0 +1,204 @@
+<?php
+
+/**
+* ownCloud - App Framework
+*
+* @author Bernhard Posselt
+* @copyright 2012 Bernhard Posselt dev@bernhard-posselt.com
+*
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either
+* version 3 of the License, or any later version.
+*
+* This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
+*
+*/
+
+namespace OCP\AppFramework\Db;
+
+
+
+class TestEntity extends Entity {
+	public $name;
+	public $email;
+	public $testId;
+	public $preName;
+
+	public function __construct(){
+		$this->addType('testId', 'integer');		
+	}
+};
+
+
+class EntityTest extends \PHPUnit_Framework_TestCase {
+
+	private $entity;
+
+	protected function setUp(){
+		$this->entity = new TestEntity();
+	}
+
+
+	public function testResetUpdatedFields(){
+		$entity = new TestEntity();
+		$entity->setId(3);
+		$entity->resetUpdatedFields();
+
+		$this->assertEquals(array(), $entity->getUpdatedFields());
+	}
+
+
+	public function testFromRow(){
+		$row = array(
+			'pre_name' => 'john', 
+			'email' => 'john@something.com'
+		);
+		$this->entity = TestEntity::fromRow($row);
+
+		$this->assertEquals($row['pre_name'], $this->entity->getPreName());
+		$this->assertEquals($row['email'], $this->entity->getEmail());
+	}
+
+
+	public function testGetSetId(){
+		$id = 3;
+		$this->entity->setId(3);
+
+		$this->assertEquals($id, $this->entity->getId());
+	}
+
+
+	public function testColumnToPropertyNoReplacement(){
+		$column = 'my';
+		$this->assertEquals('my', 
+			$this->entity->columnToProperty($column));
+	}
+
+
+	public function testColumnToProperty(){
+		$column = 'my_attribute';
+		$this->assertEquals('myAttribute', 
+			$this->entity->columnToProperty($column));
+	}
+
+
+	public function testPropertyToColumnNoReplacement(){
+		$property = 'my';
+		$this->assertEquals('my', 
+			$this->entity->propertyToColumn($property));
+	}
+
+
+	public function testSetterMarksFieldUpdated(){
+		$id = 3;
+		$this->entity->setId(3);
+
+		$this->assertContains('id', $this->entity->getUpdatedFields());
+	}
+
+
+	public function testCallShouldOnlyWorkForGetterSetter(){
+		$this->setExpectedException('\BadFunctionCallException');
+
+		$this->entity->something();
+	}
+
+
+	public function testGetterShouldFailIfAttributeNotDefined(){
+		$this->setExpectedException('\BadFunctionCallException');
+
+		$this->entity->getTest();
+	}
+
+
+	public function testSetterShouldFailIfAttributeNotDefined(){
+		$this->setExpectedException('\BadFunctionCallException');
+
+		$this->entity->setTest();
+	}
+
+
+	public function testFromRowShouldNotAssignEmptyArray(){
+		$row = array();
+		$entity2 = new TestEntity();
+
+		$this->entity = TestEntity::fromRow($row);
+		$this->assertEquals($entity2, $this->entity);
+	}
+
+
+	public function testIdGetsConvertedToInt(){
+		$row = array('id' => '4');
+
+		$this->entity = TestEntity::fromRow($row);
+		$this->assertSame(4, $this->entity->getId());
+	}
+
+
+	public function testSetType(){
+		$row = array('testId' => '4');
+
+		$this->entity = TestEntity::fromRow($row);
+		$this->assertSame(4, $this->entity->getTestId());
+	}
+
+
+	public function testFromParams(){
+		$params = array(
+			'testId' => 4,
+			'email' => 'john@doe'
+		);
+
+		$entity = TestEntity::fromParams($params);
+
+		$this->assertEquals($params['testId'], $entity->getTestId());
+		$this->assertEquals($params['email'], $entity->getEmail());
+		$this->assertTrue($entity instanceof TestEntity);
+	}
+
+	public function testSlugify(){
+		$entity = new TestEntity();
+		$entity->setName('Slugify this!');
+		$this->assertEquals('slugify-this', $entity->slugify('name'));
+		$entity->setName('°!"§$%&/()=?`´ß\}][{³²#\'+~*-_.:,;<>|äöüÄÖÜSlugify this!');
+		$this->assertEquals('slugify-this', $entity->slugify('name'));
+	}
+
+
+	public function testSetterCasts() {
+		$entity = new TestEntity();
+		$entity->setId('3');
+		$this->assertSame(3, $entity->getId());
+	}
+
+
+	public function testSetterDoesNotCastOnNull() {
+		$entity = new TestEntity();
+		$entity->setId(null);
+		$this->assertSame(null, $entity->getId());
+	}
+
+
+	public function testGetFieldTypes() {
+		$entity = new TestEntity();
+		$this->assertEquals(array(
+			'id' => 'integer',
+			'testId' => 'integer'
+		), $entity->getFieldTypes());
+	}
+
+
+	public function testGetItInt() {
+		$entity = new TestEntity();
+		$entity->setId(3);
+		$this->assertEquals('integer', gettype($entity->getId()));
+	}
+
+}
\ No newline at end of file
diff --git a/tests/lib/appframework/db/MapperTest.php b/tests/lib/appframework/db/MapperTest.php
new file mode 100644
index 00000000000..2a7a3700dab
--- /dev/null
+++ b/tests/lib/appframework/db/MapperTest.php
@@ -0,0 +1,264 @@
+<?php
+
+/**
+ * ownCloud - App Framework
+ *
+ * @author Bernhard Posselt
+ * @copyright 2012 Bernhard Posselt dev@bernhard-posselt.com
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+
+namespace OCP\AppFramework\Db;
+
+
+require_once __DIR__ . '/MapperTestUtility.php';
+
+
+class Example extends Entity {
+	public $preName;
+	public $email;
+};
+
+
+class ExampleMapper extends Mapper {
+	public function __construct(IDb $db){ parent::__construct($db, 'table'); }
+	public function find($table, $id){ return $this->findOneQuery($table, $id); }
+	public function findOneEntity($table, $id){ return $this->findEntity($table, $id); }
+	public function findAll($table){ return $this->findAllQuery($table); }
+	public function findAllEntities($table){ return $this->findEntities($table); }
+	public function mapRow($row){ return $this->mapRowToEntity($row); }
+	public function pDeleteQuery($table, $id){ $this->deleteQuery($table, $id); }
+}
+
+
+class MapperTest extends MapperTestUtility {
+
+	private $mapper;
+
+	public function setUp(){
+		parent::setUp();
+		$this->mapper = new ExampleMapper($this->db);
+	}
+
+
+	public function testMapperShouldSetTableName(){
+		$this->assertEquals('*PREFIX*table', $this->mapper->getTableName());
+	}
+
+
+	public function testFindQuery(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array(
+			array('hi')
+		);
+		$row = $this->setMapperResult($sql, $params, $rows);		
+		$this->mapper->find($sql, $params);
+	}
+
+	public function testFindEntity(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array(
+			array('pre_name' => 'hi')
+		);
+		$row = $this->setMapperResult($sql, $params, $rows);
+		$this->mapper->findOneEntity($sql, $params);
+	}
+
+	public function testFindNotFound(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array();
+		$row = $this->setMapperResult($sql, $params, $rows);		
+		$this->setExpectedException(
+			'\OCP\AppFramework\Db\DoesNotExistException');
+		$this->mapper->find($sql, $params);
+	}
+
+	public function testFindEntityNotFound(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array();
+		$row = $this->setMapperResult($sql, $params, $rows);
+		$this->setExpectedException(
+			'\OCP\AppFramework\Db\DoesNotExistException');
+		$this->mapper->findOneEntity($sql, $params);
+	}
+
+	public function testFindMultiple(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array(
+			array('jo'), array('ho')
+		);
+		$row = $this->setMapperResult($sql, $params, $rows);
+		$this->setExpectedException(
+			'\OCP\AppFramework\Db\MultipleObjectsReturnedException');
+		$this->mapper->find($sql, $params);
+	}
+
+	public function testFindEntityMultiple(){
+		$sql = 'hi';
+		$params = array('jo');
+		$rows = array(
+			array('jo'), array('ho')
+		);
+		$row = $this->setMapperResult($sql, $params, $rows);
+		$this->setExpectedException(
+			'\OCP\AppFramework\Db\MultipleObjectsReturnedException');
+		$this->mapper->findOneEntity($sql, $params);
+	}
+
+
+	public function testDelete(){
+		$sql = 'DELETE FROM `*PREFIX*table` WHERE `id` = ?';
+		$params = array(2);
+
+		$this->setMapperResult($sql, $params);
+		$entity = new Example();
+		$entity->setId($params[0]);
+
+		$this->mapper->delete($entity);
+	}
+
+
+	public function testCreate(){
+		$this->db->expects($this->once())
+			->method('getInsertId')
+			->with($this->equalTo('*PREFIX*table'))
+			->will($this->returnValue(3));
+		$this->mapper = new ExampleMapper($this->db);
+
+		$sql = 'INSERT INTO `*PREFIX*table`(`pre_name`,`email`) ' .
+				'VALUES(?,?)';
+		$params = array('john', 'my@email');
+		$entity = new Example();
+		$entity->setPreName($params[0]);
+		$entity->setEmail($params[1]);
+
+		$this->setMapperResult($sql, $params);
+
+		$this->mapper->insert($entity);
+	}
+
+
+	public function testCreateShouldReturnItemWithCorrectInsertId(){
+		$this->db->expects($this->once())
+			->method('getInsertId')
+			->with($this->equalTo('*PREFIX*table'))
+			->will($this->returnValue(3));
+		$this->mapper = new ExampleMapper($this->db);
+
+		$sql = 'INSERT INTO `*PREFIX*table`(`pre_name`,`email`) ' .
+				'VALUES(?,?)';
+		$params = array('john', 'my@email');
+		$entity = new Example();
+		$entity->setPreName($params[0]);
+		$entity->setEmail($params[1]);
+
+		$this->setMapperResult($sql, $params);
+
+		$result = $this->mapper->insert($entity);
+
+		$this->assertEquals(3, $result->getId());
+	}
+
+
+	public function testUpdate(){
+		$sql = 'UPDATE `*PREFIX*table` ' .
+				'SET ' .
+				'`pre_name` = ?,'.
+				'`email` = ? ' .
+				'WHERE `id` = ?';
+
+		$params = array('john', 'my@email', 1);
+		$entity = new Example();
+		$entity->setPreName($params[0]);
+		$entity->setEmail($params[1]);
+		$entity->setId($params[2]);
+
+		$this->setMapperResult($sql, $params);
+
+		$this->mapper->update($entity);
+	}
+
+
+	public function testUpdateNoId(){
+		$sql = 'UPDATE `*PREFIX*table` ' .
+				'SET ' .
+				'`pre_name` = ?,'.
+				'`email` = ? ' .
+				'WHERE `id` = ?';
+
+		$params = array('john', 'my@email');
+		$entity = new Example();
+		$entity->setPreName($params[0]);
+		$entity->setEmail($params[1]);
+
+		$this->setExpectedException('InvalidArgumentException');
+
+		$this->mapper->update($entity);
+	}
+
+
+	public function testMapRowToEntity(){
+		$entity1 = $this->mapper->mapRow(array('pre_name' => 'test1', 'email' => 'test2'));
+		$entity2 = new Example();
+		$entity2->setPreName('test1');
+		$entity2->setEmail('test2');
+		$entity2->resetUpdatedFields();
+		$this->assertEquals($entity2, $entity1);
+	}
+
+	public function testFindEntities(){
+		$sql = 'hi';
+		$rows = array(
+			array('pre_name' => 'hi')
+		);
+		$entity = new Example();
+		$entity->setPreName('hi');
+		$entity->resetUpdatedFields();
+		$row = $this->setMapperResult($sql, array(), $rows);
+		$result = $this->mapper->findAllEntities($sql);
+		$this->assertEquals(array($entity), $result);
+	}
+
+	public function testFindEntitiesNotFound(){
+		$sql = 'hi';
+		$rows = array();
+		$row = $this->setMapperResult($sql, array(), $rows);
+		$result = $this->mapper->findAllEntities($sql);
+		$this->assertEquals(array(), $result);
+	}
+
+	public function testFindEntitiesMultiple(){
+		$sql = 'hi';
+		$rows = array(
+			array('pre_name' => 'jo'), array('email' => 'ho')
+		);
+		$entity1 = new Example();
+		$entity1->setPreName('jo');
+		$entity1->resetUpdatedFields();
+		$entity2 = new Example();
+		$entity2->setEmail('ho');
+		$entity2->resetUpdatedFields();
+		$row = $this->setMapperResult($sql, array(), $rows);
+		$result = $this->mapper->findAllEntities($sql);
+		$this->assertEquals(array($entity1, $entity2), $result);
+	}
+}
\ No newline at end of file
diff --git a/tests/lib/appframework/db/MapperTestUtility.php b/tests/lib/appframework/db/MapperTestUtility.php
new file mode 100644
index 00000000000..ecd79fef263
--- /dev/null
+++ b/tests/lib/appframework/db/MapperTestUtility.php
@@ -0,0 +1,179 @@
+<?php
+
+/**
+ * ownCloud - App Framework
+ *
+ * @author Bernhard Posselt
+ * @copyright 2012 Bernhard Posselt dev@bernhard-posselt.com
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or any later version.
+ *
+ * This library 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 along with this library.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+
+namespace OCP\AppFramework\Db;
+
+
+/**
+ * Simple utility class for testing mappers
+ */
+abstract class MapperTestUtility extends \PHPUnit_Framework_TestCase {
+
+
+	protected $db;
+	private $query;
+	private $pdoResult;
+	private $queryAt;
+	private $prepareAt;
+	private $fetchAt;
+	private $iterators;
+	
+
+	/**
+	 * Run this function before the actual test to either set or initialize the
+	 * db. After this the db can be accessed by using $this->db
+	 */
+	protected function setUp(){
+		$this->db = $this->getMockBuilder(
+			'\OCP\AppFramework\Db\IDb')
+			->disableOriginalConstructor()
+			->getMock();
+
+		$this->query = $this->getMock('Query', array('execute', 'bindValue'));
+		$this->pdoResult = $this->getMock('Result', array('fetchRow'));
+		$this->queryAt = 0;
+		$this->prepareAt = 0;
+		$this->iterators = array();
+		$this->fetchAt = 0;
+	}
+
+
+	/**
+	 * Create mocks and set expected results for database queries
+	 * @param string $sql the sql query that you expect to receive
+	 * @param array $arguments the expected arguments for the prepare query
+	 * method
+	 * @param array $returnRows the rows that should be returned for the result
+	 * of the database query. If not provided, it wont be assumed that fetchRow
+	 * will be called on the result
+	 */
+	protected function setMapperResult($sql, $arguments=array(), $returnRows=array(),
+		$limit=null, $offset=null){
+
+		$this->iterators[] = new ArgumentIterator($returnRows);
+
+		$iterators = $this->iterators;
+		$fetchAt = $this->fetchAt;
+
+		$this->pdoResult->expects($this->any())
+			->method('fetchRow')
+			->will($this->returnCallback(
+				function() use ($iterators, $fetchAt){
+					$iterator = $iterators[$fetchAt];
+					$result = $iterator->next();
+
+					if($result === false) {
+						$fetchAt++;
+					}
+
+					return $result;
+			  	}
+			));
+
+		$index = 1;
+		foreach($arguments as $argument) {
+			switch (gettype($argument)) {
+				case 'integer':
+					$pdoConstant = \PDO::PARAM_INT;
+					break;
+
+				case 'NULL':
+					$pdoConstant = \PDO::PARAM_NULL;
+					break;
+
+				case 'boolean':
+					$pdoConstant = \PDO::PARAM_BOOL;
+					break;
+				
+				default:
+					$pdoConstant = \PDO::PARAM_STR;
+					break;
+			}
+			$this->query->expects($this->at($this->queryAt))
+				->method('bindValue')
+				->with($this->equalTo($index),
+					$this->equalTo($argument),
+					$this->equalTo($pdoConstant));
+			$index++;
+			$this->queryAt++;
+		}
+
+		$this->query->expects($this->at($this->queryAt))
+			->method('execute')
+			->with()
+			->will($this->returnValue($this->pdoResult));
+		$this->queryAt++;
+
+		if($limit === null && $offset === null) {
+			$this->db->expects($this->at($this->prepareAt))
+				->method('prepareQuery')
+				->with($this->equalTo($sql))
+				->will(($this->returnValue($this->query)));
+		} elseif($limit !== null && $offset === null) {
+			$this->db->expects($this->at($this->prepareAt))
+				->method('prepareQuery')
+				->with($this->equalTo($sql), $this->equalTo($limit))
+				->will(($this->returnValue($this->query)));
+		} elseif($limit === null && $offset !== null) {
+			$this->db->expects($this->at($this->prepareAt))
+				->method('prepareQuery')
+				->with($this->equalTo($sql), 
+					$this->equalTo(null),
+					$this->equalTo($offset))
+				->will(($this->returnValue($this->query)));
+		} else  {
+			$this->db->expects($this->at($this->prepareAt))
+				->method('prepareQuery')
+				->with($this->equalTo($sql), 
+					$this->equalTo($limit),
+					$this->equalTo($offset))
+				->will(($this->returnValue($this->query)));
+		}
+		$this->prepareAt++;
+		$this->fetchAt++;
+
+	}
+
+
+}
+
+
+class ArgumentIterator {
+
+	private $arguments;
+	
+	public function __construct($arguments){
+		$this->arguments = $arguments;
+	}
+	
+	public function next(){
+		$result = array_shift($this->arguments);
+		if($result === null){
+			return false;
+		} else {
+			return $result;
+		}
+	}
+}
+