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 'wgStyleSheetPath' => '/skins',
384 'wgSitename' => 'MediaWiki',
385 'wgServerName' => 'Britney Spears',
386 'wgLanguageCode' => $lang,
387 'wgContLanguageCode' => $lang,
388 'wgDBprefix' => 'parsertest_',
389 'wgRawHtml' => preg_match('/\\brawhtml\\b/i', $opts),
391 'wgContLang' => null,
392 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
393 'wgMaxTocLevel' => $maxtoclevel,
394 'wgCapitalLinks' => true,
395 'wgNoFollowLinks' => true,
396 'wgThumbnailScriptPath' => false,
398 'wgLocaltimezone' => 'UTC',
399 'wgAllowExternalImages' => true,
400 'wgUseTidy' => false,
401 'wgDefaultLanguageVariant' => $variant,
402 'wgVariantArticlePath' => false,
404 $this->savedGlobals = array();
405 foreach( $settings as $var => $val ) {
406 $this->savedGlobals[$var] = $GLOBALS[$var];
407 $GLOBALS[$var] = $val;
409 $langObj = Language::factory( $lang );
410 $GLOBALS['wgLang'] = $langObj;
411 $GLOBALS['wgContLang'] = $langObj;
413 $GLOBALS['wgLoadBalancer']->loadMasterPos();
414 //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
415 $this->setupDatabase();
418 $wgUser = new User();
422 * List of temporary tables to create, without prefix.
423 * Some of these probably aren't necessary.
425 private function listTables() {
426 $tables = array('user', 'page', 'page_restrictions', 'revision', 'text',
427 'pagelinks', 'imagelinks', 'categorylinks',
428 'templatelinks', 'externallinks', 'langlinks',
429 'site_stats', 'hitcounter',
430 'ipblocks', 'image', 'oldimage',
432 'watchlist', 'math', 'searchindex',
433 'interwiki', 'querycache',
434 'objectcache', 'job', 'redirect',
438 // Allow extensions to add to the list of tables to duplicate;
439 // may be necessary if they hook into page save or other code
440 // which will require them while running tests.
441 wfRunHooks( 'ParserTestTables', array( &$tables ) );
447 * Set up a temporary set of wiki tables to work with for the tests.
448 * Currently this will only be done once per run, and any changes to
449 * the db will be visible to later tests in the run.
451 private function setupDatabase() {
452 static $setupDB = false;
455 # Make sure we don't mess with the live DB
456 if (!$setupDB && $wgDBprefix === 'parsertest_') {
458 $GLOBALS['wgLoadBalancer'] = LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] );
459 $db = wfGetDB( DB_MASTER );
461 $tables = $this->listTables();
463 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
464 # Database that supports CREATE TABLE ... LIKE
466 if( $wgDBtype == 'postgres' ) {
467 $def = 'INCLUDING DEFAULTS';
471 foreach ($tables as $tbl) {
472 $newTableName = $db->tableName( $tbl );
473 $tableName = $this->oldTableNames[$tbl];
474 $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
477 # Hack for MySQL versions < 4.1, which don't support
478 # "CREATE TABLE ... LIKE". Note that
479 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
480 # would not create the indexes we need....
481 foreach ($tables as $tbl) {
482 $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
483 $row = $db->fetchRow($res);
485 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
486 . $wgDBprefix . $tbl .'`', $create);
487 if ($create === $create_tmp) {
488 # Couldn't do replacement
489 wfDie("could not create temporary table $tbl");
491 $db->query($create_tmp);
496 # Hack: insert a few Wikipedia in-project interwiki prefixes,
497 # for testing inter-language links
498 $db->insert( 'interwiki', array(
499 array( 'iw_prefix' => 'Wikipedia',
500 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
502 array( 'iw_prefix' => 'MeatBall',
503 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
505 array( 'iw_prefix' => 'zh',
506 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
508 array( 'iw_prefix' => 'es',
509 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
511 array( 'iw_prefix' => 'fr',
512 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
514 array( 'iw_prefix' => 'ru',
515 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
519 # Hack: Insert an image to work with
520 $db->insert( 'image', array(
521 'img_name' => 'Foobar.jpg',
523 'img_description' => 'Some lame file',
525 'img_user_text' => 'WikiSysop',
526 'img_timestamp' => $db->timestamp( '20010115123500' ),
530 'img_media_type' => MEDIATYPE_BITMAP,
531 'img_major_mime' => "image",
532 'img_minor_mime' => "jpeg",
533 'img_metadata' => serialize( array() ),
536 # Update certain things in site_stats
537 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
544 * Create a dummy uploads directory which will contain a couple
545 * of files in order to pass existence tests.
546 * @return string The directory
548 private function setupUploadDir() {
550 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
551 wfDebug( "Creating upload directory $dir\n" );
553 mkdir( $dir . '/3' );
554 mkdir( $dir . '/3/3a' );
555 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
560 * Restore default values and perform any necessary clean-up
561 * after each test runs.
563 private function teardownGlobals() {
564 RepoGroup::destroySingleton();
565 foreach( $this->savedGlobals as $var => $val ) {
566 $GLOBALS[$var] = $val;
568 if( isset( $this->uploadDir ) ) {
569 $this->teardownUploadDir( $this->uploadDir );
570 unset( $this->uploadDir );
575 * Remove the dummy uploads directory
577 private function teardownUploadDir( $dir ) {
578 // delete the files first, then the dirs.
581 "$dir/3/3a/Foobar.jpg",
582 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
583 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
584 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
585 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
595 "$dir/thumb/3/3a/Foobar.jpg",
605 * @desc delete the specified files, if they exist.
606 * @param array $files full paths to files to delete.
608 private static function deleteFiles( $files ) {
609 foreach( $files as $file ) {
610 if( file_exists( $file ) ) {
617 * @desc delete the specified directories, if they exist. Must be empty.
618 * @param array $dirs full paths to directories to delete.
620 private static function deleteDirs( $dirs ) {
621 foreach( $dirs as $dir ) {
622 if( is_dir( $dir ) ) {
629 * "Running test $desc..."
631 private function showTesting( $desc ) {
632 print "Running test $desc... ";
636 * Print a happy success message.
638 * @param string $desc The test name
641 private function showSuccess( $desc ) {
642 if( $this->showProgress ) {
643 print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
649 * Print a failure message and provide some explanatory output
650 * about what went wrong if so configured.
652 * @param string $desc The test name
653 * @param string $result Expected HTML output
654 * @param string $html Actual HTML output
657 private function showFailure( $desc, $result, $html ) {
658 if( $this->showFailure ) {
659 if( !$this->showProgress ) {
660 # In quiet mode we didn't show the 'Testing' message before the
661 # test, in case it succeeded. Show it now:
662 $this->showTesting( $desc );
664 print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
665 if ( $this->showOutput ) {
666 print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
668 if( $this->showDiffs ) {
669 print $this->quickDiff( $result, $html );
670 if( !$this->wellFormed( $html ) ) {
671 print "XML error: $this->mXmlError\n";
679 * Run given strings through a diff and return the (colorized) output.
680 * Requires writable /tmp directory and a 'diff' command in the PATH.
682 * @param string $input
683 * @param string $output
684 * @param string $inFileTail Tailing for the input file name
685 * @param string $outFileTail Tailing for the output file name
688 private function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
689 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
691 $infile = "$prefix-$inFileTail";
692 $this->dumpToFile( $input, $infile );
694 $outfile = "$prefix-$outFileTail";
695 $this->dumpToFile( $output, $outfile );
697 $diff = `diff -au $infile $outfile`;
701 return $this->colorDiff( $diff );
705 * Write the given string to a file, adding a final newline.
707 * @param string $data
708 * @param string $filename
710 private function dumpToFile( $data, $filename ) {
711 $file = fopen( $filename, "wt" );
712 fwrite( $file, $data . "\n" );
717 * Colorize unified diff output if set for ANSI color output.
718 * Subtractions are colored blue, additions red.
720 * @param string $text
723 private function colorDiff( $text ) {
725 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
726 array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
727 $this->term->color( 31 ) . '$1' . $this->term->reset() ),
732 * Insert a temporary test article
733 * @param string $name the title, including any prefix
734 * @param string $text the article text
735 * @param int $line the input line number, for reporting errors
737 private function addArticle($name, $text, $line) {
738 $this->setupGlobals();
739 $title = Title::newFromText( $name );
740 if ( is_null($title) ) {
741 wfDie( "invalid title at line $line\n" );
744 $aid = $title->getArticleID( GAID_FOR_UPDATE );
746 wfDie( "duplicate article at line $line\n" );
749 $art = new Article($title);
750 $art->insertNewArticle($text, '', false, false );
751 $this->teardownGlobals();
755 * Steal a callback function from the primary parser, save it for
756 * application to our scary parser. If the hook is not installed,
757 * die a painful dead to warn the others.
758 * @param string $name
760 private function requireHook( $name ) {
762 if( isset( $wgParser->mTagHooks[$name] ) ) {
763 $this->hooks[$name] = $wgParser->mTagHooks[$name];
765 wfDie( "This test suite requires the '$name' hook extension.\n" );
770 * Steal a callback function from the primary parser, save it for
771 * application to our scary parser. If the hook is not installed,
772 * die a painful dead to warn the others.
773 * @param string $name
775 private function requireFunctionHook( $name ) {
777 if( isset( $wgParser->mFunctionHooks[$name] ) ) {
778 $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
780 wfDie( "This test suite requires the '$name' function hook extension.\n" );
785 * Run the "tidy" command on text if the $wgUseTidy
788 * @param string $text the text to tidy
792 private function tidy( $text ) {
795 $text = Parser::tidy($text);
800 private function wellFormed( $text ) {
802 Sanitizer::hackDocType() .
807 $parser = xml_parser_create( "UTF-8" );
809 # case folding violates XML standard, turn it off
810 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
812 if( !xml_parse( $parser, $html, true ) ) {
813 $err = xml_error_string( xml_get_error_code( $parser ) );
814 $position = xml_get_current_byte_index( $parser );
815 $fragment = $this->extractFragment( $html, $position );
816 $this->mXmlError = "$err at byte $position:\n$fragment";
817 xml_parser_free( $parser );
820 xml_parser_free( $parser );
824 private function extractFragment( $text, $position ) {
825 $start = max( 0, $position - 10 );
826 $before = $position - $start;
828 $this->term->color( 34 ) .
829 substr( $text, $start, $before ) .
830 $this->term->color( 0 ) .
831 $this->term->color( 31 ) .
832 $this->term->color( 1 ) .
833 substr( $text, $position, 1 ) .
834 $this->term->color( 0 ) .
835 $this->term->color( 34 ) .
836 substr( $text, $position + 1, 9 ) .
837 $this->term->color( 0 ) .
839 $display = str_replace( "\n", ' ', $fragment );
841 str_repeat( ' ', $before ) .
842 $this->term->color( 31 ) .
844 $this->term->color( 0 );
845 return "$display\n$caret";
849 class AnsiTermColorer {
850 function __construct() {
854 * Return ANSI terminal escape code for changing text attribs/color
856 * @param string $color Semicolon-separated list of attribute/color codes
859 public function color( $color ) {
860 global $wgCommandLineDarkBg;
861 $light = $wgCommandLineDarkBg ? "1;" : "0;";
862 return "\x1b[{$light}{$color}m";
866 * Return ANSI terminal escape code for restoring default text attributes
870 public function reset() {
871 return $this->color( 0 );
875 /* A colour-less terminal */
876 class DummyTermColorer {
877 public function color( $color ) {
881 public function reset() {
887 function __construct( $term ) {
896 function record( $test, $result ) {
898 $this->success += ($result ? 1 : 0);
906 if( $this->total > 0 ) {
907 $this->reportPercentage( $this->success, $this->total );
909 wfDie( "No tests found.\n" );
913 function reportPercentage( $success, $total ) {
914 $ratio = wfPercent( 100 * $success / $total );
915 print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
916 if( $success == $total ) {
917 print $this->term->color( 32 ) . "ALL TESTS PASSED!";
919 $failed = $total - $success ;
920 print $this->term->color( 31 ) . "$failed tests failed!";
922 print $this->term->reset() . "\n";
923 return ($success == $total);
927 class DbTestRecorder extends TestRecorder {
928 protected $db; ///< Database connection to the main DB
929 protected $curRun; ///< run ID number for the current run
930 protected $prevRun; ///< run ID number for the previous run, if any
932 function __construct( $term ) {
933 parent::__construct( $term );
934 $this->db = wfGetDB( DB_MASTER );
938 * Set up result recording; insert a record for the run with the date
939 * and all that fun stuff
946 if( ! $this->db->tableExists( 'testrun' ) or ! $this->db->tableExists( 'testitem') ) {
947 print "WARNING> `testrun` table not found in database. Trying to create table.\n";
948 dbsource( 'testRunner.sql', $this->db );
949 echo "OK, resuming.\n";
952 // We'll make comparisons against the previous run later...
953 $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
955 $this->db->insert( 'testrun',
957 'tr_date' => $this->db->timestamp(),
958 'tr_mw_version' => SpecialVersion::getVersion(),
959 'tr_php_version' => phpversion(),
960 'tr_db_version' => $this->db->getServerVersion(),
961 'tr_uname' => php_uname()
964 $this->curRun = $this->db->insertId();
968 * Record an individual test item's success or failure to the db
969 * @param string $test
970 * @param bool $result
972 function record( $test, $result ) {
973 parent::record( $test, $result );
974 $this->db->insert( 'testitem',
976 'ti_run' => $this->curRun,
978 'ti_success' => $result ? 1 : 0,
984 * Commit transaction and clean up for result recording
992 if( $this->prevRun ) {
994 array( 'previously failing test(s) now PASSING! :)', 0, 1 ),
995 array( 'previously PASSING test(s) removed o_O', 1, null ),
996 array( 'new PASSING test(s) :)', null, 1 ),
998 array( 'previously passing test(s) now FAILING! :(', 1, 0 ),
999 array( 'previously FAILING test(s) removed O_o', 0, null ),
1000 array( 'new FAILING test(s) :(', null, 0 ),
1001 array( 'still FAILING test(s) :(', 0, 0 ),
1003 foreach( $table as $criteria ) {
1004 list( $label, $before, $after ) = $criteria;
1005 $differences = $this->compareResult( $before, $after );
1006 if( $differences ) {
1007 $count = count($differences);
1008 printf( "\n%4d %s\n", $count, $label );
1009 foreach ($differences as $differing_test_name => $statusInfo) {
1010 print " * $differing_test_name [$statusInfo]\n";
1015 print "No previous test runs to compare against.\n";
1022 ** Returns an array of the test names with changed results, based on the specified
1023 ** before/after criteria.
1025 private function compareResult( $before, $after ) {
1026 $testitem = $this->db->tableName( 'testitem' );
1027 $prevRun = intval( $this->prevRun );
1028 $curRun = intval( $this->curRun );
1029 $prevStatus = $this->condition( $before );
1030 $curStatus = $this->condition( $after );
1032 // note: requires mysql >= ver 4.1 for subselects
1033 if( is_null( $after ) ) {
1035 select prev.ti_name as t from $testitem as prev
1036 where prev.ti_run=$prevRun and
1037 prev.ti_success $prevStatus and
1038 (select current.ti_success from $testitem as current
1039 where current.ti_run=$curRun
1040 and prev.ti_name=current.ti_name) $curStatus";
1043 select current.ti_name as t from $testitem as current
1044 where current.ti_run=$curRun and
1045 current.ti_success $curStatus and
1046 (select prev.ti_success from $testitem as prev
1047 where prev.ti_run=$prevRun
1048 and prev.ti_name=current.ti_name) $prevStatus";
1050 $result = $this->db->query( $sql, __METHOD__ );
1052 while ($row = $this->db->fetchObject( $result )) {
1053 $testname = $row->t;
1054 $retval[$testname] = $this->getTestStatusInfo( $testname, $after, $curRun );
1056 $this->db->freeResult( $result );
1061 ** Returns a string giving information about when a test last had a status change.
1062 ** Could help to track down when regressions were introduced, as distinct from tests
1063 ** which have never passed (which are more change requests than regressions).
1065 private function getTestStatusInfo($testname, $after, $curRun) {
1067 // If we're looking at a test that has just been removed, then say when it first appeared.
1068 if ( is_null( $after ) ) {
1069 $changedRun = $this->db->selectField ( 'testitem',
1071 array( 'ti_name' => $testname ),
1073 $appear = $this->db->selectRow ( 'testrun',
1074 array( 'tr_date', 'tr_mw_version' ),
1075 array( 'tr_id' => $changedRun ),
1077 return "First recorded appearance: "
1078 . date( "d-M-Y H:i:s", strtotime ( $appear->tr_date ) )
1079 . ", " . $appear->tr_mw_version;
1082 // Otherwise, this test has previous recorded results.
1083 // See when this test last had a different result to what we're seeing now.
1084 $changedRun = $this->db->selectField ( 'testitem',
1087 'ti_name' => $testname,
1088 'ti_success' => ($after ? "0" : "1"),
1089 "ti_run != " . $this->db->addQuotes ( $curRun )
1093 // If no record of ever having had a different result.
1094 if ( is_null ( $changedRun ) ) {
1095 if ($after == "0") {
1096 return "Has never passed";
1098 return "Has never failed";
1102 // Otherwise, we're looking at a test whose status has changed.
1103 // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
1104 // In this situation, give as much info as we can as to when it changed status.
1105 $pre = $this->db->selectRow ( 'testrun',
1106 array( 'tr_date', 'tr_mw_version' ),
1107 array( 'tr_id' => $changedRun ),
1109 $post = $this->db->selectRow ( 'testrun',
1110 array( 'tr_date', 'tr_mw_version' ),
1111 array( "tr_id > " . $this->db->addQuotes ( $changedRun) ),
1113 array( "LIMIT" => 1, "ORDER BY" => 'tr_id' )
1116 return ( $after == "0" ? "Introduced" : "Fixed" ) . " between "
1117 . date( "d-M-Y H:i:s", strtotime ( $pre->tr_date ) ) . ", " . $pre->tr_mw_version
1119 . date( "d-M-Y H:i:s", strtotime ( $post->tr_date ) ) . ", " . $post->tr_mw_version ;
1123 ** Helper function for compareResult() database querying.
1125 private function condition( $value ) {
1126 if( is_null( $value ) ) {
1129 return '=' . intval( $value );
1135 class DbTestPreviewer extends DbTestRecorder {
1137 * Commit transaction and clean up for result recording
1140 $this->db->rollback();
1141 TestRecorder::end();