mappertestutility.php 5.21 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?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/>.
 *
 */


25
namespace Test\AppFramework\Db;
26
27
28
29
30


/**
 * Simple utility class for testing mappers
 */
31
abstract class MapperTestUtility extends \Test\TestCase {
32
33
34
35
36
37
	protected $db;
	private $query;
	private $queryAt;
	private $prepareAt;
	private $fetchAt;
	private $iterators;
Bernhard Posselt's avatar
Bernhard Posselt committed
38

39
40
41
42
43
44

	/**
	 * 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(){
45
46
		parent::setUp();

47
		$this->db = $this->getMockBuilder(
48
			'\OCP\IDBConnection')
49
50
51
			->disableOriginalConstructor()
			->getMock();

52
		$this->query = $this->getMock('\PDOStatement');
53
54
		$this->queryAt = 0;
		$this->prepareAt = 0;
55
		$this->iterators = [];
56
57
58
		$this->fetchAt = 0;
	}

59
60
61
62
63
64
65
66
	/**
	 * Checks if an array is associative
	 * @param array $array
	 * @return bool true if associative
	 */
	private function isAssocArray(array $array) {
		return array_values($array) !== $array;
	}
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
	/**
	 * Returns the correct PDO constant based on the value type
	 * @param $value
	 * @return PDO constant
	 */
	private function getPDOType($value) {
		switch (gettype($value)) {
			case 'integer':
				return \PDO::PARAM_INT;
			case 'boolean':
				return \PDO::PARAM_BOOL;
			default:
				return \PDO::PARAM_STR;
		}
	}
Bernhard Posselt's avatar
Bernhard Posselt committed
83

Bernhard Posselt's avatar
Bernhard Posselt committed
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
	/**
	 * 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 fetch
	 * will be called on the result
	 */
	protected function setMapperResult($sql, $arguments=array(), $returnRows=array(),
		$limit=null, $offset=null, $expectClose=false){
		if($limit === null && $offset === null) {
			$this->db->expects($this->at($this->prepareAt))
				->method('prepare')
				->with($this->equalTo($sql))
				->will(($this->returnValue($this->query)));
		} elseif($limit !== null && $offset === null) {
			$this->db->expects($this->at($this->prepareAt))
				->method('prepare')
				->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('prepare')
				->with($this->equalTo($sql),
					$this->equalTo(null),
					$this->equalTo($offset))
				->will(($this->returnValue($this->query)));
		} else  {
			$this->db->expects($this->at($this->prepareAt))
				->method('prepare')
				->with($this->equalTo($sql),
					$this->equalTo($limit),
					$this->equalTo($offset))
				->will(($this->returnValue($this->query)));
		}

		$this->iterators[] = new ArgumentIterator($returnRows);

		$iterators = $this->iterators;
		$fetchAt = $this->fetchAt;

		$this->query->expects($this->any())
			->method('fetch')
			->will($this->returnCallback(
				function() use ($iterators, $fetchAt){
					$iterator = $iterators[$fetchAt];
					$result = $iterator->next();

					if($result === false) {
						$fetchAt++;
					}

					$this->queryAt++;

					return $result;
				}
			));

143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
		if ($this->isAssocArray($arguments)) {
			foreach($arguments as $key => $argument) {
				$pdoConstant = $this->getPDOType($argument);
				$this->query->expects($this->at($this->queryAt))
					->method('bindValue')
					->with($this->equalTo($key),
						$this->equalTo($argument),
						$this->equalTo($pdoConstant));
				$this->queryAt++;
			}
		} else {
			$index = 1;
			foreach($arguments as $argument) {
				$pdoConstant = $this->getPDOType($argument);
				$this->query->expects($this->at($this->queryAt))
					->method('bindValue')
					->with($this->equalTo($index),
						$this->equalTo($argument),
						$this->equalTo($pdoConstant));
				$index++;
				$this->queryAt++;
Bernhard Posselt's avatar
Bernhard Posselt committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
			}
		}

		$this->query->expects($this->at($this->queryAt))
			->method('execute')
			->will($this->returnCallback(function($sql, $p=null, $o=null, $s=null) {

			}));
		$this->queryAt++;



		if ($expectClose) {
			$closing = $this->at($this->queryAt);
		} else {
			$closing = $this->any();
		}
		$this->query->expects($closing)->method('closeCursor');
		$this->queryAt++;

		$this->prepareAt++;
		$this->fetchAt++;
	}
187
188
189
190
191
192
193


}


class ArgumentIterator {

Bernhard Posselt's avatar
Bernhard Posselt committed
194
	private $arguments;
Bernhard Posselt's avatar
Bernhard Posselt committed
195

Bernhard Posselt's avatar
Bernhard Posselt committed
196
197
198
	public function __construct($arguments){
		$this->arguments = $arguments;
	}
Bernhard Posselt's avatar
Bernhard Posselt committed
199

Bernhard Posselt's avatar
Bernhard Posselt committed
200
201
202
203
204
205
206
207
	public function next(){
		$result = array_shift($this->arguments);
		if($result === null){
			return false;
		} else {
			return $result;
		}
	}
208
209
}