1d02140f51b075177463aeedb96bb0b2ff559139
[moodle.git] / lib / dml / simpletest / testdml.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * @package    moodlecore
20  * @subpackage DML
21  * @copyright  2008 Petr Skoda (http://skodak.org)
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 if (!defined('MOODLE_INTERNAL')) {
26     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
27 }
29 class dml_test extends UnitTestCase {
30     private $tables = array();
31     private $tdb;
32     private $data;
33     public  static $includecoverage = array('lib/dml');
34     public  static $excludecoverage = array('lib/dml/simpletest');
36     function setUp() {
37         global $CFG, $DB, $UNITTEST;
39         if (isset($UNITTEST->func_test_db)) {
40             $this->tdb = $UNITTEST->func_test_db;
41         } else {
42             $this->tdb = $DB;
43         }
45     }
47     function tearDown() {
48         $dbman = $this->tdb->get_manager();
50         foreach ($this->tables as $table) {
51             if ($dbman->table_exists($table)) {
52                 $dbman->drop_table($table);
53             }
54         }
55         $this->tables = array();
56     }
58     /**
59      * Get a xmldb_table object for testing, deleting any existing table
60      * of the same name, for example if one was left over from a previous test
61      * run that crashed.
62      *
63      * @param database_manager $dbman the database_manager to use.
64      * @param string $tablename the name of the table to create.
65      * @return xmldb_table the table object.
66      */
67     private function get_test_table($tablename="") {
68         $DB = $this->tdb;
69         $dbman = $this->tdb->get_manager();
71         if ($tablename == '') {
72             $tablename = "unit_table";
73         }
75         $table = new xmldb_table($tablename);
76         if ($dbman->table_exists($table)) {
77             $dbman->drop_table($table);
78         }
79         return new xmldb_table($tablename);
80     }
82     function test_fix_sql_params() {
83         $DB = $this->tdb;
85         $table = $this->get_test_table();
86         $tablename = $table->getName();
88         // Correct table placeholder substitution
89         $sql = "SELECT * FROM {".$tablename."}";
90         $sqlarray = $DB->fix_sql_params($sql);
91         $this->assertEqual("SELECT * FROM {$DB->get_prefix()}".$tablename, $sqlarray[0]);
93         // Conversions of all param types
94         $sql = array();
95         $sql[SQL_PARAMS_NAMED]  = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = :param1, course = :param2";
96         $sql[SQL_PARAMS_QM]     = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = ?, course = ?";
97         $sql[SQL_PARAMS_DOLLAR] = "SELECT * FROM {$DB->get_prefix()}testtable WHERE name = \$1, course = \$2";
99         $params = array();
100         $params[SQL_PARAMS_NAMED]  = array('param1'=>'first record', 'param2'=>1);
101         $params[SQL_PARAMS_QM]     = array('first record', 1);
102         $params[SQL_PARAMS_DOLLAR] = array('first record', 1);
104         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_NAMED], $params[SQL_PARAMS_NAMED]);
105         $this->assertEqual($rsql, $sql[$rtype]);
106         $this->assertEqual($rparams, $params[$rtype]);
108         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_QM], $params[SQL_PARAMS_QM]);
109         $this->assertEqual($rsql, $sql[$rtype]);
110         $this->assertEqual($rparams, $params[$rtype]);
112         list($rsql, $rparams, $rtype) = $DB->fix_sql_params($sql[SQL_PARAMS_DOLLAR], $params[SQL_PARAMS_DOLLAR]);
113         $this->assertEqual($rsql, $sql[$rtype]);
114         $this->assertEqual($rparams, $params[$rtype]);
117         // Malformed table placeholder
118         $sql = "SELECT * FROM [testtable]";
119         $sqlarray = $DB->fix_sql_params($sql);
120         $this->assertEqual($sql, $sqlarray[0]);
123         // Mixed param types (colon and dollar)
124         $sql = "SELECT * FROM {".$tablename."} WHERE name = :param1, course = \$1";
125         $params = array('param1' => 'record1', 'param2' => 3);
126         try {
127             $sqlarray = $DB->fix_sql_params($sql, $params);
128             $this->fail("Expecting an exception, none occurred");
129         } catch (Exception $e) {
130             $this->assertTrue($e instanceof moodle_exception);
131         }
133         // Mixed param types (question and dollar)
134         $sql = "SELECT * FROM {".$tablename."} WHERE name = ?, course = \$1";
135         $params = array('param1' => 'record2', 'param2' => 5);
136         try {
137             $sqlarray = $DB->fix_sql_params($sql, $params);
138             $this->fail("Expecting an exception, none occurred");
139         } catch (Exception $e) {
140             $this->assertTrue($e instanceof moodle_exception);
141         }
143         // Too many params in sql
144         $sql = "SELECT * FROM {".$tablename."} WHERE name = ?, course = ?, id = ?";
145         $params = array('record2', 3);
146         try {
147             $sqlarray = $DB->fix_sql_params($sql, $params);
148             $this->fail("Expecting an exception, none occurred");
149         } catch (Exception $e) {
150             $this->assertTrue($e instanceof moodle_exception);
151         }
153         // Too many params in array: no error
154         $params[] = 1;
155         $params[] = time();
156         $sqlarray = null;
158         try {
159             $sqlarray = $DB->fix_sql_params($sql, $params);
160             $this->pass();
161         } catch (Exception $e) {
162             $this->fail("Unexpected ".get_class($e)." exception");
163         }
164         $this->assertTrue($sqlarray[0]);
166         // Named params missing from array
167         $sql = "SELECT * FROM {".$tablename."} WHERE name = :name, course = :course";
168         $params = array('wrongname' => 'record1', 'course' => 1);
169         try {
170             $sqlarray = $DB->fix_sql_params($sql, $params);
171             $this->fail("Expecting an exception, none occurred");
172         } catch (Exception $e) {
173             $this->assertTrue($e instanceof moodle_exception);
174         }
176         // Duplicate named param in query
177         $sql = "SELECT * FROM {".$tablename."} WHERE name = :name, course = :name";
178         $params = array('name' => 'record2', 'course' => 3);
179         try {
180             $sqlarray = $DB->fix_sql_params($sql, $params);
181             $this->fail("Expecting an exception, none occurred");
182         } catch (Exception $e) {
183             $this->assertTrue($e instanceof moodle_exception);
184         }
186     }
188     public function testGetTables() {
189         $DB = $this->tdb;
190         $dbman = $this->tdb->get_manager();
192         // Need to test with multiple DBs
193         $table = $this->get_test_table();
194         $tablename = $table->getName();
196         $original_count = count($DB->get_tables());
198         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
199         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
200         $dbman->create_table($table);
201         $this->tables[$tablename] = $table;
203         $this->assertTrue(count($DB->get_tables()) == $original_count + 1);
204     }
206     public function testDefaults() {
207         $DB = $this->tdb;
208         $dbman = $this->tdb->get_manager();
210         $table = $this->get_test_table();
211         $tablename = $table->getName();
213         $table->add_field('enumfield', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, 'test2');
214         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
215         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
216         $dbman->create_table($table);
217         $this->tables[$tablename] = $table;
219         $columns = $DB->get_columns($tablename);
221         $enumfield = $columns['enumfield'];
222         $this->assertEqual('test2', $enumfield->default_value);
223         $this->assertEqual('C', $enumfield->meta_type);
225     }
227     public function testGetIndexes() {
228         $DB = $this->tdb;
229         $dbman = $this->tdb->get_manager();
231         $table = $this->get_test_table();
232         $tablename = $table->getName();
234         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
235         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
236         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
237         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
238         $table->add_index('course-id', XMLDB_INDEX_UNIQUE, array('course', 'id'));
239         $dbman->create_table($table);
240         $this->tables[$tablename] = $table;
242         $this->assertTrue($indices = $DB->get_indexes($tablename));
243         $this->assertEqual(count($indices), 2);
244         // we do not care about index names for now
245         $first = array_shift($indices);
246         $second = array_shift($indices);
247         if (count($first['columns']) == 2) {
248             $composed = $first;
249             $single   = $second;
250         } else {
251             $composed = $second;
252             $single   = $first;
253         }
254         $this->assertFalse($single['unique']);
255         $this->assertTrue($composed['unique']);
256         $this->assertEqual(1, count($single['columns']));
257         $this->assertEqual(2, count($composed['columns']));
258         $this->assertEqual('course', $single['columns'][0]);
259         $this->assertEqual('course', $composed['columns'][0]);
260         $this->assertEqual('id', $composed['columns'][1]);
261     }
263     public function testGetColumns() {
264         $DB = $this->tdb;
265         $dbman = $this->tdb->get_manager();
267         $table = $this->get_test_table();
268         $tablename = $table->getName();
270         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
271         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
272         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
273         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
274         $dbman->create_table($table);
275         $this->tables[$tablename] = $table;
277         $this->assertTrue($columns = $DB->get_columns($tablename));
278         $fields = $this->tables[$tablename]->getFields();
279         $this->assertEqual(count($columns), count($fields));
281         for ($i = 0; $i < count($columns); $i++) {
282             if ($i == 0) {
283                 $next_column = reset($columns);
284                 $next_field  = reset($fields);
285             } else {
286                 $next_column = next($columns);
287                 $next_field  = next($fields);
288             }
290             $this->assertEqual($next_column->name, $next_field->name);
291         }
292     }
294     public function testExecute() {
295         $DB = $this->tdb;
296         $dbman = $this->tdb->get_manager();
298         $table = $this->get_test_table();
299         $tablename = $table->getName();
301         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
302         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
303         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
304         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
305         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
306         $dbman->create_table($table);
307         $this->tables[$tablename] = $table;
309         $sql = "SELECT * FROM {".$tablename."}";
311         $this->assertTrue($DB->execute($sql));
313         $params = array('course' => 1, 'name' => 'test');
315         $sql = "INSERT INTO {".$tablename."} (".implode(',', array_keys($params)).")
316                        VALUES (".implode(',', array_fill(0, count($params), '?')).")";
319         $this->assertTrue($DB->execute($sql, $params));
321         $record = $DB->get_record($tablename, array('id' => 1));
323         foreach ($params as $field => $value) {
324             $this->assertEqual($value, $record->$field, "Field $field in DB ({$record->$field}) is not equal to field $field in sql ($value)");
325         }
326     }
328     public function test_get_in_or_equal() {
329         $DB = $this->tdb;
331         // SQL_PARAMS_QM - IN or =
333         // Correct usage of multiple values
334         $in_values = array('value1', 'value2', 'value3', 'value4');
335         list($usql, $params) = $DB->get_in_or_equal($in_values);
336         $this->assertEqual("IN (?,?,?,?)", $usql);
337         $this->assertEqual(4, count($params));
338         foreach ($params as $key => $value) {
339             $this->assertEqual($in_values[$key], $value);
340         }
342         // Correct usage of single value (in an array)
343         $in_values = array('value1');
344         list($usql, $params) = $DB->get_in_or_equal($in_values);
345         $this->assertEqual("= ?", $usql);
346         $this->assertEqual(1, count($params));
347         $this->assertEqual($in_values[0], $params[0]);
349         // Correct usage of single value
350         $in_value = 'value1';
351         list($usql, $params) = $DB->get_in_or_equal($in_values);
352         $this->assertEqual("= ?", $usql);
353         $this->assertEqual(1, count($params));
354         $this->assertEqual($in_value, $params[0]);
356         // SQL_PARAMS_QM - NOT IN or <>
358         // Correct usage of multiple values
359         $in_values = array('value1', 'value2', 'value3', 'value4');
360         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
361         $this->assertEqual("NOT IN (?,?,?,?)", $usql);
362         $this->assertEqual(4, count($params));
363         foreach ($params as $key => $value) {
364             $this->assertEqual($in_values[$key], $value);
365         }
367         // Correct usage of single value (in array()
368         $in_values = array('value1');
369         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
370         $this->assertEqual("<> ?", $usql);
371         $this->assertEqual(1, count($params));
372         $this->assertEqual($in_values[0], $params[0]);
374         // Correct usage of single value
375         $in_value = 'value1';
376         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_QM, null, false);
377         $this->assertEqual("<> ?", $usql);
378         $this->assertEqual(1, count($params));
379         $this->assertEqual($in_value, $params[0]);
381         // SQL_PARAMS_NAMED - IN or =
383         // Correct usage of multiple values
384         $in_values = array('value1', 'value2', 'value3', 'value4');
385         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
386         $this->assertEqual("IN (:param01,:param02,:param03,:param04)", $usql);
387         $this->assertEqual(4, count($params));
388         reset($in_values);
389         foreach ($params as $key => $value) {
390             $this->assertEqual(current($in_values), $value);
391             next($in_values);
392         }
394         // Correct usage of single values (in array)
395         $in_values = array('value1');
396         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
397         $this->assertEqual("= :param01", $usql);
398         $this->assertEqual(1, count($params));
399         $this->assertEqual($in_values[0], $params['param01']);
401         // Correct usage of single value
402         $in_value = 'value1';
403         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', true);
404         $this->assertEqual("= :param01", $usql);
405         $this->assertEqual(1, count($params));
406         $this->assertEqual($in_value, $params['param01']);
408         // SQL_PARAMS_NAMED - NOT IN or <>
410         // Correct usage of multiple values
411         $in_values = array('value1', 'value2', 'value3', 'value4');
412         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
413         $this->assertEqual("NOT IN (:param01,:param02,:param03,:param04)", $usql);
414         $this->assertEqual(4, count($params));
415         reset($in_values);
416         foreach ($params as $key => $value) {
417             $this->assertEqual(current($in_values), $value);
418             next($in_values);
419         }
421         // Correct usage of single values (in array)
422         $in_values = array('value1');
423         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
424         $this->assertEqual("<> :param01", $usql);
425         $this->assertEqual(1, count($params));
426         $this->assertEqual($in_values[0], $params['param01']);
428         // Correct usage of single value
429         $in_value = 'value1';
430         list($usql, $params) = $DB->get_in_or_equal($in_values, SQL_PARAMS_NAMED, 'param01', false);
431         $this->assertEqual("<> :param01", $usql);
432         $this->assertEqual(1, count($params));
433         $this->assertEqual($in_value, $params['param01']);
435     }
437     public function test_fix_table_names() {
438         $DB = new moodle_database_for_testing();
439         $prefix = $DB->get_prefix();
441         // Simple placeholder
442         $placeholder = "{user}";
443         $this->assertEqual($prefix."user", $DB->public_fix_table_names($placeholder));
445         // Full SQL
446         $sql = "SELECT * FROM {user}, {funny_table_name}, {mdl_stupid_table} WHERE {user}.id = {funny_table_name}.userid";
447         $expected = "SELECT * FROM {$prefix}user, {$prefix}funny_table_name, {$prefix}mdl_stupid_table WHERE {$prefix}user.id = {$prefix}funny_table_name.userid";
448         $this->assertEqual($expected, $DB->public_fix_table_names($sql));
451     }
453     public function test_get_recordset() {
454         $DB = $this->tdb;
455         $dbman = $DB->get_manager();
457         $table = $this->get_test_table();
458         $tablename = $table->getName();
460         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
461         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
462         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
463         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
464         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
465         $dbman->create_table($table);
466         $this->tables[$tablename] = $table;
468         $data = array(array('id' => 1, 'course' => 3, 'name' => 'record1'),
469                       array('id' => 2, 'course' => 3, 'name' => 'record2'),
470                       array('id' => 3, 'course' => 5, 'name' => 'record3'));
472         foreach ($data as $record) {
473             $DB->insert_record($tablename, $record);
474         }
476         $rs = $DB->get_recordset($tablename);
477         $this->assertTrue($rs);
479         reset($data);
480         foreach($rs as $record) {
481             $data_record = current($data);
482             foreach ($record as $k => $v) {
483                 $this->assertEqual($data_record[$k], $v);
484             }
485             next($data);
486         }
487         $rs->close();
489         // note: delegate limits testing to test_get_recordset_sql()
490     }
492     public function test_get_recordset_iterator_keys() {
493         $DB = $this->tdb;
494         $dbman = $DB->get_manager();
496         $table = $this->get_test_table();
497         $tablename = $table->getName();
499         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
500         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
501         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, '0');
502         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
503         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
504         $dbman->create_table($table);
505         $this->tables[$tablename] = $table;
507         $data = array(array('id'=> 1, 'course' => 3, 'name' => 'record1'),
508                       array('id'=> 2, 'course' => 3, 'name' => 'record2'),
509                       array('id'=> 3, 'course' => 5, 'name' => 'record3'));
510         foreach ($data as $record) {
511             $DB->insert_record($tablename, $record);
512         }
514     /// Test repeated numeric keys are returned ok
515         $rs = $DB->get_recordset($tablename, NULL, NULL, 'course, name, id');
517         reset($data);
518         $count = 0;
519         foreach($rs as $key => $record) {
520             $data_record = current($data);
521             $this->assertEqual($data_record['course'], $key);
522             next($data);
523             $count++;
524         }
525         $rs->close();
527     /// Test record returned are ok
528         $this->assertEqual($count, 3);
530     /// Test string keys are returned ok
531         $rs = $DB->get_recordset($tablename, NULL, NULL, 'name, course, id');
533         reset($data);
534         $count = 0;
535         foreach($rs as $key => $record) {
536             $data_record = current($data);
537             $this->assertEqual($data_record['name'], $key);
538             next($data);
539             $count++;
540         }
541         $rs->close();
543     /// Test record returned are ok
544         $this->assertEqual($count, 3);
546     /// Test numeric not starting in 1 keys are returned ok
547         $rs = $DB->get_recordset($tablename, NULL, 'id DESC', 'id, course, name');
549         $data = array_reverse($data);
550         reset($data);
551         $count = 0;
552         foreach($rs as $key => $record) {
553             $data_record = current($data);
554             $this->assertEqual($data_record['id'], $key);
555             next($data);
556             $count++;
557         }
558         $rs->close();
560     /// Test record returned are ok
561         $this->assertEqual($count, 3);
562     }
564     public function test_get_recordset_list() {
565         $DB = $this->tdb;
566         $dbman = $DB->get_manager();
568         $table = $this->get_test_table();
569         $tablename = $table->getName();
571         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
572         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
573         $table->add_index('course', XMLDB_INDEX_NOTUNIQUE, array('course'));
574         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
575         $dbman->create_table($table);
576         $this->tables[$tablename] = $table;
578         $DB->insert_record($tablename, array('course' => 3));
579         $DB->insert_record($tablename, array('course' => 3));
580         $DB->insert_record($tablename, array('course' => 5));
581         $DB->insert_record($tablename, array('course' => 2));
583         $rs = $DB->get_recordset_list($tablename, 'course', array(3, 2));
585         $this->assertTrue($rs);
587         $counter = 0;
588         foreach ($rs as $record) {
589             $counter++;
590         }
591         $this->assertEqual(3, $counter);
592         $rs->close();
594         $rs = $DB->get_recordset_list($tablename, 'course',array()); /// Must return 0 rows without conditions. MDL-17645
596         $counter = 0;
597         foreach ($rs as $record) {
598             $counter++;
599         }
600         $rs->close();
601         $this->assertEqual(0, $counter);
603         // note: delegate limits testing to test_get_recordset_sql()
604     }
606     public function test_get_recordset_select() {
607         $DB = $this->tdb;
608         $dbman = $DB->get_manager();
610         $table = $this->get_test_table();
611         $tablename = $table->getName();
613         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
614         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
615         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
616         $dbman->create_table($table);
617         $this->tables[$tablename] = $table;
619         $DB->insert_record($tablename, array('course' => 3));
620         $DB->insert_record($tablename, array('course' => 3));
621         $DB->insert_record($tablename, array('course' => 5));
622         $DB->insert_record($tablename, array('course' => 2));
624         $rs = $DB->get_recordset_select($tablename, '');
625         $counter = 0;
626         foreach ($rs as $record) {
627             $counter++;
628         }
629         $rs->close();
630         $this->assertEqual(4, $counter);
632         $this->assertTrue($rs = $DB->get_recordset_select($tablename, 'course = 3'));
633         $counter = 0;
634         foreach ($rs as $record) {
635             $counter++;
636         }
637         $rs->close();
638         $this->assertEqual(2, $counter);
640         // note: delegate limits testing to test_get_recordset_sql()
641     }
643     public function test_get_recordset_sql() {
644         $DB = $this->tdb;
645         $dbman = $DB->get_manager();
647         $table = $this->get_test_table();
648         $tablename = $table->getName();
650         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
651         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
652         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
653         $dbman->create_table($table);
654         $this->tables[$tablename] = $table;
656         $inskey1 = $DB->insert_record($tablename, array('course' => 3));
657         $inskey2 = $DB->insert_record($tablename, array('course' => 5));
658         $inskey3 = $DB->insert_record($tablename, array('course' => 4));
659         $inskey4 = $DB->insert_record($tablename, array('course' => 3));
660         $inskey5 = $DB->insert_record($tablename, array('course' => 2));
661         $inskey6 = $DB->insert_record($tablename, array('course' => 1));
662         $inskey7 = $DB->insert_record($tablename, array('course' => 0));
664         $this->assertTrue($rs = $DB->get_recordset_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
665         $counter = 0;
666         foreach ($rs as $record) {
667             $counter++;
668         }
669         $rs->close();
670         $this->assertEqual(2, $counter);
672         // limits - only need to test this case, the rest have been tested by test_get_records_sql()
673         // only limitfrom = skips that number of records
674         $rs = $DB->get_recordset_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 2, 0);
675         $records = array();
676         foreach($rs as $key => $record) {
677             $records[$key] = $record;
678         }
679         $rs->close();
680         $this->assertEqual(5, count($records));
681         $this->assertEqual($inskey3, reset($records)->id);
682         $this->assertEqual($inskey7, end($records)->id);
684         // note: fetching nulls, empties, LOBs already tested by test_insert_record() no needed here
685     }
687     public function test_get_records() {
688         $DB = $this->tdb;
689         $dbman = $DB->get_manager();
691         $table = $this->get_test_table();
692         $tablename = $table->getName();
694         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
695         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
696         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
697         $dbman->create_table($table);
698         $this->tables[$tablename] = $table;
700         $DB->insert_record($tablename, array('course' => 3));
701         $DB->insert_record($tablename, array('course' => 3));
702         $DB->insert_record($tablename, array('course' => 5));
703         $DB->insert_record($tablename, array('course' => 2));
705         // All records
706         $records = $DB->get_records($tablename);
707         $this->assertEqual(4, count($records));
708         $this->assertEqual(3, $records[1]->course);
709         $this->assertEqual(3, $records[2]->course);
710         $this->assertEqual(5, $records[3]->course);
711         $this->assertEqual(2, $records[4]->course);
713         // Records matching certain conditions
714         $records = $DB->get_records($tablename, array('course' => 3));
715         $this->assertEqual(2, count($records));
716         $this->assertEqual(3, $records[1]->course);
717         $this->assertEqual(3, $records[2]->course);
719         // All records sorted by course
720         $records = $DB->get_records($tablename, null, 'course');
721         $this->assertEqual(4, count($records));
722         $current_record = reset($records);
723         $this->assertEqual(4, $current_record->id);
724         $current_record = next($records);
725         $this->assertEqual(1, $current_record->id);
726         $current_record = next($records);
727         $this->assertEqual(2, $current_record->id);
728         $current_record = next($records);
729         $this->assertEqual(3, $current_record->id);
731         // All records, but get only one field
732         $records = $DB->get_records($tablename, null, '', 'id');
733         $this->assertTrue(empty($records[1]->course));
734         $this->assertFalse(empty($records[1]->id));
735         $this->assertEqual(4, count($records));
737         // note: delegate limits testing to test_get_records_sql()
738     }
740     public function test_get_records_list() {
741         $DB = $this->tdb;
742         $dbman = $DB->get_manager();
744         $table = $this->get_test_table();
745         $tablename = $table->getName();
747         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
748         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
749         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
750         $dbman->create_table($table);
751         $this->tables[$tablename] = $table;
753         $DB->insert_record($tablename, array('course' => 3));
754         $DB->insert_record($tablename, array('course' => 3));
755         $DB->insert_record($tablename, array('course' => 5));
756         $DB->insert_record($tablename, array('course' => 2));
758         $this->assertTrue($records = $DB->get_records_list($tablename, 'course', array(3, 2)));
759         $this->assertEqual(3, count($records));
760         $this->assertEqual(1, reset($records)->id);
761         $this->assertEqual(2, next($records)->id);
762         $this->assertEqual(4, next($records)->id);
764         $this->assertIdentical(array(), $records = $DB->get_records_list($tablename, 'course', array())); /// Must return 0 rows without conditions. MDL-17645
765         $this->assertEqual(0, count($records));
767         // note: delegate limits testing to test_get_records_sql()
768     }
770     public function test_get_record_select() {
771         $DB = $this->tdb;
772         $dbman = $DB->get_manager();
774         $table = $this->get_test_table();
775         $tablename = $table->getName();
777         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
778         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
779         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
780         $dbman->create_table($table);
781         $this->tables[$tablename] = $table;
783         $DB->insert_record($tablename, array('course' => 3));
784         $DB->insert_record($tablename, array('course' => 2));
786         $this->assertTrue($record = $DB->get_record_select($tablename, "id = ?", array(2)));
788         $this->assertEqual(2, $record->course);
790         // note: delegates limit testing to test_get_records_sql()
791     }
793     public function test_get_records_sql() {
794         global $CFG;
795         $DB = $this->tdb;
796         $dbman = $DB->get_manager();
798         $table = $this->get_test_table();
799         $tablename = $table->getName();
801         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
802         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
803         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
804         $dbman->create_table($table);
805         $this->tables[$tablename] = $table;
807         $inskey1 = $DB->insert_record($tablename, array('course' => 3));
808         $inskey2 = $DB->insert_record($tablename, array('course' => 5));
809         $inskey3 = $DB->insert_record($tablename, array('course' => 4));
810         $inskey4 = $DB->insert_record($tablename, array('course' => 3));
811         $inskey5 = $DB->insert_record($tablename, array('course' => 2));
812         $inskey6 = $DB->insert_record($tablename, array('course' => 1));
813         $inskey7 = $DB->insert_record($tablename, array('course' => 0));
815         $this->assertTrue($records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
816         $this->assertEqual(2, count($records));
817         $this->assertEqual($inskey1, reset($records)->id);
818         $this->assertEqual($inskey4, next($records)->id);
820         // Awful test, requires debug enabled and sent to browser. Let's do that and restore after test
821         $olddebug   = $CFG->debug;       // Save current debug settings
822         $olddisplay = $CFG->debugdisplay;
823         $CFG->debug = DEBUG_DEVELOPER;
824         $CFG->debugdisplay = true;
825         ob_start(); // hide debug warning
826         $records = $DB->get_records_sql("SELECT course AS id, course AS course FROM {".$tablename."}", null);
827         ob_end_clean();
828         $debuginfo = ob_get_contents();
829         $CFG->debug = $olddebug;         // Restore original debug settings
830         $CFG->debugdisplay = $olddisplay;
832         $this->assertEqual(6, count($records));
833         $this->assertFalse($debuginfo === '');
835         // negative limits = no limits
836         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, -1, -1);
837         $this->assertEqual(7, count($records));
839         // zero limits = no limits
840         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 0, 0);
841         $this->assertEqual(7, count($records));
843         // only limitfrom = skips that number of records
844         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 2, 0);
845         $this->assertEqual(5, count($records));
846         $this->assertEqual($inskey3, reset($records)->id);
847         $this->assertEqual($inskey7, end($records)->id);
849         // only limitnum = fetches that number of records
850         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 0, 3);
851         $this->assertEqual(3, count($records));
852         $this->assertEqual($inskey1, reset($records)->id);
853         $this->assertEqual($inskey3, end($records)->id);
855         // both limitfrom and limitnum = skips limitfrom records and fetches limitnum ones
856         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} ORDER BY id", null, 3, 2);
857         $this->assertEqual(2, count($records));
858         $this->assertEqual($inskey4, reset($records)->id);
859         $this->assertEqual($inskey5, end($records)->id);
861         // note: fetching nulls, empties, LOBs already tested by test_update_record() no needed here
862     }
864     public function test_get_records_menu() {
865         $DB = $this->tdb;
866         $dbman = $DB->get_manager();
868         $table = $this->get_test_table();
869         $tablename = $table->getName();
871         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
872         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
873         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
874         $dbman->create_table($table);
875         $this->tables[$tablename] = $table;
877         $DB->insert_record($tablename, array('course' => 3));
878         $DB->insert_record($tablename, array('course' => 3));
879         $DB->insert_record($tablename, array('course' => 5));
880         $DB->insert_record($tablename, array('course' => 2));
882         $this->assertTrue($records = $DB->get_records_menu($tablename, array('course' => 3)));
883         $this->assertEqual(2, count($records));
884         $this->assertFalse(empty($records[1]));
885         $this->assertFalse(empty($records[2]));
886         $this->assertEqual(3, $records[1]);
887         $this->assertEqual(3, $records[2]);
889         // note: delegate limits testing to test_get_records_sql()
890     }
892     public function test_get_records_select_menu() {
893         $DB = $this->tdb;
894         $dbman = $DB->get_manager();
896         $table = $this->get_test_table();
897         $tablename = $table->getName();
899         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
900         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
901         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
902         $dbman->create_table($table);
903         $this->tables[$tablename] = $table;
905         $DB->insert_record($tablename, array('course' => 3));
906         $DB->insert_record($tablename, array('course' => 2));
907         $DB->insert_record($tablename, array('course' => 3));
908         $DB->insert_record($tablename, array('course' => 5));
910         $this->assertTrue($records = $DB->get_records_select_menu($tablename, "course > ?", array(2)));
912         $this->assertEqual(3, count($records));
913         $this->assertFalse(empty($records[1]));
914         $this->assertTrue(empty($records[2]));
915         $this->assertFalse(empty($records[3]));
916         $this->assertFalse(empty($records[4]));
917         $this->assertEqual(3, $records[1]);
918         $this->assertEqual(3, $records[3]);
919         $this->assertEqual(5, $records[4]);
921         // note: delegate limits testing to test_get_records_sql()
922     }
924     public function test_get_records_sql_menu() {
925         $DB = $this->tdb;
926         $dbman = $DB->get_manager();
928         $table = $this->get_test_table();
929         $tablename = $table->getName();
931         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
932         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
933         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
934         $dbman->create_table($table);
935         $this->tables[$tablename] = $table;
937         $DB->insert_record($tablename, array('course' => 3));
938         $DB->insert_record($tablename, array('course' => 2));
939         $DB->insert_record($tablename, array('course' => 3));
940         $DB->insert_record($tablename, array('course' => 5));
942         $this->assertTrue($records = $DB->get_records_sql_menu("SELECT * FROM {".$tablename."} WHERE course > ?", array(2)));
944         $this->assertEqual(3, count($records));
945         $this->assertFalse(empty($records[1]));
946         $this->assertTrue(empty($records[2]));
947         $this->assertFalse(empty($records[3]));
948         $this->assertFalse(empty($records[4]));
949         $this->assertEqual(3, $records[1]);
950         $this->assertEqual(3, $records[3]);
951         $this->assertEqual(5, $records[4]);
953         // note: delegate limits testing to test_get_records_sql()
954     }
956     public function test_get_record() {
957         $DB = $this->tdb;
958         $dbman = $DB->get_manager();
960         $table = $this->get_test_table();
961         $tablename = $table->getName();
963         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
964         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
965         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
966         $dbman->create_table($table);
967         $this->tables[$tablename] = $table;
969         $DB->insert_record($tablename, array('course' => 3));
970         $DB->insert_record($tablename, array('course' => 2));
972         $this->assertTrue($record = $DB->get_record($tablename, array('id' => 2)));
974         $this->assertEqual(2, $record->course);
975     }
977     public function test_get_record_sql() {
978         $DB = $this->tdb;
979         $dbman = $DB->get_manager();
981         $table = $this->get_test_table();
982         $tablename = $table->getName();
984         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
985         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
986         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
987         $dbman->create_table($table);
988         $this->tables[$tablename] = $table;
990         $DB->insert_record($tablename, array('course' => 3));
991         $DB->insert_record($tablename, array('course' => 2));
993         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(2)));
995         $this->assertEqual(2, $record->course);
997         // backwards compatibility with $ignoremultiple
998         $this->assertFalse(IGNORE_MISSING);
999         $this->assertTrue(IGNORE_MULTIPLE);
1001         // record not found
1002         $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), IGNORE_MISSING));
1003         $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), IGNORE_MULTIPLE));
1004         try {
1005             $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), MUST_EXIST);
1006             $this->fail("Exception expected");
1007         } catch (dml_missing_record_exception $e) {
1008             $this->assertTrue(true);
1009         }
1011         // multiple matches
1012         ob_start(); // hide debug warning
1013         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), IGNORE_MISSING));
1014         ob_end_clean();
1015         $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), IGNORE_MULTIPLE));
1016         try {
1017             $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), MUST_EXIST);
1018             $this->fail("Exception expected");
1019         } catch (dml_multiple_records_exception $e) {
1020             $this->assertTrue(true);
1021         }
1022     }
1024     public function test_get_field() {
1025         $DB = $this->tdb;
1026         $dbman = $DB->get_manager();
1028         $table = $this->get_test_table();
1029         $tablename = $table->getName();
1031         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1032         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1033         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1034         $dbman->create_table($table);
1035         $this->tables[$tablename] = $table;
1037         $DB->insert_record($tablename, array('course' => 3));
1039         $this->assertTrue($course = $DB->get_field($tablename, 'course', array('id' => 1)));
1040         $this->assertEqual(3, $course);
1042         // Add one get_field() example where the field being get is also one condition
1043         // to check we haven't problem with any type of param (specially NAMED ones)
1044         $DB->get_field($tablename, 'course', array('course' => 3));
1045         $this->assertEqual(3, $DB->get_field($tablename, 'course', array('course' => 3)));
1046     }
1048     public function test_get_field_select() {
1049         $DB = $this->tdb;
1050         $dbman = $DB->get_manager();
1052         $table = $this->get_test_table();
1053         $tablename = $table->getName();
1055         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1056         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1057         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1058         $dbman->create_table($table);
1059         $this->tables[$tablename] = $table;
1061         $DB->insert_record($tablename, array('course' => 3));
1063         $this->assertTrue($course = $DB->get_field_select($tablename, 'course', "id = ?", array(1)));
1064         $this->assertEqual(3, $course);
1066     }
1068     public function test_get_field_sql() {
1069         $DB = $this->tdb;
1070         $dbman = $DB->get_manager();
1072         $table = $this->get_test_table();
1073         $tablename = $table->getName();
1075         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1076         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1077         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1078         $dbman->create_table($table);
1079         $this->tables[$tablename] = $table;
1081         $DB->insert_record($tablename, array('course' => 3));
1083         $this->assertTrue($course = $DB->get_field_sql("SELECT course FROM {".$tablename."} WHERE id = ?", array(1)));
1084         $this->assertEqual(3, $course);
1086     }
1088     public function test_get_fieldset_select() {
1089         $DB = $this->tdb;
1090         $dbman = $DB->get_manager();
1092         $table = $this->get_test_table();
1093         $tablename = $table->getName();
1095         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1096         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1097         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1098         $dbman->create_table($table);
1099         $this->tables[$tablename] = $table;
1101         $DB->insert_record($tablename, array('course' => 1));
1102         $DB->insert_record($tablename, array('course' => 3));
1103         $DB->insert_record($tablename, array('course' => 2));
1104         $DB->insert_record($tablename, array('course' => 6));
1106         $this->assertTrue($fieldset = $DB->get_fieldset_select($tablename, 'course', "course > ?", array(1)));
1108         $this->assertEqual(3, count($fieldset));
1109         $this->assertEqual(3, $fieldset[0]);
1110         $this->assertEqual(2, $fieldset[1]);
1111         $this->assertEqual(6, $fieldset[2]);
1113     }
1115     public function test_get_fieldset_sql() {
1116         $DB = $this->tdb;
1117         $dbman = $DB->get_manager();
1119         $table = $this->get_test_table();
1120         $tablename = $table->getName();
1122         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1123         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1124         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1125         $dbman->create_table($table);
1126         $this->tables[$tablename] = $table;
1128         $DB->insert_record($tablename, array('course' => 1));
1129         $DB->insert_record($tablename, array('course' => 3));
1130         $DB->insert_record($tablename, array('course' => 2));
1131         $DB->insert_record($tablename, array('course' => 6));
1133         $this->assertTrue($fieldset = $DB->get_fieldset_sql("SELECT * FROM {".$tablename."} WHERE course > ?", array(1)));
1135         $this->assertEqual(3, count($fieldset));
1136         $this->assertEqual(2, $fieldset[0]);
1137         $this->assertEqual(3, $fieldset[1]);
1138         $this->assertEqual(4, $fieldset[2]);
1139     }
1141     public function test_insert_record_raw() {
1142         $DB = $this->tdb;
1143         $dbman = $DB->get_manager();
1145         $table = $this->get_test_table();
1146         $tablename = $table->getName();
1148         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1149         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1150         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1151         $dbman->create_table($table);
1152         $this->tables[$tablename] = $table;
1154         $this->assertTrue($DB->insert_record_raw($tablename, array('course' => 1)));
1155         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 1)));
1156         $this->assertEqual(1, $record->course);
1157     }
1159     public function test_insert_record() {
1161         // All the information in this test is fetched from DB by get_recordset() so we
1162         // have such method properly tested against nulls, empties and friends...
1164         global $CFG;
1166         $DB = $this->tdb;
1167         $dbman = $DB->get_manager();
1169         $table = $this->get_test_table();
1170         $tablename = $table->getName();
1172         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1173         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1174         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, 100);
1175         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null, 200);
1176         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null, 'onestring');
1177         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1178         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1179         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1180         $dbman->create_table($table);
1181         $this->tables[$tablename] = $table;
1183         $this->assertTrue($DB->insert_record($tablename, array('course' => 1), false)); // Without returning id
1184         $rs = $DB->get_recordset($tablename, array('course' => 1));
1185         $record = $rs->current();
1186         $rs->close();
1187         $this->assertEqual(1, $record->id);
1188         $this->assertEqual(100, $record->oneint); // Just check column defaults have been applied
1189         $this->assertEqual(200, $record->onenum);
1190         $this->assertEqual('onestring', $record->onechar);
1191         $this->assertNull($record->onetext);
1192         $this->assertNull($record->onebinary);
1194         // Check nulls are set properly for all types
1195         $record->oneint = null;
1196         $record->onenum = null;
1197         $record->onechar = null;
1198         $record->onetext = null;
1199         $record->onebinary = null;
1200         $recid = $DB->insert_record($tablename, $record);
1201         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1202         $record = $rs->current();
1203         $rs->close();
1204         $this->assertNull($record->oneint);
1205         $this->assertNull($record->onenum);
1206         $this->assertNull($record->onechar);
1207         $this->assertNull($record->onetext);
1208         $this->assertNull($record->onebinary);
1210         // Check zeros are set properly for all types
1211         $record->oneint = 0;
1212         $record->onenum = 0;
1213         $recid = $DB->insert_record($tablename, $record);
1214         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1215         $record = $rs->current();
1216         $rs->close();
1217         $this->assertEqual(0, $record->oneint);
1218         $this->assertEqual(0, $record->onenum);
1220         // Check booleans are set properly for all types
1221         $record->oneint = true; // trues
1222         $record->onenum = true;
1223         $record->onechar = true;
1224         $record->onetext = true;
1225         $recid = $DB->insert_record($tablename, $record);
1226         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1227         $record = $rs->current();
1228         $rs->close();
1229         $this->assertEqual(1, $record->oneint);
1230         $this->assertEqual(1, $record->onenum);
1231         $this->assertEqual(1, $record->onechar);
1232         $this->assertEqual(1, $record->onetext);
1234         $record->oneint = false; // falses
1235         $record->onenum = false;
1236         $record->onechar = false;
1237         $record->onetext = false;
1238         $recid = $DB->insert_record($tablename, $record);
1239         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1240         $record = $rs->current();
1241         $rs->close();
1242         $this->assertEqual(0, $record->oneint);
1243         $this->assertEqual(0, $record->onenum);
1244         $this->assertEqual(0, $record->onechar);
1245         $this->assertEqual(0, $record->onetext);
1247         // Check string data causes exception in numeric types
1248         $record->oneint = 'onestring';
1249         $record->onenum = 0;
1250         try {
1251             $DB->insert_record($tablename, $record);
1252             $this->fail("Expecting an exception, none occurred");
1253         } catch (exception $e) {
1254             $this->assertTrue($e instanceof dml_exception);
1255         }
1256         $record->oneint = 0;
1257         $record->onenum = 'onestring';
1258         try {
1259            $DB->insert_record($tablename, $record);
1260            $this->fail("Expecting an exception, none occurred");
1261         } catch (exception $e) {
1262             $this->assertTrue($e instanceof dml_exception);
1263         }
1265         // Check empty string data is stored as 0 in numeric datatypes
1266         $record->oneint = ''; // empty string
1267         $record->onenum = 0;
1268         $recid = $DB->insert_record($tablename, $record);
1269         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1270         $record = $rs->current();
1271         $rs->close();
1272         $this->assertTrue(is_numeric($record->oneint) && $record->oneint == 0);
1274         $record->oneint = 0;
1275         $record->onenum = ''; // empty string
1276         $recid = $DB->insert_record($tablename, $record);
1277         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1278         $record = $rs->current();
1279         $rs->close();
1280         $this->assertTrue(is_numeric($record->onenum) && $record->onenum == 0);
1282         // Check empty strings are set properly in string types
1283         $record->oneint = 0;
1284         $record->onenum = 0;
1285         $record->onechar = '';
1286         $record->onetext = '';
1287         $recid = $DB->insert_record($tablename, $record);
1288         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1289         $record = $rs->current();
1290         $rs->close();
1291         $this->assertTrue($record->onechar === '');
1292         $this->assertTrue($record->onetext === '');
1294         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1295         $record->oneint = ((210.10 + 39.92) - 150.02);
1296         $record->onenum = ((210.10 + 39.92) - 150.02);
1297         $recid = $DB->insert_record($tablename, $record);
1298         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1299         $record = $rs->current();
1300         $rs->close();
1301         $this->assertEqual(100, $record->oneint);
1302         $this->assertEqual(100, $record->onenum);
1304         // Check various quotes/backslashes combinations in string types
1305         $teststrings = array(
1306             'backslashes and quotes alone (even): "" \'\' \\\\',
1307             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1308             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1309             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1310         foreach ($teststrings as $teststring) {
1311             $record->onechar = $teststring;
1312             $record->onetext = $teststring;
1313             $recid = $DB->insert_record($tablename, $record);
1314             $rs = $DB->get_recordset($tablename, array('id' => $recid));
1315             $record = $rs->current();
1316             $rs->close();
1317             $this->assertEqual($teststring, $record->onechar);
1318             $this->assertEqual($teststring, $record->onetext);
1319         }
1321         // Check LOBs in text/binary columns
1322         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1323         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1324         $record->onetext = $clob;
1325         $record->onebinary = $blob;
1326         $recid = $DB->insert_record($tablename, $record);
1327         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1328         $record = $rs->current();
1329         $rs->close();
1330         $this->assertEqual($clob, $record->onetext, 'Test CLOB insert (full contents output disabled)');
1331         $this->assertEqual($blob, $record->onebinary, 'Test BLOB insert (full contents output disabled)');
1333         // And "small" LOBs too, just in case
1334         $newclob = substr($clob, 0, 500);
1335         $newblob = substr($blob, 0, 250);
1336         $record->onetext = $newclob;
1337         $record->onebinary = $newblob;
1338         $recid = $DB->insert_record($tablename, $record);
1339         $rs = $DB->get_recordset($tablename, array('id' => $recid));
1340         $record = $rs->current();
1341         $rs->close();
1342         $this->assertEqual($newclob, $record->onetext, 'Test "small" CLOB insert (full contents output disabled)');
1343         $this->assertEqual($newblob, $record->onebinary, 'Test "small" BLOB insert (full contents output disabled)');
1344         $this->assertEqual(false, $rs->key()); // Ensure recordset key() method to be working ok after closing
1345     }
1347     public function test_import_record() {
1348         $DB = $this->tdb;
1349         $dbman = $DB->get_manager();
1351         $table = $this->get_test_table();
1352         $tablename = $table->getName();
1354         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1355         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1356         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1357         $dbman->create_table($table);
1358         $this->tables[$tablename] = $table;
1360         $record = (object)array('id'=>666, 'course'=>10);
1361         $this->assertTrue($DB->import_record($tablename, $record));
1362         $records = $DB->get_records($tablename);
1363         $this->assertEqual(1, count($records));
1364         $this->assertEqual(10, $records[666]->course);
1366         $record = (object)array('id'=>13, 'course'=>2);
1367         $this->assertTrue($DB->import_record($tablename, $record));
1368         $records = $DB->get_records($tablename);
1369         $this->assertEqual(2, $records[13]->course);
1370     }
1372     public function test_update_record_raw() {
1373         $DB = $this->tdb;
1374         $dbman = $DB->get_manager();
1376         $table = $this->get_test_table();
1377         $tablename = $table->getName();
1379         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1380         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1381         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1382         $dbman->create_table($table);
1383         $this->tables[$tablename] = $table;
1385         $DB->insert_record($tablename, array('course' => 1));
1386         $record = $DB->get_record($tablename, array('course' => 1));
1387         $record->course = 2;
1388         $this->assertTrue($DB->update_record_raw($tablename, $record));
1389         $this->assertFalse($record = $DB->get_record($tablename, array('course' => 1)));
1390         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 2)));
1391     }
1393     public function test_update_record() {
1395         // All the information in this test is fetched from DB by get_record() so we
1396         // have such method properly tested against nulls, empties and friends...
1398         global $CFG;
1400         $DB = $this->tdb;
1401         $dbman = $DB->get_manager();
1403         $table = $this->get_test_table();
1404         $tablename = $table->getName();
1406         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1407         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1408         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null, 100);
1409         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null, 200);
1410         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null, 'onestring');
1411         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1412         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1413         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1414         $dbman->create_table($table);
1415         $this->tables[$tablename] = $table;
1417         $DB->insert_record($tablename, array('course' => 1));
1418         $record = $DB->get_record($tablename, array('course' => 1));
1419         $record->course = 2;
1421         $this->assertTrue($DB->update_record($tablename, $record));
1422         $this->assertFalse($record = $DB->get_record($tablename, array('course' => 1)));
1423         $this->assertTrue($record = $DB->get_record($tablename, array('course' => 2)));
1424         $this->assertEqual(100, $record->oneint); // Just check column defaults have been applied
1425         $this->assertEqual(200, $record->onenum);
1426         $this->assertEqual('onestring', $record->onechar);
1427         $this->assertNull($record->onetext);
1428         $this->assertNull($record->onebinary);
1430         // Check nulls are set properly for all types
1431         $record->oneint = null;
1432         $record->onenum = null;
1433         $record->onechar = null;
1434         $record->onetext = null;
1435         $record->onebinary = null;
1436         $DB->update_record($tablename, $record);
1437         $record = $DB->get_record($tablename, array('course' => 2));
1438         $this->assertNull($record->oneint);
1439         $this->assertNull($record->onenum);
1440         $this->assertNull($record->onechar);
1441         $this->assertNull($record->onetext);
1442         $this->assertNull($record->onebinary);
1444         // Check zeros are set properly for all types
1445         $record->oneint = 0;
1446         $record->onenum = 0;
1447         $DB->update_record($tablename, $record);
1448         $record = $DB->get_record($tablename, array('course' => 2));
1449         $this->assertEqual(0, $record->oneint);
1450         $this->assertEqual(0, $record->onenum);
1452         // Check booleans are set properly for all types
1453         $record->oneint = true; // trues
1454         $record->onenum = true;
1455         $record->onechar = true;
1456         $record->onetext = true;
1457         $DB->update_record($tablename, $record);
1458         $record = $DB->get_record($tablename, array('course' => 2));
1459         $this->assertEqual(1, $record->oneint);
1460         $this->assertEqual(1, $record->onenum);
1461         $this->assertEqual(1, $record->onechar);
1462         $this->assertEqual(1, $record->onetext);
1464         $record->oneint = false; // falses
1465         $record->onenum = false;
1466         $record->onechar = false;
1467         $record->onetext = false;
1468         $DB->update_record($tablename, $record);
1469         $record = $DB->get_record($tablename, array('course' => 2));
1470         $this->assertEqual(0, $record->oneint);
1471         $this->assertEqual(0, $record->onenum);
1472         $this->assertEqual(0, $record->onechar);
1473         $this->assertEqual(0, $record->onetext);
1475         // Check string data causes exception in numeric types
1476         $record->oneint = 'onestring';
1477         $record->onenum = 0;
1478         try {
1479             $DB->update_record($tablename, $record);
1480             $this->fail("Expecting an exception, none occurred");
1481         } catch (exception $e) {
1482             $this->assertTrue($e instanceof dml_exception);
1483         }
1484         $record->oneint = 0;
1485         $record->onenum = 'onestring';
1486         try {
1487             $DB->update_record($tablename, $record);
1488             $this->fail("Expecting an exception, none occurred");
1489         } catch (exception $e) {
1490             $this->assertTrue($e instanceof dml_exception);
1491         }
1493         // Check empty string data is stored as 0 in numeric datatypes
1494         $record->oneint = ''; // empty string
1495         $record->onenum = 0;
1496         $DB->update_record($tablename, $record);
1497         $record = $DB->get_record($tablename, array('course' => 2));
1498         $this->assertTrue(is_numeric($record->oneint) && $record->oneint == 0);
1500         $record->oneint = 0;
1501         $record->onenum = ''; // empty string
1502         $DB->update_record($tablename, $record);
1503         $record = $DB->get_record($tablename, array('course' => 2));
1504         $this->assertTrue(is_numeric($record->onenum) && $record->onenum == 0);
1506         // Check empty strings are set properly in string types
1507         $record->oneint = 0;
1508         $record->onenum = 0;
1509         $record->onechar = '';
1510         $record->onetext = '';
1511         $DB->update_record($tablename, $record);
1512         $record = $DB->get_record($tablename, array('course' => 2));
1513         $this->assertTrue($record->onechar === '');
1514         $this->assertTrue($record->onetext === '');
1516         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1517         $record->oneint = ((210.10 + 39.92) - 150.02);
1518         $record->onenum = ((210.10 + 39.92) - 150.02);
1519         $DB->update_record($tablename, $record);
1520         $record = $DB->get_record($tablename, array('course' => 2));
1521         $this->assertEqual(100, $record->oneint);
1522         $this->assertEqual(100, $record->onenum);
1524         // Check various quotes/backslashes combinations in string types
1525         $teststrings = array(
1526             'backslashes and quotes alone (even): "" \'\' \\\\',
1527             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1528             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1529             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1530         foreach ($teststrings as $teststring) {
1531             $record->onechar = $teststring;
1532             $record->onetext = $teststring;
1533             $DB->update_record($tablename, $record);
1534             $record = $DB->get_record($tablename, array('course' => 2));
1535             $this->assertEqual($teststring, $record->onechar);
1536             $this->assertEqual($teststring, $record->onetext);
1537         }
1539         // Check LOBs in text/binary columns
1540         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1541         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1542         $record->onetext = $clob;
1543         $record->onebinary = $blob;
1544         $DB->update_record($tablename, $record);
1545         $record = $DB->get_record($tablename, array('course' => 2));
1546         $this->assertEqual($clob, $record->onetext, 'Test CLOB update (full contents output disabled)');
1547         $this->assertEqual($blob, $record->onebinary, 'Test BLOB update (full contents output disabled)');
1549         // And "small" LOBs too, just in case
1550         $newclob = substr($clob, 0, 500);
1551         $newblob = substr($blob, 0, 250);
1552         $record->onetext = $newclob;
1553         $record->onebinary = $newblob;
1554         $DB->update_record($tablename, $record);
1555         $record = $DB->get_record($tablename, array('course' => 2));
1556         $this->assertEqual($newclob, $record->onetext, 'Test "small" CLOB update (full contents output disabled)');
1557         $this->assertEqual($newblob, $record->onebinary, 'Test "small" BLOB update (full contents output disabled)');
1558     }
1560     public function test_set_field() {
1561         $DB = $this->tdb;
1562         $dbman = $DB->get_manager();
1564         $table = $this->get_test_table();
1565         $tablename = $table->getName();
1567         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1568         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1569         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1570         $dbman->create_table($table);
1571         $this->tables[$tablename] = $table;
1573         $DB->insert_record($tablename, array('course' => 1));
1575         $this->assertTrue($DB->set_field($tablename, 'course', 2, array('id' => 1)));
1576         $this->assertEqual(2, $DB->get_field($tablename, 'course', array('id' => 1)));
1578         // Add one set_field() example where the field being set is also one condition
1579         // to check we haven't problem with any type of param (specially NAMED ones)
1580         $DB->set_field($tablename, 'course', '1', array('course' => 2));
1581         $this->assertEqual(1, $DB->get_field($tablename, 'course', array('id' => 1)));
1583         // Note: All the nulls, booleans, empties, quoted and backslashes tests
1584         // go to set_field_select() because set_field() is just one wrapper over it
1585     }
1587     public function test_set_field_select() {
1589         // All the information in this test is fetched from DB by get_field() so we
1590         // have such method properly tested against nulls, empties and friends...
1592         global $CFG;
1594         $DB = $this->tdb;
1595         $dbman = $DB->get_manager();
1597         $table = $this->get_test_table();
1598         $tablename = $table->getName();
1600         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1601         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1602         $table->add_field('oneint', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, null, null);
1603         $table->add_field('onenum', XMLDB_TYPE_NUMBER, '10,2', null, null, null);
1604         $table->add_field('onechar', XMLDB_TYPE_CHAR, '100', null, null, null);
1605         $table->add_field('onetext', XMLDB_TYPE_TEXT, 'big', null, null, null);
1606         $table->add_field('onebinary', XMLDB_TYPE_BINARY, 'big', null, null, null);
1607         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1608         $dbman->create_table($table);
1609         $this->tables[$tablename] = $table;
1611         $DB->insert_record($tablename, array('course' => 1));
1613         $this->assertTrue($DB->set_field_select($tablename, 'course', 2, 'id = ?', array(1)));
1614         $this->assertEqual(2, $DB->get_field($tablename, 'course', array('id' => 1)));
1616         // Check nulls are set properly for all types
1617         $DB->set_field_select($tablename, 'oneint', null, 'id = ?', array(1)); // trues
1618         $DB->set_field_select($tablename, 'onenum', null, 'id = ?', array(1));
1619         $DB->set_field_select($tablename, 'onechar', null, 'id = ?', array(1));
1620         $DB->set_field_select($tablename, 'onetext', null, 'id = ?', array(1));
1621         $DB->set_field_select($tablename, 'onebinary', null, 'id = ?', array(1));
1622         $this->assertNull($DB->get_field($tablename, 'oneint', array('id' => 1)));
1623         $this->assertNull($DB->get_field($tablename, 'onenum', array('id' => 1)));
1624         $this->assertNull($DB->get_field($tablename, 'onechar', array('id' => 1)));
1625         $this->assertNull($DB->get_field($tablename, 'onetext', array('id' => 1)));
1626         $this->assertNull($DB->get_field($tablename, 'onebinary', array('id' => 1)));
1628         // Check zeros are set properly for all types
1629         $DB->set_field_select($tablename, 'oneint', 0, 'id = ?', array(1));
1630         $DB->set_field_select($tablename, 'onenum', 0, 'id = ?', array(1));
1631         $this->assertEqual(0, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1632         $this->assertEqual(0, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1634         // Check booleans are set properly for all types
1635         $DB->set_field_select($tablename, 'oneint', true, 'id = ?', array(1)); // trues
1636         $DB->set_field_select($tablename, 'onenum', true, 'id = ?', array(1));
1637         $DB->set_field_select($tablename, 'onechar', true, 'id = ?', array(1));
1638         $DB->set_field_select($tablename, 'onetext', true, 'id = ?', array(1));
1639         $this->assertEqual(1, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1640         $this->assertEqual(1, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1641         $this->assertEqual(1, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1642         $this->assertEqual(1, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1644         $DB->set_field_select($tablename, 'oneint', false, 'id = ?', array(1)); // falses
1645         $DB->set_field_select($tablename, 'onenum', false, 'id = ?', array(1));
1646         $DB->set_field_select($tablename, 'onechar', false, 'id = ?', array(1));
1647         $DB->set_field_select($tablename, 'onetext', false, 'id = ?', array(1));
1648         $this->assertEqual(0, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1649         $this->assertEqual(0, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1650         $this->assertEqual(0, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1651         $this->assertEqual(0, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1653         // Check string data causes exception in numeric types
1654         try {
1655             $DB->set_field_select($tablename, 'oneint', 'onestring', 'id = ?', array(1));
1656             $this->fail("Expecting an exception, none occurred");
1657         } catch (exception $e) {
1658             $this->assertTrue($e instanceof dml_exception);
1659         }
1660         try {
1661             $DB->set_field_select($tablename, 'onenum', 'onestring', 'id = ?', array(1));
1662             $this->fail("Expecting an exception, none occurred");
1663         } catch (exception $e) {
1664             $this->assertTrue($e instanceof dml_exception);
1665         }
1667         // Check empty string data is stored as 0 in numeric datatypes
1668         $DB->set_field_select($tablename, 'oneint', '', 'id = ?', array(1));
1669         $field = $DB->get_field($tablename, 'oneint', array('id' => 1));
1670         $this->assertTrue(is_numeric($field) && $field == 0);
1672         $DB->set_field_select($tablename, 'onenum', '', 'id = ?', array(1));
1673         $field = $DB->get_field($tablename, 'onenum', array('id' => 1));
1674         $this->assertTrue(is_numeric($field) && $field == 0);
1676         // Check empty strings are set properly in string types
1677         $DB->set_field_select($tablename, 'onechar', '', 'id = ?', array(1));
1678         $DB->set_field_select($tablename, 'onetext', '', 'id = ?', array(1));
1679         $this->assertTrue($DB->get_field($tablename, 'onechar', array('id' => 1)) === '');
1680         $this->assertTrue($DB->get_field($tablename, 'onetext', array('id' => 1)) === '');
1682         // Check operation ((210.10 + 39.92) - 150.02) against numeric types
1683         $DB->set_field_select($tablename, 'oneint', ((210.10 + 39.92) - 150.02), 'id = ?', array(1));
1684         $DB->set_field_select($tablename, 'onenum', ((210.10 + 39.92) - 150.02), 'id = ?', array(1));
1685         $this->assertEqual(100, $DB->get_field($tablename, 'oneint', array('id' => 1)));
1686         $this->assertEqual(100, $DB->get_field($tablename, 'onenum', array('id' => 1)));
1688         // Check various quotes/backslashes combinations in string types
1689         $teststrings = array(
1690             'backslashes and quotes alone (even): "" \'\' \\\\',
1691             'backslashes and quotes alone (odd): """ \'\'\' \\\\\\',
1692             'backslashes and quotes sequences (even): \\"\\" \\\'\\\'',
1693             'backslashes and quotes sequences (odd): \\"\\"\\" \\\'\\\'\\\'');
1694         foreach ($teststrings as $teststring) {
1695             $DB->set_field_select($tablename, 'onechar', $teststring, 'id = ?', array(1));
1696             $DB->set_field_select($tablename, 'onetext', $teststring, 'id = ?', array(1));
1697             $this->assertEqual($teststring, $DB->get_field($tablename, 'onechar', array('id' => 1)));
1698             $this->assertEqual($teststring, $DB->get_field($tablename, 'onetext', array('id' => 1)));
1699         }
1701         // Check LOBs in text/binary columns
1702         $clob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/clob.txt');
1703         $blob = file_get_contents($CFG->libdir.'/dml/simpletest/fixtures/randombinary');
1704         $DB->set_field_select($tablename, 'onetext', $clob, 'id = ?', array(1));
1705         $DB->set_field_select($tablename, 'onebinary', $blob, 'id = ?', array(1));
1706         $this->assertEqual($clob, $DB->get_field($tablename, 'onetext', array('id' => 1)), 'Test CLOB set_field (full contents output disabled)');
1707         $this->assertEqual($blob, $DB->get_field($tablename, 'onebinary', array('id' => 1)), 'Test BLOB set_field (full contents output disabled)');
1709         // And "small" LOBs too, just in case
1710         $newclob = substr($clob, 0, 500);
1711         $newblob = substr($blob, 0, 250);
1712         $DB->set_field_select($tablename, 'onetext', $newclob, 'id = ?', array(1));
1713         $DB->set_field_select($tablename, 'onebinary', $newblob, 'id = ?', array(1));
1714         $this->assertEqual($newclob, $DB->get_field($tablename, 'onetext', array('id' => 1)), 'Test "small" CLOB set_field (full contents output disabled)');
1715         $this->assertEqual($newblob, $DB->get_field($tablename, 'onebinary', array('id' => 1)), 'Test "small" BLOB set_field (full contents output disabled)');
1716     }
1718     public function test_count_records() {
1719         $DB = $this->tdb;
1721         $dbman = $DB->get_manager();
1723         $table = $this->get_test_table();
1724         $tablename = $table->getName();
1726         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1727         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1728         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1729         $dbman->create_table($table);
1730         $this->tables[$tablename] = $table;
1732         $this->assertEqual(0, $DB->count_records($tablename));
1734         $DB->insert_record($tablename, array('course' => 3));
1735         $DB->insert_record($tablename, array('course' => 4));
1736         $DB->insert_record($tablename, array('course' => 5));
1738         $this->assertEqual(3, $DB->count_records($tablename));
1739     }
1741     public function test_count_records_select() {
1742         $DB = $this->tdb;
1744         $dbman = $DB->get_manager();
1746         $table = $this->get_test_table();
1747         $tablename = $table->getName();
1749         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1750         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1751         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1752         $dbman->create_table($table);
1753         $this->tables[$tablename] = $table;
1755         $this->assertEqual(0, $DB->count_records($tablename));
1757         $DB->insert_record($tablename, array('course' => 3));
1758         $DB->insert_record($tablename, array('course' => 4));
1759         $DB->insert_record($tablename, array('course' => 5));
1761         $this->assertEqual(2, $DB->count_records_select($tablename, 'course > ?', array(3)));
1762     }
1764     public function test_count_records_sql() {
1765         $DB = $this->tdb;
1766         $dbman = $DB->get_manager();
1768         $table = $this->get_test_table();
1769         $tablename = $table->getName();
1771         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1772         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1773         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1774         $dbman->create_table($table);
1775         $this->tables[$tablename] = $table;
1777         $this->assertEqual(0, $DB->count_records($tablename));
1779         $DB->insert_record($tablename, array('course' => 3));
1780         $DB->insert_record($tablename, array('course' => 4));
1781         $DB->insert_record($tablename, array('course' => 5));
1783         $this->assertEqual(2, $DB->count_records_sql("SELECT COUNT(*) FROM {".$tablename."} WHERE course > ?", array(3)));
1784     }
1786     public function test_record_exists() {
1787         $DB = $this->tdb;
1788         $dbman = $DB->get_manager();
1790         $table = $this->get_test_table();
1791         $tablename = $table->getName();
1793         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1794         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1795         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1796         $dbman->create_table($table);
1797         $this->tables[$tablename] = $table;
1799         $this->assertEqual(0, $DB->count_records($tablename));
1801         $this->assertFalse($DB->record_exists($tablename, array('course' => 3)));
1802         $DB->insert_record($tablename, array('course' => 3));
1804         $this->assertTrue($DB->record_exists($tablename, array('course' => 3)));
1806     }
1808     public function test_record_exists_select() {
1809         $DB = $this->tdb;
1810         $dbman = $DB->get_manager();
1812         $table = $this->get_test_table();
1813         $tablename = $table->getName();
1815         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1816         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1817         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1818         $dbman->create_table($table);
1819         $this->tables[$tablename] = $table;
1821         $this->assertEqual(0, $DB->count_records($tablename));
1823         $this->assertFalse($DB->record_exists_select($tablename, "course = ?", array(3)));
1824         $DB->insert_record($tablename, array('course' => 3));
1826         $this->assertTrue($DB->record_exists_select($tablename, "course = ?", array(3)));
1827     }
1829     public function test_record_exists_sql() {
1830         $DB = $this->tdb;
1831         $dbman = $DB->get_manager();
1833         $table = $this->get_test_table();
1834         $tablename = $table->getName();
1836         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1837         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1838         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1839         $dbman->create_table($table);
1840         $this->tables[$tablename] = $table;
1842         $this->assertEqual(0, $DB->count_records($tablename));
1844         $this->assertFalse($DB->record_exists_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
1845         $DB->insert_record($tablename, array('course' => 3));
1847         $this->assertTrue($DB->record_exists_sql("SELECT * FROM {".$tablename."} WHERE course = ?", array(3)));
1848     }
1850     public function test_delete_records() {
1851         $DB = $this->tdb;
1852         $dbman = $DB->get_manager();
1854         $table = $this->get_test_table();
1855         $tablename = $table->getName();
1857         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1858         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1859         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1860         $dbman->create_table($table);
1861         $this->tables[$tablename] = $table;
1863         $DB->insert_record($tablename, array('course' => 3));
1864         $DB->insert_record($tablename, array('course' => 2));
1865         $DB->insert_record($tablename, array('course' => 2));
1867         // Delete all records
1868         $this->assertTrue($DB->delete_records($tablename));
1869         $this->assertEqual(0, $DB->count_records($tablename));
1871         // Delete subset of records
1872         $DB->insert_record($tablename, array('course' => 3));
1873         $DB->insert_record($tablename, array('course' => 2));
1874         $DB->insert_record($tablename, array('course' => 2));
1876         $this->assertTrue($DB->delete_records($tablename, array('course' => 2)));
1877         $this->assertEqual(1, $DB->count_records($tablename));
1878     }
1880     public function test_delete_records_select() {
1881         $DB = $this->tdb;
1882         $dbman = $DB->get_manager();
1884         $table = $this->get_test_table();
1885         $tablename = $table->getName();
1887         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1888         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1889         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1890         $dbman->create_table($table);
1891         $this->tables[$tablename] = $table;
1893         $DB->insert_record($tablename, array('course' => 3));
1894         $DB->insert_record($tablename, array('course' => 2));
1895         $DB->insert_record($tablename, array('course' => 2));
1897         $this->assertTrue($DB->delete_records_select($tablename, 'course = ?', array(2)));
1898         $this->assertEqual(1, $DB->count_records($tablename));
1899     }
1901     public function test_delete_records_list() {
1902         $DB = $this->tdb;
1903         $dbman = $DB->get_manager();
1905         $table = $this->get_test_table();
1906         $tablename = $table->getName();
1908         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1909         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1910         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1911         $dbman->create_table($table);
1912         $this->tables[$tablename] = $table;
1914         $DB->insert_record($tablename, array('course' => 1));
1915         $DB->insert_record($tablename, array('course' => 2));
1916         $DB->insert_record($tablename, array('course' => 3));
1918         $this->assertTrue($DB->delete_records_list($tablename, 'course', array(2, 3)));
1919         $this->assertEqual(1, $DB->count_records($tablename));
1921         $this->assertTrue($DB->delete_records_list($tablename, 'course', array())); /// Must delete 0 rows without conditions. MDL-17645
1922         $this->assertEqual(1, $DB->count_records($tablename));
1923     }
1925     function test_sql_null_from_clause() {
1926         $DB = $this->tdb;
1927         $sql = "SELECT 1 AS id ".$DB->sql_null_from_clause();
1928         $this->assertEqual($DB->get_field_sql($sql), 1);
1929     }
1931     function test_sql_bitand() {
1932         $DB = $this->tdb;
1933         $sql = "SELECT ".$DB->sql_bitand(10, 3)." AS res ".$DB->sql_null_from_clause();
1934         $this->assertEqual($DB->get_field_sql($sql), 2);
1935     }
1937     function test_sql_bitnot() {
1938         $DB = $this->tdb;
1940         $not = $DB->sql_bitnot(2);
1941         $notlimited = $DB->sql_bitand($not, 7); // might be positive or negative number which can not fit into PHP INT!
1943         $sql = "SELECT $notlimited AS res ".$DB->sql_null_from_clause();
1944         $this->assertEqual($DB->get_field_sql($sql), 5);
1945     }
1947     function test_sql_bitor() {
1948         $DB = $this->tdb;
1949         $sql = "SELECT ".$DB->sql_bitor(10, 3)." AS res ".$DB->sql_null_from_clause();
1950         $this->assertEqual($DB->get_field_sql($sql), 11);
1951     }
1953     function test_sql_bitxor() {
1954         $DB = $this->tdb;
1955         $sql = "SELECT ".$DB->sql_bitxor(10, 3)." AS res ".$DB->sql_null_from_clause();
1956         $this->assertEqual($DB->get_field_sql($sql), 9);
1957     }
1959     function test_sql_modulo() {
1960         $DB = $this->tdb;
1961         $sql = "SELECT ".$DB->sql_modulo(10, 7)." AS res ".$DB->sql_null_from_clause();
1962         $this->assertEqual($DB->get_field_sql($sql), 3);
1963     }
1965     function test_sql_ceil() {
1966         $DB = $this->tdb;
1967         $sql = "SELECT ".$DB->sql_ceil(665.666)." AS res ".$DB->sql_null_from_clause();
1968         $this->assertEqual($DB->get_field_sql($sql), 666);
1969     }
1971     function test_cast_char2int() {
1972         $DB = $this->tdb;
1973         $dbman = $DB->get_manager();
1975         $table1 = $this->get_test_table("testtable1");
1976         $tablename1 = $table1->getName();
1978         $table1->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1979         $table1->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
1980         $table1->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1981         $dbman->create_table($table1);
1982         $this->tables[$tablename1] = $table1;
1984         $DB->insert_record($tablename1, array('name'=>'100'));
1986         $table2 = $this->get_test_table("testtable2");
1987         $tablename2 = $table2->getName();
1988         $table2->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
1989         $table2->add_field('res', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
1990         $table2->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
1991         $dbman->create_table($table2);
1992         $this->tables[$table2->getName()] = $table2;
1994         $DB->insert_record($tablename2, array('res'=>100));
1996         try {
1997             $sql = "SELECT * FROM {".$tablename1."} t1, {".$tablename2."} t2 WHERE ".$DB->sql_cast_char2int("t1.name")." = t2.res ";
1998             $records = $DB->get_records_sql($sql);
1999             $this->assertEqual(count($records), 1);
2000         } catch (dml_exception $e) {
2001             $this->fail("No exception expected");
2002         }
2003     }
2005     function test_cast_char2real() {
2006         $DB = $this->tdb;
2007         $dbman = $DB->get_manager();
2009         $table = $this->get_test_table();
2010         $tablename = $table->getName();
2012         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2013         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2014         $table->add_field('res', XMLDB_TYPE_NUMBER, '12, 7', null, null, null, null);
2015         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2016         $dbman->create_table($table);
2017         $this->tables[$tablename] = $table;
2019         $DB->insert_record($tablename, array('name'=>'10.10', 'res'=>5.1));
2020         $DB->insert_record($tablename, array('name'=>'1.10', 'res'=>666));
2021         $DB->insert_record($tablename, array('name'=>'11.10', 'res'=>0.1));
2023         $sql = "SELECT * FROM {".$tablename."} WHERE ".$DB->sql_cast_char2real('name')." > res";
2024         $records = $DB->get_records_sql($sql);
2025         $this->assertEqual(count($records), 2);
2026     }
2028     function sql_compare_text() {
2029         $DB = $this->tdb;
2030         $dbman = $DB->get_manager();
2032         $table = $this->get_test_table();
2033         $tablename = $table->getName();
2035         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2036         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2037         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2038         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2039         $dbman->create_table($table);
2040         $this->tables[$tablename] = $table;
2042         $DB->insert_record($tablename, array('name'=>'abcd',   'description'=>'abcd'));
2043         $DB->insert_record($tablename, array('name'=>'abcdef', 'description'=>'bbcdef'));
2044         $DB->insert_record($tablename, array('name'=>'aaaabb', 'description'=>'aaaacccccccccccccccccc'));
2046         $sql = "SELECT * FROM {".$tablename."} WHERE name = ".$DB->sql_compare_text('description');
2047         $records = $DB->get_records_sql($sql);
2048         $this->assertEqual(count($records), 1);
2050         $sql = "SELECT * FROM {".$tablename."} WHERE name = ".$DB->sql_compare_text('description', 4);
2051         $records = $DB->get_records_sql($sql);
2052         $this->assertEqual(count($records), 2);
2053     }
2055     function test_ilike() {
2056         $DB = $this->tdb;
2057         $dbman = $DB->get_manager();
2059         $table = $this->get_test_table();
2060         $tablename = $table->getName();
2062         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2063         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2064         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2065         $dbman->create_table($table);
2066         $this->tables[$tablename] = $table;
2068         $DB->insert_record($tablename, array('name'=>'SuperDuperRecord'));
2069         $DB->insert_record($tablename, array('name'=>'NoDupor'));
2070         $DB->insert_record($tablename, array('name'=>'ouch'));
2072         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_ilike()." ?";
2073         $params = array("%dup_r%");
2074         $records = $DB->get_records_sql($sql, $params);
2075         $this->assertEqual(count($records), 2);
2076     }
2078     function test_sql_concat() {
2079         $DB = $this->tdb;
2080         $dbman = $DB->get_manager();
2082         /// Testing all sort of values
2083         $sql = "SELECT ".$DB->sql_concat("?", "?", "?")." AS fullname ". $DB->sql_null_from_clause();
2084         // string, some unicode chars
2085         $params = array('name', 'áéíóú', 'name3');
2086         $this->assertEqual('nameáéíóúname3', $DB->get_field_sql($sql, $params));
2087         // string, spaces and numbers
2088         $params = array('name', '  ', 12345);
2089         $this->assertEqual('name  12345', $DB->get_field_sql($sql, $params));
2090         // float, empty and strings
2091         $params = array(123.45, '', 'test');
2092         $this->assertEqual('123.45test', $DB->get_field_sql($sql, $params));
2093         // float, null and strings
2094         $params = array(123.45, null, 'test');
2095         $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
2097         /// Testing fieldnames + values
2098         $table = $this->get_test_table();
2099         $tablename = $table->getName();
2101         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2102         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2103         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2104         $dbman->create_table($table);
2105         $this->tables[$tablename] = $table;
2107         $DB->insert_record($tablename, array('description'=>'áéíóú'));
2108         $DB->insert_record($tablename, array('description'=>'dxxx'));
2109         $DB->insert_record($tablename, array('description'=>'bcde'));
2111         $sql = 'SELECT id, ' . $DB->sql_concat('description', "'harcoded'", '?', '?') . ' AS result FROM {' . $tablename . '}';
2112         $records = $DB->get_records_sql($sql, array(123.45, 'test'));
2113         $this->assertEqual(count($records), 3);
2114         $this->assertEqual($records[1]->result, 'áéíóúharcoded123.45test');
2115     }
2117     function test_concat_join() {
2118         $DB = $this->tdb;
2119         $sql = "SELECT ".$DB->sql_concat_join("' '", array("?", "?", "?"))." AS fullname ".$DB->sql_null_from_clause();
2120         $params = array("name", "name2", "name3");
2121         $result = $DB->get_field_sql($sql, $params);
2122         $this->assertEqual("name name2 name3", $result);
2123     }
2125     function test_sql_fullname() {
2126         $DB = $this->tdb;
2127         $sql = "SELECT ".$DB->sql_fullname(':first', ':last')." AS fullname ".$DB->sql_null_from_clause();
2128         $params = array('first'=>'Firstname', 'last'=>'Surname');
2129         $this->assertEqual("Firstname Surname", $DB->get_field_sql($sql, $params));
2130     }
2132     function sql_sql_order_by_text() {
2133         $DB = $this->tdb;
2134         $dbman = $DB->get_manager();
2136         $table = $this->get_test_table();
2137         $tablename = $table->getName();
2139         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2140         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2141         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2142         $dbman->create_table($table);
2143         $this->tables[$tablename] = $table;
2145         $DB->insert_record($tablename, array('description'=>'abcd'));
2146         $DB->insert_record($tablename, array('description'=>'dxxx'));
2147         $DB->insert_record($tablename, array('description'=>'bcde'));
2149         $sql = "SELECT * FROM {".$tablename."} ORDER BY ".$DB->sql_order_by_text('description');
2150         $records = $DB->get_records_sql($sql);
2151         $first = array_unshift($records);
2152         $this->assertEqual(1, $first->id);
2153         $second = array_unshift($records);
2154         $this->assertEqual(3, $second->id);
2155         $last = array_unshift($records);
2156         $this->assertEqual(2, $last->id);
2157     }
2159     function test_sql_substring() {
2160         $DB = $this->tdb;
2161         $dbman = $DB->get_manager();
2163         $table = $this->get_test_table();
2164         $tablename = $table->getName();
2166         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2167         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2168         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2169         $dbman->create_table($table);
2170         $this->tables[$tablename] = $table;
2172         $string = 'abcdefghij';
2174         $DB->insert_record($tablename, array('name'=>$string));
2176         $sql = "SELECT id, ".$DB->sql_substr("name", 5)." AS name FROM {".$tablename."}";
2177         $record = $DB->get_record_sql($sql);
2178         $this->assertEqual(substr($string, 5-1), $record->name);
2180         $sql = "SELECT id, ".$DB->sql_substr("name", 5, 2)." AS name FROM {".$tablename."}";
2181         $record = $DB->get_record_sql($sql);
2182         $this->assertEqual(substr($string, 5-1, 2), $record->name);
2184         try {
2185             // silence php warning ;-)
2186             @$DB->sql_substr("name");
2187             $this->fail("Expecting an exception, none occurred");
2188         } catch (Exception $e) {
2189             $this->assertTrue($e instanceof coding_exception);
2190         }
2191     }
2193     function test_sql_length() {
2194         $DB = $this->tdb;
2195         $this->assertEqual($DB->get_field_sql(
2196                 "SELECT ".$DB->sql_length("'aeiou'").$DB->sql_null_from_clause()), 5);
2197         $this->assertEqual($DB->get_field_sql(
2198                 "SELECT ".$DB->sql_length("'áéíóú'").$DB->sql_null_from_clause()), 5);
2199     }
2201     function test_sql_position() {
2202         $DB = $this->tdb;
2203         $this->assertEqual($DB->get_field_sql(
2204                 "SELECT ".$DB->sql_position("'ood'", "'Moodle'").$DB->sql_null_from_clause()), 2);
2205         $this->assertEqual($DB->get_field_sql(
2206                 "SELECT ".$DB->sql_position("'Oracle'", "'Moodle'").$DB->sql_null_from_clause()), 0);
2207     }
2209     function test_sql_empty() {
2210         $DB = $this->tdb;
2211         $dbman = $DB->get_manager();
2213         $table = $this->get_test_table();
2214         $tablename = $table->getName();
2216         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2217         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2218         $table->add_field('namenotnull', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, 'default value');
2219         $table->add_field('namenotnullnodeflt', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
2220         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2221         $dbman->create_table($table);
2222         $this->tables[$tablename] = $table;
2224         $DB->insert_record($tablename, array('name'=>'', 'namenotnull'=>''));
2225         $DB->insert_record($tablename, array('name'=>null));
2226         $DB->insert_record($tablename, array('name'=>'lalala'));
2227         $DB->insert_record($tablename, array('name'=>0));
2229         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE name = '".$DB->sql_empty()."'");
2230         $this->assertEqual(count($records), 1);
2231         $record = reset($records);
2232         $this->assertEqual($record->name, '');
2234         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE namenotnull = '".$DB->sql_empty()."'");
2235         $this->assertEqual(count($records), 1);
2236         $record = reset($records);
2237         $this->assertEqual($record->namenotnull, '');
2239         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE namenotnullnodeflt = '".$DB->sql_empty()."'");
2240         $this->assertEqual(count($records), 4);
2241         $record = reset($records);
2242         $this->assertEqual($record->namenotnullnodeflt, '');
2243     }
2245     function test_sql_isempty() {
2246         $DB = $this->tdb;
2247         $dbman = $DB->get_manager();
2249         $table = $this->get_test_table();
2250         $tablename = $table->getName();
2252         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2253         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
2254         $table->add_field('namenull', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2255         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, XMLDB_NOTNULL, null, null);
2256         $table->add_field('descriptionnull', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2257         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2258         $dbman->create_table($table);
2259         $this->tables[$tablename] = $table;
2261         $DB->insert_record($tablename, array('name'=>'',   'namenull'=>'',   'description'=>'',   'descriptionnull'=>''));
2262         $DB->insert_record($tablename, array('name'=>'??', 'namenull'=>null, 'description'=>'??', 'descriptionnull'=>null));
2263         $DB->insert_record($tablename, array('name'=>'la', 'namenull'=>'la', 'description'=>'la', 'descriptionnull'=>'lalala'));
2264         $DB->insert_record($tablename, array('name'=>0,    'namenull'=>0,    'description'=>0,    'descriptionnull'=>0));
2266         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'name', false, false));
2267         $this->assertEqual(count($records), 1);
2268         $record = reset($records);
2269         $this->assertEqual($record->name, '');
2271         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'namenull', true, false));
2272         $this->assertEqual(count($records), 1);
2273         $record = reset($records);
2274         $this->assertEqual($record->namenull, '');
2276         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'description', false, true));
2277         $this->assertEqual(count($records), 1);
2278         $record = reset($records);
2279         $this->assertEqual($record->description, '');
2281         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isempty($tablename, 'descriptionnull', true, true));
2282         $this->assertEqual(count($records), 1);
2283         $record = reset($records);
2284         $this->assertEqual($record->descriptionnull, '');
2285     }
2287     function test_sql_isnotempty() {
2288         $DB = $this->tdb;
2289         $dbman = $DB->get_manager();
2291         $table = $this->get_test_table();
2292         $tablename = $table->getName();
2294         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2295         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, XMLDB_NOTNULL, null, null);
2296         $table->add_field('namenull', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2297         $table->add_field('description', XMLDB_TYPE_TEXT, 'big', null, XMLDB_NOTNULL, null, null);
2298         $table->add_field('descriptionnull', XMLDB_TYPE_TEXT, 'big', null, null, null, null);
2299         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2300         $dbman->create_table($table);
2301         $this->tables[$tablename] = $table;
2303         $DB->insert_record($tablename, array('name'=>'',   'namenull'=>'',   'description'=>'',   'descriptionnull'=>''));
2304         $DB->insert_record($tablename, array('name'=>'??', 'namenull'=>null, 'description'=>'??', 'descriptionnull'=>null));
2305         $DB->insert_record($tablename, array('name'=>'la', 'namenull'=>'la', 'description'=>'la', 'descriptionnull'=>'lalala'));
2306         $DB->insert_record($tablename, array('name'=>0,    'namenull'=>0,    'description'=>0,    'descriptionnull'=>0));
2308         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isnotempty($tablename, 'name', false, false));
2309         $this->assertEqual(count($records), 3);
2310         $record = reset($records);
2311         $this->assertEqual($record->name, '??');
2313         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isnotempty($tablename, 'namenull', true, false));
2314         $this->assertEqual(count($records), 2); // nulls aren't comparable (so they aren't "not empty"). SQL expected behaviour
2315         $record = reset($records);
2316         $this->assertEqual($record->namenull, 'la'); // so 'la' is the first non-empty 'namenull' record
2318         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isnotempty($tablename, 'description', false, true));
2319         $this->assertEqual(count($records), 3);
2320         $record = reset($records);
2321         $this->assertEqual($record->description, '??');
2323         $records = $DB->get_records_sql("SELECT * FROM {".$tablename."} WHERE ".$DB->sql_isnotempty($tablename, 'descriptionnull', true, true));
2324         $this->assertEqual(count($records), 2); // nulls aren't comparable (so they aren't "not empty"). SQL expected behaviour
2325         $record = reset($records);
2326         $this->assertEqual($record->descriptionnull, 'lalala'); // so 'lalala' is the first non-empty 'descriptionnull' record
2327     }
2329     function test_sql_regex() {
2330         $DB = $this->tdb;
2331         $dbman = $DB->get_manager();
2333         $table = $this->get_test_table();
2334         $tablename = $table->getName();
2336         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2337         $table->add_field('name', XMLDB_TYPE_CHAR, '255', null, null, null, null);
2338         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2339         $dbman->create_table($table);
2340         $this->tables[$tablename] = $table;
2342         $DB->insert_record($tablename, array('name'=>'lalala'));
2343         $DB->insert_record($tablename, array('name'=>'holaaa'));
2344         $DB->insert_record($tablename, array('name'=>'aouch'));
2346         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_regex()." ?";
2347         $params = array('a$');
2348         if ($DB->sql_regex_supported()) {
2349             $records = $DB->get_records_sql($sql, $params);
2350             $this->assertEqual(count($records), 2);
2351         } else {
2352             $this->assertTrue(true, 'Regexp operations not supported. Test skipped');
2353         }
2355         $sql = "SELECT * FROM {".$tablename."} WHERE name ".$DB->sql_regex(false)." ?";
2356         $params = array('.a');
2357         if ($DB->sql_regex_supported()) {
2358             $records = $DB->get_records_sql($sql, $params);
2359             $this->assertEqual(count($records), 1);
2360         } else {
2361             $this->assertTrue(true, 'Regexp operations not supported. Test skipped');
2362         }
2364     }
2366     /**
2367      * Test some more complex SQL syntax which moodle uses and depends on to work
2368      * useful to determine if new database libraries can be supported.
2369      */
2370     public function test_get_records_sql_complicated() {
2371         global $CFG;
2372         $DB = $this->tdb;
2373         $dbman = $DB->get_manager();
2375         $table = $this->get_test_table();
2376         $tablename = $table->getName();
2378         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2379         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2380         $table->add_field('content', XMLDB_TYPE_TEXT, 'big', XMLDB_UNSIGNED, XMLDB_NOTNULL);
2381         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2382         $dbman->create_table($table);
2383         $this->tables[$tablename] = $table;
2385         $DB->insert_record($tablename, array('course' => 3, 'content' => 'hello'));
2386         $DB->insert_record($tablename, array('course' => 3, 'content' => 'world'));
2387         $DB->insert_record($tablename, array('course' => 5, 'content' => 'hello'));
2388         $DB->insert_record($tablename, array('course' => 2, 'content' => 'universe'));
2390         // we have sql like this in moodle, this syntax breaks on older versions of sqlite for example..
2391         $sql = 'SELECT a.id AS id, a.course AS course
2392                 FROM {'.$tablename.'} a
2393                 JOIN (SELECT * FROM {'.$tablename.'}) b
2394                 ON a.id = b.id
2395                 WHERE a.course = ?';
2397         $this->assertTrue($records = $DB->get_records_sql($sql, array(3)));
2398         $this->assertEqual(2, count($records));
2399         $this->assertEqual(1, reset($records)->id);
2400         $this->assertEqual(2, next($records)->id);
2402         // try embeding sql_xxxx() helper functions, to check they don't break params/binding
2403         $count = $DB->count_records($tablename, array('course' => 3, $DB->sql_compare_text('content') => 'hello'));
2404         $this->assertEqual(1, $count);
2405     }
2407     function test_onelevel_commit() {
2408         $DB = $this->tdb;
2409         $dbman = $DB->get_manager();
2411         $table = $this->get_test_table();
2412         $tablename = $table->getName();
2414         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2415         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2416         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2417         $dbman->create_table($table);
2418         $this->tables[$tablename] = $table;
2420         $transaction = $DB->start_delegated_transaction();
2421         $data = (object)array('course'=>3);
2422         $this->assertEqual(0, $DB->count_records($tablename));
2423         $DB->insert_record($tablename, $data);
2424         $this->assertEqual(1, $DB->count_records($tablename));
2425         $transaction->allow_commit();
2426         $this->assertEqual(1, $DB->count_records($tablename));
2427     }
2429     function test_onelevel_rollback() {
2430         $DB = $this->tdb;
2431         $dbman = $DB->get_manager();
2433         $table = $this->get_test_table();
2434         $tablename = $table->getName();
2436         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2437         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2438         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2439         $dbman->create_table($table);
2440         $this->tables[$tablename] = $table;
2442         // this might in fact encourage ppl to migrate from myisam to innodb
2444         $transaction = $DB->start_delegated_transaction();
2445         $data = (object)array('course'=>3);
2446         $this->assertEqual(0, $DB->count_records($tablename));
2447         $DB->insert_record($tablename, $data);
2448         $this->assertEqual(1, $DB->count_records($tablename));
2449         try {
2450             $transaction->rollback(new Exception('test'));
2451             $this->fail('transaction rollback must rethrow exception');
2452         } catch (Exception $e) {
2453         }
2454         $this->assertEqual(0, $DB->count_records($tablename));
2455     }
2457     function test_nested_transactions() {
2458         $DB = $this->tdb;
2459         $dbman = $DB->get_manager();
2461         $table = $this->get_test_table();
2462         $tablename = $table->getName();
2464         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2465         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2466         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2467         $dbman->create_table($table);
2468         $this->tables[$tablename] = $table;
2470         // two level commit
2471         $this->assertFalse($DB->is_transaction_started());
2472         $transaction1 = $DB->start_delegated_transaction();
2473         $this->assertTrue($DB->is_transaction_started());
2474         $data = (object)array('course'=>3);
2475         $DB->insert_record($tablename, $data);
2476         $transaction2 = $DB->start_delegated_transaction();
2477         $data = (object)array('course'=>4);
2478         $DB->insert_record($tablename, $data);
2479         $transaction2->allow_commit();
2480         $this->assertTrue($DB->is_transaction_started());
2481         $transaction1->allow_commit();
2482         $this->assertFalse($DB->is_transaction_started());
2483         $this->assertEqual(2, $DB->count_records($tablename));
2485         $DB->delete_records($tablename);
2487         // rollback from top level
2488         $transaction1 = $DB->start_delegated_transaction();
2489         $data = (object)array('course'=>3);
2490         $DB->insert_record($tablename, $data);
2491         $transaction2 = $DB->start_delegated_transaction();
2492         $data = (object)array('course'=>4);
2493         $DB->insert_record($tablename, $data);
2494         $transaction2->allow_commit();
2495         try {
2496             $transaction1->rollback(new Exception('test'));
2497             $this->fail('transaction rollback must rethrow exception');
2498         } catch (Exception $e) {
2499             $this->assertEqual(get_class($e), 'Exception');
2500         }
2501         $this->assertEqual(0, $DB->count_records($tablename));
2503         $DB->delete_records($tablename);
2505         // rollback from nested level
2506         $transaction1 = $DB->start_delegated_transaction();
2507         $data = (object)array('course'=>3);
2508         $DB->insert_record($tablename, $data);
2509         $transaction2 = $DB->start_delegated_transaction();
2510         $data = (object)array('course'=>4);
2511         $DB->insert_record($tablename, $data);
2512         try {
2513             $transaction2->rollback(new Exception('test'));
2514             $this->fail('transaction rollback must rethrow exception');
2515         } catch (Exception $e) {
2516             $this->assertEqual(get_class($e), 'Exception');
2517         }
2518         $this->assertEqual(2, $DB->count_records($tablename)); // not rolled back yet
2519         try {
2520             $transaction1->allow_commit();
2521         } catch (Exception $e) {
2522             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2523         }
2524         $this->assertEqual(2, $DB->count_records($tablename)); // not rolled back yet
2525         // the forced rollback is done from the default_exception handler and similar places,
2526         // let's do it manually here
2527         $this->assertTrue($DB->is_transaction_started());
2528         $DB->force_transaction_rollback();
2529         $this->assertFalse($DB->is_transaction_started());
2530         $this->assertEqual(0, $DB->count_records($tablename)); // finally rolled back
2532         $DB->delete_records($tablename);
2533     }
2535     function test_transactions_forbidden() {
2536         $DB = $this->tdb;
2537         $dbman = $DB->get_manager();
2539         $table = $this->get_test_table();
2540         $tablename = $table->getName();
2542         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2543         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2544         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2545         $dbman->create_table($table);
2546         $this->tables[$tablename] = $table;
2548         $DB->transactions_forbidden();
2549         $transaction = $DB->start_delegated_transaction();
2550         $data = (object)array('course'=>1);
2551         $DB->insert_record($tablename, $data);
2552         try {
2553             $DB->transactions_forbidden();
2554         } catch (Exception $e) {
2555             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2556         }
2557         // the previous test does not force rollback
2558         $transaction->allow_commit();
2559         $this->assertFalse($DB->is_transaction_started());
2560         $this->assertEqual(1, $DB->count_records($tablename));
2561     }
2563     function test_wrong_transactions() {
2564         $DB = $this->tdb;
2565         $dbman = $DB->get_manager();
2567         $table = $this->get_test_table();
2568         $tablename = $table->getName();
2570         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2571         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2572         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2573         $dbman->create_table($table);
2574         $this->tables[$tablename] = $table;
2577         // wrong order of nested commits
2578         $transaction1 = $DB->start_delegated_transaction();
2579         $data = (object)array('course'=>3);
2580         $DB->insert_record($tablename, $data);
2581         $transaction2 = $DB->start_delegated_transaction();
2582         $data = (object)array('course'=>4);
2583         $DB->insert_record($tablename, $data);
2584         try {
2585             $transaction1->allow_commit();
2586             $this->fail('wrong order of commits must throw exception');
2587         } catch (Exception $e) {
2588             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2589         }
2590         try {
2591             $transaction2->allow_commit();
2592             $this->fail('first wrong commit forces rollback');
2593         } catch (Exception $e) {
2594             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2595         }
2596         // this is done in default exception handler usually
2597         $this->assertTrue($DB->is_transaction_started());
2598         $this->assertEqual(2, $DB->count_records($tablename)); // not rolled back yet
2599         $DB->force_transaction_rollback();
2600         $this->assertEqual(0, $DB->count_records($tablename));
2601         $DB->delete_records($tablename);
2604         // wrong order of nested rollbacks
2605         $transaction1 = $DB->start_delegated_transaction();
2606         $data = (object)array('course'=>3);
2607         $DB->insert_record($tablename, $data);
2608         $transaction2 = $DB->start_delegated_transaction();
2609         $data = (object)array('course'=>4);
2610         $DB->insert_record($tablename, $data);
2611         try {
2612             // this first rollback should prevent all otehr rollbacks
2613             $transaction1->rollback(new Exception('test'));
2614         } catch (Exception $e) {
2615             $this->assertEqual(get_class($e), 'Exception');
2616         }
2617         try {
2618             $transaction2->rollback(new Exception('test'));
2619         } catch (Exception $e) {
2620             $this->assertEqual(get_class($e), 'Exception');
2621         }
2622         try {
2623             $transaction1->rollback(new Exception('test'));
2624         } catch (Exception $e) {
2625             // the rollback was used already once, no way to use it again
2626             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2627         }
2628         // this is done in default exception handler usually
2629         $this->assertTrue($DB->is_transaction_started());
2630         $DB->force_transaction_rollback();
2631         $DB->delete_records($tablename);
2634         // unknown transaction object
2635         $transaction1 = $DB->start_delegated_transaction();
2636         $data = (object)array('course'=>3);
2637         $DB->insert_record($tablename, $data);
2638         $transaction2 = new moodle_transaction($DB);
2639         try {
2640             $transaction2->allow_commit();
2641             $this->fail('foreign transaction must fail');
2642         } catch (Exception $e) {
2643             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2644         }
2645         try {
2646             $transaction1->allow_commit();
2647             $this->fail('first wrong commit forces rollback');
2648         } catch (Exception $e) {
2649             $this->assertEqual(get_class($e), 'dml_transaction_exception');
2650         }
2651         $DB->force_transaction_rollback();
2652         $DB->delete_records($tablename);
2653     }
2655     function test_concurent_transactions() {
2656         // Notes about this test:
2657         // 1- MySQL needs to use one engine with transactions support (InnoDB).
2658         // 2- MSSQL needs to have enabled versioning for read committed
2659         //    transactions (ALTER DATABASE xxx SET READ_COMMITTED_SNAPSHOT ON)
2660         $DB = $this->tdb;
2661         $dbman = $DB->get_manager();
2663         $table = $this->get_test_table();
2664         $tablename = $table->getName();
2666         $table->add_field('id', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, XMLDB_SEQUENCE, null);
2667         $table->add_field('course', XMLDB_TYPE_INTEGER, '10', XMLDB_UNSIGNED, XMLDB_NOTNULL, null, '0');
2668         $table->add_key('primary', XMLDB_KEY_PRIMARY, array('id'));
2669         $dbman->create_table($table);
2670         $this->tables[$tablename] = $table;
2672         $transaction = $DB->start_delegated_transaction();
2673         $data = (object)array('course'=>1);
2674         $this->assertEqual(0, $DB->count_records($tablename));
2675         $DB->insert_record($tablename, $data);
2676         $this->assertEqual(1, $DB->count_records($tablename));
2678         //open second connection
2679         $cfg = $DB->export_dbconfig();
2680         if (!isset($cfg->dboptions)) {
2681             $cfg->dboptions = array();
2682         }
2683         $DB2 = moodle_database::get_driver_instance($cfg->dbtype, $cfg->dblibrary);
2684         $DB2->connect($cfg->dbhost, $cfg->dbuser, $cfg->dbpass, $cfg->dbname, $cfg->prefix, $cfg->dboptions);
2686         // second instance should not see pending inserts
2687         $this->assertEqual(0, $DB2->count_records($tablename));
2688         $data = (object)array('course'=>2);
2689         $DB2->insert_record($tablename, $data);
2690         $this->assertEqual(1, $DB2->count_records($tablename));
2692         // first should see the changes done from second
2693         $this->assertEqual(2, $DB->count_records($tablename));
2695         // now commit and we should see it finally in second connections
2696         $transaction->allow_commit();
2697         $this->assertEqual(2, $DB2->count_records($tablename));
2699         $DB2->dispose();
2700     }
2703 /**
2704  * This class is not a proper subclass of moodle_database. It is
2705  * intended to be used only in unit tests, in order to gain access to the
2706  * protected methods of moodle_database, and unit test them.
2707  */
2708 class moodle_database_for_testing extends moodle_database {
2709     protected $prefix = 'mdl_';
2711     public function public_fix_table_names($sql) {
2712         return $this->fix_table_names($sql);
2713     }
2715     public function driver_installed(){}
2716     public function get_dbfamily(){}
2717     protected function get_dbtype(){}
2718     protected function get_dblibrary(){}
2719     public function get_name(){}
2720     public function get_configuration_help(){}
2721     public function get_configuration_hints(){}
2722     public function connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, array $dboptions=null){}
2723     public function get_server_info(){}
2724     protected function allowed_param_types(){}
2725     public function get_last_error(){}
2726     public function get_tables($usecache=true){}
2727     public function get_indexes($table){}
2728     public function get_columns($table, $usecache=true){}
2729     protected function normalise_value($column, $value){}
2730     public function set_debug($state){}
2731     public function get_debug(){}
2732     public function set_logging($state){}
2733     public function change_database_structure($sql){}
2734     public function execute($sql, array $params=null){}
2735     public function get_recordset_sql($sql, array $params=null, $limitfrom=0, $limitnum=0){}
2736     public function get_records_sql($sql, array $params=null, $limitfrom=0, $limitnum=0){}
2737     public function get_fieldset_sql($sql, array $params=null){}
2738     public function insert_record_raw($table, $params, $returnid=true, $bulk=false, $customsequence=false){}
2739     public function insert_record($table, $dataobject, $returnid=true, $bulk=false){}
2740     public function import_record($table, $dataobject){}
2741     public function update_record_raw($table, $params, $bulk=false){}
2742     public function update_record($table, $dataobject, $bulk=false){}
2743     public function set_field_select($table, $newfield, $newvalue, $select, array $params=null){}
2744     public function delete_records_select($table, $select, array $params=null){}
2745     public function sql_concat(){}
2746     public function sql_concat_join($separator="' '", $elements=array()){}
2747     public function sql_substr($expr, $start, $length=false){}
2748     public function begin_transaction() {}
2749     public function commit_transaction() {}
2750     public function rollback_transaction() {}