forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
simpletestlib.php
391 lines (354 loc) · 14.5 KB
/
simpletestlib.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
<?php // $Id$
/**
* Utility functions to make unit testing easier.
*
* These functions, particularly the the database ones, are quick and
* dirty methods for getting things done in test cases. None of these
* methods should be used outside test code.
*
* @copyright © 2006 The Open University
* @author T.J.Hunt@open.ac.uk
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License
* @version $Id$
* @package SimpleTestEx
*/
require_once(dirname(__FILE__) . '/../config.php');
require_once($CFG->libdir . '/simpletestlib/simpletest.php');
require_once($CFG->libdir . '/simpletestlib/unit_tester.php');
require_once($CFG->libdir . '/simpletestlib/expectation.php');
require_once($CFG->libdir . '/simpletestlib/reporter.php');
require_once($CFG->libdir . '/simpletestlib/web_tester.php');
require_once($CFG->libdir . '/simpletestlib/mock_objects.php');
/**
* Recursively visit all the files in the source tree. Calls the callback
* function with the pathname of each file found.
*
* @param $path the folder to start searching from.
* @param $callback the function to call with the name of each file found.
* @param $fileregexp a regexp used to filter the search (optional).
* @param $exclude If true, pathnames that match the regexp will be ingored. If false,
* only files that match the regexp will be included. (default false).
* @param array $ignorefolders will not go into any of these folders (optional).
*/
function recurseFolders($path, $callback, $fileregexp = '/.*/', $exclude = false, $ignorefolders = array()) {
$files = scandir($path);
foreach ($files as $file) {
$filepath = $path .'/'. $file;
if ($file == '.' || $file == '..') {
continue;
} else if (is_dir($filepath)) {
if (!in_array($filepath, $ignorefolders)) {
recurseFolders($filepath, $callback, $fileregexp, $exclude, $ignorefolders);
}
} else if ($exclude xor preg_match($fileregexp, $filepath)) {
call_user_func($callback, $filepath);
}
}
}
/**
* An expectation for comparing strings ignoring whitespace.
*/
class IgnoreWhitespaceExpectation extends SimpleExpectation {
var $expect;
function IgnoreWhitespaceExpectation($content, $message = '%s') {
$this->SimpleExpectation($message);
$this->expect=$this->normalise($content);
}
function test($ip) {
return $this->normalise($ip)==$this->expect;
}
function normalise($text) {
return preg_replace('/\s+/m',' ',trim($text));
}
function testMessage($ip) {
return "Input string [$ip] doesn't match the required value.";
}
}
/**
* An Expectation that two arrays contain the same list of values.
*/
class ArraysHaveSameValuesExpectation extends SimpleExpectation {
var $expect;
function ArraysHaveSameValuesExpectation($expected, $message = '%s') {
$this->SimpleExpectation($message);
if (!is_array($expected)) {
trigger_error('Attempt to create an ArraysHaveSameValuesExpectation ' .
'with an expected value that is not an array.');
}
$this->expect = $this->normalise($expected);
}
function test($actual) {
return $this->normalise($actual) == $this->expect;
}
function normalise($array) {
sort($array);
return $array;
}
function testMessage($actual) {
return 'Array [' . implode(', ', $actual) .
'] does not contain the expected list of values [' . implode(', ', $this->expect) . '].';
}
}
/**
* An Expectation that compares to objects, and ensures that for every field in the
* expected object, there is a key of the same name in the actual object, with
* the same value. (The actual object may have other fields to, but we ignore them.)
*/
class CheckSpecifiedFieldsExpectation extends SimpleExpectation {
var $expect;
function CheckSpecifiedFieldsExpectation($expected, $message = '%s') {
$this->SimpleExpectation($message);
if (!is_object($expected)) {
trigger_error('Attempt to create a CheckSpecifiedFieldsExpectation ' .
'with an expected value that is not an object.');
}
$this->expect = $expected;
}
function test($actual) {
foreach ($this->expect as $key => $value) {
if (isset($value) && isset($actual->$key) && $actual->$key == $value) {
// OK
} else if (is_null($value) && is_null($actual->$key)) {
// OK
} else {
return false;
}
}
return true;
}
function testMessage($actual) {
$mismatches = array();
foreach ($this->expect as $key => $value) {
if (isset($value) && isset($actual->$key) && $actual->$key == $value) {
// OK
} else if (is_null($value) && is_null($actual->$key)) {
// OK
} else {
$mismatches[] = $key;
}
}
return 'Actual object does not have all the same fields with the same values as the expected object (' .
implode(', ', $mismatches) . ').';
}
}
/**
* Given a table name, a two-dimensional array of data, and a database connection,
* creates a table in the database. The array of data should look something like this.
*
* $testdata = array(
* array('id', 'username', 'firstname', 'lastname', 'email'),
* array(1, 'u1', 'user', 'one', 'u1@example.com'),
* array(2, 'u2', 'user', 'two', 'u2@example.com'),
* array(3, 'u3', 'user', 'three', 'u3@example.com'),
* array(4, 'u4', 'user', 'four', 'u4@example.com'),
* array(5, 'u5', 'user', 'five', 'u5@example.com'),
* );
*
* The first 'row' of the test data gives the column names. The type of each column
* is set to either INT or VARCHAR($strlen), guessed by inspecting the first row of
* data. Unless the col name is 'id' in which case the col type will be SERIAL.
* The remaining 'rows' of the data array are values loaded into the table. All columns
* are created with a default of 0xdefa or 'Default' as appropriate.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $tablename the name of the table to create. E.g. 'mdl_unittest_user'.
* @param array $data a two-dimensional array of data, in the format described above.
* @param object $db an AdoDB database connection.
* @param int $strlen the width to use for string fields.
*/
function load_test_table($tablename, $data, $db = null, $strlen = 255) {
$colnames = array_shift($data);
$coldefs = array();
foreach (array_combine($colnames, $data[0]) as $colname => $value) {
if ($colname == 'id') {
$type = 'SERIAL';
} else if (is_int($value)) {
$type = 'INTEGER DEFAULT 57082'; // 0xdefa
} else {
$type = "VARCHAR($strlen) DEFAULT 'Default'";
}
$coldefs[] = "$colname $type";
}
_private_execute_sql("CREATE TABLE $tablename (" . join(',', $coldefs) . ');', $db);
array_unshift($data, $colnames);
load_test_data($tablename, $data, $db);
}
/**
* Given a table name, a two-dimensional array of data, and a database connection,
* adds data to the database table. The array should have the same format as for
* load_test_table(), with the first 'row' giving column names.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $tablename the name of the table to populate. E.g. 'mdl_unittest_user'.
* @param array $data a two-dimensional array of data, in the format described.
* @param object $localdb an AdoDB database connection.
*/
function load_test_data($tablename, $data, $localdb = null) {
global $CFG;
if (null == $localdb) {
global $db;
$localdb = $db;
}
$colnames = array_shift($data);
$idcol = array_search('id', $colnames);
$maxid = -1;
foreach ($data as $row) {
_private_execute_sql($localdb->GetInsertSQL($tablename, array_combine($colnames, $row)), $localdb);
if ($idcol !== false && $row[$idcol] > $maxid) {
$maxid = $row[$idcol];
}
}
if ($CFG->dbfamily == 'postgres' && $idcol !== false) {
$maxid += 1;
_private_execute_sql("ALTER SEQUENCE {$tablename}_id_seq RESTART WITH $maxid;", $localdb);
}
}
/**
* Make multiple tables that are the same as a real table but empty.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param mixed $tablename Array of strings containing the names of the table to populate (without prefix).
* @param string $realprefix the prefix used for real tables. E.g. 'mdl_'.
* @param string $testprefix the prefix used for test tables. E.g. 'mdl_unittest_'.
* @param object $db an AdoDB database connection.
*/
function make_test_tables_like_real_one($tablenames, $realprefix, $testprefix, $db,$dropconstraints=false) {
foreach($tablenames as $individual) {
make_test_table_like_real_one($individual,$realprefix,$testprefix,$db,$dropconstraints);
}
}
/**
* Make a test table that has all the same columns as a real moodle table,
* but which is empty.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $tablename Name of the table to populate. E.g. 'user'.
* @param string $realprefix the prefix used for real tables. E.g. 'mdl_'.
* @param string $testprefix the prefix used for test tables. E.g. 'mdl_unittest_'.
* @param object $db an AdoDB database connection.
*/
function make_test_table_like_real_one($tablename, $realprefix, $testprefix, $db, $dropconstraints=false) {
_private_execute_sql("CREATE TABLE $testprefix$tablename (LIKE $realprefix$tablename INCLUDING DEFAULTS);", $db);
if (_private_has_id_column($testprefix . $tablename, $db)) {
_private_execute_sql("CREATE SEQUENCE $testprefix{$tablename}_id_seq;", $db);
_private_execute_sql("ALTER TABLE $testprefix$tablename ALTER COLUMN id SET DEFAULT nextval('{$testprefix}{$tablename}_id_seq'::regclass);", $db);
_private_execute_sql("ALTER TABLE $testprefix$tablename ADD PRIMARY KEY (id);", $db);
}
if($dropconstraints) {
$cols=$db->MetaColumnNames($testprefix.$tablename);
foreach($cols as $col) {
$rs=_private_execute_sql(
"SELECT constraint_name FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS WHERE table_name='$testprefix$tablename'",$db);
while(!$rs->EOF) {
$constraintname=$rs->fields['constraint_name'];
_private_execute_sql("ALTER TABLE $testprefix$tablename DROP CONSTRAINT $constraintname",$db);
$rs->MoveNext();
}
_private_execute_sql("ALTER TABLE $testprefix$tablename ALTER COLUMN $col DROP NOT NULL",$db);
}
}
}
/**
* Drops a table from the database pointed to by the database connection.
* This undoes the create performed by load_test_table().
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $tablename the name of the table to populate. E.g. 'mdl_unittest_user'.
* @param object $db an AdoDB database connection.
* @param bool $cascade If true, also drop tables that depend on this one, e.g. through
* foreign key constraints.
*/
function remove_test_table($tablename, $db, $cascade = false) {
global $CFG;
_private_execute_sql('DROP TABLE ' . $tablename . ($cascade ? ' CASCADE' : '') . ';', $db);
if ($CFG->dbfamily == 'postgres') {
$rs = $db->Execute("SELECT relname FROM pg_class WHERE relname = '{$tablename}_id_seq' AND relkind = 'S';");
if ($rs && !rs_EOF($rs)) {
_private_execute_sql("DROP SEQUENCE {$tablename}_id_seq;", $db);
}
}
}
/**
* Drops all the tables with a particular prefix from the database pointed to by the database connection.
* Useful for cleaning up after a unit test run has crashed leaving the DB full of junk.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $prefix the prfix of tables to drop 'mdl_unittest_'.
* @param object $db an AdoDB database connection.
*/
function wipe_tables($prefix, $db) {
if (strpos($prefix, 'test') === false) {
notice('The wipe_tables function should only be used to wipe test tables.');
return;
}
$tables = $db->Metatables('TABLES', false, "$prefix%");
foreach ($tables as $table) {
_private_execute_sql("DROP TABLE $table CASCADE", $db);
}
}
/**
* Drops all the sequences with a particular prefix from the database pointed to by the database connection.
* Useful for cleaning up after a unit test run has crashed leaving the DB full of junk.
*
* This function should not be used in real code. Only for testing and debugging.
*
* @param string $prefix the prfix of sequences to drop 'mdl_unittest_'.
* @param object $db an AdoDB database connection.
*/
function wipe_sequences($prefix, $db) {
global $CFG;
if ($CFG->dbfamily == 'postgres') {
$sequences = $db->GetCol("SELECT relname FROM pg_class WHERE relname LIKE '$prefix%_id_seq' AND relkind = 'S';");
if ($sequences) {
foreach ($sequences as $sequence) {
_private_execute_sql("DROP SEQUENCE $sequence CASCADE", $db);
}
}
}
}
function _private_has_id_column($table, $db) {
return in_array('id', $db->MetaColumnNames($table));
}
function _private_execute_sql($sql, $localdb = null) {
if (null == $localdb) {
global $db;
$localdb = $db;
}
if (!$rs = $localdb->Execute($sql)) {
echo '<p>SQL ERROR: ', $localdb->ErrorMsg(), ". STATEMENT: $sql</p>";
}
return $rs;
}
/**
* Base class for testcases that want a different DB prefix.
*
* That is, when you need to load test data into the database for
* unit testing, instead of messing with the real mdl_course table,
* we will temporarily change $CFG->prefix from (say) mdl_ to mdl_unittest_
* and create a table called mdl_unittest_course to hold the test data.
*/
class prefix_changing_test_case extends UnitTestCase {
var $old_prefix;
function change_prefix() {
global $CFG;
$this->old_prefix = $CFG->prefix;
$CFG->prefix = $CFG->prefix . 'unittest_';
}
function change_prefix_back() {
global $CFG;
$CFG->prefix = $this->old_prefix;
}
function setUp() {
$this->change_prefix();
}
function tearDown() {
$this->change_prefix_back();
}
}
?>