ec03870b8e5c4e5c61802e7b4243c63f4d3385c9
[moodle.git] / lib / dml / simpletest / testdml.php
1 <?php
3 /**
4  * Unit tests for dml
5  */
7 if (!defined('MOODLE_INTERNAL')) {
8     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
9 }
11 class dml_test extends UnitTestCase {
12     private $tables = array();
13     private $tdb;
14     private $data;
15     public  static $includecoverage = array('lib/dml');
16     public  static $excludecoverage = array('lib/dml/simpletest');
18     function setUp() {
19         global $CFG, $DB, $UNITTEST;
21         if (isset($UNITTEST->func_test_db)) {
22             $this->tdb = $UNITTEST->func_test_db;
23         } else {
24             $this->tdb = $DB;
25         }
27     }
29     function tearDown() {
30         $dbman = $this->tdb->get_manager();
32         foreach ($this->tables as $table) {
33             if ($dbman->table_exists($table)) {
34                 $dbman->drop_table($table);
35             }
36         }
37         $this->tables = array();
38     }
40     /**
41      * Get a xmldb_table object for testing, deleting any existing table
42      * of the same name, for example if one was left over from a previous test
43      * run that crashed.
44      *
45      * @param database_manager $dbman the database_manager to use.
46      * @param string $tablename the name of the table to create.
47      * @return xmldb_table the table object.
48      */
49     private function get_test_table($tablename="") {
50         $DB = $this->tdb;
51         $dbman = $this->tdb->get_manager();
53         if ($tablename == '') {
54             $tablename = "unit_table";
55         }
57         $table = new xmldb_table($tablename);
58         if ($dbman->table_exists($table)) {
59             $dbman->drop_table($table);
60         }
61         return new xmldb_table($tablename);
62     }
64     function test_fix_sql_params() {
65         $DB = $this->tdb;
67         $table = $this->get_test_table();
68         $tablename = $table->getName();
70         // Correct table placeholder substitution
71         $sql = "SELECT * FROM {".$tablename."}";
72         $sqlarray = $DB->fix_sql_params($sql);
73         $this->assertEqual("SELECT * FROM {$DB->get_prefix()}".$tablename, $sqlarray[0]);
75         // Conversions of all param types
76         $sql = array();
77         $sql[SQL_PARAMS_NAMED]  = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = :param1, course = :param2";
78         $sql[SQL_PARAMS_QM]     = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = ?, course = ?";
79         $sql[SQL_PARAMS_DOLLAR] = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = \$1, course = \$2";
81         $params = array();
82         $params[SQL_PARAMS_NAMED]  = array('param1'=>'first record', 'param2'=>1);
83         $params[SQL_PARAMS_QM]     = array('first record', 1);
84         $params[SQL_PARAMS_DOLLAR] = array('first record', 1);
86         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_NAMED], $params[SQL_PARAMS_NAMED]);
87         $this->assertEqual($rsql, $sql[$rtype]);
88         $this->assertEqual($rparams, $params[$rtype]);
90         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_QM], $params[SQL_PARAMS_QM]);
91         $this->assertEqual($rsql, $sql[$rtype]);
92         $this->assertEqual($rparams, $params[$rtype]);
94         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_DOLLAR], $params[SQL_PARAMS_DOLLAR]);
95         $this->assertEqual($rsql, $sql[$rtype]);
96         $this->assertEqual($rparams, $params[$rtype]);
99         // Malformed table placeholder
100         $sql = "SELECT * FROM [testtable]";
101         $sqlarray = $DB->fix_sql_params($sql);
102         $this->assertEqual($sql, $sqlarray[0]);
105         // Mixed param types (colon and dollar)
106         $sql = "SELECT * FROM {".$tablename."} WHERE name = :param1, course = \$1";
107         $params = array('param1' => 'record1', 'param2' => 3);
108         try {
109             $sqlarray = $DB->fix_sql_params($sql, $params);
110             $this->fail("Expecting an exception, none occurred");
111         } catch (Exception $e) {
112             $this->assertTrue($e instanceof moodle_exception);
113         }
115         // Mixed param types (question and dollar)
116         $sql = "SELECT * FROM {".$tablename."} WHERE name = ?, course = \$1";
117         $params = array('param1' => 'record2', 'param2' => 5);
118         try {
119             $sqlarray = $DB->fix_sql_params($sql, $params);
120             $this->fail("Expecting an exception, none occurred");
121         } catch (Exception $e) {
122             $this->assertTrue($e instanceof moodle_exception);
123         }
125         // Too many params in sql
126         $sql = "SELECT * FROM {".$tablename."} WHERE name = ?, course = ?, id = ?";
127         $params = array('record2', 3);
128         try {
129             $sqlarray = $DB->fix_sql_params($sql, $params);
130             $this->fail("Expecting an exception, none occurred");
131         } catch (Exception $e) {
132             $this->assertTrue($e instanceof moodle_exception);
133         }
135         // Too many params in array: no error
136         $params[] = 1;
137         $params[] = time();
138         $sqlarray = null;
140         try {
141             $sqlarray = $DB->fix_sql_params($sql, $params);
142             $this->pass();
143         } catch (Exception $e) {
144             $this->fail("Unexpected ".get_class($e)." exception");
145         }
146         $this->assertTrue($sqlarray[0]);
148         // Named params missing from array
149         $sql = "SELECT * FROM {".$tablename."} WHERE name = :name, course = :course";
150         $params = array('wrongname' => 'record1', 'course' => 1);
151         try {
152             $sqlarray = $DB->fix_sql_params($sql, $params);
153             $this->fail("Expecting an exception, none occurred");
154         } catch (Exception $e) {
155             $this->assertTrue($e instanceof moodle_exception);
156         }
158         // Duplicate named param in query
159         $sql = "SELECT * FROM {".$tablename."} WHERE name = :name, course = :name";
160         $params = array('name' => 'record2', 'course' => 3);
161         try {
162             $sqlarray = $DB->fix_sql_params($sql, $params);
163             $this->fail("Expecting an exception, none occurred");
164         } catch (Exception $e) {
165             $this->assertTrue($e instanceof moodle_exception);
166         }
168     }
170     public function testGetTables() {
171         $DB = $this->tdb;
172         $dbman = $this->tdb->get_manager();
174         // Need to test with multiple DBs
175         $table = $this->get_test_table();
176         $tablename = $table->getName();
178         $original_count = count($DB->get_tables());
180         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
181         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
182         $dbman->create_table($table);
183         $this->tables[$tablename] = $table;
185         $this->assertTrue(count($DB->get_tables()) == $original_count + 1);
186     }
188     public function testDefaults() {
189         $DB = $this->tdb;
190         $dbman = $this->tdb->get_manager();
192         $table = $this->get_test_table();
193         $tablename = $table->getName();
195         $table->add_field('enumfield', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, 'test2');
196         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
197         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
198         $dbman->create_table($table);
199         $this->tables[$tablename] = $table;
201         $columns = $DB->get_columns($tablename);
203         $enumfield = $columns['enumfield'];
204         $this->assertEqual('test2', $enumfield->default_value);
205         $this->assertEqual('C', $enumfield->meta_type);
207     }
209     public function testGetIndexes() {
210         $DB = $this->tdb;
211         $dbman = $this->tdb->get_manager();
213         $table = $this->get_test_table();
214         $tablename = $table->getName();
216         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
217         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
218         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
219         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
220         $table->add_index('course-id', XMLDB_INDEX_UNIQUE, array('course', 'id'));
221         $dbman->create_table($table);
222         $this->tables[$tablename] = $table;
224         $this->assertTrue($indices = $DB->get_indexes($tablename));
225         $this->assertEqual(count($indices), 2);
226         // we do not care about index names for now
227         $first = array_shift($indices);
228         $second = array_shift($indices);
229         if (count($first['columns']) == 2) {
230             $composed = $first;
231             $single   = $second;
232         } else {
233             $composed = $second;
234             $single   = $first;
235         }
236         $this->assertFalse($single['unique']);
237         $this->assertTrue($composed['unique']);
238         $this->assertEqual(1, count($single['columns']));
239         $this->assertEqual(2, count($composed['columns']));
240         $this->assertEqual('course', $single['columns'][0]);
241         $this->assertEqual('course', $composed['columns'][0]);
242         $this->assertEqual('id', $composed['columns'][1]);
243     }
245     public function testGetColumns() {
246         $DB = $this->tdb;
247         $dbman = $this->tdb->get_manager();
249         $table = $this->get_test_table();
250         $tablename = $table->getName();
252         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
253         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
254         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
255         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
256         $dbman->create_table($table);
257         $this->tables[$tablename] = $table;
259         $this->assertTrue($columns = $DB->get_columns($tablename));
260         $fields = $this->tables[$tablename]->getFields();
261         $this->assertEqual(count($columns), count($fields));
263         for ($i = 0; $i < count($columns); $i++) {
264             if ($i == 0) {
265                 $next_column = reset($columns);
266                 $next_field  = reset($fields);
267             } else {
268                 $next_column = next($columns);
269                 $next_field  = next($fields);
270             }
272             $this->assertEqual($next_column->name, $next_field->name);
273         }
274     }
276     public function testExecute() {
277         $DB = $this->tdb;
278         $dbman = $this->tdb->get_manager();
280         $table = $this->get_test_table();
281         $tablename = $table->getName();
283         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
284         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
285         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
286         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
287         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
288         $dbman->create_table($table);
289         $this->tables[$tablename] = $table;
291         $sql = "SELECT * FROM {".$tablename."}";
293         $this->assertTrue($DB->execute($sql));
295         $params = array('course' => 1, 'name' => 'test');
297         $sql = "INSERT INTO {".$tablename."} (".implode(',', array_keys($params)).")
298                        VALUES (".implode(',', array_fill(0, count($params), '?')).")";
301         $this->assertTrue($DB->execute($sql, $params));
303         $record = $DB->get_record($tablename, array('id' => 1));
305         foreach ($params as $field => $value) {
306             $this->assertEqual($value, $record->$field, "Field $field in DB ({$record->$field}) is not equal to field $field in sql ($value)");
307         }
308     }
310     public function test_get_in_or_equal() {
311         $DB = $this->tdb;
313         // SQL_PARAMS_QM - IN or =
315         // Correct usage of multiple values
316         $in_values = array('value1', 'value2', 'value3', 'value4');
317         list($usql, $params) = $DB->get_in_or_equal($in_values);
318         $this->assertEqual("IN (?,?,?,?)", $usql);
319         $this->assertEqual(4, count($params));
320         foreach ($params as $key => $value) {
321             $this->assertEqual($in_values[$key], $value);
322         }
324         // Correct usage of single value (in an array)
325         $in_values = array('value1');
326         list($usql, $params) = $DB->get_in_or_equal($in_values);
327         $this->assertEqual("= ?", $usql);
328         $this->assertEqual(1, count($params));
329         $this->assertEqual($in_values[0], $params[0]);
331         // Correct usage of single value
332         $in_value = 'value1';
333         list($usql, $params) = $DB->get_in_or_equal($in_values);
334         $this->assertEqual("= ?", $usql);
335         $this->assertEqual(1, count($params));
336         $this->assertEqual($in_value, $params[0]);
338         // SQL_PARAMS_QM - NOT IN or <>
340         // Correct usage of multiple values
341         $in_values = array('value1', 'value2', 'value3', 'value4');
342         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
343         $this->assertEqual("NOT IN (?,?,?,?)", $usql);
344         $this->assertEqual(4, count($params));
345         foreach ($params as $key => $value) {
346             $this->assertEqual($in_values[$key], $value);
347         }
349         // Correct usage of single value (in array()
350         $in_values = array('value1');
351         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
352         $this->assertEqual("<> ?", $usql);
353         $this->assertEqual(1, count($params));
354         $this->assertEqual($in_values[0], $params[0]);
356         // Correct usage of single value
357         $in_value = 'value1';
358         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
359         $this->assertEqual("<> ?", $usql);
360         $this->assertEqual(1, count($params));
361         $this->assertEqual($in_value, $params[0]);
363         // SQL_PARAMS_NAMED - IN or =
365         // Correct usage of multiple values
366         $in_values = array('value1', 'value2', 'value3', 'value4');
367         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
368         $this->assertEqual("IN (:param01,:param02,:param03,:param04)", $usql);
369         $this->assertEqual(4, count($params));
370         reset($in_values);
371         foreach ($params as $key => $value) {
372             $this->assertEqual(current($in_values), $value);
373             next($in_values);
374         }
376         // Correct usage of single values (in array)
377         $in_values = array('value1');
378         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
379         $this->assertEqual("= :param01", $usql);
380         $this->assertEqual(1, count($params));
381         $this->assertEqual($in_values[0], $params['param01']);
383         // Correct usage of single value
384         $in_value = 'value1';
385         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
386         $this->assertEqual("= :param01", $usql);
387         $this->assertEqual(1, count($params));
388         $this->assertEqual($in_value, $params['param01']);
390         // SQL_PARAMS_NAMED - NOT IN or <>
392         // Correct usage of multiple values
393         $in_values = array('value1', 'value2', 'value3', 'value4');
394         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
395         $this->assertEqual("NOT IN (:param01,:param02,:param03,:param04)", $usql);
396         $this->assertEqual(4, count($params));
397         reset($in_values);
398         foreach ($params as $key => $value) {
399             $this->assertEqual(current($in_values), $value);
400             next($in_values);
401         }
403         // Correct usage of single values (in array)
404         $in_values = array('value1');
405         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
406         $this->assertEqual("<> :param01", $usql);
407         $this->assertEqual(1, count($params));
408         $this->assertEqual($in_values[0], $params['param01']);
410         // Correct usage of single value
411         $in_value = 'value1';
412         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
413         $this->assertEqual("<> :param01", $usql);
414         $this->assertEqual(1, count($params));
415         $this->assertEqual($in_value, $params['param01']);
417     }
419     public function test_fix_table_names() {
420         $DB = new moodle_database_for_testing();
421         $prefix = $DB->get_prefix();
423         // Simple placeholder
424         $placeholder = "{user}";
425         $this->assertEqual($prefix."user", $DB->public_fix_table_names($placeholder));
427         // Full SQL
428         $sql = "SELECT * FROM {user}, {funny_table_name}, {mdl_stupid_table} WHERE {user}.id = {funny_table_name}.userid";
429         $expected = "SELECT * FROM {$prefix}user, {$prefix}funny_table_name, {$prefix}mdl_stupid_table WHERE {$prefix}user.id = {$prefix}funny_table_name.userid";
430         $this->assertEqual($expected, $DB->public_fix_table_names($sql));
433     }
435     public function test_get_recordset() {
436         $DB = $this->tdb;
437         $dbman = $DB->get_manager();
439         $table = $this->get_test_table();
440         $tablename = $table->getName();
442         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
443         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
444         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
445         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
446         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
447         $dbman->create_table($table);
448         $this->tables[$tablename] = $table;
450         $data = array(array('id' => 1, 'course' => 3, 'name' => 'record1'),
451                       array('id' => 2, 'course' => 3, 'name' => 'record2'),
452                       array('id' => 3, 'course' => 5, 'name' => 'record3'));
454         foreach ($data as $record) {
455             $DB->insert_record($tablename, $record);
456         }
458         $rs = $DB->get_recordset($tablename);
459         $this->assertTrue($rs);
461         reset($data);
462         foreach($rs as $record) {
463             $data_record = current($data);
464             foreach ($record as $k => $v) {
465                 $this->assertEqual($data_record[$k], $v);
466             }
467             next($data);
468         }
469         $rs->close();
471         // note: delegate limits testing to test_get_recordset_sql()
472     }
474     public function test_get_recordset_iterator_keys() {
475         $DB = $this->tdb;
476         $dbman = $DB->get_manager();
478         $table = $this->get_test_table();
479         $tablename = $table->getName();
481         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
482         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
483         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
484         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
485         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
486         $dbman->create_table($table);
487         $this->tables[$tablename] = $table;
489         $data = array(array('id'=> 1, 'course' => 3, 'name' => 'record1'),
490                       array('id'=> 2, 'course' => 3, 'name' => 'record2'),
491                       array('id'=> 3, 'course' => 5, 'name' => 'record3'));
492         foreach ($data as $record) {
493             $DB->insert_record($tablename, $record);
494         }
496     /// Test repeated numeric keys are returned ok
497         $rs = $DB->get_recordset($tablename, NULL, NULL, 'course, name, id');
499         reset($data);
500         $count = 0;
501         foreach($rs as $key => $record) {
502             $data_record = current($data);
503             $this->assertEqual($data_record['course'], $key);
504             next($data);
505             $count++;
506         }
507         $rs->close();
509     /// Test record returned are ok
510         $this->assertEqual($count, 3);
512     /// Test string keys are returned ok
513         $rs = $DB->get_recordset($tablename, NULL, NULL, 'name, course, id');
515         reset($data);
516         $count = 0;
517         foreach($rs as $key => $record) {
518             $data_record = current($data);
519             $this->assertEqual($data_record['name'], $key);
520             next($data);
521             $count++;
522         }
523         $rs->close();
525     /// Test record returned are ok
526         $this->assertEqual($count, 3);
528     /// Test numeric not starting in 1 keys are returned ok
529         $rs = $DB->get_recordset($tablename, NULL, 'id DESC', 'id, course, name');
531         $data = array_reverse($data);
532         reset($data);
533         $count = 0;
534         foreach($rs as $key => $record) {
535             $data_record = current($data);
536             $this->assertEqual($data_record['id'], $key);
537             next($data);
538             $count++;
539         }
540         $rs->close();
542     /// Test record returned are ok
543         $this->assertEqual($count, 3);
544     }
546     public function test_get_recordset_list() {
547         $DB = $this->tdb;
548         $dbman = $DB->get_manager();
550         $table = $this->get_test_table();
551         $tablename = $table->getName();
553         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
554         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
555         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
556         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
557         $dbman->create_table($table);
558         $this->tables[$tablename] = $table;
560         $DB->insert_record($tablename, array('course' => 3));
561         $DB->insert_record($tablename, array('course' => 3));
562         $DB->insert_record($tablename, array('course' => 5));
563         $DB->insert_record($tablename, array('course' => 2));
565         $rs = $DB->get_recordset_list($tablename, 'course', array(3, 2));
567         $this->assertTrue($rs);
569         $counter = 0;
570         foreach ($rs as $record) {
571             $counter++;
572         }
573         $this->assertEqual(3, $counter);
574         $rs->close();
576         $rs = $DB->get_recordset_list($tablename, 'course',array()); /// Must return 0 rows without conditions. MDL-17645
578         $counter = 0;
579         foreach ($rs as $record) {
580             $counter++;
581         }
582         $rs->close();
583         $this->assertEqual(0, $counter);
585         // note: delegate limits testing to test_get_recordset_sql()
586     }
588     public function test_get_recordset_select() {
589         $DB = $this->tdb;
590         $dbman = $DB->get_manager();
592         $table = $this->get_test_table();
593         $tablename = $table->getName();
595         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
596         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
597         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
598         $dbman->create_table($table);
599         $this->tables[$tablename] = $table;
601         $DB->insert_record($tablename, array('course' => 3));
602         $DB->insert_record($tablename, array('course' => 3));
603         $DB->insert_record($tablename, array('course' => 5));
604         $DB->insert_record($tablename, array('course' => 2));
606         $rs = $DB->get_recordset_select($tablename, '');
607         $counter = 0;
608         foreach ($rs as $record) {
609             $counter++;
610         }
611         $rs->close();
612         $this->assertEqual(4, $counter);
614         $this->assertTrue($rs = $DB->get_recordset_select($tablename, 'course = 3'));
615         $counter = 0;
616         foreach ($rs as $record) {
617             $counter++;
618         }
619         $rs->close();
620         $this->assertEqual(2, $counter);
622         // note: delegate limits testing to test_get_recordset_sql()
623     }
625     public function test_get_recordset_sql() {
626         $DB = $this->tdb;
627         $dbman = $DB->get_manager();
629         $table = $this->get_test_table();
630         $tablename = $table->getName();
632         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
633         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
634         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
635         $dbman->create_table($table);
636         $this->tables[$tablename] = $table;
638         $inskey1 = $DB->insert_record($tablename, array('course' => 3));
639         $inskey2 = $DB->insert_record($tablename, array('course' => 5));
640         $inskey3 = $DB->insert_record($tablename, array('course' => 4));
641         $inskey4 = $DB->insert_record($tablename, array('course' => 3));
642         $inskey5 = $DB->insert_record($tablename, array('course' => 2));
643         $inskey6 = $DB->insert_record($tablename, array('course' => 1));
644         $inskey7 = $DB->insert_record($tablename, array('course' => 0));
646         $this->assertTrue($rs = $DB->get_recordset_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
647         $counter = 0;
648         foreach ($rs as $record) {
649             $counter++;
650         }
651         $rs->close();
652         $this->assertEqual(2, $counter);
654         // limits - only need to test this case, the rest have been tested by test_get_records_sql()
655         // only limitfrom = skips that number of records
656         $rs = $DB->get_recordset_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 2, 0);
657         $records = array();
658         foreach($rs as $key => $record) {
659             $records[$key] = $record;
660         }
661         $rs->close();
662         $this->assertEqual(5, count($records));
663         $this->assertEqual($inskey3, reset($records)->id);
664         $this->assertEqual($inskey7, end($records)->id);
666         // note: fetching nulls, empties, LOBs already tested by test_insert_record() no needed here
667     }
669     public function test_get_records() {
670         $DB = $this->tdb;
671         $dbman = $DB->get_manager();
673         $table = $this->get_test_table();
674         $tablename = $table->getName();
676         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
677         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
678         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
679         $dbman->create_table($table);
680         $this->tables[$tablename] = $table;
682         $DB->insert_record($tablename, array('course' => 3));
683         $DB->insert_record($tablename, array('course' => 3));
684         $DB->insert_record($tablename, array('course' => 5));
685         $DB->insert_record($tablename, array('course' => 2));
687         // All records
688         $records = $DB->get_records($tablename);
689         $this->assertEqual(4, count($records));
690         $this->assertEqual(3, $records[1]->course);
691         $this->assertEqual(3, $records[2]->course);
692         $this->assertEqual(5, $records[3]->course);
693         $this->assertEqual(2, $records[4]->course);
695         // Records matching certain conditions
696         $records = $DB->get_records($tablename, array('course' => 3));
697         $this->assertEqual(2, count($records));
698         $this->assertEqual(3, $records[1]->course);
699         $this->assertEqual(3, $records[2]->course);
701         // All records sorted by course
702         $records = $DB->get_records($tablename, null, 'course');
703         $this->assertEqual(4, count($records));
704         $current_record = reset($records);
705         $this->assertEqual(4, $current_record->id);
706         $current_record = next($records);
707         $this->assertEqual(1, $current_record->id);
708         $current_record = next($records);
709         $this->assertEqual(2, $current_record->id);
710         $current_record = next($records);
711         $this->assertEqual(3, $current_record->id);
713         // All records, but get only one field
714         $records = $DB->get_records($tablename, null, '', 'id');
715         $this->assertTrue(empty($records[1]->course));
716         $this->assertFalse(empty($records[1]->id));
717         $this->assertEqual(4, count($records));
719         // note: delegate limits testing to test_get_records_sql()
720     }
722     public function test_get_records_list() {
723         $DB = $this->tdb;
724         $dbman = $DB->get_manager();
726         $table = $this->get_test_table();
727         $tablename = $table->getName();
729         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
730         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
731         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
732         $dbman->create_table($table);
733         $this->tables[$tablename] = $table;
735         $DB->insert_record($tablename, array('course' => 3));
736         $DB->insert_record($tablename, array('course' => 3));
737         $DB->insert_record($tablename, array('course' => 5));
738         $DB->insert_record($tablename, array('course' => 2));
740         $this->assertTrue($records = $DB->get_records_list($tablename, 'course', array(3, 2)));
741         $this->assertEqual(3, count($records));
742         $this->assertEqual(1, reset($records)->id);
743         $this->assertEqual(2, next($records)->id);
744         $this->assertEqual(4, next($records)->id);
746         $this->assertIdentical(array(), $records = $DB->get_records_list($tablename, 'course', array())); /// Must return 0 rows without conditions. MDL-17645
747         $this->assertEqual(0, count($records));
749         // note: delegate limits testing to test_get_records_sql()
750     }
752     public function test_get_record_select() {
753         $DB = $this->tdb;
754         $dbman = $DB->get_manager();
756         $table = $this->get_test_table();
757         $tablename = $table->getName();
759         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
760         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
761         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
762         $dbman->create_table($table);
763         $this->tables[$tablename] = $table;
765         $DB->insert_record($tablename, array('course' => 3));
766         $DB->insert_record($tablename, array('course' => 2));
768         $this->assertTrue($record = $DB->get_record_select($tablename, "id = ?", array(2)));
770         $this->assertEqual(2, $record->course);
772         // note: delegates limit testing to test_get_records_sql()
773     }
775     public function test_get_records_sql() {
776         global $CFG;
777         $DB = $this->tdb;
778         $dbman = $DB->get_manager();
780         $table = $this->get_test_table();
781         $tablename = $table->getName();
783         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
784         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
785         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
786         $dbman->create_table($table);
787         $this->tables[$tablename] = $table;
789         $inskey1 = $DB->insert_record($tablename, array('course' => 3));
790         $inskey2 = $DB->insert_record($tablename, array('course' => 5));
791         $inskey3 = $DB->insert_record($tablename, array('course' => 4));
792         $inskey4 = $DB->insert_record($tablename, array('course' => 3));
793         $inskey5 = $DB->insert_record($tablename, array('course' => 2));
794         $inskey6 = $DB->insert_record($tablename, array('course' => 1));
795         $inskey7 = $DB->insert_record($tablename, array('course' => 0));
797         $this->assertTrue($records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
798         $this->assertEqual(2, count($records));
799         $this->assertEqual($inskey1, reset($records)->id);
800         $this->assertEqual($inskey4, next($records)->id);
802         // Awful test, requires debug enabled and sent to browser. Let's do that and restore after test
803         $olddebug   = $CFG->debug;       // Save current debug settings
804         $olddisplay = $CFG->debugdisplay;
805         $CFG->debug = DEBUG_DEVELOPER;
806         $CFG->debugdisplay = true;
807         ob_start(); // hide debug warning
808         $records = $DB->get_records_sql("SELECT course AS id, course AS course FROM {".$tablename."}", null);
809         ob_end_clean();
810         $debuginfo = ob_get_contents();
811         $CFG->debug = $olddebug;         // Restore original debug settings
812         $CFG->debugdisplay = $olddisplay;
814         $this->assertEqual(6, count($records));
815         $this->assertFalse($debuginfo === '');
817         // negative limits = no limits
818         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, -1, -1);
819         $this->assertEqual(7, count($records));
821         // zero limits = no limits
822         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 0, 0);
823         $this->assertEqual(7, count($records));
825         // only limitfrom = skips that number of records
826         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 2, 0);
827         $this->assertEqual(5, count($records));
828         $this->assertEqual($inskey3, reset($records)->id);
829         $this->assertEqual($inskey7, end($records)->id);
831         // only limitnum = fetches that number of records
832         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 0, 3);
833         $this->assertEqual(3, count($records));
834         $this->assertEqual($inskey1, reset($records)->id);
835         $this->assertEqual($inskey3, end($records)->id);
837         // both limitfrom and limitnum = skips limitfrom records and fetches limitnum ones
838         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 3, 2);
839         $this->assertEqual(2, count($records));
840         $this->assertEqual($inskey4, reset($records)->id);
841         $this->assertEqual($inskey5, end($records)->id);
843         // note: fetching nulls, empties, LOBs already tested by test_update_record() no needed here
844     }
846     public function test_get_records_menu() {
847         $DB = $this->tdb;
848         $dbman = $DB->get_manager();
850         $table = $this->get_test_table();
851         $tablename = $table->getName();
853         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
854         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
855         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
856         $dbman->create_table($table);
857         $this->tables[$tablename] = $table;
859         $DB->insert_record($tablename, array('course' => 3));
860         $DB->insert_record($tablename, array('course' => 3));
861         $DB->insert_record($tablename, array('course' => 5));
862         $DB->insert_record($tablename, array('course' => 2));
864         $this->assertTrue($records = $DB->get_records_menu($tablename, array('course' => 3)));
865         $this->assertEqual(2, count($records));
866         $this->assertFalse(empty($records[1]));
867         $this->assertFalse(empty($records[2]));
868         $this->assertEqual(3, $records[1]);
869         $this->assertEqual(3, $records[2]);
871         // note: delegate limits testing to test_get_records_sql()
872     }
874     public function test_get_records_select_menu() {
875         $DB = $this->tdb;
876         $dbman = $DB->get_manager();
878         $table = $this->get_test_table();
879         $tablename = $table->getName();
881         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
882         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
883         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
884         $dbman->create_table($table);
885         $this->tables[$tablename] = $table;
887         $DB->insert_record($tablename, array('course' => 3));
888         $DB->insert_record($tablename, array('course' => 2));
889         $DB->insert_record($tablename, array('course' => 3));
890         $DB->insert_record($tablename, array('course' => 5));
892         $this->assertTrue($records = $DB->get_records_select_menu($tablename, "course > ?", array(2)));
894         $this->assertEqual(3, count($records));
895         $this->assertFalse(empty($records[1]));
896         $this->assertTrue(empty($records[2]));
897         $this->assertFalse(empty($records[3]));
898         $this->assertFalse(empty($records[4]));
899         $this->assertEqual(3, $records[1]);
900         $this->assertEqual(3, $records[3]);
901         $this->assertEqual(5, $records[4]);
903         // note: delegate limits testing to test_get_records_sql()
904     }
906     public function test_get_records_sql_menu() {
907         $DB = $this->tdb;
908         $dbman = $DB->get_manager();
910         $table = $this->get_test_table();
911         $tablename = $table->getName();
913         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
914         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
915         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
916         $dbman->create_table($table);
917         $this->tables[$tablename] = $table;
919         $DB->insert_record($tablename, array('course' => 3));
920         $DB->insert_record($tablename, array('course' => 2));
921         $DB->insert_record($tablename, array('course' => 3));
922         $DB->insert_record($tablename, array('course' => 5));
924         $this->assertTrue($records = $DB->get_records_sql_menu("SELECT * FROM {".$tablename."} WHERE course > ?", array(2)));
926         $this->assertEqual(3, count($records));
927         $this->assertFalse(empty($records[1]));
928         $this->assertTrue(empty($records[2]));
929         $this->assertFalse(empty($records[3]));
930         $this->assertFalse(empty($records[4]));
931         $this->assertEqual(3, $records[1]);
932         $this->assertEqual(3, $records[3]);
933         $this->assertEqual(5, $records[4]);
935         // note: delegate limits testing to test_get_records_sql()
936     }
938     public function test_get_record() {
939         $DB = $this->tdb;
940         $dbman = $DB->get_manager();
942         $table = $this->get_test_table();
943         $tablename = $table->getName();
945         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
946         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
947         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
948         $dbman->create_table($table);
949         $this->tables[$tablename] = $table;
951         $DB->insert_record($tablename, array('course' => 3));
952         $DB->insert_record($tablename, array('course' => 2));
954         $this->assertTrue($record = $DB->get_record($tablename, array('id' => 2)));
956         $this->assertEqual(2, $record->course);
957     }
959     public function test_get_record_sql() {
960         $DB = $this->tdb;
961         $dbman = $DB->get_manager();
963         $table = $this->get_test_table();
964         $tablename = $table->getName();
966         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
967         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
968         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
969         $dbman->create_table($table);
970         $this->tables[$tablename] = $table;
972         $DB->insert_record($tablename, array('course' => 3));
973         $DB->insert_record($tablename, array('course' => 2));
975         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(2)));
977         $this->assertEqual(2, $record->course);
979         // backwards compatibility with $ignoremultiple
980         $this->assertFalse(IGNORE_MISSING);
981         $this->assertTrue(IGNORE_MULTIPLE);
983         // record not found
984         $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), IGNORE_MISSING));
985         $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), IGNORE_MULTIPLE));
986         try {
987             $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), MUST_EXIST);
988             $this->fail("Exception expected");
989         } catch (dml_missing_record_exception $e) {
990             $this->assertTrue(true);
991         }
993         // multiple matches
994         ob_start(); // hide debug warning
995         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), IGNORE_MISSING));
996         ob_end_clean();
997         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), IGNORE_MULTIPLE));
998         try {
999             $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), MUST_EXIST);
1000             $this->fail("Exception expected");
1001         } catch (dml_multiple_records_exception $e) {
1002             $this->assertTrue(true);
1003         }
1004     }
1006     public function test_get_field() {
1007         $DB = $this->tdb;
1008         $dbman = $DB->get_manager();
1010         $table = $this->get_test_table();
1011         $tablename = $table->getName();
1013         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1014         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1015         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1016         $dbman->create_table($table);
1017         $this->tables[$tablename] = $table;
1019         $DB->insert_record($tablename, array('course' => 3));
1021         $this->assertTrue($course = $DB->get_field($tablename, 'course', array('id' => 1)));
1022         $this->assertEqual(3, $course);
1023     }
1025     public function test_get_field_select() {
1026         $DB = $this->tdb;
1027         $dbman = $DB->get_manager();
1029         $table = $this->get_test_table();
1030         $tablename = $table->getName();
1032         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1033         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1034         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1035         $dbman->create_table($table);
1036         $this->tables[$tablename] = $table;
1038         $DB->insert_record($tablename, array('course' => 3));
1040         $this->assertTrue($course = $DB->get_field_select($tablename, 'course', "id = ?", array(1)));
1041         $this->assertEqual(3, $course);
1043     }
1045     public function test_get_field_sql() {
1046         $DB = $this->tdb;
1047         $dbman = $DB->get_manager();
1049         $table = $this->get_test_table();
1050         $tablename = $table->getName();
1052         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1053         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1054         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1055         $dbman->create_table($table);
1056         $this->tables[$tablename] = $table;
1058         $DB->insert_record($tablename, array('course' => 3));
1060         $this->assertTrue($course = $DB->get_field_sql("SELECT course FROM {".$tablename."} WHERE id = ?", array(1)));
1061         $this->assertEqual(3, $course);
1063     }
1065     public function test_get_fieldset_select() {
1066         $DB = $this->tdb;
1067         $dbman = $DB->get_manager();
1069         $table = $this->get_test_table();
1070         $tablename = $table->getName();
1072         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1073         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1074         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1075         $dbman->create_table($table);
1076         $this->tables[$tablename] = $table;
1078         $DB->insert_record($tablename, array('course' => 1));
1079         $DB->insert_record($tablename, array('course' => 3));
1080         $DB->insert_record($tablename, array('course' => 2));
1081         $DB->insert_record($tablename, array('course' => 6));
1083         $this->assertTrue($fieldset = $DB->get_fieldset_select($tablename, 'course', "course > ?", array(1)));
1085         $this->assertEqual(3, count($fieldset));
1086         $this->assertEqual(3, $fieldset[0]);
1087         $this->assertEqual(2, $fieldset[1]);
1088         $this->assertEqual(6, $fieldset[2]);
1090     }
1092     public function test_get_fieldset_sql() {
1093         $DB = $this->tdb;
1094         $dbman = $DB->get_manager();
1096         $table = $this->get_test_table();
1097         $tablename = $table->getName();
1099         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1100         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1101         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1102         $dbman->create_table($table);
1103         $this->tables[$tablename] = $table;
1105         $DB->insert_record($tablename, array('course' => 1));
1106         $DB->insert_record($tablename, array('course' => 3));
1107         $DB->insert_record($tablename, array('course' => 2));
1108         $DB->insert_record($tablename, array('course' => 6));
1110         $this->assertTrue($fieldset = $DB->get_fieldset_sql("SELECT * FROM {".$tablename."} WHERE course > ?", array(1)));
1112         $this->assertEqual(3, count($fieldset));
1113         $this->assertEqual(2, $fieldset[0]);
1114         $this->assertEqual(3, $fieldset[1]);
1115         $this->assertEqual(4, $fieldset[2]);
1116     }
1118     public function test_insert_record_raw() {
1119         $DB = $this->tdb;
1120         $dbman = $DB->get_manager();
1122         $table = $this->get_test_table();
1123         $tablename = $table->getName();
1125         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1126         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1127         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1128         $dbman->create_table($table);
1129         $this->tables[$tablename] = $table;
1131         $this->assertTrue($DB->insert_record_raw($tablename, array('course' => 1)));
1132         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 1)));
1133         $this->assertEqual(1, $record->course);
1134     }
1136     public function test_insert_record() {
1138         // All the information in this test is fetched from DB by get_recordset() so we
1139         // have such method properly tested against nulls, empties and friends...
1141         global $CFG;
1143         $DB = $this->tdb;
1144         $dbman = $DB->get_manager();
1146         $table = $this->get_test_table();
1147         $tablename = $table->getName();
1149         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1150         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1151         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, 100);
1152         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null, 200);
1153         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null, 'onestring');
1154         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1155         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1156         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1157         $dbman->create_table($table);
1158         $this->tables[$tablename] = $table;
1160         $this->assertTrue($DB->insert_record($tablename, array('course' => 1), false)); // Without returning id
1161         $rs = $DB->get_recordset($tablename, array('course' => 1));
1162         $record = $rs->current();
1163         $rs->close();
1164         $this->assertEqual(1, $record->id);
1165         $this->assertEqual(100, $record->oneint); // Just check column defaults have been applied
1166         $this->assertEqual(200, $record->onenum);
1167         $this->assertEqual('onestring', $record->onechar);
1168         $this->assertNull($record->onetext);
1169         $this->assertNull($record->onebinary);
1171         // Check nulls are set properly for all types
1172         $record->oneint = null;
1173         $record->onenum = null;
1174         $record->onechar = null;
1175         $record->onetext = null;
1176         $record->onebinary = null;
1177         $recid = $DB->insert_record($tablename, $record);
1178         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1179         $record = $rs->current();
1180         $rs->close();
1181         $this->assertNull($record->oneint);
1182         $this->assertNull($record->onenum);
1183         $this->assertNull($record->onechar);
1184         $this->assertNull($record->onetext);
1185         $this->assertNull($record->onebinary);
1187         // Check zeros are set properly for all types
1188         $record->oneint = 0;
1189         $record->onenum = 0;
1190         $recid = $DB->insert_record($tablename, $record);
1191         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1192         $record = $rs->current();
1193         $rs->close();
1194         $this->assertEqual(0, $record->oneint);
1195         $this->assertEqual(0, $record->onenum);
1197         // Check booleans are set properly for all types
1198         $record->oneint = true; // trues
1199         $record->onenum = true;
1200         $record->onechar = true;
1201         $record->onetext = true;
1202         $recid = $DB->insert_record($tablename, $record);
1203         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1204         $record = $rs->current();
1205         $rs->close();
1206         $this->assertEqual(1, $record->oneint);
1207         $this->assertEqual(1, $record->onenum);
1208         $this->assertEqual(1, $record->onechar);
1209         $this->assertEqual(1, $record->onetext);
1211         $record->oneint = false; // falses
1212         $record->onenum = false;
1213         $record->onechar = false;
1214         $record->onetext = false;
1215         $recid = $DB->insert_record($tablename, $record);
1216         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1217         $record = $rs->current();
1218         $rs->close();
1219         $this->assertEqual(0, $record->oneint);
1220         $this->assertEqual(0, $record->onenum);
1221         $this->assertEqual(0, $record->onechar);
1222         $this->assertEqual(0, $record->onetext);
1224         // Check string data causes exception in numeric types
1225         $record->oneint = 'onestring';
1226         $record->onenum = 0;
1227         try {
1228             $DB->insert_record($tablename, $record);
1229             $this->fail("Expecting an exception, none occurred");
1230         } catch (exception $e) {
1231             $this->assertTrue($e instanceof dml_exception);
1232         }
1233         $record->oneint = 0;
1234         $record->onenum = 'onestring';
1235         try {
1236            $DB->insert_record($tablename, $record);
1237            $this->fail("Expecting an exception, none occurred");
1238         } catch (exception $e) {
1239             $this->assertTrue($e instanceof dml_exception);
1240         }
1242         // Check empty string data causes exception in numeric types
1243         $record->oneint = ''; // empty string
1244         $record->onenum = 0;
1245         try {
1246             $DB->insert_record($tablename, $record);
1247             $this->fail("Expecting an exception, none occurred");
1248         } catch (exception $e) {
1249             $this->assertTrue($e instanceof dml_exception);
1250         }
1251         $record->oneint = 0;
1252         $record->onenum = ''; // empty string
1253         try {
1254            $DB->insert_record($tablename, $record);
1255            $this->fail("Expecting an exception, none occurred");
1256         } catch (exception $e) {
1257             $this->assertTrue($e instanceof dml_exception);
1258         }
1260         // Check empty strings are set properly in string types
1261         $record->oneint = 0;
1262         $record->onenum = 0;
1263         $record->onechar = '';
1264         $record->onetext = '';
1265         $recid = $DB->insert_record($tablename, $record);
1266         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1267         $record = $rs->current();
1268         $rs->close();
1269         $this->assertTrue($record->onechar === '');
1270         $this->assertTrue($record->onetext === '');
1272         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1273         $record->oneint = ((210.10 + 39.92) - 150.02);
1274         $record->onenum = ((210.10 + 39.92) - 150.02);
1275         $recid = $DB->insert_record($tablename, $record);
1276         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1277         $record = $rs->current();
1278         $rs->close();
1279         $this->assertEqual(100, $record->oneint);
1280         $this->assertEqual(100, $record->onenum);
1282         // Check various quotes/backslashes combinations in string types
1283         $teststrings = array(
1284             'backslashes and quotes alone (even): "" \'\' \\\\',
1285             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1286             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1287             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1288         foreach ($teststrings as $teststring) {
1289             $record->onechar = $teststring;
1290             $record->onetext = $teststring;
1291             $recid = $DB->insert_record($tablename, $record);
1292             $rs = $DB->get_recordset($tablename, array('id' => $recid));
1293             $record = $rs->current();
1294             $rs->close();
1295             $this->assertEqual($teststring, $record->onechar);
1296             $this->assertEqual($teststring, $record->onetext);
1297         }
1299         // Check LOBs in text/binary columns
1300         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1301         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1302         $record->onetext = $clob;
1303         $record->onebinary = $blob;
1304         $recid = $DB->insert_record($tablename, $record);
1305         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1306         $record = $rs->current();
1307         $rs->close();
1308         $this->assertEqual($clob, $record->onetext);
1309         $this->assertEqual($blob, $record->onebinary);
1311         // And "small" LOBs too, just in case
1312         $newclob = substr($clob, 0, 500);
1313         $newblob = substr($blob, 0, 250);
1314         $record->onetext = $newclob;
1315         $record->onebinary = $newblob;
1316         $recid = $DB->insert_record($tablename, $record);
1317         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1318         $record = $rs->current();
1319         $rs->close();
1320         $this->assertEqual($newclob, $record->onetext);
1321         $this->assertEqual($newblob, $record->onebinary);
1322         $this->assertEqual(false, $rs->key()); // Ensure recordset key() method to be working ok after closing
1323     }
1325     public function test_import_record() {
1326         $DB = $this->tdb;
1327         $dbman = $DB->get_manager();
1329         $table = $this->get_test_table();
1330         $tablename = $table->getName();
1332         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1333         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1334         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1335         $dbman->create_table($table);
1336         $this->tables[$tablename] = $table;
1338         $record = (object)array('id'=>666, 'course'=>10);
1339         $this->assertTrue($DB->import_record($tablename, $record));
1340         $records = $DB->get_records($tablename);
1341         $this->assertEqual(1, count($records));
1342         $this->assertEqual(10, $records[666]->course);
1344         $record = (object)array('id'=>13, 'course'=>2);
1345         $this->assertTrue($DB->import_record($tablename, $record));
1346         $records = $DB->get_records($tablename);
1347         $this->assertEqual(2, $records[13]->course);
1348     }
1350     public function test_update_record_raw() {
1351         $DB = $this->tdb;
1352         $dbman = $DB->get_manager();
1354         $table = $this->get_test_table();
1355         $tablename = $table->getName();
1357         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1358         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1359         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1360         $dbman->create_table($table);
1361         $this->tables[$tablename] = $table;
1363         $DB->insert_record($tablename, array('course' => 1));
1364         $record = $DB->get_record($tablename, array('course' => 1));
1365         $record->course = 2;
1366         $this->assertTrue($DB->update_record_raw($tablename, $record));
1367         $this->assertFalse($record = $DB->get_record($tablename, array('course' => 1)));
1368         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 2)));
1369     }
1371     public function test_update_record() {
1373         // All the information in this test is fetched from DB by get_record() so we
1374         // have such method properly tested against nulls, empties and friends...
1376         global $CFG;
1378         $DB = $this->tdb;
1379         $dbman = $DB->get_manager();
1381         $table = $this->get_test_table();
1382         $tablename = $table->getName();
1384         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1385         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1386         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, 100);
1387         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null, 200);
1388         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null, 'onestring');
1389         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1390         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1391         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1392         $dbman->create_table($table);
1393         $this->tables[$tablename] = $table;
1395         $DB->insert_record($tablename, array('course' => 1));
1396         $record = $DB->get_record($tablename, array('course' => 1));
1397         $record->course = 2;
1399         $this->assertTrue($DB->update_record($tablename, $record));
1400         $this->assertFalse($record = $DB->get_record($tablename, array('course' => 1)));
1401         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 2)));
1402         $this->assertEqual(100, $record->oneint); // Just check column defaults have been applied
1403         $this->assertEqual(200, $record->onenum);
1404         $this->assertEqual('onestring', $record->onechar);
1405         $this->assertNull($record->onetext);
1406         $this->assertNull($record->onebinary);
1408         // Check nulls are set properly for all types
1409         $record->oneint = null;
1410         $record->onenum = null;
1411         $record->onechar = null;
1412         $record->onetext = null;
1413         $record->onebinary = null;
1414         $DB->update_record($tablename, $record);
1415         $record = $DB->get_record($tablename, array('course' => 2));
1416         $this->assertNull($record->oneint);
1417         $this->assertNull($record->onenum);
1418         $this->assertNull($record->onechar);
1419         $this->assertNull($record->onetext);
1420         $this->assertNull($record->onebinary);
1422         // Check zeros are set properly for all types
1423         $record->oneint = 0;
1424         $record->onenum = 0;
1425         $DB->update_record($tablename, $record);
1426         $record = $DB->get_record($tablename, array('course' => 2));
1427         $this->assertEqual(0, $record->oneint);
1428         $this->assertEqual(0, $record->onenum);
1430         // Check booleans are set properly for all types
1431         $record->oneint = true; // trues
1432         $record->onenum = true;
1433         $record->onechar = true;
1434         $record->onetext = true;
1435         $DB->update_record($tablename, $record);
1436         $record = $DB->get_record($tablename, array('course' => 2));
1437         $this->assertEqual(1, $record->oneint);
1438         $this->assertEqual(1, $record->onenum);
1439         $this->assertEqual(1, $record->onechar);
1440         $this->assertEqual(1, $record->onetext);
1442         $record->oneint = false; // falses
1443         $record->onenum = false;
1444         $record->onechar = false;
1445         $record->onetext = false;
1446         $DB->update_record($tablename, $record);
1447         $record = $DB->get_record($tablename, array('course' => 2));
1448         $this->assertEqual(0, $record->oneint);
1449         $this->assertEqual(0, $record->onenum);
1450         $this->assertEqual(0, $record->onechar);
1451         $this->assertEqual(0, $record->onetext);
1453         // Check string data causes exception in numeric types
1454         $record->oneint = 'onestring';
1455         $record->onenum = 0;
1456         try {
1457             $DB->update_record($tablename, $record);
1458             $this->fail("Expecting an exception, none occurred");
1459         } catch (exception $e) {
1460             $this->assertTrue($e instanceof dml_exception);
1461         }
1462         $record->oneint = 0;
1463         $record->onenum = 'onestring';
1464         try {
1465             $DB->update_record($tablename, $record);
1466             $this->fail("Expecting an exception, none occurred");
1467         } catch (exception $e) {
1468             $this->assertTrue($e instanceof dml_exception);
1469         }
1471         // Check empty string data causes exception in numeric types
1472         $record->oneint = ''; // empty string
1473         $record->onenum = 0;
1474         try {
1475             $DB->update_record($tablename, $record);
1476             $this->fail("Expecting an exception, none occurred");
1477         } catch (exception $e) {
1478             $this->assertTrue($e instanceof dml_exception);
1479         }
1480         $record->oneint = 0;
1481         $record->onenum = ''; // empty string
1482         try {
1483             $DB->update_record($tablename, $record);
1484             $this->fail("Expecting an exception, none occurred");
1485         } catch (exception $e) {
1486             $this->assertTrue($e instanceof dml_exception);
1487         }
1489         // Check empty strings are set properly in string types
1490         $record->oneint = 0;
1491         $record->onenum = 0;
1492         $record->onechar = '';
1493         $record->onetext = '';
1494         $DB->update_record($tablename, $record);
1495         $record = $DB->get_record($tablename, array('course' => 2));
1496         $this->assertTrue($record->onechar === '');
1497         $this->assertTrue($record->onetext === '');
1499         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1500         $record->oneint = ((210.10 + 39.92) - 150.02);
1501         $record->onenum = ((210.10 + 39.92) - 150.02);
1502         $DB->update_record($tablename, $record);
1503         $record = $DB->get_record($tablename, array('course' => 2));
1504         $this->assertEqual(100, $record->oneint);
1505         $this->assertEqual(100, $record->onenum);
1507         // Check various quotes/backslashes combinations in string types
1508         $teststrings = array(
1509             'backslashes and quotes alone (even): "" \'\' \\\\',
1510             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1511             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1512             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1513         foreach ($teststrings as $teststring) {
1514             $record->onechar = $teststring;
1515             $record->onetext = $teststring;
1516             $DB->update_record($tablename, $record);
1517             $record = $DB->get_record($tablename, array('course' => 2));
1518             $this->assertEqual($teststring, $record->onechar);
1519             $this->assertEqual($teststring, $record->onetext);
1520         }
1522         // Check LOBs in text/binary columns
1523         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1524         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1525         $record->onetext = $clob;
1526         $record->onebinary = $blob;
1527         $DB->update_record($tablename, $record);
1528         $record = $DB->get_record($tablename, array('course' => 2));
1529         $this->assertEqual($clob, $record->onetext);
1530         $this->assertEqual($blob, $record->onebinary);
1532         // And "small" LOBs too, just in case
1533         $newclob = substr($clob, 0, 500);
1534         $newblob = substr($blob, 0, 250);
1535         $record->onetext = $newclob;
1536         $record->onebinary = $newblob;
1537         $DB->update_record($tablename, $record);
1538         $record = $DB->get_record($tablename, array('course' => 2));
1539         $this->assertEqual($newclob, $record->onetext);
1540         $this->assertEqual($newblob, $record->onebinary);
1541     }
1543     public function test_set_field() {
1544         $DB = $this->tdb;
1545         $dbman = $DB->get_manager();
1547         $table = $this->get_test_table();
1548         $tablename = $table->getName();
1550         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1551         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1552         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1553         $dbman->create_table($table);
1554         $this->tables[$tablename] = $table;
1556         $DB->insert_record($tablename, array('course' => 1));
1558         $this->assertTrue($DB->set_field($tablename, 'course', 2, array('id' => 1)));
1559         $this->assertEqual(2, $DB->get_field($tablename, 'course', array('id' => 1)));
1561         // Note: All the nulls, booleans, empties, quoted and backslashes tests
1562         // go to set_field_select() because set_field() is just one wrapper over it
1563     }
1565     public function test_set_field_select() {
1567         // All the information in this test is fetched from DB by get_field() so we
1568         // have such method properly tested against nulls, empties and friends...
1570         global $CFG;
1572         $DB = $this->tdb;
1573         $dbman = $DB->get_manager();
1575         $table = $this->get_test_table();
1576         $tablename = $table->getName();
1578         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1579         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1580         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null);
1581         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null);
1582         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null);
1583         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1584         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1585         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1586         $dbman->create_table($table);
1587         $this->tables[$tablename] = $table;
1589         $DB->insert_record($tablename, array('course' => 1));
1591         $this->assertTrue($DB->set_field_select($tablename, 'course', 2, 'id = ?', array(1)));
1592         $this->assertEqual(2, $DB->get_field($tablename, 'course', array('id' => 1)));
1594         // Check nulls are set properly for all types
1595         $DB->set_field_select($tablename, 'oneint', null, 'id = ?', array(1)); // trues
1596         $DB->set_field_select($tablename, 'onenum', null, 'id = ?', array(1));
1597         $DB->set_field_select($tablename, 'onechar', null, 'id = ?', array(1));
1598         $DB->set_field_select($tablename, 'onetext', null, 'id = ?', array(1));
1599         $DB->set_field_select($tablename, 'onebinary', null, 'id = ?', array(1));
1600         $this->assertNull($DB->get_field($tablename, 'oneint', array('id' => 1)));
1601         $this->assertNull($DB->get_field($tablename, 'onenum', array('id' => 1)));
1602         $this->assertNull($DB->get_field($tablename, 'onechar', array('id' => 1)));
1603         $this->assertNull($DB->get_field($tablename, 'onetext', array('id' => 1)));
1604         $this->assertNull($DB->get_field($tablename, 'onebinary', array('id' => 1)));
1606         // Check zeros are set properly for all types
1607         $DB->set_field_select($tablename, 'oneint', 0, 'id = ?', array(1));
1608         $DB->set_field_select($tablename, 'onenum', 0, 'id = ?', array(1));
1609         $this->assertEqual(0, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1610         $this->assertEqual(0, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1612         // Check booleans are set properly for all types
1613         $DB->set_field_select($tablename, 'oneint', true, 'id = ?', array(1)); // trues
1614         $DB->set_field_select($tablename, 'onenum', true, 'id = ?', array(1));
1615         $DB->set_field_select($tablename, 'onechar', true, 'id = ?', array(1));
1616         $DB->set_field_select($tablename, 'onetext', true, 'id = ?', array(1));
1617         $this->assertEqual(1, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1618         $this->assertEqual(1, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1619         $this->assertEqual(1, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1620         $this->assertEqual(1, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1622         $DB->set_field_select($tablename, 'oneint', false, 'id = ?', array(1)); // falses
1623         $DB->set_field_select($tablename, 'onenum', false, 'id = ?', array(1));
1624         $DB->set_field_select($tablename, 'onechar', false, 'id = ?', array(1));
1625         $DB->set_field_select($tablename, 'onetext', false, 'id = ?', array(1));
1626         $this->assertEqual(0, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1627         $this->assertEqual(0, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1628         $this->assertEqual(0, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1629         $this->assertEqual(0, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1631         // Check string data causes exception in numeric types
1632         try {
1633             $DB->set_field_select($tablename, 'oneint', 'onestring', 'id = ?', array(1));
1634             $this->fail("Expecting an exception, none occurred");
1635         } catch (exception $e) {
1636             $this->assertTrue($e instanceof dml_exception);
1637         }
1638         try {
1639             $DB->set_field_select($tablename, 'onenum', 'onestring', 'id = ?', array(1));
1640             $this->fail("Expecting an exception, none occurred");
1641         } catch (exception $e) {
1642             $this->assertTrue($e instanceof dml_exception);
1643         }
1645         // Check empty string data causes exception in numeric types
1646         try {
1647             $DB->set_field_select($tablename, 'oneint', '', 'id = ?', array(1));
1648             $this->fail("Expecting an exception, none occurred");
1649         } catch (exception $e) {
1650             $this->assertTrue($e instanceof dml_exception);
1651         }
1652         try {
1653             $DB->set_field_select($tablename, 'onenum', '', 'id = ?', array(1));
1654             $this->fail("Expecting an exception, none occurred");
1655         } catch (exception $e) {
1656             $this->assertTrue($e instanceof dml_exception);
1657         }
1659         // Check empty strings are set properly in string types
1660         $DB->set_field_select($tablename, 'onechar', '', 'id = ?', array(1));
1661         $DB->set_field_select($tablename, 'onetext', '', 'id = ?', array(1));
1662         $this->assertTrue($DB->get_field($tablename, 'onechar', array('id' => 1)) === '');
1663         $this->assertTrue($DB->get_field($tablename, 'onetext', array('id' => 1)) === '');
1665         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1666         $DB->set_field_select($tablename, 'oneint', ((210.10 + 39.92) - 150.02), 'id = ?', array(1));
1667         $DB->set_field_select($tablename, 'onenum', ((210.10 + 39.92) - 150.02), 'id = ?', array(1));
1668         $this->assertEqual(100, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1669         $this->assertEqual(100, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1671         // Check various quotes/backslashes combinations in string types
1672         $teststrings = array(
1673             'backslashes and quotes alone (even): "" \'\' \\\\',
1674             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1675             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1676             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1677         foreach ($teststrings as $teststring) {
1678             $DB->set_field_select($tablename, 'onechar', $teststring, 'id = ?', array(1));
1679             $DB->set_field_select($tablename, 'onetext', $teststring, 'id = ?', array(1));
1680             $this->assertEqual($teststring, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1681             $this->assertEqual($teststring, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1682         }
1684         // Check LOBs in text/binary columns
1685         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1686         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1687         $DB->set_field_select($tablename, 'onetext', $clob, 'id = ?', array(1));
1688         $DB->set_field_select($tablename, 'onebinary', $blob, 'id = ?', array(1));
1689         $this->assertEqual($clob, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1690         $this->assertEqual($blob, $DB->get_field($tablename, 'onebinary', array('id' => 1)));
1692         // And "small" LOBs too, just in case
1693         $newclob = substr($clob, 0, 500);
1694         $newblob = substr($blob, 0, 250);
1695         $DB->set_field_select($tablename, 'onetext', $newclob, 'id = ?', array(1));
1696         $DB->set_field_select($tablename, 'onebinary', $newblob, 'id = ?', array(1));
1697         $this->assertEqual($newclob, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1698         $this->assertEqual($newblob, $DB->get_field($tablename, 'onebinary', array('id' => 1)));
1699     }
1701     public function test_count_records() {
1702         $DB = $this->tdb;
1704         $dbman = $DB->get_manager();
1706         $table = $this->get_test_table();
1707         $tablename = $table->getName();
1709         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1710         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1711         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1712         $dbman->create_table($table);
1713         $this->tables[$tablename] = $table;
1715         $this->assertEqual(0, $DB->count_records($tablename));
1717         $DB->insert_record($tablename, array('course' => 3));
1718         $DB->insert_record($tablename, array('course' => 4));
1719         $DB->insert_record($tablename, array('course' => 5));
1721         $this->assertEqual(3, $DB->count_records($tablename));
1722     }
1724     public function test_count_records_select() {
1725         $DB = $this->tdb;
1727         $dbman = $DB->get_manager();
1729         $table = $this->get_test_table();
1730         $tablename = $table->getName();
1732         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1733         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1734         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1735         $dbman->create_table($table);
1736         $this->tables[$tablename] = $table;
1738         $this->assertEqual(0, $DB->count_records($tablename));
1740         $DB->insert_record($tablename, array('course' => 3));
1741         $DB->insert_record($tablename, array('course' => 4));
1742         $DB->insert_record($tablename, array('course' => 5));
1744         $this->assertEqual(2, $DB->count_records_select($tablename, 'course > ?', array(3)));
1745     }
1747     public function test_count_records_sql() {
1748         $DB = $this->tdb;
1749         $dbman = $DB->get_manager();
1751         $table = $this->get_test_table();
1752         $tablename = $table->getName();
1754         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1755         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1756         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1757         $dbman->create_table($table);
1758         $this->tables[$tablename] = $table;
1760         $this->assertEqual(0, $DB->count_records($tablename));
1762         $DB->insert_record($tablename, array('course' => 3));
1763         $DB->insert_record($tablename, array('course' => 4));
1764         $DB->insert_record($tablename, array('course' => 5));
1766         $this->assertEqual(2, $DB->count_records_sql("SELECT COUNT(*) FROM {".$tablename."} WHERE course > ?", array(3)));
1767     }
1769     public function test_record_exists() {
1770         $DB = $this->tdb;
1771         $dbman = $DB->get_manager();
1773         $table = $this->get_test_table();
1774         $tablename = $table->getName();
1776         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1777         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1778         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1779         $dbman->create_table($table);
1780         $this->tables[$tablename] = $table;
1782         $this->assertEqual(0, $DB->count_records($tablename));
1784         $this->assertFalse($DB->record_exists($tablename, array('course' => 3)));
1785         $DB->insert_record($tablename, array('course' => 3));
1787         $this->assertTrue($DB->record_exists($tablename, array('course' => 3)));
1789     }
1791     public function test_record_exists_select() {
1792         $DB = $this->tdb;
1793         $dbman = $DB->get_manager();
1795         $table = $this->get_test_table();
1796         $tablename = $table->getName();
1798         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1799         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1800         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1801         $dbman->create_table($table);
1802         $this->tables[$tablename] = $table;
1804         $this->assertEqual(0, $DB->count_records($tablename));
1806         $this->assertFalse($DB->record_exists_select($tablename, "course = ?", array(3)));
1807         $DB->insert_record($tablename, array('course' => 3));
1809         $this->assertTrue($DB->record_exists_select($tablename, "course = ?", array(3)));
1810     }
1812     public function test_record_exists_sql() {
1813         $DB = $this->tdb;
1814         $dbman = $DB->get_manager();
1816         $table = $this->get_test_table();
1817         $tablename = $table->getName();
1819         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1820         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1821         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1822         $dbman->create_table($table);
1823         $this->tables[$tablename] = $table;
1825         $this->assertEqual(0, $DB->count_records($tablename));
1827         $this->assertFalse($DB->record_exists_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
1828         $DB->insert_record($tablename, array('course' => 3));
1830         $this->assertTrue($DB->record_exists_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
1831     }
1833     public function test_delete_records() {
1834         $DB = $this->tdb;
1835         $dbman = $DB->get_manager();
1837         $table = $this->get_test_table();
1838         $tablename = $table->getName();
1840         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1841         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1842         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1843         $dbman->create_table($table);
1844         $this->tables[$tablename] = $table;
1846         $DB->insert_record($tablename, array('course' => 3));
1847         $DB->insert_record($tablename, array('course' => 2));
1848         $DB->insert_record($tablename, array('course' => 2));
1850         // Delete all records
1851         $this->assertTrue($DB->delete_records($tablename));
1852         $this->assertEqual(0, $DB->count_records($tablename));
1854         // Delete subset of records
1855         $DB->insert_record($tablename, array('course' => 3));
1856         $DB->insert_record($tablename, array('course' => 2));
1857         $DB->insert_record($tablename, array('course' => 2));
1859         $this->assertTrue($DB->delete_records($tablename, array('course' => 2)));
1860         $this->assertEqual(1, $DB->count_records($tablename));
1861     }
1863     public function test_delete_records_select() {
1864         $DB = $this->tdb;
1865         $dbman = $DB->get_manager();
1867         $table = $this->get_test_table();
1868         $tablename = $table->getName();
1870         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1871         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1872         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1873         $dbman->create_table($table);
1874         $this->tables[$tablename] = $table;
1876         $DB->insert_record($tablename, array('course' => 3));
1877         $DB->insert_record($tablename, array('course' => 2));
1878         $DB->insert_record($tablename, array('course' => 2));
1880         $this->assertTrue($DB->delete_records_select($tablename, 'course = ?', array(2)));
1881         $this->assertEqual(1, $DB->count_records($tablename));
1882     }
1884     public function test_delete_records_list() {
1885         $DB = $this->tdb;
1886         $dbman = $DB->get_manager();
1888         $table = $this->get_test_table();
1889         $tablename = $table->getName();
1891         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1892         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1893         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1894         $dbman->create_table($table);
1895         $this->tables[$tablename] = $table;
1897         $DB->insert_record($tablename, array('course' => 1));
1898         $DB->insert_record($tablename, array('course' => 2));
1899         $DB->insert_record($tablename, array('course' => 3));
1901         $this->assertTrue($DB->delete_records_list($tablename, 'course', array(2, 3)));
1902         $this->assertEqual(1, $DB->count_records($tablename));
1904         $this->assertTrue($DB->delete_records_list($tablename, 'course', array())); /// Must delete 0 rows without conditions. MDL-17645
1905         $this->assertEqual(1, $DB->count_records($tablename));
1906     }
1908     function test_sql_null_from_clause() {
1909         $DB = $this->tdb;
1910         $sql = "SELECT 1 AS id ".$DB->sql_null_from_clause();
1911         $this->assertEqual($DB->get_field_sql($sql), 1);
1912     }
1914     function test_sql_bitand() {
1915         $DB = $this->tdb;
1916         $sql = "SELECT ".$DB->sql_bitand(10, 3)." AS res ".$DB->sql_null_from_clause();
1917         $this->assertEqual($DB->get_field_sql($sql), 2);
1918     }
1920     function test_sql_bitnot() {
1921         $DB = $this->tdb;
1923         $not = $DB->sql_bitnot(2);
1924         $notlimited = $DB->sql_bitand($not, 7); // might be positive or negative number which can not fit into PHP INT!
1926         $sql = "SELECT $notlimited AS res ".$DB->sql_null_from_clause();
1927         $this->assertEqual($DB->get_field_sql($sql), 5);
1928     }
1930     function test_sql_bitor() {
1931         $DB = $this->tdb;
1932         $sql = "SELECT ".$DB->sql_bitor(10, 3)." AS res ".$DB->sql_null_from_clause();
1933         $this->assertEqual($DB->get_field_sql($sql), 11);
1934     }
1936     function test_sql_bitxor() {
1937         $DB = $this->tdb;
1938         $sql = "SELECT ".$DB->sql_bitxor(10, 3)." AS res ".$DB->sql_null_from_clause();
1939         $this->assertEqual($DB->get_field_sql($sql), 9);
1940     }
1942     function test_sql_modulo() {
1943         $DB = $this->tdb;
1944         $sql = "SELECT ".$DB->sql_modulo(10, 7)." AS res ".$DB->sql_null_from_clause();
1945         $this->assertEqual($DB->get_field_sql($sql), 3);
1946     }
1948     function test_sql_ceil() {
1949         $DB = $this->tdb;
1950         $sql = "SELECT ".$DB->sql_ceil(665.666)." AS res ".$DB->sql_null_from_clause();
1951         $this->assertEqual($DB->get_field_sql($sql), 666);
1952     }
1954     function test_cast_char2int() {
1955         $DB = $this->tdb;
1956         $dbman = $DB->get_manager();
1958         $table1 = $this->get_test_table("testtable1");
1959         $tablename1 = $table1->getName();
1961         $table1->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1962         $table1->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
1963         $table1->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1964         $dbman->create_table($table1);
1965         $this->tables[$tablename1] = $table1;
1967         $DB->insert_record($tablename1, array('name'=>'100'));
1969         $table2 = $this->get_test_table("testtable2");
1970         $tablename2 = $table2->getName();
1971         $table2->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1972         $table2->add_field('res', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1973         $table2->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1974         $dbman->create_table($table2);
1975         $this->tables[$table2->getName()] = $table2;
1977         $DB->insert_record($tablename2, array('res'=>100));
1979         try {
1980             $sql = "SELECT * FROM {".$tablename1."} t1, {".$tablename2."} t2 WHERE ".$DB->sql_cast_char2int("t1.name")." = t2.res ";
1981             $records = $DB->get_records_sql($sql);
1982             $this->assertEqual(count($records), 1);
1983         } catch (dml_exception $e) {
1984             $this->fail("No exception expected");
1985         }
1986     }
1988     function test_cast_char2real() {
1989         $DB = $this->tdb;
1990         $dbman = $DB->get_manager();
1992         $table = $this->get_test_table();
1993         $tablename = $table->getName();
1995         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1996         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
1997         $table->add_field('res', XMLDB_TYPE_NUMBER, '12, 7', null, null, null, null);
1998         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1999         $dbman->create_table($table);
2000         $this->tables[$tablename] = $table;
2002         $DB->insert_record($tablename, array('name'=>'10.10', 'res'=>5.1));
2003         $DB->insert_record($tablename, array('name'=>'1.10', 'res'=>666));
2004         $DB->insert_record($tablename, array('name'=>'11.10', 'res'=>0.1));
2006         $sql = "SELECT * FROM {".$tablename."} WHERE ".$DB->sql_cast_char2real('name')." > res";
2007         $records = $DB->get_records_sql($sql);
2008         $this->assertEqual(count($records), 2);
2009     }
2011     function sql_compare_text() {
2012         $DB = $this->tdb;
2013         $dbman = $DB->get_manager();
2015         $table = $this->get_test_table();
2016         $tablename = $table->getName();
2018         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2019         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2020         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2021         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2022         $dbman->create_table($table);
2023         $this->tables[$tablename] = $table;
2025         $DB->insert_record($tablename, array('name'=>'abcd',   'description'=>'abcd'));
2026         $DB->insert_record($tablename, array('name'=>'abcdef', 'description'=>'bbcdef'));
2027         $DB->insert_record($tablename, array('name'=>'aaaabb', 'description'=>'aaaacccccccccccccccccc'));
2029         $sql = "SELECT * FROM {".$tablename."} WHERE name = ".$DB->sql_compare_text('description');
2030         $records = $DB->get_records_sql($sql);
2031         $this->assertEqual(count($records), 1);
2033         $sql = "SELECT * FROM {".$tablename."} WHERE name = ".$DB->sql_compare_text('description', 4);
2034         $records = $DB->get_records_sql($sql);
2035         $this->assertEqual(count($records), 2);
2036     }
2038     function test_ilike() {
2039         $DB = $this->tdb;
2040         $dbman = $DB->get_manager();
2042         $table = $this->get_test_table();
2043         $tablename = $table->getName();
2045         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2046         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2047         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2048         $dbman->create_table($table);
2049         $this->tables[$tablename] = $table;
2051         $DB->insert_record($tablename, array('name'=>'SuperDuperRecord'));
2052         $DB->insert_record($tablename, array('name'=>'NoDupor'));
2053         $DB->insert_record($tablename, array('name'=>'ouch'));
2055         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_ilike()." ?";
2056         $params = array("%dup_r%");
2057         $records = $DB->get_records_sql($sql, $params);
2058         $this->assertEqual(count($records), 2);
2059     }
2061     function test_sql_concat() {
2062         $DB = $this->tdb;
2063         $dbman = $DB->get_manager();
2065         /// Testing all sort of values
2066         $sql = "SELECT ".$DB->sql_concat("?", "?", "?")." AS fullname ". $DB->sql_null_from_clause();
2067         // string, some unicode chars
2068         $params = array('name', 'áéíóú', 'name3');
2069         $this->assertEqual('nameáéíóúname3', $DB->get_field_sql($sql, $params));
2070         // string, spaces and numbers
2071         $params = array('name', '  ', 12345);
2072         $this->assertEqual('name  12345', $DB->get_field_sql($sql, $params));
2073         // float, empty and strings
2074         $params = array(123.45, '', 'test');
2075         $this->assertEqual('123.45test', $DB->get_field_sql($sql, $params));
2076         // float, null and strings
2077         $params = array(123.45, null, 'test');
2078         $this->assertNull($DB->get_field_sql($sql, $params), 'ANSI behaviour: Concatenating NULL must return NULL - But in Oracle :-(. [%s]'); // Concatenate NULL with anything result = NULL
2080         /// Testing fieldnames + values
2081         $table = $this->get_test_table();
2082         $tablename = $table->getName();
2084         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2085         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2086         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2087         $dbman->create_table($table);
2088         $this->tables[$tablename] = $table;
2090         $DB->insert_record($tablename, array('description'=>'áéíóú'));
2091         $DB->insert_record($tablename, array('description'=>'dxxx'));
2092         $DB->insert_record($tablename, array('description'=>'bcde'));
2094         $sql = 'SELECT id, ' . $DB->sql_concat('description', "'harcoded'", '?', '?') . ' AS result FROM {' . $tablename . '}';
2095         $records = $DB->get_records_sql($sql, array(123.45, 'test'));
2096         $this->assertEqual(count($records), 3);
2097         $this->assertEqual($records[1]->result, 'áéíóúharcoded123.45test');
2098     }
2100     function test_concat_join() {
2101         $DB = $this->tdb;
2102         $sql = "SELECT ".$DB->sql_concat_join("' '", array("?", "?", "?"))." AS fullname ".$DB->sql_null_from_clause();
2103         $params = array("name", "name2", "name3");
2104         $result = $DB->get_field_sql($sql, $params);
2105         $this->assertEqual("name name2 name3", $result);
2106     }
2108     function test_sql_fullname() {
2109         $DB = $this->tdb;
2110         $sql = "SELECT ".$DB->sql_fullname(':first', ':last')." AS fullname ".$DB->sql_null_from_clause();
2111         $params = array('first'=>'Firstname', 'last'=>'Surname');
2112         $this->assertEqual("Firstname Surname", $DB->get_field_sql($sql, $params));
2113     }
2115     function sql_sql_order_by_text() {
2116         $DB = $this->tdb;
2117         $dbman = $DB->get_manager();
2119         $table = $this->get_test_table();
2120         $tablename = $table->getName();
2122         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2123         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2124         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2125         $dbman->create_table($table);
2126         $this->tables[$tablename] = $table;
2128         $DB->insert_record($tablename, array('description'=>'abcd'));
2129         $DB->insert_record($tablename, array('description'=>'dxxx'));
2130         $DB->insert_record($tablename, array('description'=>'bcde'));
2132         $sql = "SELECT * FROM {".$tablename."} ORDER BY ".$DB->sql_order_by_text('description');
2133         $records = $DB->get_records_sql($sql);
2134         $first = array_unshift($records);
2135         $this->assertEqual(1, $first->id);
2136         $second = array_unshift($records);
2137         $this->assertEqual(3, $second->id);
2138         $last = array_unshift($records);
2139         $this->assertEqual(2, $last->id);
2140     }
2142     function test_sql_substring() {
2143         $DB = $this->tdb;
2144         $dbman = $DB->get_manager();
2146         $table = $this->get_test_table();
2147         $tablename = $table->getName();
2149         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2150         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2151         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2152         $dbman->create_table($table);
2153         $this->tables[$tablename] = $table;
2155         $string = 'abcdefghij';
2157         $DB->insert_record($tablename, array('name'=>$string));
2159         $sql = "SELECT id, ".$DB->sql_substr("name", 5)." AS name FROM {".$tablename."}";
2160         $record = $DB->get_record_sql($sql);
2161         $this->assertEqual(substr($string, 5-1), $record->name);
2163         $sql = "SELECT id, ".$DB->sql_substr("name", 5, 2)." AS name FROM {".$tablename."}";
2164         $record = $DB->get_record_sql($sql);
2165         $this->assertEqual(substr($string, 5-1, 2), $record->name);
2167         try {
2168             // silence php warning ;-)
2169             @$DB->sql_substr("name");
2170             $this->fail("Expecting an exception, none occurred");
2171         } catch (Exception $e) {
2172             $this->assertTrue($e instanceof coding_exception);
2173         }
2174     }
2176     function test_sql_length() {
2177         $DB = $this->tdb;
2178         $this->assertEqual($DB->get_field_sql(
2179                 "SELECT ".$DB->sql_length("'aeiou'").$DB->sql_null_from_clause()), 5);
2180         $this->assertEqual($DB->get_field_sql(
2181                 "SELECT ".$DB->sql_length("'áéíóú'").$DB->sql_null_from_clause()), 5);
2182     }
2184     function test_sql_position() {
2185         $DB = $this->tdb;
2186         $this->assertEqual($DB->get_field_sql(
2187                 "SELECT ".$DB->sql_position("'ood'", "'Moodle'").$DB->sql_null_from_clause()), 2);
2188         $this->assertEqual($DB->get_field_sql(
2189                 "SELECT ".$DB->sql_position("'Oracle'", "'Moodle'").$DB->sql_null_from_clause()), 0);
2190     }
2192     function test_sql_empty() {
2193         $DB = $this->tdb;
2194         $dbman = $DB->get_manager();
2196         $table = $this->get_test_table();
2197         $tablename = $table->getName();
2199         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2200         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2201         $table->add_field('namenotnull', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, 'default value');
2202         $table->add_field('namenotnullnodeflt', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
2203         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2204         $dbman->create_table($table);
2205         $this->tables[$tablename] = $table;
2207         $DB->insert_record($tablename, array('name'=>'', 'namenotnull'=>''));
2208         $DB->insert_record($tablename, array('name'=>null));
2209         $DB->insert_record($tablename, array('name'=>'lalala'));
2210         $DB->insert_record($tablename, array('name'=>0));
2212         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE name = '".$DB->sql_empty()."'");
2213         $this->assertEqual(count($records), 1);
2214         $record = reset($records);
2215         $this->assertEqual($record->name, '');
2217         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE namenotnull = '".$DB->sql_empty()."'");
2218         $this->assertEqual(count($records), 1);
2219         $record = reset($records);
2220         $this->assertEqual($record->namenotnull, '');
2222         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE namenotnullnodeflt = '".$DB->sql_empty()."'");
2223         $this->assertEqual(count($records), 4);
2224         $record = reset($records);
2225         $this->assertEqual($record->namenotnullnodeflt, '');
2226     }
2228     function test_sql_isempty() {
2229         $DB = $this->tdb;
2230         $dbman = $DB->get_manager();
2232         $table = $this->get_test_table();
2233         $tablename = $table->getName();
2235         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2236         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
2237         $table->add_field('namenull', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2238         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, XMLDB_NOTNULL, null, null);
2239         $table->add_field('descriptionnull', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2240         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2241         $dbman->create_table($table);
2242         $this->tables[$tablename] = $table;
2244         $DB->insert_record($tablename, array('name'=>'',   'namenull'=>'',   'description'=>'',   'descriptionnull'=>''));
2245         $DB->insert_record($tablename, array('name'=>'??', 'namenull'=>null, 'description'=>'??', 'descriptionnull'=>null));
2246         $DB->insert_record($tablename, array('name'=>'la', 'namenull'=>'la', 'description'=>'la', 'descriptionnull'=>'lalala'));
2247         $DB->insert_record($tablename, array('name'=>0,    'namenull'=>0,    'description'=>0,    'descriptionnull'=>0));
2249         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'name', false, false));
2250         $this->assertEqual(count($records), 1);
2251         $record = reset($records);
2252         $this->assertEqual($record->name, '');
2254         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'namenull', true, false));
2255         $this->assertEqual(count($records), 1);
2256         $record = reset($records);
2257         $this->assertEqual($record->namenull, '');
2259         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'description', false, true));
2260         $this->assertEqual(count($records), 1);
2261         $record = reset($records);
2262         $this->assertEqual($record->description, '');
2264         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'descriptionnull', true, true));
2265         $this->assertEqual(count($records), 1);
2266         $record = reset($records);
2267         $this->assertEqual($record->descriptionnull, '');
2268     }
2270     function sql_isnotempty() {
2271         //TODO
2272     }
2274     function test_sql_regex() {
2275         $DB = $this->tdb;
2276         $dbman = $DB->get_manager();
2278         $table = $this->get_test_table();
2279         $tablename = $table->getName();
2281         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2282         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2283         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2284         $dbman->create_table($table);
2285         $this->tables[$tablename] = $table;
2287         $DB->insert_record($tablename, array('name'=>'lalala'));
2288         $DB->insert_record($tablename, array('name'=>'holaaa'));
2289         $DB->insert_record($tablename, array('name'=>'aouch'));
2291         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_regex()." ?";
2292         $params = array('a$');
2293         if ($DB->sql_regex_supported()) {
2294             $records = $DB->get_records_sql($sql, $params);
2295             $this->assertEqual(count($records), 2);
2296         } else {
2297             $this->assertTrue(true, 'Regexp operations not supported. Test skipped');
2298         }
2300         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_regex(false)." ?";
2301         $params = array('.a');
2302         if ($DB->sql_regex_supported()) {
2303             $records = $DB->get_records_sql($sql, $params);
2304             $this->assertEqual(count($records), 1);
2305         } else {
2306             $this->assertTrue(true, 'Regexp operations not supported. Test skipped');
2307         }
2309     }
2311     function test_begin_sql() {
2312         $DB = $this->tdb;
2313         $dbman = $DB->get_manager();
2315         $table = $this->get_test_table();
2316         $tablename = $table->getName();
2318         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2319         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2320         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2321         $dbman->create_table($table);
2322         $this->tables[$tablename] = $table;
2324         $active = $DB->begin_sql();
2325         if ($active) {
2326             // test only if driver supports transactions
2327             $data = (object)array('course'=>3);
2328             $DB->insert_record($tablename, $data);
2329             $this->assertEqual(1, $DB->count_records($tablename));
2330             $DB->commit_sql();
2331         } else {
2332             $this->assertTrue(true, 'DB Transactions not supported. Test skipped');
2333         }
2334     }
2336     function test_commit_sql() {
2337         $DB = $this->tdb;
2338         $dbman = $DB->get_manager();
2340         $table = $this->get_test_table();
2341         $tablename = $table->getName();
2343         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2344         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2345         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2346         $dbman->create_table($table);
2347         $this->tables[$tablename] = $table;
2349         $active = $DB->begin_sql();
2350         if ($active) {
2351             // test only if driver supports transactions
2352             $data = (object)array('course'=>3);
2353             $DB->insert_record($tablename, $data);
2354             $DB->commit_sql();
2355             $this->assertEqual(1, $DB->count_records($tablename));
2356         } else {
2357             $this->assertTrue(true, 'BD Transactions not supported. Test skipped');
2358         }
2359     }
2361     function test_rollback_sql() {
2362         $DB = $this->tdb;
2363         $dbman = $DB->get_manager();
2365         $table = $this->get_test_table();
2366         $tablename = $table->getName();
2368         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2369         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2370         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2371         $dbman->create_table($table);
2372         $this->tables[$tablename] = $table;
2374         $active = $DB->begin_sql();
2375         if ($active) {
2376             // test only if driver supports transactions
2377             $data = (object)array('course'=>3);
2378             $DB->insert_record($tablename, $data);
2379             $DB->rollback_sql();
2380             $this->assertEqual(0, $DB->count_records($tablename));
2381         } else {
2382             $this->assertTrue(true, 'DB Transactions not supported. Test skipped');
2383         }
2384     }
2386     /**
2387      * Test some more complex SQL syntax which moodle uses and depends on to work
2388      * useful to determine if new database libraries can be supported.
2389      */
2390     public function test_get_records_sql_complicated() {
2391         global $CFG;
2392         $DB = $this->tdb;
2393         $dbman = $DB->get_manager();
2395         $table = $this->get_test_table();
2396         $tablename = $table->getName();
2398         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2399         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2400         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2401         $dbman->create_table($table);
2402         $this->tables[$tablename] = $table;
2404         $DB->insert_record($tablename, array('course' => 3));
2405         $DB->insert_record($tablename, array('course' => 3));
2406         $DB->insert_record($tablename, array('course' => 5));
2407         $DB->insert_record($tablename, array('course' => 2));
2409         // we have sql like this in moodle, this syntax breaks on older versions of sqlite for example..
2410         $sql = 'SELECT a.id AS id, a.course AS course
2411                 FROM {'.$tablename.'} a
2412                 JOIN (SELECT * FROM {'.$tablename.'}) b
2413                 ON a.id = b.id
2414                 WHERE a.course = ?';
2416         $this->assertTrue($records = $DB->get_records_sql($sql, array(3)));
2417         $this->assertEqual(2, count($records));
2418         $this->assertEqual(1, reset($records)->id);
2419         $this->assertEqual(2, next($records)->id);
2420     }
2423 /**
2424  * This class is not a proper subclass of moodle_database. It is
2425  * intended to be used only in unit tests, in order to gain access to the
2426  * protected methods of moodle_database, and unit test them.
2427  */
2428 class moodle_database_for_testing extends moodle_database {
2429     protected $prefix = 'mdl_';
2431     public function public_fix_table_names($sql) {
2432         return $this->fix_table_names($sql);
2433     }
2435     public function driver_installed(){}
2436     public function get_dbfamily(){}
2437     protected function get_dbtype(){}
2438     protected function get_dblibrary(){}
2439     public function get_name(){}
2440     public function get_configuration_help(){}
2441     public function get_configuration_hints(){}
2442     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null){}
2443     public function get_server_info(){}
2444     protected function allowed_param_types(){}
2445     public function get_last_error(){}
2446     public function get_tables($usecache=true){}
2447     public function get_indexes($table){}
2448     public function get_columns($table, $usecache=true){}
2449     public function set_debug($state){}
2450     public function get_debug(){}
2451     public function set_logging($state){}
2452     public function change_database_structure($sql){}
2453     public function execute($sql, array $params=null){}
2454     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0){}
2455     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0){}
2456     public function get_fieldset_sql($sql, array $params=null){}
2457     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false){}
2458     public function insert_record($table, $dataobject, $returnid=true, $bulk=false){}
2459     public function import_record($table, $dataobject){}
2460     public function update_record_raw($table, $params, $bulk=false){}
2461     public function update_record($table, $dataobject, $bulk=false){}
2462     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null){}
2463     public function delete_records_select($table, $select, array $params=null){}
2464     public function sql_concat(){}
2465     public function sql_concat_join($separator="' '", $elements=array()){}
2466     public function sql_substr($expr, $start, $length=false){}