2 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
3 # http://www.mediawiki.org/
5 # This program 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 2 of the License, or
8 # (at your option) any later version.
10 # This program 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.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 # http://www.gnu.org/copyleft/gpl.html
21 * @todo Make this more independent of the configuration (and if possible the database)
23 * @addtogroup Maintenance
27 $options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record' );
28 $optionsWithArgs = array( 'regex' );
30 require_once( 'commandLine.inc' );
31 require_once( "$IP/maintenance/parserTestsParserHook.php" );
32 require_once( "$IP/maintenance/parserTestsStaticParserHook.php" );
33 require_once( "$IP/maintenance/parserTestsParserTime.php" );
36 * @addtogroup Maintenance
40 * boolean $color whereas output should be colorized
45 * boolean $showOutput Show test output
50 * Sets terminal colorization and diff/quick modes depending on OS and
51 * command-line options (--color and --quick).
53 public function ParserTest() {
56 # Only colorize output if stdout is a terminal.
57 $this->color = !wfIsWindows() && posix_isatty(1);
59 if( isset( $options['color'] ) ) {
60 switch( $options['color'] ) {
70 $this->term = $this->color
71 ? new AnsiTermColorer()
72 : new DummyTermColorer();
74 $this->showDiffs = !isset( $options['quick'] );
75 $this->showProgress = !isset( $options['quiet'] );
76 $this->showFailure = !(
77 isset( $options['quiet'] )
78 && ( isset( $options['record'] )
79 || isset( $options['compare'] ) ) ); // redundant output
81 $this->showOutput = isset( $options['show-output'] );
84 if (isset($options['regex'])) {
85 $this->regex = $options['regex'];
91 if( isset( $options['record'] ) ) {
92 $this->recorder = new DbTestRecorder( $this->term );
93 } elseif( isset( $options['compare'] ) ) {
94 $this->recorder = new DbTestPreviewer( $this->term );
96 $this->recorder = new TestRecorder( $this->term );
99 $this->hooks = array();
100 $this->functionHooks = array();
104 * Remove last character if it is a newline
106 private function chomp($s) {
107 if (substr($s, -1) === "\n") {
108 return substr($s, 0, -1);
116 * Run a series of tests listed in the given text files.
117 * Each test consists of a brief description, wikitext input,
118 * and the expected HTML output.
120 * Prints status updates on stdout and counts up the total
121 * number and percentage of passed tests.
123 * @param array of strings $filenames
124 * @return bool True if passed all tests, false if any tests failed.
126 public function runTestsFromFiles( $filenames ) {
127 $this->recorder->start();
129 foreach( $filenames as $filename ) {
130 $ok = $this->runFile( $filename ) && $ok;
132 $this->recorder->report();
133 $this->recorder->end();
137 private function runFile( $filename ) {
138 $infile = fopen( $filename, 'rt' );
140 wfDie( "Couldn't open $filename\n" );
143 $relative = wfRelativePath( $filename, $IP );
144 print $this->term->color( 1 ) .
145 "Reading tests from \"$relative\"..." .
146 $this->term->reset() .
154 while( false !== ($line = fgets( $infile ) ) ) {
157 if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
158 $section = strtolower( $matches[1] );
159 if( $section == 'endarticle') {
160 if( !isset( $data['text'] ) ) {
161 wfDie( "'endarticle' without 'text' at line $n of $filename\n" );
163 if( !isset( $data['article'] ) ) {
164 wfDie( "'endarticle' without 'article' at line $n of $filename\n" );
166 $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
171 if( $section == 'endhooks' ) {
172 if( !isset( $data['hooks'] ) ) {
173 wfDie( "'endhooks' without 'hooks' at line $n of $filename\n" );
175 foreach( explode( "\n", $data['hooks'] ) as $line ) {
176 $line = trim( $line );
178 $this->requireHook( $line );
185 if( $section == 'endfunctionhooks' ) {
186 if( !isset( $data['functionhooks'] ) ) {
187 wfDie( "'endfunctionhooks' without 'functionhooks' at line $n of $filename\n" );
189 foreach( explode( "\n", $data['functionhooks'] ) as $line ) {
190 $line = trim( $line );
192 $this->requireFunctionHook( $line );
199 if( $section == 'end' ) {
200 if( !isset( $data['test'] ) ) {
201 wfDie( "'end' without 'test' at line $n of $filename\n" );
203 if( !isset( $data['input'] ) ) {
204 wfDie( "'end' without 'input' at line $n of $filename\n" );
206 if( !isset( $data['result'] ) ) {
207 wfDie( "'end' without 'result' at line $n of $filename\n" );
209 if( !isset( $data['options'] ) ) {
210 $data['options'] = '';
213 $data['options'] = $this->chomp( $data['options'] );
215 if (preg_match('/\\bdisabled\\b/i', $data['options'])
216 || !preg_match("/{$this->regex}/i", $data['test'])) {
222 $result = $this->runTest(
223 $this->chomp( $data['test'] ),
224 $this->chomp( $data['input'] ),
225 $this->chomp( $data['result'] ),
226 $this->chomp( $data['options'] ) );
227 $ok = $ok && $result;
228 $this->recorder->record( $this->chomp( $data['test'] ), $result );
233 if ( isset ($data[$section] ) ) {
234 wfDie( "duplicate section '$section' at line $n of $filename\n" );
236 $data[$section] = '';
240 $data[$section] .= $line;
243 if ( $this->showProgress ) {
250 * Run a given wikitext input through a freshly-constructed wiki parser,
251 * and compare the output against the expected results.
252 * Prints status and explanatory messages to stdout.
254 * @param string $input Wikitext to try rendering
255 * @param string $result Result to output
258 private function runTest( $desc, $input, $result, $opts ) {
259 if( $this->showProgress ) {
260 $this->showTesting( $desc );
263 $this->setupGlobals($opts);
266 $options = ParserOptions::newFromUser( $user );
268 if (preg_match('/\\bmath\\b/i', $opts)) {
269 # XXX this should probably be done by the ParserOptions
270 $options->setUseTex(true);
274 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
278 $titleText = 'Parser test';
281 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
283 $parser = new Parser();
284 foreach( $this->hooks as $tag => $callback ) {
285 $parser->setHook( $tag, $callback );
287 foreach( $this->functionHooks as $tag => $callback ) {
288 $parser->setFunctionHook( $tag, $callback );
290 wfRunHooks( 'ParserTestParser', array( &$parser ) );
292 $title =& Title::makeTitle( NS_MAIN, $titleText );
295 if (preg_match('/\\bpst\\b/i', $opts)) {
296 $out = $parser->preSaveTransform( $input, $title, $user, $options );
297 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
298 $out = $parser->transformMsg( $input, $options );
299 } elseif( preg_match( '/\\bsection=(\d+)\b/i', $opts, $matches ) ) {
300 $section = intval( $matches[1] );
301 $out = $parser->getSection( $input, $section );
302 } elseif( preg_match( '/\\breplace=(\d+),"(.*?)"/i', $opts, $matches ) ) {
303 $section = intval( $matches[1] );
304 $replace = $matches[2];
305 $out = $parser->replaceSection( $input, $section, $replace );
307 $output = $parser->parse( $input, $title, $options, true, true, 1337 );
308 $out = $output->getText();
310 if (preg_match('/\\bill\\b/i', $opts)) {
311 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
312 } else if (preg_match('/\\bcat\\b/i', $opts)) {
314 $wgOut->addCategoryLinks($output->getCategories());
315 $out = $this->tidy ( implode( ' ', $wgOut->getCategoryLinks() ) );
318 $result = $this->tidy($result);
321 $this->teardownGlobals();
323 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
324 return $this->showSuccess( $desc );
326 return $this->showFailure( $desc, $result, $out );
332 * Use a regex to find out the value of an option
333 * @param $regex A regex, the first group will be the value returned
334 * @param $opts Options line to look in
335 * @param $defaults Default value returned if the regex does not match
337 private static function getOptionValue( $regex, $opts, $default ) {
339 if( preg_match( $regex, $opts, $m ) ) {
347 * Set up the global variables for a consistent environment for each test.
348 * Ideally this should replace the global configuration entirely.
350 private function setupGlobals($opts = '') {
351 # Save the prefixed / quoted table names for later use when we make the temporaries.
352 $db = wfGetDB( DB_READ );
353 $this->oldTableNames = array();
354 foreach( $this->listTables() as $table ) {
355 $this->oldTableNames[$table] = $db->tableName( $table );
357 if( !isset( $this->uploadDir ) ) {
358 $this->uploadDir = $this->setupUploadDir();
361 # Find out values for some special options.
363 self::getOptionValue( '/language=([a-z]+(?:_[a-z]+)?)/', $opts, 'en' );
365 self::getOptionValue( '/variant=([a-z]+(?:-[a-z]+)?)/', $opts, false );
367 self::getOptionValue( '/wgMaxTocLevel=(\d+)/', $opts, 999 );
370 'wgServer' => 'http://localhost',
371 'wgScript' => '/index.php',
372 'wgScriptPath' => '/',
373 'wgArticlePath' => '/wiki/$1',
374 'wgActionPaths' => array(),
375 'wgLocalFileRepo' => array(
376 'class' => 'LocalRepo',
378 'directory' => $this->uploadDir,
379 'url' => 'http://example.com/images',
381 'transformVia404' => false,
383 'wgEnableUploads' => true,
384 'wgStyleSheetPath' => '/skins',
385 'wgSitename' => 'MediaWiki',
386 'wgServerName' => 'Britney Spears',
387 'wgLanguageCode' => $lang,
388 'wgContLanguageCode' => $lang,
389 'wgDBprefix' => 'parsertest_',
390 'wgRawHtml' => preg_match('/\\brawhtml\\b/i', $opts),
392 'wgContLang' => null,
393 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
394 'wgMaxTocLevel' => $maxtoclevel,
395 'wgCapitalLinks' => true,
396 'wgNoFollowLinks' => true,
397 'wgThumbnailScriptPath' => false,
399 'wgLocaltimezone' => 'UTC',
400 'wgAllowExternalImages' => true,
401 'wgUseTidy' => false,
402 'wgDefaultLanguageVariant' => $variant,
403 'wgVariantArticlePath' => false,
405 $this->savedGlobals = array();
406 foreach( $settings as $var => $val ) {
407 $this->savedGlobals[$var] = $GLOBALS[$var];
408 $GLOBALS[$var] = $val;
410 $langObj = Language::factory( $lang );
411 $GLOBALS['wgLang'] = $langObj;
412 $GLOBALS['wgContLang'] = $langObj;
414 $GLOBALS['wgLoadBalancer']->loadMasterPos();
415 //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
416 $this->setupDatabase();
419 $wgUser = new User();
423 * List of temporary tables to create, without prefix.
424 * Some of these probably aren't necessary.
426 private function listTables() {
427 $tables = array('user', 'page', 'page_restrictions', 'revision', 'text',
428 'pagelinks', 'imagelinks', 'categorylinks',
429 'templatelinks', 'externallinks', 'langlinks',
430 'site_stats', 'hitcounter',
431 'ipblocks', 'image', 'oldimage',
433 'watchlist', 'math', 'searchindex',
434 'interwiki', 'querycache',
435 'objectcache', 'job', 'redirect',
439 // Allow extensions to add to the list of tables to duplicate;
440 // may be necessary if they hook into page save or other code
441 // which will require them while running tests.
442 wfRunHooks( 'ParserTestTables', array( &$tables ) );
448 * Set up a temporary set of wiki tables to work with for the tests.
449 * Currently this will only be done once per run, and any changes to
450 * the db will be visible to later tests in the run.
452 private function setupDatabase() {
453 static $setupDB = false;
456 # Make sure we don't mess with the live DB
457 if (!$setupDB && $wgDBprefix === 'parsertest_') {
459 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
460 $db = wfGetDB( DB_MASTER );
462 $tables = $this->listTables();
464 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
465 # Database that supports CREATE TABLE ... LIKE
467 if( $wgDBtype == 'postgres' ) {
468 $def = 'INCLUDING DEFAULTS';
472 foreach ($tables as $tbl) {
473 $newTableName = $db->tableName( $tbl );
474 $tableName = $this->oldTableNames[$tbl];
475 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
478 # Hack for MySQL versions < 4.1, which don't support
479 # "CREATE TABLE ... LIKE". Note that
480 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
481 # would not create the indexes we need....
482 foreach ($tables as $tbl) {
483 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
484 $row = $db->fetchRow($res);
486 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
487 . $wgDBprefix . $tbl .'`', $create);
488 if ($create === $create_tmp) {
489 # Couldn't do replacement
490 wfDie("could not create temporary table $tbl");
492 $db->query($create_tmp);
497 # Hack: insert a few Wikipedia in-project interwiki prefixes,
498 # for testing inter-language links
499 $db->insert( 'interwiki', array(
500 array( 'iw_prefix' => 'Wikipedia',
501 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
503 array( 'iw_prefix' => 'MeatBall',
504 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
506 array( 'iw_prefix' => 'zh',
507 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
509 array( 'iw_prefix' => 'es',
510 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
512 array( 'iw_prefix' => 'fr',
513 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
515 array( 'iw_prefix' => 'ru',
516 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
520 # Hack: Insert an image to work with
521 $db->insert( 'image', array(
522 'img_name' => 'Foobar.jpg',
524 'img_description' => 'Some lame file',
526 'img_user_text' => 'WikiSysop',
527 'img_timestamp' => $db->timestamp( '20010115123500' ),
531 'img_media_type' => MEDIATYPE_BITMAP,
532 'img_major_mime' => "image",
533 'img_minor_mime' => "jpeg",
534 'img_metadata' => serialize( array() ),
537 # Update certain things in site_stats
538 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
545 * Create a dummy uploads directory which will contain a couple
546 * of files in order to pass existence tests.
547 * @return string The directory
549 private function setupUploadDir() {
551 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
552 wfDebug( "Creating upload directory $dir\n" );
554 mkdir( $dir . '/3' );
555 mkdir( $dir . '/3/3a' );
556 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
561 * Restore default values and perform any necessary clean-up
562 * after each test runs.
564 private function teardownGlobals() {
565 RepoGroup::destroySingleton();
566 foreach( $this->savedGlobals as $var => $val ) {
567 $GLOBALS[$var] = $val;
569 if( isset( $this->uploadDir ) ) {
570 $this->teardownUploadDir( $this->uploadDir );
571 unset( $this->uploadDir );
576 * Remove the dummy uploads directory
578 private function teardownUploadDir( $dir ) {
579 // delete the files first, then the dirs.
582 "$dir/3/3a/Foobar.jpg",
583 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
584 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
585 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
586 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
596 "$dir/thumb/3/3a/Foobar.jpg",
606 * @desc delete the specified files, if they exist.
607 * @param array $files full paths to files to delete.
609 private static function deleteFiles( $files ) {
610 foreach( $files as $file ) {
611 if( file_exists( $file ) ) {
618 * @desc delete the specified directories, if they exist. Must be empty.
619 * @param array $dirs full paths to directories to delete.
621 private static function deleteDirs( $dirs ) {
622 foreach( $dirs as $dir ) {
623 if( is_dir( $dir ) ) {
630 * "Running test $desc..."
632 private function showTesting( $desc ) {
633 print "Running test $desc... ";
637 * Print a happy success message.
639 * @param string $desc The test name
642 private function showSuccess( $desc ) {
643 if( $this->showProgress ) {
644 print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
650 * Print a failure message and provide some explanatory output
651 * about what went wrong if so configured.
653 * @param string $desc The test name
654 * @param string $result Expected HTML output
655 * @param string $html Actual HTML output
658 private function showFailure( $desc, $result, $html ) {
659 if( $this->showFailure ) {
660 if( !$this->showProgress ) {
661 # In quiet mode we didn't show the 'Testing' message before the
662 # test, in case it succeeded. Show it now:
663 $this->showTesting( $desc );
665 print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
666 if ( $this->showOutput ) {
667 print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
669 if( $this->showDiffs ) {
670 print $this->quickDiff( $result, $html );
671 if( !$this->wellFormed( $html ) ) {
672 print "XML error: $this->mXmlError\n";
680 * Run given strings through a diff and return the (colorized) output.
681 * Requires writable /tmp directory and a 'diff' command in the PATH.
683 * @param string $input
684 * @param string $output
685 * @param string $inFileTail Tailing for the input file name
686 * @param string $outFileTail Tailing for the output file name
689 private function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
690 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
692 $infile = "$prefix-$inFileTail";
693 $this->dumpToFile( $input, $infile );
695 $outfile = "$prefix-$outFileTail";
696 $this->dumpToFile( $output, $outfile );
698 $diff = `diff -au $infile $outfile`;
702 return $this->colorDiff( $diff );
706 * Write the given string to a file, adding a final newline.
708 * @param string $data
709 * @param string $filename
711 private function dumpToFile( $data, $filename ) {
712 $file = fopen( $filename, "wt" );
713 fwrite( $file, $data . "\n" );
718 * Colorize unified diff output if set for ANSI color output.
719 * Subtractions are colored blue, additions red.
721 * @param string $text
724 private function colorDiff( $text ) {
726 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
727 array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
728 $this->term->color( 31 ) . '$1' . $this->term->reset() ),
733 * Insert a temporary test article
734 * @param string $name the title, including any prefix
735 * @param string $text the article text
736 * @param int $line the input line number, for reporting errors
738 private function addArticle($name, $text, $line) {
739 $this->setupGlobals();
740 $title = Title::newFromText( $name );
741 if ( is_null($title) ) {
742 wfDie( "invalid title at line $line\n" );
745 $aid = $title->getArticleID( GAID_FOR_UPDATE );
747 wfDie( "duplicate article at line $line\n" );
750 $art = new Article($title);
751 $art->insertNewArticle($text, '', false, false );
752 $this->teardownGlobals();
756 * Steal a callback function from the primary parser, save it for
757 * application to our scary parser. If the hook is not installed,
758 * die a painful dead to warn the others.
759 * @param string $name
761 private function requireHook( $name ) {
763 if( isset( $wgParser->mTagHooks[$name] ) ) {
764 $this->hooks[$name] = $wgParser->mTagHooks[$name];
766 wfDie( "This test suite requires the '$name' hook extension.\n" );
771 * Steal a callback function from the primary parser, save it for
772 * application to our scary parser. If the hook is not installed,
773 * die a painful dead to warn the others.
774 * @param string $name
776 private function requireFunctionHook( $name ) {
778 if( isset( $wgParser->mFunctionHooks[$name] ) ) {
779 $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
781 wfDie( "This test suite requires the '$name' function hook extension.\n" );
786 * Run the "tidy" command on text if the $wgUseTidy
789 * @param string $text the text to tidy
793 private function tidy( $text ) {
796 $text = Parser::tidy($text);
801 private function wellFormed( $text ) {
803 Sanitizer::hackDocType() .
808 $parser = xml_parser_create( "UTF-8" );
810 # case folding violates XML standard, turn it off
811 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
813 if( !xml_parse( $parser, $html, true ) ) {
814 $err = xml_error_string( xml_get_error_code( $parser ) );
815 $position = xml_get_current_byte_index( $parser );
816 $fragment = $this->extractFragment( $html, $position );
817 $this->mXmlError = "$err at byte $position:\n$fragment";
818 xml_parser_free( $parser );
821 xml_parser_free( $parser );
825 private function extractFragment( $text, $position ) {
826 $start = max( 0, $position - 10 );
827 $before = $position - $start;
829 $this->term->color( 34 ) .
830 substr( $text, $start, $before ) .
831 $this->term->color( 0 ) .
832 $this->term->color( 31 ) .
833 $this->term->color( 1 ) .
834 substr( $text, $position, 1 ) .
835 $this->term->color( 0 ) .
836 $this->term->color( 34 ) .
837 substr( $text, $position + 1, 9 ) .
838 $this->term->color( 0 ) .
840 $display = str_replace( "\n", ' ', $fragment );
842 str_repeat( ' ', $before ) .
843 $this->term->color( 31 ) .
845 $this->term->color( 0 );
846 return "$display\n$caret";
850 class AnsiTermColorer {
851 function __construct() {
855 * Return ANSI terminal escape code for changing text attribs/color
857 * @param string $color Semicolon-separated list of attribute/color codes
860 public function color( $color ) {
861 global $wgCommandLineDarkBg;
862 $light = $wgCommandLineDarkBg ? "1;" : "0;";
863 return "\x1b[{$light}{$color}m";
867 * Return ANSI terminal escape code for restoring default text attributes
871 public function reset() {
872 return $this->color( 0 );
876 /* A colour-less terminal */
877 class DummyTermColorer {
878 public function color( $color ) {
882 public function reset() {
888 function __construct( $term ) {
897 function record( $test, $result ) {
899 $this->success += ($result ? 1 : 0);
907 if( $this->total > 0 ) {
908 $this->reportPercentage( $this->success, $this->total );
910 wfDie( "No tests found.\n" );
914 function reportPercentage( $success, $total ) {
915 $ratio = wfPercent( 100 * $success / $total );
916 print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
917 if( $success == $total ) {
918 print $this->term->color( 32 ) . "ALL TESTS PASSED!";
920 $failed = $total - $success ;
921 print $this->term->color( 31 ) . "$failed tests failed!";
923 print $this->term->reset() . "\n";
924 return ($success == $total);
928 class DbTestRecorder extends TestRecorder {
929 protected $db; ///< Database connection to the main DB
930 protected $curRun; ///< run ID number for the current run
931 protected $prevRun; ///< run ID number for the previous run, if any
933 function __construct( $term ) {
934 parent::__construct( $term );
935 $this->db = wfGetDB( DB_MASTER );
939 * Set up result recording; insert a record for the run with the date
940 * and all that fun stuff
947 if( ! $this->db->tableExists( 'testrun' ) or ! $this->db->tableExists( 'testitem') ) {
948 print "WARNING> `testrun` table not found in database. Trying to create table.\n";
949 dbsource( 'testRunner.sql', $this->db );
950 echo "OK, resuming.\n";
953 // We'll make comparisons against the previous run later...
954 $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
956 $this->db->insert( 'testrun',
958 'tr_date' => $this->db->timestamp(),
959 'tr_mw_version' => SpecialVersion::getVersion(),
960 'tr_php_version' => phpversion(),
961 'tr_db_version' => $this->db->getServerVersion(),
962 'tr_uname' => php_uname()
965 $this->curRun = $this->db->insertId();
969 * Record an individual test item's success or failure to the db
970 * @param string $test
971 * @param bool $result
973 function record( $test, $result ) {
974 parent::record( $test, $result );
975 $this->db->insert( 'testitem',
977 'ti_run' => $this->curRun,
979 'ti_success' => $result ? 1 : 0,
985 * Commit transaction and clean up for result recording
993 if( $this->prevRun ) {
995 array( 'previously failing test(s) now PASSING! :)', 0, 1 ),
996 array( 'previously PASSING test(s) removed o_O', 1, null ),
997 array( 'new PASSING test(s) :)', null, 1 ),
999 array( 'previously passing test(s) now FAILING! :(', 1, 0 ),
1000 array( 'previously FAILING test(s) removed O_o', 0, null ),
1001 array( 'new FAILING test(s) :(', null, 0 ),
1002 array( 'still FAILING test(s) :(', 0, 0 ),
1004 foreach( $table as $criteria ) {
1005 list( $label, $before, $after ) = $criteria;
1006 $differences = $this->compareResult( $before, $after );
1007 if( $differences ) {
1008 $count = count($differences);
1009 printf( "\n%4d %s\n", $count, $label );
1010 foreach ($differences as $differing_test_name => $statusInfo) {
1011 print " * $differing_test_name [$statusInfo]\n";
1016 print "No previous test runs to compare against.\n";
1023 ** Returns an array of the test names with changed results, based on the specified
1024 ** before/after criteria.
1026 private function compareResult( $before, $after ) {
1027 $testitem = $this->db->tableName( 'testitem' );
1028 $prevRun = intval( $this->prevRun );
1029 $curRun = intval( $this->curRun );
1030 $prevStatus = $this->condition( $before );
1031 $curStatus = $this->condition( $after );
1033 // note: requires mysql >= ver 4.1 for subselects
1034 if( is_null( $after ) ) {
1036 select prev.ti_name as t from $testitem as prev
1037 where prev.ti_run=$prevRun and
1038 prev.ti_success $prevStatus and
1039 (select current.ti_success from $testitem as current
1040 where current.ti_run=$curRun
1041 and prev.ti_name=current.ti_name) $curStatus";
1044 select current.ti_name as t from $testitem as current
1045 where current.ti_run=$curRun and
1046 current.ti_success $curStatus and
1047 (select prev.ti_success from $testitem as prev
1048 where prev.ti_run=$prevRun
1049 and prev.ti_name=current.ti_name) $prevStatus";
1051 $result = $this->db->query( $sql, __METHOD__ );
1053 while ($row = $this->db->fetchObject( $result )) {
1054 $testname = $row->t;
1055 $retval[$testname] = $this->getTestStatusInfo( $testname, $after, $curRun );
1057 $this->db->freeResult( $result );
1062 ** Returns a string giving information about when a test last had a status change.
1063 ** Could help to track down when regressions were introduced, as distinct from tests
1064 ** which have never passed (which are more change requests than regressions).
1066 private function getTestStatusInfo($testname, $after, $curRun) {
1068 // If we're looking at a test that has just been removed, then say when it first appeared.
1069 if ( is_null( $after ) ) {
1070 $changedRun = $this->db->selectField ( 'testitem',
1072 array( 'ti_name' => $testname ),
1074 $appear = $this->db->selectRow ( 'testrun',
1075 array( 'tr_date', 'tr_mw_version' ),
1076 array( 'tr_id' => $changedRun ),
1078 return "First recorded appearance: "
1079 . date( "d-M-Y H:i:s", strtotime ( $appear->tr_date ) )
1080 . ", " . $appear->tr_mw_version;
1083 // Otherwise, this test has previous recorded results.
1084 // See when this test last had a different result to what we're seeing now.
1085 $changedRun = $this->db->selectField ( 'testitem',
1088 'ti_name' => $testname,
1089 'ti_success' => ($after ? "0" : "1"),
1090 "ti_run != " . $this->db->addQuotes ( $curRun )
1094 // If no record of ever having had a different result.
1095 if ( is_null ( $changedRun ) ) {
1096 if ($after == "0") {
1097 return "Has never passed";
1099 return "Has never failed";
1103 // Otherwise, we're looking at a test whose status has changed.
1104 // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
1105 // In this situation, give as much info as we can as to when it changed status.
1106 $pre = $this->db->selectRow ( 'testrun',
1107 array( 'tr_date', 'tr_mw_version' ),
1108 array( 'tr_id' => $changedRun ),
1110 $post = $this->db->selectRow ( 'testrun',
1111 array( 'tr_date', 'tr_mw_version' ),
1112 array( "tr_id > " . $this->db->addQuotes ( $changedRun) ),
1114 array( "LIMIT" => 1, "ORDER BY" => 'tr_id' )
1117 return ( $after == "0" ? "Introduced" : "Fixed" ) . " between "
1118 . date( "d-M-Y H:i:s", strtotime ( $pre->tr_date ) ) . ", " . $pre->tr_mw_version
1120 . date( "d-M-Y H:i:s", strtotime ( $post->tr_date ) ) . ", " . $post->tr_mw_version ;
1124 ** Helper function for compareResult() database querying.
1126 private function condition( $value ) {
1127 if( is_null( $value ) ) {
1130 return '=' . intval( $value );
1136 class DbTestPreviewer extends DbTestRecorder {
1138 * Commit transaction and clean up for result recording
1141 $this->db->rollback();
1142 TestRecorder::end();