MDL-32697 use current database sequences instead of global scope
[moodle.git] / lib / phpunit / lib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Various PHPUnit classes and functions
19  *
20  * @package    core
21  * @category   phpunit
22  * @copyright  2012 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 require_once 'PHPUnit/Autoload.php';
27 require_once 'PHPUnit/Extensions/Database/Autoload.php';
30 /**
31  * Collection of utility methods.
32  *
33  * @package    core
34  * @category   phpunit
35  * @copyright  2012 Petr Skoda {@link http://skodak.org}
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class phpunit_util {
39     /** @var string current version hash from php files */
40     protected static $versionhash = null;
42     /** @var array original content of all database tables*/
43     protected static $tabledata = null;
45     /** @var array original structure of all database tables */
46     protected static $tablestructure = null;
48     /** @var array original structure of all database tables */
49     protected static $sequencenames = null;
51     /** @var array An array of original globals, restored after each test */
52     protected static $globals = array();
54     /** @var int last value of db writes counter, used for db resetting */
55     public static $lastdbwrites = null;
57     /** @var phpunit_data_generator */
58     protected static $generator = null;
60     /** @var resource used for prevention of parallel test execution */
61     protected static $lockhandle = null;
63     /**
64      * Prevent parallel test execution - this can not work in Moodle because we modify database and dataroot.
65      *
66      * Note: do not call manually!
67      *
68      * @internal
69      * @static
70      * @return void
71      */
72     public static function acquire_test_lock() {
73         global $CFG;
74         if (!file_exists("$CFG->phpunit_dataroot/phpunit")) {
75             // dataroot not initialised yet
76             return;
77         }
78         if (!file_exists("$CFG->phpunit_dataroot/phpunit/lock")) {
79             file_put_contents("$CFG->phpunit_dataroot/phpunit/lock", 'This file prevents concurrent execution of Moodle PHPUnit tests');
80             phpunit_boostrap_fix_file_permissions("$CFG->phpunit_dataroot/phpunit/lock");
81         }
82         if (self::$lockhandle = fopen("$CFG->phpunit_dataroot/phpunit/lock", 'r')) {
83             $wouldblock = null;
84             $locked = flock(self::$lockhandle, (LOCK_EX | LOCK_NB), $wouldblock);
85             if (!$locked) {
86                 if ($wouldblock) {
87                     echo "Waiting for other test execution to complete...\n";
88                 }
89                 $locked = flock(self::$lockhandle, LOCK_EX);
90             }
91             if (!$locked) {
92                 fclose(self::$lockhandle);
93                 self::$lockhandle = null;
94             }
95         }
96         register_shutdown_function(array('phpunit_util', 'release_test_lock'));
97     }
99     /**
100      * Note: do not call manually!
101      * @internal
102      * @static
103      * @return void
104      */
105     public static function release_test_lock() {
106         if (self::$lockhandle) {
107             flock(self::$lockhandle, LOCK_UN);
108             fclose(self::$lockhandle);
109             self::$lockhandle = null;
110         }
111     }
113     /**
114      * Load global $CFG;
115      * @internal
116      * @static
117      * @return void
118      */
119     public static function initialise_cfg() {
120         global $DB;
121         $dbhash = false;
122         try {
123             $dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'));
124         } catch (Exception $e) {
125             // not installed yet
126             initialise_cfg();
127             return;
128         }
129         if ($dbhash !== phpunit_util::get_version_hash()) {
130             // do not set CFG - the only way forward is to drop and reinstall
131             return;
132         }
133         // standard CFG init
134         initialise_cfg();
135     }
137     /**
138      * Get data generator
139      * @static
140      * @return phpunit_data_generator
141      */
142     public static function get_data_generator() {
143         if (is_null(self::$generator)) {
144             require_once(__DIR__.'/generatorlib.php');
145             self::$generator = new phpunit_data_generator();
146         }
147         return self::$generator;
148     }
150     /**
151      * Returns contents of all tables right after installation.
152      * @static
153      * @return array $table=>$records
154      */
155     protected static function get_tabledata() {
156         global $CFG;
158         if (!file_exists("$CFG->dataroot/phpunit/tabledata.ser")) {
159             // not initialised yet
160             return array();
161         }
163         if (!isset(self::$tabledata)) {
164             $data = file_get_contents("$CFG->dataroot/phpunit/tabledata.ser");
165             self::$tabledata = unserialize($data);
166         }
168         if (!is_array(self::$tabledata)) {
169             phpunit_bootstrap_error(1, 'Can not read dataroot/phpunit/tabledata.ser or invalid format, reinitialize test database.');
170         }
172         return self::$tabledata;
173     }
175     /**
176      * Returns structure of all tables right after installation.
177      * @static
178      * @return array $table=>$records
179      */
180     public static function get_tablestructure() {
181         global $CFG;
183         if (!file_exists("$CFG->dataroot/phpunit/tablestructure.ser")) {
184             // not initialised yet
185             return array();
186         }
188         if (!isset(self::$tablestructure)) {
189             $data = file_get_contents("$CFG->dataroot/phpunit/tablestructure.ser");
190             self::$tablestructure = unserialize($data);
191         }
193         if (!is_array(self::$tablestructure)) {
194             phpunit_bootstrap_error(1, 'Can not read dataroot/phpunit/tablestructure.ser or invalid format, reinitialize test database.');
195         }
197         return self::$tablestructure;
198     }
200     /**
201      * Returns the names of sequences for each autoincrementing id field in all standard tables.
202      * @static
203      * @return array $table=>$sequencename
204      */
205     public static function get_sequencenames() {
206         global $DB;
208         if (isset(self::$sequencenames)) {
209             return self::$sequencenames;
210         }
212         if (!$structure = self::get_tablestructure()) {
213             return array();
214         }
216         self::$sequencenames = array();
217         foreach ($structure as $table=>$ignored) {
218             $name = $DB->get_manager()->generator->getSequenceFromDB(new xmldb_table($table));
219             if ($name !== false) {
220                 self::$sequencenames[$table] = $name;
221             }
222         }
224         return self::$sequencenames;
225     }
227     /**
228      * Returns list of tables that are unmodified and empty.
229      *
230      * @static
231      * @return array of table names, empty if unknown
232      */
233     protected static function guess_unmodified_empty_tables() {
234         global $DB;
236         $dbfamily = $DB->get_dbfamily();
238         if ($dbfamily === 'mysql') {
239             $empties = array();
240             $prefix = $DB->get_prefix();
241             $rs = $DB->get_recordset_sql("SHOW TABLE STATUS LIKE ?", array($prefix.'%'));
242             foreach ($rs as $info) {
243                 $table = strtolower($info->name);
244                 if (strpos($table, $prefix) !== 0) {
245                     // incorrect table match caused by _
246                     continue;
247                 }
248                 if (!is_null($info->auto_increment)) {
249                     $table = preg_replace('/^'.preg_quote($prefix, '/').'/', '', $table);
250                     if ($info->auto_increment == 1) {
251                         $empties[$table] = $table;
252                     }
253                 }
254             }
255             $rs->close();
256             return $empties;
258         } else if ($dbfamily === 'mssql') {
259             $empties = array();
260             $prefix = $DB->get_prefix();
261             $sql = "SELECT t.name
262                       FROM sys.identity_columns i
263                       JOIN sys.tables t ON t.object_id = i.object_id
264                      WHERE t.name LIKE ?
265                        AND i.name = 'id'
266                        AND i.last_value IS NULL";
267             $rs = $DB->get_recordset_sql($sql, array($prefix.'%'));
268             foreach ($rs as $info) {
269                 $table = strtolower($info->name);
270                 if (strpos($table, $prefix) !== 0) {
271                     // incorrect table match caused by _
272                     continue;
273                 }
274                 $table = preg_replace('/^'.preg_quote($prefix, '/').'/', '', $table);
275                 $empties[$table] = $table;
276             }
277             $rs->close();
278             return $empties;
280         } else if ($dbfamily === 'oracle') {
281             $sequences = phpunit_util::get_sequencenames();
282             $sequences = array_map('strtoupper', $sequences);
283             $lookup = array_flip($sequences);
284             $empties = array();
285             list($seqs, $params) = $DB->get_in_or_equal($sequences);
286             $sql = "SELECT sequence_name FROM user_sequences WHERE last_number = 1 AND sequence_name $seqs";
287             $rs = $DB->get_recordset_sql($sql, $params);
288             foreach ($rs as $seq) {
289                 $table = $lookup[$seq->sequence_name];
290                 $empties[$table] = $table;
291             }
292             $rs->close();
293             return $empties;
295         } else {
296             return array();
297         }
298     }
300     /**
301      * Reset all database sequences to initial values.
302      *
303      * @static
304      * @param array $empties tables that are known to be unmodified and empty
305      * @return void
306      */
307     public static function reset_all_database_sequences(array $empties = null) {
308         global $DB;
310         if (!$data = self::get_tabledata()) {
311             // not initialised yet
312             return;
313         }
314         if (!$structure = self::get_tablestructure()) {
315             // not initialised yet
316             return;
317         }
319         $dbfamily = $DB->get_dbfamily();
320         if ($dbfamily === 'postgres') {
321             $queries = array();
322             $prefix = $DB->get_prefix();
323             foreach ($data as $table=>$records) {
324                 if (isset($structure[$table]['id']) and $structure[$table]['id']->auto_increment) {
325                     if (empty($records)) {
326                         $nextid = 1;
327                     } else {
328                         $lastrecord = end($records);
329                         $nextid = $lastrecord->id + 1;
330                     }
331                     $queries[] = "ALTER SEQUENCE {$prefix}{$table}_id_seq RESTART WITH $nextid";
332                 }
333             }
334             if ($queries) {
335                 $DB->change_database_structure(implode(';', $queries));
336             }
338         } else if ($dbfamily === 'mysql') {
339             $sequences = array();
340             $prefix = $DB->get_prefix();
341             $rs = $DB->get_recordset_sql("SHOW TABLE STATUS LIKE ?", array($prefix.'%'));
342             foreach ($rs as $info) {
343                 $table = strtolower($info->name);
344                 if (strpos($table, $prefix) !== 0) {
345                     // incorrect table match caused by _
346                     continue;
347                 }
348                 if (!is_null($info->auto_increment)) {
349                     $table = preg_replace('/^'.preg_quote($prefix, '/').'/', '', $table);
350                     $sequences[$table] = $info->auto_increment;
351                 }
352             }
353             $rs->close();
354             $prefix = $DB->get_prefix();
355             foreach ($data as $table=>$records) {
356                 if (isset($structure[$table]['id']) and $structure[$table]['id']->auto_increment) {
357                     if (isset($sequences[$table])) {
358                         if (empty($records)) {
359                             $nextid = 1;
360                         } else {
361                             $lastrecord = end($records);
362                             $nextid = $lastrecord->id + 1;
363                         }
364                         if ($sequences[$table] != $nextid) {
365                             $DB->change_database_structure("ALTER TABLE {$prefix}{$table} AUTO_INCREMENT = $nextid");
366                         }
368                     } else {
369                         // some problem exists, fallback to standard code
370                         $DB->get_manager()->reset_sequence($table);
371                     }
372                 }
373             }
375         } else if ($dbfamily === 'oracle') {
376             $sequences = phpunit_util::get_sequencenames();
377             $sequences = array_map('strtoupper', $sequences);
378             $lookup = array_flip($sequences);
380             $current = array();
381             list($seqs, $params) = $DB->get_in_or_equal($sequences);
382             $sql = "SELECT sequence_name, last_number FROM user_sequences WHERE sequence_name $seqs";
383             $rs = $DB->get_recordset_sql($sql, $params);
384             foreach ($rs as $seq) {
385                 $table = $lookup[$seq->sequence_name];
386                 $current[$table] = $seq->last_number;
387             }
388             $rs->close();
390             foreach ($data as $table=>$records) {
391                 if (isset($structure[$table]['id']) and $structure[$table]['id']->auto_increment) {
392                     $lastrecord = end($records);
393                     if ($lastrecord) {
394                         $nextid = $lastrecord->id + 1;
395                     } else {
396                         $nextid = 1;
397                     }
398                     if (!isset($current[$table])) {
399                         $DB->get_manager()->reset_sequence($table);
400                     } else if ($nextid == $current[$table]) {
401                         continue;
402                     }
403                     // reset as fast as possible - alternatively we could use http://stackoverflow.com/questions/51470/how-do-i-reset-a-sequence-in-oracle
404                     $seqname = $sequences[$table];
405                     $cachesize = $DB->get_manager()->generator->sequence_cache_size;
406                     $DB->change_database_structure("DROP SEQUENCE $seqname");
407                     $DB->change_database_structure("CREATE SEQUENCE $seqname START WITH $nextid INCREMENT BY 1 NOMAXVALUE CACHE $cachesize");
408                 }
409             }
411         } else {
412             // note: does mssql support any kind of faster reset?
413             if (is_null($empties)) {
414                 $empties = self::guess_unmodified_empty_tables();
415             }
416             foreach ($data as $table=>$records) {
417                 if (isset($empties[$table])) {
418                     continue;
419                 }
420                 if (isset($structure[$table]['id']) and $structure[$table]['id']->auto_increment) {
421                     $DB->get_manager()->reset_sequence($table);
422                 }
423             }
424         }
425     }
427     /**
428      * Reset all database tables to default values.
429      * @static
430      * @return bool true if reset done, false if skipped
431      */
432     public static function reset_database() {
433         global $DB;
435         $tables = $DB->get_tables(false);
436         if (!$tables or empty($tables['config'])) {
437             // not installed yet
438             return false;
439         }
441         if (!is_null(self::$lastdbwrites) and self::$lastdbwrites == $DB->perf_get_writes()) {
442             return false;
443         }
444         if (!$data = self::get_tabledata()) {
445             // not initialised yet
446             return false;
447         }
448         if (!$structure = self::get_tablestructure()) {
449             // not initialised yet
450             return false;
451         }
453         $empties = self::guess_unmodified_empty_tables();
455         foreach ($data as $table=>$records) {
456             if (empty($records)) {
457                 if (isset($empties[$table])) {
458                     // table was not modified and is empty
459                 } else {
460                     $DB->delete_records($table, array());
461                 }
462                 continue;
463             }
465             if (isset($structure[$table]['id']) and $structure[$table]['id']->auto_increment) {
466                 $currentrecords = $DB->get_records($table, array(), 'id ASC');
467                 $changed = false;
468                 foreach ($records as $id=>$record) {
469                     if (!isset($currentrecords[$id])) {
470                         $changed = true;
471                         break;
472                     }
473                     if ((array)$record != (array)$currentrecords[$id]) {
474                         $changed = true;
475                         break;
476                     }
477                     unset($currentrecords[$id]);
478                 }
479                 if (!$changed) {
480                     if ($currentrecords) {
481                         $lastrecord = end($records);
482                         $DB->delete_records_select($table, "id > ?", array($lastrecord->id));
483                         continue;
484                     } else {
485                         continue;
486                     }
487                 }
488             }
490             $DB->delete_records($table, array());
491             foreach ($records as $record) {
492                 $DB->import_record($table, $record, false, true);
493             }
494         }
496         // reset all next record ids - aka sequences
497         self::reset_all_database_sequences($empties);
499         // remove extra tables
500         foreach ($tables as $table) {
501             if (!isset($data[$table])) {
502                 $DB->get_manager()->drop_table(new xmldb_table($table));
503             }
504         }
506         self::$lastdbwrites = $DB->perf_get_writes();
508         return true;
509     }
511     /**
512      * Purge dataroot directory
513      * @static
514      * @return void
515      */
516     public static function reset_dataroot() {
517         global $CFG;
519         $handle = opendir($CFG->dataroot);
520         $skip = array('.', '..', 'phpunittestdir.txt', 'phpunit', '.htaccess');
521         while (false !== ($item = readdir($handle))) {
522             if (in_array($item, $skip)) {
523                 continue;
524             }
525             if (is_dir("$CFG->dataroot/$item")) {
526                 remove_dir("$CFG->dataroot/$item", false);
527             } else {
528                 unlink("$CFG->dataroot/$item");
529             }
530         }
531         closedir($handle);
532         make_temp_directory('');
533         make_cache_directory('');
534         make_cache_directory('htmlpurifier');
535     }
537     /**
538      * Reset contents of all database tables to initial values, reset caches, etc.
539      *
540      * Note: this is relatively slow (cca 2 seconds for pg and 7 for mysql) - please use with care!
541      *
542      * @static
543      * @param bool $logchanges log changes in global state and database in error log
544      * @return void
545      */
546     public static function reset_all_data($logchanges = false) {
547         global $DB, $CFG, $USER, $SITE, $COURSE, $PAGE, $OUTPUT, $SESSION;
549         // reset global $DB in case somebody mocked it
550         $DB = self::get_global_backup('DB');
552         if ($DB->is_transaction_started()) {
553             // we can not reset inside transaction
554             $DB->force_transaction_rollback();
555         }
557         $resetdb = self::reset_database();
558         $warnings = array();
560         if ($logchanges) {
561             if ($resetdb) {
562                 $warnings[] = 'Warning: unexpected database modification, resetting DB state';
563             }
565             $oldcfg = self::get_global_backup('CFG');
566             $oldsite = self::get_global_backup('SITE');
567             foreach($CFG as $k=>$v) {
568                 if (!property_exists($oldcfg, $k)) {
569                     $warnings[] = 'Warning: unexpected new $CFG->'.$k.' value';
570                 } else if ($oldcfg->$k !== $CFG->$k) {
571                     $warnings[] = 'Warning: unexpected change of $CFG->'.$k.' value';
572                 }
573                 unset($oldcfg->$k);
575             }
576             if ($oldcfg) {
577                 foreach($oldcfg as $k=>$v) {
578                     $warnings[] = 'Warning: unexpected removal of $CFG->'.$k;
579                 }
580             }
582             if ($USER->id != 0) {
583                 $warnings[] = 'Warning: unexpected change of $USER';
584             }
586             if ($COURSE->id != $oldsite->id) {
587                 $warnings[] = 'Warning: unexpected change of $COURSE';
588             }
589         }
591         // restore original globals
592         $_SERVER = self::get_global_backup('_SERVER');
593         $CFG = self::get_global_backup('CFG');
594         $SITE = self::get_global_backup('SITE');
595         $COURSE = $SITE;
597         // reinitialise following globals
598         $OUTPUT = new bootstrap_renderer();
599         $PAGE = new moodle_page();
600         $FULLME = null;
601         $ME = null;
602         $SCRIPT = null;
603         $SESSION = new stdClass();
604         $_SESSION['SESSION'] =& $SESSION;
606         // set fresh new not-logged-in user
607         $user = new stdClass();
608         $user->id = 0;
609         $user->mnethostid = $CFG->mnet_localhost_id;
610         session_set_user($user);
612         // reset all static caches
613         accesslib_clear_all_caches(true);
614         get_string_manager()->reset_caches();
615         events_get_handlers('reset');
616         textlib::reset_caches();
617         //TODO: add more resets here and probably refactor them to new core function
619         // purge dataroot directory
620         self::reset_dataroot();
622         // restore original config once more in case resetting of caches changed CFG
623         $CFG = self::get_global_backup('CFG');
625         // inform data generator
626         self::get_data_generator()->reset();
628         // fix PHP settings
629         error_reporting($CFG->debug);
631         // verify db writes just in case something goes wrong in reset
632         if (self::$lastdbwrites != $DB->perf_get_writes()) {
633             error_log('Unexpected DB writes in phpunit_util::reset_all_data()');
634             self::$lastdbwrites = $DB->perf_get_writes();
635         }
637         if ($warnings) {
638             $warnings = implode("\n", $warnings);
639             trigger_error($warnings, E_USER_WARNING);
640         }
641     }
643     /**
644      * Called during bootstrap only!
645      * @internal
646      * @static
647      * @return void
648      */
649     public static function bootstrap_init() {
650         global $CFG, $SITE, $DB;
652         // backup the globals
653         self::$globals['_SERVER'] = $_SERVER;
654         self::$globals['CFG'] = clone($CFG);
655         self::$globals['SITE'] = clone($SITE);
656         self::$globals['DB'] = $DB;
658         // refresh data in all tables, clear caches, etc.
659         phpunit_util::reset_all_data();
660     }
662     /**
663      * Returns original state of global variable.
664      * @static
665      * @param string $name
666      * @return mixed
667      */
668     public static function get_global_backup($name) {
669         if ($name === 'DB') {
670             // no cloning of database object,
671             // we just need the original reference, not original state
672             return self::$globals['DB'];
673         }
674         if (isset(self::$globals[$name])) {
675             if (is_object(self::$globals[$name])) {
676                 $return = clone(self::$globals[$name]);
677                 return $return;
678             } else {
679                 return self::$globals[$name];
680             }
681         }
682         return null;
683     }
685     /**
686      * Does this site (db and dataroot) appear to be used for production?
687      * We try very hard to prevent accidental damage done to production servers!!
688      *
689      * @static
690      * @return bool
691      */
692     public static function is_test_site() {
693         global $DB, $CFG;
695         if (!file_exists("$CFG->dataroot/phpunittestdir.txt")) {
696             // this is already tested in bootstrap script,
697             // but anyway presence of this file means the dataroot is for testing
698             return false;
699         }
701         $tables = $DB->get_tables(false);
702         if ($tables) {
703             if (!$DB->get_manager()->table_exists('config')) {
704                 return false;
705             }
706             if (!get_config('core', 'phpunittest')) {
707                 return false;
708             }
709         }
711         return true;
712     }
714     /**
715      * Is this site initialised to run unit tests?
716      *
717      * @static
718      * @return int array errorcode=>message, 0 means ok
719      */
720     public static function testing_ready_problem() {
721         global $CFG, $DB;
723         $tables = $DB->get_tables(false);
725         if (!self::is_test_site()) {
726             // dataroot was verified in bootstrap, so it must be DB
727             return array(PHPUNIT_EXITCODE_CONFIGERROR, 'Can not use database for testing, try different prefix');
728         }
730         if (empty($tables)) {
731             return array(PHPUNIT_EXITCODE_INSTALL, '');
732         }
734         if (!file_exists("$CFG->dataroot/phpunit/tabledata.ser") or !file_exists("$CFG->dataroot/phpunit/tablestructure.ser")) {
735             return array(PHPUNIT_EXITCODE_REINSTALL, '');
736         }
738         if (!file_exists("$CFG->dataroot/phpunit/versionshash.txt")) {
739             return array(PHPUNIT_EXITCODE_REINSTALL, '');
740         }
742         $hash = phpunit_util::get_version_hash();
743         $oldhash = file_get_contents("$CFG->dataroot/phpunit/versionshash.txt");
745         if ($hash !== $oldhash) {
746             return array(PHPUNIT_EXITCODE_REINSTALL, '');
747         }
749         $dbhash = get_config('core', 'phpunittest');
750         if ($hash !== $dbhash) {
751             return array(PHPUNIT_EXITCODE_REINSTALL, '');
752         }
754         return array(0, '');
755     }
757     /**
758      * Drop all test site data.
759      *
760      * Note: To be used from CLI scripts only.
761      *
762      * @static
763      * @return void may terminate execution with exit code
764      */
765     public static function drop_site() {
766         global $DB, $CFG;
768         if (!self::is_test_site()) {
769             phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, 'Can not drop non-test site!!');
770         }
772         // purge dataroot
773         self::reset_dataroot();
774         phpunit_bootstrap_initdataroot($CFG->dataroot);
775         $keep = array('.', '..', 'lock', 'webrunner.xml');
776         $files = scandir("$CFG->dataroot/phpunit");
777         foreach ($files as $file) {
778             if (in_array($file, $keep)) {
779                 continue;
780             }
781             $path = "$CFG->dataroot/phpunit/$file";
782             if (is_dir($path)) {
783                 remove_dir($path, false);
784             } else {
785                 unlink($path);
786             }
787         }
789         // drop all tables
790         $tables = $DB->get_tables(false);
791         if (isset($tables['config'])) {
792             // config always last to prevent problems with interrupted drops!
793             unset($tables['config']);
794             $tables['config'] = 'config';
795         }
796         foreach ($tables as $tablename) {
797             $table = new xmldb_table($tablename);
798             $DB->get_manager()->drop_table($table);
799         }
800     }
802     /**
803      * Perform a fresh test site installation
804      *
805      * Note: To be used from CLI scripts only.
806      *
807      * @static
808      * @return void may terminate execution with exit code
809      */
810     public static function install_site() {
811         global $DB, $CFG;
813         if (!self::is_test_site()) {
814             phpunit_bootstrap_error(PHPUNIT_EXITCODE_CONFIGERROR, 'Can not install on non-test site!!');
815         }
817         if ($DB->get_tables()) {
818             list($errorcode, $message) = phpunit_util::testing_ready_problem();
819             if ($errorcode) {
820                 phpunit_bootstrap_error(PHPUNIT_EXITCODE_REINSTALL, 'Database tables already present, Moodle PHPUnit test environment can not be initialised');
821             } else {
822                 phpunit_bootstrap_error(0, 'Moodle PHPUnit test environment is already initialised');
823             }
824         }
826         $options = array();
827         $options['adminpass'] = 'admin';
828         $options['shortname'] = 'phpunit';
829         $options['fullname'] = 'PHPUnit test site';
831         install_cli_database($options, false);
833         // install timezone info
834         $timezones = get_records_csv($CFG->libdir.'/timezone.txt', 'timezone');
835         update_timezone_records($timezones);
837         // add test db flag
838         $hash = phpunit_util::get_version_hash();
839         set_config('phpunittest', $hash);
841         // store data for all tables
842         $data = array();
843         $structure = array();
844         $tables = $DB->get_tables();
845         foreach ($tables as $table) {
846             $columns = $DB->get_columns($table);
847             $structure[$table] = $columns;
848             if (isset($columns['id']) and $columns['id']->auto_increment) {
849                 $data[$table] = $DB->get_records($table, array(), 'id ASC');
850             } else {
851                 // there should not be many of these
852                 $data[$table] = $DB->get_records($table, array());
853             }
854         }
855         $data = serialize($data);
856         file_put_contents("$CFG->dataroot/phpunit/tabledata.ser", $data);
857         phpunit_boostrap_fix_file_permissions("$CFG->dataroot/phpunit/tabledata.ser");
859         $structure = serialize($structure);
860         file_put_contents("$CFG->dataroot/phpunit/tablestructure.ser", $structure);
861         phpunit_boostrap_fix_file_permissions("$CFG->dataroot/phpunit/tablestructure.ser");
863         // hash all plugin versions - helps with very fast detection of db structure changes
864         file_put_contents("$CFG->dataroot/phpunit/versionshash.txt", $hash);
865         phpunit_boostrap_fix_file_permissions("$CFG->dataroot/phpunit/versionshash.txt", $hash);
866     }
868     /**
869      * Calculate unique version hash for all plugins and core.
870      * @static
871      * @return string sha1 hash
872      */
873     public static function get_version_hash() {
874         global $CFG;
876         if (self::$versionhash) {
877             return self::$versionhash;
878         }
880         $versions = array();
882         // main version first
883         $version = null;
884         include($CFG->dirroot.'/version.php');
885         $versions['core'] = $version;
887         // modules
888         $mods = get_plugin_list('mod');
889         ksort($mods);
890         foreach ($mods as $mod => $fullmod) {
891             $module = new stdClass();
892             $module->version = null;
893             include($fullmod.'/version.php');
894             $versions[$mod] = $module->version;
895         }
897         // now the rest of plugins
898         $plugintypes = get_plugin_types();
899         unset($plugintypes['mod']);
900         ksort($plugintypes);
901         foreach ($plugintypes as $type=>$unused) {
902             $plugs = get_plugin_list($type);
903             ksort($plugs);
904             foreach ($plugs as $plug=>$fullplug) {
905                 $plugin = new stdClass();
906                 $plugin->version = null;
907                 @include($fullplug.'/version.php');
908                 $versions[$plug] = $plugin->version;
909             }
910         }
912         self::$versionhash = sha1(serialize($versions));
914         return self::$versionhash;
915     }
917     /**
918      * Builds dirroot/phpunit.xml and dataroot/phpunit/webrunner.xml files using defaults from /phpunit.xml.dist
919      * @static
920      * @return bool true means main config file created, false means only dataroot file created
921      */
922     public static function build_config_file() {
923         global $CFG;
925         $template = '
926         <testsuite name="@component@">
927             <directory suffix="_test.php">@dir@</directory>
928         </testsuite>';
929         $data = file_get_contents("$CFG->dirroot/phpunit.xml.dist");
931         $suites = '';
933         $plugintypes = get_plugin_types();
934         ksort($plugintypes);
935         foreach ($plugintypes as $type=>$unused) {
936             $plugs = get_plugin_list($type);
937             ksort($plugs);
938             foreach ($plugs as $plug=>$fullplug) {
939                 if (!file_exists("$fullplug/tests/")) {
940                     continue;
941                 }
942                 $dir = substr($fullplug, strlen($CFG->dirroot)+1);
943                 $dir .= '/tests';
944                 $component = $type.'_'.$plug;
946                 $suite = str_replace('@component@', $component, $template);
947                 $suite = str_replace('@dir@', $dir, $suite);
949                 $suites .= $suite;
950             }
951         }
953         $data = preg_replace('|<!--@plugin_suites_start@-->.*<!--@plugin_suites_end@-->|s', $suites, $data, 1);
955         $result = false;
956         if (is_writable($CFG->dirroot)) {
957             if ($result = file_put_contents("$CFG->dirroot/phpunit.xml", $data)) {
958                 phpunit_boostrap_fix_file_permissions("$CFG->dirroot/phpunit.xml");
959             }
960         }
962         // relink - it seems that xml:base does not work in phpunit xml files, remove this nasty hack if you find a way to set xml base for relative refs
963         $data = str_replace('lib/phpunit/', $CFG->dirroot.DIRECTORY_SEPARATOR.'lib'.DIRECTORY_SEPARATOR.'phpunit'.DIRECTORY_SEPARATOR, $data);
964         $data = preg_replace('|<directory suffix="_test.php">([^<]+)</directory>|',
965             '<directory suffix="_test.php">'.$CFG->dirroot.(DIRECTORY_SEPARATOR === '\\' ? '\\\\' : DIRECTORY_SEPARATOR).'$1</directory>',
966             $data);
967         file_put_contents("$CFG->dataroot/phpunit/webrunner.xml", $data);
968         phpunit_boostrap_fix_file_permissions("$CFG->dataroot/phpunit/webrunner.xml");
970         return (bool)$result;
971     }
975 /**
976  * Simplified emulation test case for legacy SimpleTest.
977  *
978  * Note: this is supposed to work for very simple tests only.
979  *
980  * @deprecated since 2.3
981  * @package    core
982  * @category   phpunit
983  * @author     Petr Skoda
984  * @copyright  2012 Petr Skoda {@link http://skodak.org}
985  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
986  */
987 abstract class UnitTestCase extends PHPUnit_Framework_TestCase {
989     /**
990      * @deprecated since 2.3
991      * @param bool $expected
992      * @param string $message
993      * @return void
994      */
995     public function expectException($expected, $message = '') {
996         // alternatively use phpdocs: @expectedException ExceptionClassName
997         if (!$expected) {
998             return;
999         }
1000         $this->setExpectedException('moodle_exception', $message);
1001     }
1003     /**
1004      * @deprecated since 2.3
1005      * @param bool $expected
1006      * @param string $message
1007      * @return void
1008      */
1009     public function expectError($expected = false, $message = '') {
1010         // alternatively use phpdocs: @expectedException PHPUnit_Framework_Error
1011         if (!$expected) {
1012             return;
1013         }
1014         $this->setExpectedException('PHPUnit_Framework_Error', $message);
1015     }
1017     /**
1018      * @deprecated since 2.3
1019      * @static
1020      * @param mixed $actual
1021      * @param string $messages
1022      * @return void
1023      */
1024     public static function assertTrue($actual, $messages = '') {
1025         parent::assertTrue((bool)$actual, $messages);
1026     }
1028     /**
1029      * @deprecated since 2.3
1030      * @static
1031      * @param mixed $actual
1032      * @param string $messages
1033      * @return void
1034      */
1035     public static function assertFalse($actual, $messages = '') {
1036         parent::assertFalse((bool)$actual, $messages);
1037     }
1039     /**
1040      * @deprecated since 2.3
1041      * @static
1042      * @param mixed $expected
1043      * @param mixed $actual
1044      * @param string $message
1045      * @return void
1046      */
1047     public static function assertEqual($expected, $actual, $message = '') {
1048         parent::assertEquals($expected, $actual, $message);
1049     }
1051     /**
1052      * @deprecated since 2.3
1053      * @static
1054      * @param mixed $expected
1055      * @param mixed $actual
1056      * @param float|int $margin
1057      * @param string $message
1058      * @return void
1059      */
1060     public static function assertWithinMargin($expected, $actual, $margin, $message = '') {
1061         parent::assertEquals($expected, $actual, '', $margin, $message);
1062     }
1064     /**
1065      * @deprecated since 2.3
1066      * @static
1067      * @param mixed $expected
1068      * @param mixed $actual
1069      * @param string $message
1070      * @return void
1071      */
1072     public static function assertNotEqual($expected, $actual, $message = '') {
1073         parent::assertNotEquals($expected, $actual, $message);
1074     }
1076     /**
1077      * @deprecated since 2.3
1078      * @static
1079      * @param mixed $expected
1080      * @param mixed $actual
1081      * @param string $message
1082      * @return void
1083      */
1084     public static function assertIdentical($expected, $actual, $message = '') {
1085         parent::assertSame($expected, $actual, $message);
1086     }
1088     /**
1089      * @deprecated since 2.3
1090      * @static
1091      * @param mixed $expected
1092      * @param mixed $actual
1093      * @param string $message
1094      * @return void
1095      */
1096     public static function assertNotIdentical($expected, $actual, $message = '') {
1097         parent::assertNotSame($expected, $actual, $message);
1098     }
1100     /**
1101      * @deprecated since 2.3
1102      * @static
1103      * @param mixed $actual
1104      * @param mixed $expected
1105      * @param string $message
1106      * @return void
1107      */
1108     public static function assertIsA($actual, $expected, $message = '') {
1109         if ($expected === 'array') {
1110             parent::assertEquals('array', gettype($actual), $message);
1111         } else {
1112             parent::assertInstanceOf($expected, $actual, $message);
1113         }
1114     }
1116     /**
1117      * @deprecated since 2.3
1118      * @static
1119      * @param mixed $pattern
1120      * @param mixed $string
1121      * @param string $message
1122      * @return void
1123      */
1124     public static function assertPattern($pattern, $string, $message = '') {
1125         parent::assertRegExp($pattern, $string, $message);
1126     }
1128     /**
1129      * @deprecated since 2.3
1130      * @static
1131      * @param mixed $pattern
1132      * @param mixed $string
1133      * @param string $message
1134      * @return void
1135      */
1136     public static function assertNotPattern($pattern, $string, $message = '') {
1137         parent::assertNotRegExp($pattern, $string, $message);
1138     }
1142 /**
1143  * The simplest PHPUnit test case customised for Moodle
1144  *
1145  * It is intended for isolated tests that do not modify database or any globals.
1146  *
1147  * @package    core
1148  * @category   phpunit
1149  * @copyright  2012 Petr Skoda {@link http://skodak.org}
1150  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1151  */
1152 abstract class basic_testcase extends PHPUnit_Framework_TestCase {
1154     /**
1155      * Constructs a test case with the given name.
1156      *
1157      * Note: use setUp() or setUpBeforeClass() in your test cases.
1158      *
1159      * @param string $name
1160      * @param array  $data
1161      * @param string $dataName
1162      */
1163     final public function __construct($name = null, array $data = array(), $dataName = '') {
1164         parent::__construct($name, $data, $dataName);
1166         $this->setBackupGlobals(false);
1167         $this->setBackupStaticAttributes(false);
1168         $this->setRunTestInSeparateProcess(false);
1169     }
1171     /**
1172      * Runs the bare test sequence and log any changes in global state or database.
1173      * @return void
1174      */
1175     final public function runBare() {
1176         global $DB;
1178         try {
1179             parent::runBare();
1180         } catch (Exception $e) {
1181             // cleanup after failed expectation
1182             phpunit_util::reset_all_data();
1183             throw $e;
1184         }
1186         if ($DB->is_transaction_started()) {
1187             phpunit_util::reset_all_data();
1188             throw new coding_exception('basic_testcase '.$this->getName().' is not supposed to use database transactions!');
1189         }
1191         phpunit_util::reset_all_data(true);
1192     }
1196 /**
1197  * Advanced PHPUnit test case customised for Moodle.
1198  *
1199  * @package    core
1200  * @category   phpunit
1201  * @copyright  2012 Petr Skoda {@link http://skodak.org}
1202  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1203  */
1204 abstract class advanced_testcase extends PHPUnit_Framework_TestCase {
1205     /** @var bool automatically reset everything? null means log changes */
1206     private $resetAfterTest;
1208     /** @var moodle_transaction */
1209     private $testdbtransaction;
1211     /**
1212      * Constructs a test case with the given name.
1213      *
1214      * Note: use setUp() or setUpBeforeClass() in your test cases.
1215      *
1216      * @param string $name
1217      * @param array  $data
1218      * @param string $dataName
1219      */
1220     final public function __construct($name = null, array $data = array(), $dataName = '') {
1221         parent::__construct($name, $data, $dataName);
1223         $this->setBackupGlobals(false);
1224         $this->setBackupStaticAttributes(false);
1225         $this->setRunTestInSeparateProcess(false);
1226     }
1228     /**
1229      * Runs the bare test sequence.
1230      * @return void
1231      */
1232     final public function runBare() {
1233         global $DB;
1235         if (phpunit_util::$lastdbwrites != $DB->perf_get_writes()) {
1236             // this happens when previous test does not reset, we can not use transactions
1237             $this->testdbtransaction = null;
1239         } else if ($DB->get_dbfamily() === 'postgres' or $DB->get_dbfamily() === 'mssql') {
1240             // database must allow rollback of DDL, so no mysql here
1241             $this->testdbtransaction = $DB->start_delegated_transaction();
1242         }
1244         try {
1245             parent::runBare();
1246             // set DB reference in case somebody mocked it in test
1247             $DB = phpunit_util::get_global_backup('DB');
1248         } catch (Exception $e) {
1249             // cleanup after failed expectation
1250             phpunit_util::reset_all_data();
1251             throw $e;
1252         }
1254         if (!$this->testdbtransaction or $this->testdbtransaction->is_disposed()) {
1255             $this->testdbtransaction = null;
1256         }
1258         if ($this->resetAfterTest === true) {
1259             if ($this->testdbtransaction) {
1260                 $DB->force_transaction_rollback();
1261                 phpunit_util::reset_all_database_sequences();
1262                 phpunit_util::$lastdbwrites = $DB->perf_get_writes(); // no db reset necessary
1263             }
1264             phpunit_util::reset_all_data();
1266         } else if ($this->resetAfterTest === false) {
1267             if ($this->testdbtransaction) {
1268                 $this->testdbtransaction->allow_commit();
1269             }
1270             // keep all data untouched for other tests
1272         } else {
1273             // reset but log what changed
1274             if ($this->testdbtransaction) {
1275                 try {
1276                     $this->testdbtransaction->allow_commit();
1277                 } catch (dml_transaction_exception $e) {
1278                     phpunit_util::reset_all_data();
1279                     throw new coding_exception('Invalid transaction state detected in test '.$this->getName());
1280                 }
1281             }
1282             phpunit_util::reset_all_data(true);
1283         }
1285         // make sure test did not forget to close transaction
1286         if ($DB->is_transaction_started()) {
1287             phpunit_util::reset_all_data();
1288             if ($this->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_PASSED
1289                     or $this->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED
1290                     or $this->getStatus() == PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE) {
1291                 throw new coding_exception('Test '.$this->getName().' did not close database transaction');
1292             }
1293         }
1294     }
1296     /**
1297      * Creates a new FlatXmlDataSet with the given $xmlFile. (absolute path.)
1298      *
1299      * @param string $xmlFile
1300      * @return PHPUnit_Extensions_Database_DataSet_FlatXmlDataSet
1301      */
1302     protected function createFlatXMLDataSet($xmlFile) {
1303         return new PHPUnit_Extensions_Database_DataSet_FlatXmlDataSet($xmlFile);
1304     }
1306     /**
1307      * Creates a new XMLDataSet with the given $xmlFile. (absolute path.)
1308      *
1309      * @param string $xmlFile
1310      * @return PHPUnit_Extensions_Database_DataSet_XmlDataSet
1311      */
1312     protected function createXMLDataSet($xmlFile) {
1313         return new PHPUnit_Extensions_Database_DataSet_XmlDataSet($xmlFile);
1314     }
1316     /**
1317      * Creates a new CsvDataSet from the given array of csv files. (absolute paths.)
1318      *
1319      * @param array $files array tablename=>cvsfile
1320      * @param string $delimiter
1321      * @param string $enclosure
1322      * @param string $escape
1323      * @return PHPUnit_Extensions_Database_DataSet_CsvDataSet
1324      */
1325     protected function createCsvDataSet($files, $delimiter = ',', $enclosure = '"', $escape = '"') {
1326         $dataSet = new PHPUnit_Extensions_Database_DataSet_CsvDataSet($delimiter, $enclosure, $escape);
1327         foreach($files as $table=>$file) {
1328             $dataSet->addTable($table, $file);
1329         }
1330         return $dataSet;
1331     }
1333     /**
1334      * Creates new ArrayDataSet from given array
1335      *
1336      * @param array $data array of tables, first row in each table is columns
1337      * @return phpunit_ArrayDataSet
1338      */
1339     protected function createArrayDataSet(array $data) {
1340         return new phpunit_ArrayDataSet($data);
1341     }
1343     /**
1344      * Load date into moodle database tables from standard PHPUnit data set.
1345      *
1346      * Note: it is usually better to use data generators
1347      *
1348      * @param PHPUnit_Extensions_Database_DataSet_IDataSet $dataset
1349      * @return void
1350      */
1351     protected function loadDataSet(PHPUnit_Extensions_Database_DataSet_IDataSet $dataset) {
1352         global $DB;
1354         $structure = phpunit_util::get_tablestructure();
1356         foreach($dataset->getTableNames() as $tablename) {
1357             $table = $dataset->getTable($tablename);
1358             $metadata = $dataset->getTableMetaData($tablename);
1359             $columns = $metadata->getColumns();
1361             $doimport = false;
1362             if (isset($structure[$tablename]['id']) and $structure[$tablename]['id']->auto_increment) {
1363                 $doimport = in_array('id', $columns);
1364             }
1366             for($r=0; $r<$table->getRowCount(); $r++) {
1367                 $record = $table->getRow($r);
1368                 if ($doimport) {
1369                     $DB->import_record($tablename, $record);
1370                 } else {
1371                     $DB->insert_record($tablename, $record);
1372                 }
1373             }
1374             if ($doimport) {
1375                 $DB->get_manager()->reset_sequence(new xmldb_table($tablename));
1376             }
1377         }
1378     }
1380     /**
1381      * Call this method from test if you want to make sure that
1382      * the resetting of database is done the slow way without transaction
1383      * rollback.
1384      *
1385      * This is useful especially when testing stuff that is not compatible with transactions.
1386      *
1387      * @return void
1388      */
1389     public function preventResetByRollback() {
1390         if ($this->testdbtransaction and !$this->testdbtransaction->is_disposed()) {
1391             $this->testdbtransaction->allow_commit();
1392             $this->testdbtransaction = null;
1393         }
1394     }
1396     /**
1397      * Reset everything after current test.
1398      * @param bool $reset true means reset state back, false means keep all data for the next test,
1399      *      null means reset state and show warnings if anything changed
1400      * @return void
1401      */
1402     public function resetAfterTest($reset = true) {
1403         $this->resetAfterTest = $reset;
1404     }
1406     /**
1407      * Cleanup after all tests are executed.
1408      *
1409      * Note: do not forget to call this if overridden...
1410      *
1411      * @static
1412      * @return void
1413      */
1414     public static function tearDownAfterClass() {
1415         phpunit_util::reset_all_data();
1416     }
1418     /**
1419      * Reset all database tables, restore global state and clear caches and optionally purge dataroot dir.
1420      * @static
1421      * @return void
1422      */
1423     public static function resetAllData() {
1424         phpunit_util::reset_all_data();
1425     }
1427     /**
1428      * Set current $USER, reset access cache.
1429      * @static
1430      * @param null|int|stdClass $user user record, null means non-logged-in, integer means userid
1431      * @return void
1432      */
1433     public static function setUser($user = null) {
1434         global $CFG, $DB;
1436         if (is_object($user)) {
1437             $user = clone($user);
1438         } else if (!$user) {
1439             $user = new stdClass();
1440             $user->id = 0;
1441             $user->mnethostid = $CFG->mnet_localhost_id;
1442         } else {
1443             $user = $DB->get_record('user', array('id'=>$user));
1444         }
1445         unset($user->description);
1446         unset($user->access);
1448         session_set_user($user);
1449     }
1451     /**
1452      * Get data generator
1453      * @static
1454      * @return phpunit_data_generator
1455      */
1456     public static function getDataGenerator() {
1457         return phpunit_util::get_data_generator();
1458     }
1460     /**
1461      * Recursively visit all the files in the source tree. Calls the callback
1462      * function with the pathname of each file found.
1463      *
1464      * @param string $path the folder to start searching from.
1465      * @param string $callback the method of this class to call with the name of each file found.
1466      * @param string $fileregexp a regexp used to filter the search (optional).
1467      * @param bool $exclude If true, pathnames that match the regexp will be ignored. If false,
1468      *     only files that match the regexp will be included. (default false).
1469      * @param array $ignorefolders will not go into any of these folders (optional).
1470      * @return void
1471      */
1472     public function recurseFolders($path, $callback, $fileregexp = '/.*/', $exclude = false, $ignorefolders = array()) {
1473         $files = scandir($path);
1475         foreach ($files as $file) {
1476             $filepath = $path .'/'. $file;
1477             if (strpos($file, '.') === 0) {
1478                 /// Don't check hidden files.
1479                 continue;
1480             } else if (is_dir($filepath)) {
1481                 if (!in_array($filepath, $ignorefolders)) {
1482                     $this->recurseFolders($filepath, $callback, $fileregexp, $exclude, $ignorefolders);
1483                 }
1484             } else if ($exclude xor preg_match($fileregexp, $filepath)) {
1485                 $this->$callback($filepath);
1486             }
1487         }
1488     }
1492 /**
1493  * based on array iterator code from PHPUnit documentation by Sebastian Bergmann
1494  * and added new constructor parameter for different array types.
1495  */
1496 class phpunit_ArrayDataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet {
1497     /**
1498      * @var array
1499      */
1500     protected $tables = array();
1502     /**
1503      * @param array $data
1504      */
1505     public function __construct(array $data) {
1506         foreach ($data AS $tableName => $rows) {
1507             $firstrow = reset($rows);
1509             if (array_key_exists(0, $firstrow)) {
1510                 // columns in first row
1511                 $columnsInFirstRow = true;
1512                 $columns = $firstrow;
1513                 $key = key($rows);
1514                 unset($rows[$key]);
1515             } else {
1516                 // column name is in each row as key
1517                 $columnsInFirstRow = false;
1518                 $columns = array_keys($firstrow);
1519             }
1521             $metaData = new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $columns);
1522             $table = new PHPUnit_Extensions_Database_DataSet_DefaultTable($metaData);
1524             foreach ($rows AS $row) {
1525                 if ($columnsInFirstRow) {
1526                     $row = array_combine($columns, $row);
1527                 }
1528                 $table->addRow($row);
1529             }
1530             $this->tables[$tableName] = $table;
1531         }
1532     }
1534     protected function createIterator($reverse = FALSE) {
1535         return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($this->tables, $reverse);
1536     }
1538     public function getTable($tableName) {
1539         if (!isset($this->tables[$tableName])) {
1540             throw new InvalidArgumentException("$tableName is not a table in the current database.");
1541         }
1543         return $this->tables[$tableName];
1544     }
1548 /**
1549  * Special test case for testing of DML drivers and DDL layer.
1550  *
1551  * Note: Use only 'test_table*' names when creating new tables.
1552  *
1553  * For DML/DDL developers: you can add following settings to config.php if you want to test different driver than the main one,
1554  *                         the reason is to allow testing of incomplete drivers that do not allow full PHPUnit environment
1555  *                         initialisation (the database can be empty).
1556  * $CFG->phpunit_extra_drivers = array(
1557  *      1=>array('dbtype'=>'mysqli', 'dbhost'=>'localhost', 'dbname'=>'moodle', 'dbuser'=>'root', 'dbpass'=>'', 'prefix'=>'phpu2_'),
1558  *      2=>array('dbtype'=>'pgsql', 'dbhost'=>'localhost', 'dbname'=>'moodle', 'dbuser'=>'postgres', 'dbpass'=>'', 'prefix'=>'phpu2_'),
1559  *      3=>array('dbtype'=>'sqlsrv', 'dbhost'=>'127.0.0.1', 'dbname'=>'moodle', 'dbuser'=>'sa', 'dbpass'=>'', 'prefix'=>'phpu2_'),
1560  *      4=>array('dbtype'=>'oci', 'dbhost'=>'127.0.0.1', 'dbname'=>'XE', 'dbuser'=>'sa', 'dbpass'=>'', 'prefix'=>'t_'),
1561  * );
1562  * define('PHPUNIT_TEST_DRIVER')=1; //number is index in the previous array
1563  *
1564  * @package    core
1565  * @category   phpunit
1566  * @copyright  2012 Petr Skoda {@link http://skodak.org}
1567  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1568  */
1569 abstract class database_driver_testcase extends PHPUnit_Framework_TestCase {
1570     /** @var moodle_database connection to extra database */
1571     private static $extradb = null;
1573     /** @var moodle_database used in these tests*/
1574     protected $tdb;
1576     /**
1577      * Constructs a test case with the given name.
1578      *
1579      * @param string $name
1580      * @param array  $data
1581      * @param string $dataName
1582      */
1583     final public function __construct($name = null, array $data = array(), $dataName = '') {
1584         parent::__construct($name, $data, $dataName);
1586         $this->setBackupGlobals(false);
1587         $this->setBackupStaticAttributes(false);
1588         $this->setRunTestInSeparateProcess(false);
1589     }
1591     public static function setUpBeforeClass() {
1592         global $CFG;
1593         parent::setUpBeforeClass();
1595         if (!defined('PHPUNIT_TEST_DRIVER')) {
1596             // use normal $DB
1597             return;
1598         }
1600         if (!isset($CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER])) {
1601             throw new exception('Can not find driver configuration options with index: '.PHPUNIT_TEST_DRIVER);
1602         }
1604         $dblibrary = empty($CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dblibrary']) ? 'native' : $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dblibrary'];
1605         $dbtype = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dbtype'];
1606         $dbhost = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dbhost'];
1607         $dbname = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dbname'];
1608         $dbuser = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dbuser'];
1609         $dbpass = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dbpass'];
1610         $prefix = $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['prefix'];
1611         $dboptions = empty($CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dboptions']) ? array() : $CFG->phpunit_extra_drivers[PHPUNIT_TEST_DRIVER]['dboptions'];
1613         $classname = "{$dbtype}_{$dblibrary}_moodle_database";
1614         require_once("$CFG->libdir/dml/$classname.php");
1615         $d = new $classname();
1616         if (!$d->driver_installed()) {
1617             throw new exception('Database driver for '.$classname.' is not installed');
1618         }
1620         $d->connect($dbhost, $dbuser, $dbpass, $dbname, $prefix, $dboptions);
1622         self::$extradb = $d;
1623     }
1625     protected function setUp() {
1626         global $DB;
1627         parent::setUp();
1629         if (self::$extradb) {
1630             $this->tdb = self::$extradb;
1631         } else {
1632             $this->tdb = $DB;
1633         }
1634     }
1636     protected function tearDown() {
1637         // delete all test tables
1638         $dbman = $this->tdb->get_manager();
1639         $tables = $this->tdb->get_tables(false);
1640         foreach($tables as $tablename) {
1641             if (strpos($tablename, 'test_table') === 0) {
1642                 $table = new xmldb_table($tablename);
1643                 $dbman->drop_table($table);
1644             }
1645         }
1646         parent::tearDown();
1647     }
1649     public static function tearDownAfterClass() {
1650         if (self::$extradb) {
1651             self::$extradb->dispose();
1652             self::$extradb = null;
1653         }
1654         phpunit_util::reset_all_data();
1655         parent::tearDownAfterClass();
1656     }