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)
24 * @ingroup Maintenance
28 $options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record' );
29 $optionsWithArgs = array( 'regex', 'seed' );
31 require_once( 'commandLine.inc' );
32 require_once( "$IP/maintenance/parserTestsParserHook.php" );
33 require_once( "$IP/maintenance/parserTestsStaticParserHook.php" );
34 require_once( "$IP/maintenance/parserTestsParserTime.php" );
37 * @ingroup Maintenance
41 * boolean $color whereas output should be colorized
46 * boolean $showOutput Show test output
51 * boolean $useTemporaryTables Use temporary tables for the temporary database
53 private $useTemporaryTables = true;
56 * boolean $databaseSetupDone True if the database has been set up
58 private $databaseSetupDone = false;
61 * string $oldTablePrefix Original table prefix
63 private $oldTablePrefix;
65 private $maxFuzzTestLength = 300;
66 private $fuzzSeed = 0;
67 private $memoryLimit = 50;
70 * Sets terminal colorization and diff/quick modes depending on OS and
71 * command-line options (--color and --quick).
73 public function ParserTest() {
76 # Only colorize output if stdout is a terminal.
77 $this->color = !wfIsWindows() && posix_isatty(1);
79 if( isset( $options['color'] ) ) {
80 switch( $options['color'] ) {
90 $this->term = $this->color
91 ? new AnsiTermColorer()
92 : new DummyTermColorer();
94 $this->showDiffs = !isset( $options['quick'] );
95 $this->showProgress = !isset( $options['quiet'] );
96 $this->showFailure = !(
97 isset( $options['quiet'] )
98 && ( isset( $options['record'] )
99 || isset( $options['compare'] ) ) ); // redundant output
101 $this->showOutput = isset( $options['show-output'] );
104 if (isset($options['regex'])) {
105 if ( isset( $options['record'] ) ) {
106 echo "Warning: --record cannot be used with --regex, disabling --record\n";
107 unset( $options['record'] );
109 $this->regex = $options['regex'];
115 if( isset( $options['record'] ) ) {
116 $this->recorder = new DbTestRecorder( $this );
117 } elseif( isset( $options['compare'] ) ) {
118 $this->recorder = new DbTestPreviewer( $this );
120 $this->recorder = new TestRecorder( $this );
122 $this->keepUploads = isset( $options['keep-uploads'] );
124 if ( isset( $options['seed'] ) ) {
125 $this->fuzzSeed = intval( $options['seed'] ) - 1;
128 $this->hooks = array();
129 $this->functionHooks = array();
133 * Remove last character if it is a newline
135 private function chomp($s) {
136 if (substr($s, -1) === "\n") {
137 return substr($s, 0, -1);
145 * Run a fuzz test series
146 * Draw input from a set of test files
148 function fuzzTest( $filenames ) {
149 $dict = $this->getFuzzInput( $filenames );
150 $dictSize = strlen( $dict );
151 $logMaxLength = log( $this->maxFuzzTestLength );
152 $this->setupDatabase();
153 ini_set( 'memory_limit', $this->memoryLimit * 1048576 );
158 $opts = ParserOptions::newFromUser( $user );
159 $title = Title::makeTitle( NS_MAIN, 'Parser_test' );
162 // Generate test input
163 mt_srand( ++$this->fuzzSeed );
164 $totalLength = mt_rand( 1, $this->maxFuzzTestLength );
166 while ( strlen( $input ) < $totalLength ) {
167 $logHairLength = mt_rand( 0, 1000000 ) / 1000000 * $logMaxLength;
168 $hairLength = min( intval( exp( $logHairLength ) ), $dictSize );
169 $offset = mt_rand( 0, $dictSize - $hairLength );
170 $input .= substr( $dict, $offset, $hairLength );
173 $this->setupGlobals();
174 $parser = $this->getParser();
177 $parser->parse( $input, $title, $opts );
179 } catch ( Exception $exception ) {
184 echo "Test failed with seed {$this->fuzzSeed}\n";
193 $this->teardownGlobals();
194 $parser->__destruct();
196 if ( $numTotal % 100 == 0 ) {
197 $usage = intval( memory_get_usage( true ) / $this->memoryLimit / 1048576 * 100 );
198 echo "{$this->fuzzSeed}: $numSuccess/$numTotal (mem: $usage%)\n";
200 echo "Out of memory:\n";
201 $memStats = $this->getMemoryBreakdown();
202 foreach ( $memStats as $name => $usage ) {
203 echo "$name: $usage\n";
212 * Get an input dictionary from a set of parser test files
214 function getFuzzInput( $filenames ) {
216 foreach( $filenames as $filename ) {
217 $contents = file_get_contents( $filename );
218 preg_match_all( '/!!\s*input\n(.*?)\n!!\s*result/s', $contents, $matches );
219 foreach ( $matches[1] as $match ) {
220 $dict .= $match . "\n";
227 * Get a memory usage breakdown
229 function getMemoryBreakdown() {
231 foreach ( $GLOBALS as $name => $value ) {
232 $memStats['$'.$name] = strlen( serialize( $value ) );
234 $classes = get_declared_classes();
235 foreach ( $classes as $class ) {
236 $rc = new ReflectionClass( $class );
237 $props = $rc->getStaticProperties();
238 $memStats[$class] = strlen( serialize( $props ) );
239 $methods = $rc->getMethods();
240 foreach ( $methods as $method ) {
241 $memStats[$class] += strlen( serialize( $method->getStaticVariables() ) );
244 $functions = get_defined_functions();
245 foreach ( $functions['user'] as $function ) {
246 $rf = new ReflectionFunction( $function );
247 $memStats["$function()"] = strlen( serialize( $rf->getStaticVariables() ) );
258 * Run a series of tests listed in the given text files.
259 * Each test consists of a brief description, wikitext input,
260 * and the expected HTML output.
262 * Prints status updates on stdout and counts up the total
263 * number and percentage of passed tests.
265 * @param array of strings $filenames
266 * @return bool True if passed all tests, false if any tests failed.
268 public function runTestsFromFiles( $filenames ) {
269 $this->recorder->start();
270 $this->setupDatabase();
272 foreach( $filenames as $filename ) {
273 $ok = $this->runFile( $filename ) && $ok;
275 $this->teardownDatabase();
276 $this->recorder->report();
277 $this->recorder->end();
281 private function runFile( $filename ) {
282 $infile = fopen( $filename, 'rt' );
284 wfDie( "Couldn't open $filename\n" );
287 $relative = wfRelativePath( $filename, $IP );
288 $this->showRunFile( $relative );
295 while( false !== ($line = fgets( $infile ) ) ) {
298 if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
299 $section = strtolower( $matches[1] );
300 if( $section == 'endarticle') {
301 if( !isset( $data['text'] ) ) {
302 wfDie( "'endarticle' without 'text' at line $n of $filename\n" );
304 if( !isset( $data['article'] ) ) {
305 wfDie( "'endarticle' without 'article' at line $n of $filename\n" );
307 $this->addArticle($this->chomp($data['article']), $this->chomp($data['text']), $n);
312 if( $section == 'endhooks' ) {
313 if( !isset( $data['hooks'] ) ) {
314 wfDie( "'endhooks' without 'hooks' at line $n of $filename\n" );
316 foreach( explode( "\n", $data['hooks'] ) as $line ) {
317 $line = trim( $line );
319 $this->requireHook( $line );
326 if( $section == 'endfunctionhooks' ) {
327 if( !isset( $data['functionhooks'] ) ) {
328 wfDie( "'endfunctionhooks' without 'functionhooks' at line $n of $filename\n" );
330 foreach( explode( "\n", $data['functionhooks'] ) as $line ) {
331 $line = trim( $line );
333 $this->requireFunctionHook( $line );
340 if( $section == 'end' ) {
341 if( !isset( $data['test'] ) ) {
342 wfDie( "'end' without 'test' at line $n of $filename\n" );
344 if( !isset( $data['input'] ) ) {
345 wfDie( "'end' without 'input' at line $n of $filename\n" );
347 if( !isset( $data['result'] ) ) {
348 wfDie( "'end' without 'result' at line $n of $filename\n" );
350 if( !isset( $data['options'] ) ) {
351 $data['options'] = '';
354 $data['options'] = $this->chomp( $data['options'] );
356 if (preg_match('/\\bdisabled\\b/i', $data['options'])
357 || !preg_match("/{$this->regex}/i", $data['test'])) {
363 $result = $this->runTest(
364 $this->chomp( $data['test'] ),
365 $this->chomp( $data['input'] ),
366 $this->chomp( $data['result'] ),
367 $this->chomp( $data['options'] ) );
368 $ok = $ok && $result;
369 $this->recorder->record( $this->chomp( $data['test'] ), $result );
374 if ( isset ($data[$section] ) ) {
375 wfDie( "duplicate section '$section' at line $n of $filename\n" );
377 $data[$section] = '';
381 $data[$section] .= $line;
384 if ( $this->showProgress ) {
391 * Get a Parser object
393 function getParser() {
394 global $wgParserConf;
395 $class = $wgParserConf['class'];
396 $parser = new $class( $wgParserConf );
397 foreach( $this->hooks as $tag => $callback ) {
398 $parser->setHook( $tag, $callback );
400 foreach( $this->functionHooks as $tag => $bits ) {
401 list( $callback, $flags ) = $bits;
402 $parser->setFunctionHook( $tag, $callback, $flags );
404 wfRunHooks( 'ParserTestParser', array( &$parser ) );
409 * Run a given wikitext input through a freshly-constructed wiki parser,
410 * and compare the output against the expected results.
411 * Prints status and explanatory messages to stdout.
413 * @param string $input Wikitext to try rendering
414 * @param string $result Result to output
417 private function runTest( $desc, $input, $result, $opts ) {
418 if( $this->showProgress ) {
419 $this->showTesting( $desc );
422 $this->setupGlobals($opts);
425 $options = ParserOptions::newFromUser( $user );
427 if (preg_match('/\\bmath\\b/i', $opts)) {
428 # XXX this should probably be done by the ParserOptions
429 $options->setUseTex(true);
433 if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
437 $titleText = 'Parser test';
440 $noxml = (bool)preg_match( '~\\b noxml \\b~x', $opts );
441 $parser = $this->getParser();
442 $title =& Title::makeTitle( NS_MAIN, $titleText );
445 if (preg_match('/\\bpst\\b/i', $opts)) {
446 $out = $parser->preSaveTransform( $input, $title, $user, $options );
447 } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
448 $out = $parser->transformMsg( $input, $options );
449 } elseif( preg_match( '/\\bsection=([\w-]+)\b/i', $opts, $matches ) ) {
450 $section = $matches[1];
451 $out = $parser->getSection( $input, $section );
452 } elseif( preg_match( '/\\breplace=([\w-]+),"(.*?)"/i', $opts, $matches ) ) {
453 $section = $matches[1];
454 $replace = $matches[2];
455 $out = $parser->replaceSection( $input, $section, $replace );
457 $output = $parser->parse( $input, $title, $options, true, true, 1337 );
458 $out = $output->getText();
460 if (preg_match('/\\bill\\b/i', $opts)) {
461 $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
462 } else if (preg_match('/\\bcat\\b/i', $opts)) {
464 $wgOut->addCategoryLinks($output->getCategories());
465 $cats = $wgOut->getCategoryLinks();
466 if ( isset( $cats['normal'] ) ) {
467 $out = $this->tidy( implode( ' ', $cats['normal'] ) );
473 $result = $this->tidy($result);
476 $this->teardownGlobals();
478 if( $result === $out && ( $noxml === true || $this->wellFormed( $out ) ) ) {
479 return $this->showSuccess( $desc );
481 return $this->showFailure( $desc, $result, $out );
487 * Use a regex to find out the value of an option
488 * @param $regex A regex, the first group will be the value returned
489 * @param $opts Options line to look in
490 * @param $defaults Default value returned if the regex does not match
492 private static function getOptionValue( $regex, $opts, $default ) {
494 if( preg_match( $regex, $opts, $m ) ) {
502 * Set up the global variables for a consistent environment for each test.
503 * Ideally this should replace the global configuration entirely.
505 private function setupGlobals($opts = '') {
506 if( !isset( $this->uploadDir ) ) {
507 $this->uploadDir = $this->setupUploadDir();
510 # Find out values for some special options.
512 self::getOptionValue( '/language=([a-z]+(?:_[a-z]+)?)/', $opts, 'en' );
514 self::getOptionValue( '/variant=([a-z]+(?:-[a-z]+)?)/', $opts, false );
516 self::getOptionValue( '/wgMaxTocLevel=(\d+)/', $opts, 999 );
517 $linkHolderBatchSize =
518 self::getOptionValue( '/wgLinkHolderBatchSize=(\d+)/', $opts, 1000 );
521 'wgServer' => 'http://localhost',
522 'wgScript' => '/index.php',
523 'wgScriptPath' => '/',
524 'wgArticlePath' => '/wiki/$1',
525 'wgActionPaths' => array(),
526 'wgLocalFileRepo' => array(
527 'class' => 'LocalRepo',
529 'directory' => $this->uploadDir,
530 'url' => 'http://example.com/images',
532 'transformVia404' => false,
534 'wgEnableUploads' => true,
535 'wgStyleSheetPath' => '/skins',
536 'wgSitename' => 'MediaWiki',
537 'wgServerName' => 'Britney Spears',
538 'wgLanguageCode' => $lang,
539 'wgContLanguageCode' => $lang,
540 'wgDBprefix' => 'parsertest_',
541 'wgRawHtml' => preg_match('/\\brawhtml\\b/i', $opts),
543 'wgContLang' => null,
544 'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
545 'wgMaxTocLevel' => $maxtoclevel,
546 'wgCapitalLinks' => true,
547 'wgNoFollowLinks' => true,
548 'wgThumbnailScriptPath' => false,
550 'wgLocaltimezone' => 'UTC',
551 'wgAllowExternalImages' => true,
552 'wgUseTidy' => false,
553 'wgDefaultLanguageVariant' => $variant,
554 'wgVariantArticlePath' => false,
555 'wgGroupPermissions' => array( '*' => array(
556 'createaccount' => true,
559 'createpage' => true,
560 'createtalk' => true,
562 'wgNamespaceProtection' => array( NS_MEDIAWIKI => 'editinterface' ),
563 'wgDefaultExternalStore' => array(),
564 'wgForeignFileRepos' => array(),
565 'wgLinkHolderBatchSize' => $linkHolderBatchSize,
567 $this->savedGlobals = array();
568 foreach( $settings as $var => $val ) {
569 $this->savedGlobals[$var] = $GLOBALS[$var];
570 $GLOBALS[$var] = $val;
572 $langObj = Language::factory( $lang );
573 $GLOBALS['wgLang'] = $langObj;
574 $GLOBALS['wgContLang'] = $langObj;
575 $GLOBALS['wgMemc'] = new FakeMemCachedClient;
577 //$GLOBALS['wgMessageCache'] = new MessageCache( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
580 $wgUser = new User();
584 * List of temporary tables to create, without prefix.
585 * Some of these probably aren't necessary.
587 private function listTables() {
589 $tables = array('user', 'page', 'page_restrictions',
590 'protected_titles', 'revision', 'text', 'pagelinks', 'imagelinks',
591 'categorylinks', 'templatelinks', 'externallinks', 'langlinks',
592 'site_stats', 'hitcounter', 'ipblocks', 'image', 'oldimage',
593 'recentchanges', 'watchlist', 'math', 'interwiki',
594 'querycache', 'objectcache', 'job', 'redirect', 'querycachetwo',
595 'archive', 'user_groups', 'page_props', 'category'
598 if ($wgDBtype === 'mysql')
599 array_push( $tables, 'searchindex' );
601 // Allow extensions to add to the list of tables to duplicate;
602 // may be necessary if they hook into page save or other code
603 // which will require them while running tests.
604 wfRunHooks( 'ParserTestTables', array( &$tables ) );
610 * Set up a temporary set of wiki tables to work with for the tests.
611 * Currently this will only be done once per run, and any changes to
612 * the db will be visible to later tests in the run.
614 private function setupDatabase() {
616 if ( $this->databaseSetupDone ) {
619 if ( $wgDBprefix === 'parsertest_' ) {
620 throw new MWException( 'setupDatabase should be called before setupGlobals' );
622 $this->databaseSetupDone = true;
623 $this->oldTablePrefix = $wgDBprefix;
625 # CREATE TEMPORARY TABLE breaks if there is more than one server
626 # FIXME: r40209 makes temporary tables break even with just one server
627 # FIXME: (bug 15892); disabling the feature entirely as a temporary fix
628 if ( true || wfGetLB()->getServerCount() != 1 ) {
629 $this->useTemporaryTables = false;
632 $temporary = $this->useTemporaryTables ? 'TEMPORARY' : '';
634 $db = wfGetDB( DB_MASTER );
635 $tables = $this->listTables();
637 if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
638 # Database that supports CREATE TABLE ... LIKE
640 if( $wgDBtype == 'postgres' ) {
641 $def = 'INCLUDING DEFAULTS';
645 foreach ($tables as $tbl) {
646 # Clean up from previous aborted run. So that table escaping
647 # works correctly across DB engines, we need to change the pre-
648 # fix back and forth so tableName() works right.
649 $this->changePrefix( $this->oldTablePrefix );
650 $oldTableName = $db->tableName( $tbl );
651 $this->changePrefix( 'parsertest_' );
652 $newTableName = $db->tableName( $tbl );
654 if ( $db->tableExists( $tbl ) ) {
655 $db->query("DROP TABLE $newTableName");
658 $db->query("CREATE $temporary TABLE $newTableName (LIKE $oldTableName $def)");
661 # Hack for MySQL versions < 4.1, which don't support
662 # "CREATE TABLE ... LIKE". Note that
663 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
664 # would not create the indexes we need....
666 # Note that we don't bother changing around the prefixes here be-
667 # cause we know we're using MySQL anyway.
668 foreach ($tables as $tbl) {
669 $oldTableName = $db->tableName( $tbl );
670 $res = $db->query("SHOW CREATE TABLE $oldTableName");
671 $row = $db->fetchRow($res);
673 $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/',
674 "CREATE $temporary TABLE `parsertest_$tbl`", $create);
675 if ($create === $create_tmp) {
676 # Couldn't do replacement
677 wfDie("could not create temporary table $tbl");
679 $db->query($create_tmp);
683 $this->changePrefix( 'parsertest_' );
685 # Hack: insert a few Wikipedia in-project interwiki prefixes,
686 # for testing inter-language links
687 $db->insert( 'interwiki', array(
688 array( 'iw_prefix' => 'wikipedia',
689 'iw_url' => 'http://en.wikipedia.org/wiki/$1',
691 array( 'iw_prefix' => 'meatball',
692 'iw_url' => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
694 array( 'iw_prefix' => 'zh',
695 'iw_url' => 'http://zh.wikipedia.org/wiki/$1',
697 array( 'iw_prefix' => 'es',
698 'iw_url' => 'http://es.wikipedia.org/wiki/$1',
700 array( 'iw_prefix' => 'fr',
701 'iw_url' => 'http://fr.wikipedia.org/wiki/$1',
703 array( 'iw_prefix' => 'ru',
704 'iw_url' => 'http://ru.wikipedia.org/wiki/$1',
708 # Hack: Insert an image to work with
709 $db->insert( 'image', array(
710 'img_name' => 'Foobar.jpg',
712 'img_description' => 'Some lame file',
714 'img_user_text' => 'WikiSysop',
715 'img_timestamp' => $db->timestamp( '20010115123500' ),
719 'img_media_type' => MEDIATYPE_BITMAP,
720 'img_major_mime' => "image",
721 'img_minor_mime' => "jpeg",
722 'img_metadata' => serialize( array() ),
725 # Update certain things in site_stats
726 $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
730 * Change the table prefix on all open DB connections/
732 protected function changePrefix( $prefix ) {
734 wfGetLBFactory()->forEachLB( array( $this, 'changeLBPrefix' ), array( $prefix ) );
735 $wgDBprefix = $prefix;
738 public function changeLBPrefix( $lb, $prefix ) {
739 $lb->forEachOpenConnection( array( $this, 'changeDBPrefix' ), array( $prefix ) );
742 public function changeDBPrefix( $db, $prefix ) {
743 $db->tablePrefix( $prefix );
746 private function teardownDatabase() {
748 if ( !$this->databaseSetupDone ) {
751 $this->changePrefix( $this->oldTablePrefix );
752 $this->databaseSetupDone = false;
753 if ( $this->useTemporaryTables ) {
754 # Don't need to do anything
759 $tables = $this->listTables();
760 $db = wfGetDB( DB_MASTER );
761 foreach ( $tables as $table ) {
762 $db->query( "DROP TABLE `parsertest_$table`" );
767 * Create a dummy uploads directory which will contain a couple
768 * of files in order to pass existence tests.
769 * @return string The directory
771 private function setupUploadDir() {
773 if ( $this->keepUploads ) {
774 $dir = wfTempDir() . '/mwParser-images';
775 if ( is_dir( $dir ) ) {
779 $dir = wfTempDir() . "/mwParser-" . mt_rand() . "-images";
782 wfDebug( "Creating upload directory $dir\n" );
783 if ( file_exists( $dir ) ) {
784 wfDebug( "Already exists!\n" );
787 wfMkdirParents( $dir . '/3/3a' );
788 copy( "$IP/skins/monobook/headbg.jpg", "$dir/3/3a/Foobar.jpg" );
793 * Restore default values and perform any necessary clean-up
794 * after each test runs.
796 private function teardownGlobals() {
797 RepoGroup::destroySingleton();
798 FileCache::destroySingleton();
799 LinkCache::singleton()->clear();
800 foreach( $this->savedGlobals as $var => $val ) {
801 $GLOBALS[$var] = $val;
803 if( isset( $this->uploadDir ) ) {
804 $this->teardownUploadDir( $this->uploadDir );
805 unset( $this->uploadDir );
810 * Remove the dummy uploads directory
812 private function teardownUploadDir( $dir ) {
813 if ( $this->keepUploads ) {
817 // delete the files first, then the dirs.
820 "$dir/3/3a/Foobar.jpg",
821 "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
822 "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
823 "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
824 "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
834 "$dir/thumb/3/3a/Foobar.jpg",
844 * Delete the specified files, if they exist.
845 * @param array $files full paths to files to delete.
847 private static function deleteFiles( $files ) {
848 foreach( $files as $file ) {
849 if( file_exists( $file ) ) {
856 * Delete the specified directories, if they exist. Must be empty.
857 * @param array $dirs full paths to directories to delete.
859 private static function deleteDirs( $dirs ) {
860 foreach( $dirs as $dir ) {
861 if( is_dir( $dir ) ) {
868 * "Running test $desc..."
870 protected function showTesting( $desc ) {
871 print "Running test $desc... ";
875 * Print a happy success message.
877 * @param string $desc The test name
880 protected function showSuccess( $desc ) {
881 if( $this->showProgress ) {
882 print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
888 * Print a failure message and provide some explanatory output
889 * about what went wrong if so configured.
891 * @param string $desc The test name
892 * @param string $result Expected HTML output
893 * @param string $html Actual HTML output
896 protected function showFailure( $desc, $result, $html ) {
897 if( $this->showFailure ) {
898 if( !$this->showProgress ) {
899 # In quiet mode we didn't show the 'Testing' message before the
900 # test, in case it succeeded. Show it now:
901 $this->showTesting( $desc );
903 print $this->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
904 if ( $this->showOutput ) {
905 print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
907 if( $this->showDiffs ) {
908 print $this->quickDiff( $result, $html );
909 if( !$this->wellFormed( $html ) ) {
910 print "XML error: $this->mXmlError\n";
918 * Run given strings through a diff and return the (colorized) output.
919 * Requires writable /tmp directory and a 'diff' command in the PATH.
921 * @param string $input
922 * @param string $output
923 * @param string $inFileTail Tailing for the input file name
924 * @param string $outFileTail Tailing for the output file name
927 protected function quickDiff( $input, $output, $inFileTail='expected', $outFileTail='actual' ) {
928 $prefix = wfTempDir() . "/mwParser-" . mt_rand();
930 $infile = "$prefix-$inFileTail";
931 $this->dumpToFile( $input, $infile );
933 $outfile = "$prefix-$outFileTail";
934 $this->dumpToFile( $output, $outfile );
936 $diff = `diff -au $infile $outfile`;
940 return $this->colorDiff( $diff );
944 * Write the given string to a file, adding a final newline.
946 * @param string $data
947 * @param string $filename
949 private function dumpToFile( $data, $filename ) {
950 $file = fopen( $filename, "wt" );
951 fwrite( $file, $data . "\n" );
956 * Colorize unified diff output if set for ANSI color output.
957 * Subtractions are colored blue, additions red.
959 * @param string $text
962 protected function colorDiff( $text ) {
964 array( '/^(-.*)$/m', '/^(\+.*)$/m' ),
965 array( $this->term->color( 34 ) . '$1' . $this->term->reset(),
966 $this->term->color( 31 ) . '$1' . $this->term->reset() ),
971 * Show "Reading tests from ..."
973 * @param String $path
975 protected function showRunFile( $path ){
976 print $this->term->color( 1 ) .
977 "Reading tests from \"$path\"..." .
978 $this->term->reset() .
983 * Insert a temporary test article
984 * @param string $name the title, including any prefix
985 * @param string $text the article text
986 * @param int $line the input line number, for reporting errors
988 private function addArticle($name, $text, $line) {
989 $this->setupGlobals();
990 $title = Title::newFromText( $name );
991 if ( is_null($title) ) {
992 wfDie( "invalid title at line $line\n" );
995 $aid = $title->getArticleID( GAID_FOR_UPDATE );
997 wfDie( "duplicate article at line $line\n" );
1000 $art = new Article($title);
1001 $art->insertNewArticle($text, '', false, false );
1002 $this->teardownGlobals();
1006 * Steal a callback function from the primary parser, save it for
1007 * application to our scary parser. If the hook is not installed,
1008 * die a painful dead to warn the others.
1009 * @param string $name
1011 private function requireHook( $name ) {
1013 if( isset( $wgParser->mTagHooks[$name] ) ) {
1014 $this->hooks[$name] = $wgParser->mTagHooks[$name];
1016 wfDie( "This test suite requires the '$name' hook extension.\n" );
1021 * Steal a callback function from the primary parser, save it for
1022 * application to our scary parser. If the hook is not installed,
1023 * die a painful dead to warn the others.
1024 * @param string $name
1026 private function requireFunctionHook( $name ) {
1028 if( isset( $wgParser->mFunctionHooks[$name] ) ) {
1029 $this->functionHooks[$name] = $wgParser->mFunctionHooks[$name];
1031 wfDie( "This test suite requires the '$name' function hook extension.\n" );
1036 * Run the "tidy" command on text if the $wgUseTidy
1039 * @param string $text the text to tidy
1043 private function tidy( $text ) {
1046 $text = Parser::tidy($text);
1051 private function wellFormed( $text ) {
1053 Sanitizer::hackDocType() .
1058 $parser = xml_parser_create( "UTF-8" );
1060 # case folding violates XML standard, turn it off
1061 xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
1063 if( !xml_parse( $parser, $html, true ) ) {
1064 $err = xml_error_string( xml_get_error_code( $parser ) );
1065 $position = xml_get_current_byte_index( $parser );
1066 $fragment = $this->extractFragment( $html, $position );
1067 $this->mXmlError = "$err at byte $position:\n$fragment";
1068 xml_parser_free( $parser );
1071 xml_parser_free( $parser );
1075 private function extractFragment( $text, $position ) {
1076 $start = max( 0, $position - 10 );
1077 $before = $position - $start;
1079 $this->term->color( 34 ) .
1080 substr( $text, $start, $before ) .
1081 $this->term->color( 0 ) .
1082 $this->term->color( 31 ) .
1083 $this->term->color( 1 ) .
1084 substr( $text, $position, 1 ) .
1085 $this->term->color( 0 ) .
1086 $this->term->color( 34 ) .
1087 substr( $text, $position + 1, 9 ) .
1088 $this->term->color( 0 ) .
1090 $display = str_replace( "\n", ' ', $fragment );
1092 str_repeat( ' ', $before ) .
1093 $this->term->color( 31 ) .
1095 $this->term->color( 0 );
1096 return "$display\n$caret";
1100 class AnsiTermColorer {
1101 function __construct() {
1105 * Return ANSI terminal escape code for changing text attribs/color
1107 * @param string $color Semicolon-separated list of attribute/color codes
1110 public function color( $color ) {
1111 global $wgCommandLineDarkBg;
1112 $light = $wgCommandLineDarkBg ? "1;" : "0;";
1113 return "\x1b[{$light}{$color}m";
1117 * Return ANSI terminal escape code for restoring default text attributes
1121 public function reset() {
1122 return $this->color( 0 );
1126 /* A colour-less terminal */
1127 class DummyTermColorer {
1128 public function color( $color ) {
1132 public function reset() {
1137 class TestRecorder {
1141 function __construct( $parent ) {
1142 $this->parent = $parent;
1143 $this->term = $parent->term;
1151 function record( $test, $result ) {
1153 $this->success += ($result ? 1 : 0);
1161 if( $this->total > 0 ) {
1162 $this->reportPercentage( $this->success, $this->total );
1164 wfDie( "No tests found.\n" );
1168 function reportPercentage( $success, $total ) {
1169 $ratio = wfPercent( 100 * $success / $total );
1170 print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
1171 if( $success == $total ) {
1172 print $this->term->color( 32 ) . "ALL TESTS PASSED!";
1174 $failed = $total - $success ;
1175 print $this->term->color( 31 ) . "$failed tests failed!";
1177 print $this->term->reset() . "\n";
1178 return ($success == $total);
1182 class DbTestPreviewer extends TestRecorder {
1183 protected $lb; ///< Database load balancer
1184 protected $db; ///< Database connection to the main DB
1185 protected $curRun; ///< run ID number for the current run
1186 protected $prevRun; ///< run ID number for the previous run, if any
1187 protected $results; ///< Result array
1190 * This should be called before the table prefix is changed
1192 function __construct( $parent ) {
1193 parent::__construct( $parent );
1194 $this->lb = wfGetLBFactory()->newMainLB();
1195 // This connection will have the wiki's table prefix, not parsertest_
1196 $this->db = $this->lb->getConnection( DB_MASTER );
1200 * Set up result recording; insert a record for the run with the date
1201 * and all that fun stuff
1204 global $wgDBtype, $wgDBprefix;
1207 if( ! $this->db->tableExists( 'testrun' )
1208 or ! $this->db->tableExists( 'testitem' ) )
1210 print "WARNING> `testrun` table not found in database.\n";
1211 $this->prevRun = false;
1213 // We'll make comparisons against the previous run later...
1214 $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
1216 $this->results = array();
1219 function record( $test, $result ) {
1220 parent::record( $test, $result );
1221 $this->results[$test] = $result;
1225 if( $this->prevRun ) {
1226 // f = fail, p = pass, n = nonexistent
1227 // codes show before then after
1229 'fp' => 'previously failing test(s) now PASSING! :)',
1230 'pn' => 'previously PASSING test(s) removed o_O',
1231 'np' => 'new PASSING test(s) :)',
1233 'pf' => 'previously passing test(s) now FAILING! :(',
1234 'fn' => 'previously FAILING test(s) removed O_o',
1235 'nf' => 'new FAILING test(s) :(',
1236 'ff' => 'still FAILING test(s) :(',
1239 $prevResults = array();
1241 $res = $this->db->select( 'testitem', array( 'ti_name', 'ti_success' ),
1242 array( 'ti_run' => $this->prevRun ), __METHOD__ );
1243 foreach ( $res as $row ) {
1244 if ( !$this->parent->regex
1245 || preg_match( "/{$this->parent->regex}/i", $row->ti_name ) )
1247 $prevResults[$row->ti_name] = $row->ti_success;
1251 $combined = array_keys( $this->results + $prevResults );
1253 # Determine breakdown by change type
1254 $breakdown = array();
1255 foreach ( $combined as $test ) {
1256 if ( !isset( $prevResults[$test] ) ) {
1258 } elseif ( $prevResults[$test] == 1 ) {
1260 } else /* if ( $prevResults[$test] == 0 )*/ {
1263 if ( !isset( $this->results[$test] ) ) {
1265 } elseif ( $this->results[$test] == 1 ) {
1267 } else /*if ( $this->results[$test] == 0 ) */ {
1270 $code = $before . $after;
1271 if ( isset( $table[$code] ) ) {
1272 $breakdown[$code][$test] = $this->getTestStatusInfo( $test, $after );
1277 foreach ( $table as $code => $label ) {
1278 if( !empty( $breakdown[$code] ) ) {
1279 $count = count($breakdown[$code]);
1280 printf( "\n%4d %s\n", $count, $label );
1281 foreach ($breakdown[$code] as $differing_test_name => $statusInfo) {
1282 print " * $differing_test_name [$statusInfo]\n";
1287 print "No previous test runs to compare against.\n";
1294 ** Returns a string giving information about when a test last had a status change.
1295 ** Could help to track down when regressions were introduced, as distinct from tests
1296 ** which have never passed (which are more change requests than regressions).
1298 private function getTestStatusInfo($testname, $after) {
1300 // If we're looking at a test that has just been removed, then say when it first appeared.
1301 if ( $after == 'n' ) {
1302 $changedRun = $this->db->selectField ( 'testitem',
1304 array( 'ti_name' => $testname ),
1306 $appear = $this->db->selectRow ( 'testrun',
1307 array( 'tr_date', 'tr_mw_version' ),
1308 array( 'tr_id' => $changedRun ),
1310 return "First recorded appearance: "
1311 . date( "d-M-Y H:i:s", strtotime ( $appear->tr_date ) )
1312 . ", " . $appear->tr_mw_version;
1315 // Otherwise, this test has previous recorded results.
1316 // See when this test last had a different result to what we're seeing now.
1318 'ti_name' => $testname,
1319 'ti_success' => ($after == 'f' ? "1" : "0") );
1320 if ( $this->curRun ) {
1321 $conds[] = "ti_run != " . $this->db->addQuotes ( $this->curRun );
1324 $changedRun = $this->db->selectField ( 'testitem', 'MAX(ti_run)', $conds, __METHOD__ );
1326 // If no record of ever having had a different result.
1327 if ( is_null ( $changedRun ) ) {
1328 if ($after == "f") {
1329 return "Has never passed";
1331 return "Has never failed";
1335 // Otherwise, we're looking at a test whose status has changed.
1336 // (i.e. it used to work, but now doesn't; or used to fail, but is now fixed.)
1337 // In this situation, give as much info as we can as to when it changed status.
1338 $pre = $this->db->selectRow ( 'testrun',
1339 array( 'tr_date', 'tr_mw_version' ),
1340 array( 'tr_id' => $changedRun ),
1342 $post = $this->db->selectRow ( 'testrun',
1343 array( 'tr_date', 'tr_mw_version' ),
1344 array( "tr_id > " . $this->db->addQuotes ( $changedRun) ),
1346 array( "LIMIT" => 1, "ORDER BY" => 'tr_id' )
1350 $postDate = date( "d-M-Y H:i:s", strtotime ( $post->tr_date ) ) . ", {$post->tr_mw_version}";
1354 return ( $after == "f" ? "Introduced" : "Fixed" ) . " between "
1355 . date( "d-M-Y H:i:s", strtotime ( $pre->tr_date ) ) . ", " . $pre->tr_mw_version
1361 * Commit transaction and clean up for result recording
1364 $this->lb->commitMasterChanges();
1365 $this->lb->closeAll();
1371 class DbTestRecorder extends DbTestPreviewer {
1373 * Set up result recording; insert a record for the run with the date
1374 * and all that fun stuff
1377 global $wgDBtype, $wgDBprefix;
1380 if( ! $this->db->tableExists( 'testrun' )
1381 or ! $this->db->tableExists( 'testitem' ) )
1383 print "WARNING> `testrun` table not found in database. Trying to create table.\n";
1384 if ($wgDBtype === 'postgres')
1385 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.postgres.sql' );
1387 $this->db->sourceFile( dirname(__FILE__) . '/testRunner.sql' );
1388 echo "OK, resuming.\n";
1393 $this->db->insert( 'testrun',
1395 'tr_date' => $this->db->timestamp(),
1396 'tr_mw_version' => SpecialVersion::getVersion(),
1397 'tr_php_version' => phpversion(),
1398 'tr_db_version' => $this->db->getServerVersion(),
1399 'tr_uname' => php_uname()
1402 if ($wgDBtype === 'postgres')
1403 $this->curRun = $this->db->currentSequenceValue('testrun_id_seq');
1405 $this->curRun = $this->db->insertId();
1409 * Record an individual test item's success or failure to the db
1410 * @param string $test
1411 * @param bool $result
1413 function record( $test, $result ) {
1414 parent::record( $test, $result );
1415 $this->db->insert( 'testitem',
1417 'ti_run' => $this->curRun,
1419 'ti_success' => $result ? 1 : 0,