Renamed group table to groups, and renamed the fields from group_xxx to gr_xxx. Added...
[lhc/web/wiklou.git] / maintenance / parserTests.php
index 9e6b1b8..184f876 100644 (file)
  */
 
 /** */
-$optionsWithArgs = array('regex');
+$options = array( 'quick', 'color', 'quiet', 'help' );
+$optionsWithArgs = array( 'regex' );
 
 require_once( 'commandLine.inc' );
-require_once( 'languages/LanguageUtf8.php' );
+require_once( "$IP/includes/ObjectCache.php" );
+require_once( "$IP/languages/LanguageUtf8.php" );
 
+/**
+ * @package MediaWiki
+ * @subpackage Maintenance
+ */
 class ParserTest {
-       
+       /**
+        * boolean $color whereas output should be colorized
+        * @access private
+        */
+       var $color;
+
+       /**
+        * boolean $lightcolor whereas output should use light colors
+        * @access private
+        */
+       var $lightcolor;
+
        /**
         * Sets terminal colorization and diff/quick modes depending on OS and
         * command-line options (--color and --quick).
@@ -40,29 +57,33 @@ class ParserTest {
         */
        function ParserTest() {
                global $options;
-               if( isset( $_SERVER['argv'] ) && in_array( '--color', $_SERVER['argv'] ) ) {
-                       $this->color = true;
-               } elseif( isset( $_SERVER['argv'] ) && in_array( '--color=yes', $_SERVER['argv'] ) ) {
-                       $this->color = true;
-               } elseif( isset( $_SERVER['argv'] ) && in_array( '--color=no', $_SERVER['argv'] ) ) {
-                       $this->color = false;
-               } elseif( wfIsWindows() ) {
-                       $this->color = false;
-               } else {
-                       # Only colorize output if stdout is a terminal.
-                       $this->color = posix_isatty(1);
-               }
                
-               if( isset( $_SERVER['argv'] ) && in_array( '--quick', $_SERVER['argv'] ) ) {
-                       $this->showDiffs = false;
-               } else {
-                       $this->showDiffs = true;
+               # Only colorize output if stdout is a terminal.
+               $this->lightcolor = false;
+               $this->color = !wfIsWindows() && posix_isatty(1);
+               
+               if( isset( $options['color'] ) ) {
+                       switch( $options['color'] ) {
+                       case 'no':
+                               $this->color = false;
+                               break;
+                       case 'light':
+                               $this->lightcolor = true;
+                               # Fall through
+                       case 'yes':
+                       default:
+                               $this->color = true;
+                               break;
+                       }
                }
+               
+               $this->showDiffs = !isset( $options['quick'] );
+               
+               $this->quiet = isset( $options['quiet'] );
 
                if (isset($options['regex'])) {
                        $this->regex = $options['regex'];
-               }
-               else {
+               } else {
                        # Matches anything
                        $this->regex = '';
                }
@@ -166,7 +187,7 @@ class ParserTest {
                        }
                }
                if( $total > 0 ) {
-                       $ratio = IntVal( 100.0 * $success / $total );
+                       $ratio = sprintf( "%.2f", 100 * $success / $total );
                        print $this->termColor( 1 ) . "\nPassed $success of $total tests ($ratio%) ";
                        if( $success == $total ) {
                                print $this->termColor( 32 ) . "PASSED!";
@@ -190,7 +211,9 @@ class ParserTest {
         * @return bool
         */
        function runTest( $desc, $input, $result, $opts ) {
-               print "Running test $desc... ";
+               if( !$this->quiet ) {
+                       $this->showTesting( $desc );
+               }
 
                $this->setupGlobals($opts);
 
@@ -216,33 +239,24 @@ class ParserTest {
 
                if (preg_match('/\\bpst\\b/i', $opts)) {
                        $out = $parser->preSaveTransform( $input, $title, $user, $options );
-               }
-               else if (preg_match('/\\bmsg\\b/i', $opts)) {
+               } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
                        $out = $parser->transformMsg( $input, $options );
-               }
-               else {
+               } else {
                        $output =& $parser->parse( $input, $title, $options );
                        $out = $output->getText();
 
-                       $op = new OutputPage();
-                       $op->replaceLinkHolders($out);
-
                        if (preg_match('/\\bill\\b/i', $opts)) {
-                               $out .= implode( ' ', $output->getLanguageLinks() );
-                       }       
-                       if (preg_match('/\\bcat\\b/i', $opts)) {
-                               $out .= implode( ' ', $output->getCategoryLinks() );
+                               $out = $this->tidy( implode( ' ', $output->getLanguageLinks() ) );
+                       } else if (preg_match('/\\bcat\\b/i', $opts)) {
+                               $out = $this->tidy ( implode( ' ', $output->getCategoryLinks() ) );
                        }
 
-                       if ($GLOBALS['wgUseTidy']) {
-                               $out = Parser::tidy($out);
-                               $result = Parser::tidy($result);
-                       }
+                       $result = $this->tidy($result);
                }
                
                $this->teardownGlobals();
                
-               if( $result === $out ) {
+               if( $result === $out && $this->wellFormed( $out ) ) {
                        return $this->showSuccess( $desc );
                } else {
                        return $this->showFailure( $desc, $result, $out );
@@ -256,20 +270,39 @@ class ParserTest {
         * @access private
         */
        function setupGlobals($opts = '') {
+               # Save the prefixed / quoted table names for later use when we make the temporaries.
+               $db =& wfGetDB( DB_READ );
+               $this->oldTableNames = array();
+               foreach( $this->listTables() as $table ) {
+                       $this->oldTableNames[$table] = $db->tableName( $table );
+               }
+               if( !isset( $this->uploadDir ) ) {
+                       $this->uploadDir = $this->setupUploadDir();
+               }
+               
                $settings = array(
                        'wgServer' => 'http://localhost',
                        'wgScript' => '/index.php',
                        'wgScriptPath' => '/',
                        'wgArticlePath' => '/wiki/$1',
                        'wgUploadPath' => '/images',
+                       'wgUploadDirectory' => $this->uploadDir,
+                       'wgStyleSheetPath' => '/skins',
                        'wgSitename' => 'MediaWiki',
                        'wgLanguageCode' => 'en',
-                       'wgUseLatin1' => false,
+                       'wgContLanguageCode' => 'en',
                        'wgDBprefix' => 'parsertest',
+                       'wgDefaultUserOptions' => array(),
                        
                        'wgLoadBalancer' => LoadBalancer::newFromParams( $GLOBALS['wgDBservers'] ),
                        'wgLang' => new LanguageUtf8(),
+                       'wgContLang' => new LanguageUtf8(),
                        'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
+                       'wgMaxTocLevel' => 999,
+                       'wgCapitalLinks' => true,
+                       'wgDefaultUserOptions' => array(),
+                       'wgNoFollowLinks' => true,
+                       'wgThumbnailScriptPath' => false,
                        );
                $this->savedGlobals = array();
                foreach( $settings as $var => $val ) {
@@ -277,7 +310,25 @@ class ParserTest {
                        $GLOBALS[$var] = $val;
                }
                $GLOBALS['wgLoadBalancer']->loadMasterPos();
+               $GLOBALS['wgMessageCache']->initialise( new BagOStuff(), false, 0, $GLOBALS['wgDBname'] );
                $this->setupDatabase();
+               
+               global $wgUser;
+               $wgUser = new User();
+       }
+       
+       # List of temporary tables to create, without prefix
+       # Some of these probably aren't necessary
+       function listTables() {
+               return array('user', 'page', 'revision', 'text', 'links',
+                       'brokenlinks', 'imagelinks', 'categorylinks',
+                       'linkscc', 'site_stats', 'hitcounter',
+                       'ipblocks', 'image', 'oldimage',
+                       'recentchanges',
+                       'watchlist', 'math', 'searchindex',
+                       'interwiki', 'querycache',
+                       'objectcache', 'groups'
+               );
        }
        
        /**
@@ -295,38 +346,32 @@ class ParserTest {
                if (!$setupDB && $wgDBprefix === 'parsertest') {
                        $db =& wfGetDB( DB_MASTER );
 
-                       # List of temporary tables to create, without prefix
-                       # Some of these probably aren't necessary
-                       $tables = array('user', 'cur', 'old', 'links',
-                               'brokenlinks', 'imagelinks', 'categorylinks',
-                               'linkscc', 'site_stats', 'hitcounter',
-                               'ipblocks', 'image', 'oldimage',
-                               'recentchanges',
-                               'watchlist', 'math', 'searchindex',
-                               'interwiki', 'querycache',
-                               'objectcache', 'blobs', 'validate'
-                       );
-                       
-                       # List of tables whose contents we need to copy
-                       $copy_tables = array('interwiki');
+                       $tables = $this->listTables();
 
                        if (!(strcmp($db->getServerVersion(), '4.1') < 0 and stristr($db->getSoftwareLink(), 'MySQL'))) {
                                # Database that supports CREATE TABLE ... LIKE
+                               global $wgDBtype;
+                               if( $wgDBtype == 'PostgreSQL' ) {
+                                       $def = 'INCLUDING DEFAULTS';
+                               } else {
+                                       $def = '';
+                               }
                                foreach ($tables as $tbl) {
-                                       $db->query("CREATE TEMPORARY TABLE $wgDBprefix$tbl LIKE $tbl");
+                                       $newTableName = $db->tableName( $tbl );
+                                       $tableName = $this->oldTableNames[$tbl];
+                                       $db->query("CREATE TEMPORARY TABLE $newTableName (LIKE $tableName $def)");
                                }
-                       }
-                       else {
+                       } else {
                                # Hack for MySQL versions < 4.1, which don't support
                                # "CREATE TABLE ... LIKE". Note that
                                # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
                                # would not create the indexes we need....
                                foreach ($tables as $tbl) {
-                                       $res = $db->query("SHOW CREATE TABLE $tbl");
+                                       $res = $db->query("SHOW CREATE TABLE {$this->oldTableNames[$tbl]}");
                                        $row = $db->fetchRow($res);
                                        $create = $row[1];
                                        $create_tmp = preg_replace('/CREATE TABLE `(.*?)`/', 'CREATE TEMPORARY TABLE `'
-                                               . $wgDBprefix . '\\1`', $create);
+                                               . $wgDBprefix . $tbl .'`', $create);
                                        if ($create === $create_tmp) {
                                                # Couldn't do replacement
                                                die("could not create temporary table $tbl");
@@ -336,22 +381,79 @@ class ParserTest {
 
                        }
 
-                       foreach ($copy_tables as $tbl) {
-                               $db->query("INSERT INTO $wgDBprefix$tbl SELECT * FROM $tbl");
-                       }
-
                        # Hack: insert a few Wikipedia in-project interwiki prefixes,
                        # for testing inter-language links
-                       $db->query("INSERT INTO ${wgDBprefix}interwiki
-                               (iw_prefix,iw_url,iw_local) VALUES
-                               ('zh','http://zh.wikipedia.org/wiki/$1',1),
-                               ('es','http://es.wikipedia.org/wiki/$1',1),
-                               ('fr','http://fr.wikipedia.org/wiki/$1',1)");
+                       $db->insert( 'interwiki', array(
+                               array( 'iw_prefix' => 'Wikipedia',
+                                      'iw_url'    => 'http://en.wikipedia.org/wiki/$1',
+                                      'iw_local'  => 0 ),
+                               array( 'iw_prefix' => 'MeatBall',
+                                      'iw_url'    => 'http://www.usemod.com/cgi-bin/mb.pl?$1',
+                                      'iw_local'  => 0 ),
+                               array( 'iw_prefix' => 'zh',
+                                      'iw_url'    => 'http://zh.wikipedia.org/wiki/$1',
+                                      'iw_local'  => 1 ),
+                               array( 'iw_prefix' => 'es',
+                                      'iw_url'    => 'http://es.wikipedia.org/wiki/$1',
+                                      'iw_local'  => 1 ),
+                               array( 'iw_prefix' => 'fr',
+                                      'iw_url'    => 'http://fr.wikipedia.org/wiki/$1',
+                                      'iw_local'  => 1 ),
+                               array( 'iw_prefix' => 'ru',
+                                      'iw_url'    => 'http://ru.wikipedia.org/wiki/$1',
+                                      'iw_local'  => 1 ),
+                               ) );
 
+                       # Hack: initialize a group
+                       $db->insert( 'groups', array(
+                               'gr_id' => 1,
+                               'gr_name' => 'Anonymous',
+                               'gr_description' => 'Anonymous users',
+                               'gr_rights' => 'read' ) );
+                       
+                       # Hack: Insert an image to work with
+                       $db->insert( 'image', array(
+                               'img_name'        => 'Foobar.jpg',
+                               'img_size'        => 12345,
+                               'img_description' => 'Some lame file',
+                               'img_user'        => 1,
+                               'img_user_text'   => 'WikiSysop',
+                               'img_timestamp'   => $db->timestamp( '20010115123500' ),
+                               'img_width'       => 1941,
+                               'img_height'      => 220,
+                               'img_bits'        => 24,
+                               'img_type'        => 2, // 2 == JPEG
+                               ) );
+                       
                        $setupDB = true;
                }
        }
        
+       /**
+        * Create a dummy uploads directory which will contain a couple
+        * of files in order to pass existence tests.
+        * @return string The directory
+        * @access private
+        */
+       function setupUploadDir() {
+               global $IP;
+               
+               $dir = "/tmp/mwParser-" . mt_rand() . "-images";
+               mkdir( $dir );
+               mkdir( $dir . '/3' );
+               mkdir( $dir . '/3/3a' );
+               
+               $img = "$IP/skins/monobook/headbg.jpg";
+               $h = fopen($img, 'r');
+               $c = fread($h, filesize($img));
+               fclose($h);
+               
+               $f = fopen( $dir . '/3/3a/Foobar.jpg', 'wb' );
+               fwrite( $f, $c );
+               fclose( $f );
+               return $dir;
+       }
+       
        /**
         * Restore default values and perform any necessary clean-up
         * after each test runs.
@@ -362,6 +464,36 @@ class ParserTest {
                foreach( $this->savedGlobals as $var => $val ) {
                        $GLOBALS[$var] = $val;
                }
+               if( isset( $this->uploadDir ) ) {
+                       $this->teardownUploadDir( $this->uploadDir );
+                       unset( $this->uploadDir );
+               }
+       }
+       
+       /**
+        * Remove the dummy uploads directory
+        * @access private
+        */
+       function teardownUploadDir( $dir ) {
+               unlink( "$dir/3/3a/Foobar.jpg" );
+               rmdir( "$dir/3/3a" );
+               rmdir( "$dir/3" );
+
+               @unlink( "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg" );
+               @rmdir( "$dir/thumb/3/3a/Foobar.jpg" );
+               @rmdir( "$dir/thumb/3/3a" );
+               @rmdir( "$dir/thumb/3/39" ); # wtf?
+               @rmdir( "$dir/thumb/3" );
+               @rmdir( "$dir/thumb" );
+               rmdir( "$dir" );
+       }
+       
+       /**
+        * "Running test $desc..."
+        * @access private
+        */
+       function showTesting( $desc ) {
+               print "Running test $desc... ";
        }
        
        /**
@@ -372,7 +504,9 @@ class ParserTest {
         * @access private
         */
        function showSuccess( $desc ) {
-               print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
+               if( !$this->quiet ) {
+                       print $this->termColor( '1;32' ) . 'PASSED' . $this->termReset() . "\n";
+               }
                return true;
        }
        
@@ -387,10 +521,18 @@ class ParserTest {
         * @access private
         */
        function showFailure( $desc, $result, $html ) {
+               if( $this->quiet ) {
+                       # In quiet mode we didn't show the 'Testing' message before the
+                       # test, in case it succeeded. Show it now:
+                       $this->showTesting( $desc );
+               }
                print $this->termColor( '1;31' ) . 'FAILED!' . $this->termReset() . "\n";
                if( $this->showDiffs ) {
                        print $this->quickDiff( $result, $html );
                }
+               if( !$this->wellFormed( $html ) ) {
+                       print "XML error: $this->mXmlError\n";
+               }
                return false;
        }
        
@@ -412,7 +554,7 @@ class ParserTest {
                $outfile = "$prefix-actual";
                $this->dumpToFile( $output, $outfile );
                
-               $diff = `diff -u $infile $outfile`;
+               $diff = `diff -au $infile $outfile`;
                unlink( $infile );
                unlink( $outfile );
                
@@ -441,7 +583,11 @@ class ParserTest {
         * @access private
         */
        function termColor( $color ) {
-               return $this->color ? "\x1b[{$color}m" : '';
+               if($this->lightcolor) {
+                       return $this->color ? "\x1b[1;{$color}m" : '';
+               } else {
+                       return $this->color ? "\x1b[{$color}m" : '';
+               }
        }
        
        /**
@@ -473,9 +619,9 @@ class ParserTest {
 
        /**
         * Insert a temporary test article
-        * @param $name string the title, including any prefix
-        * @param $text string the article text
-        * @param $line int the input line number, for reporting errors
+        * @param string $name the title, including any prefix
+        * @param string $text the article text
+        * @param int $line the input line number, for reporting errors
         * @static
         * @access private
         */
@@ -495,9 +641,97 @@ class ParserTest {
                $art->insertNewArticle($text, '', false, false );
                $this->teardownGlobals();
        }
+
+       /*
+        * Run the "tidy" command on text if the $wgUseTidy
+        * global is true
+        *
+        * @param string $text the text to tidy
+        * @return string
+        * @static
+        * @access private
+        */
+       function tidy( $text ) {
+               global $wgUseTidy;
+               if ($wgUseTidy) {
+                       $text = Parser::tidy($text);
+               }
+               return $text;
+       }
+       
+       function wellFormed( $text ) {
+               $html = 
+                       '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" ' .
+                       '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">' .
+                       '<html>' .
+                       $text .
+                       '</html>';
+               
+               $parser = xml_parser_create( "UTF-8" );
+               
+               # case folding violates XML standard, turn it off
+               xml_parser_set_option( $parser, XML_OPTION_CASE_FOLDING, false );
+               
+               if( !xml_parse( $parser, $html, true ) ) {
+                       $err = xml_error_string( xml_get_error_code( $parser ) );
+                       $position = xml_get_current_byte_index( $parser );
+                       $fragment = $this->extractFragment( $html, $position );
+                       $this->mXmlError = "$err at byte $position:\n$fragment";
+                       xml_parser_free( $parser );
+                       return false;
+               }
+               xml_parser_free( $parser );
+               return true;
+       }
+       
+       function extractFragment( $text, $position ) {
+               $start = max( 0, $position - 10 );
+               $before = $position - $start;
+               $fragment = '...' .
+                       $this->termColor( 34 ) .
+                       substr( $text, $start, $before ) .
+                       $this->termColor( 0 ) .
+                       $this->termColor( 31 ) .
+                       $this->termColor( 1 ) .
+                       substr( $text, $position, 1 ) .
+                       $this->termColor( 0 ) .
+                       $this->termColor( 34 ) .
+                       substr( $text, $position + 1, 9 ) .
+                       $this->termColor( 0 ) .
+                       '...';
+               $display = str_replace( "\n", ' ', $fragment );
+               $caret = '   ' .
+                       str_repeat( ' ', $before ) .
+                       $this->termColor( 31 ) .
+                       '^' .
+                       $this->termColor( 0 );
+               return "$display\n$caret";
+       }
+       
+}
+
+if( isset( $options['help'] ) ) {
+       echo <<<END
+MediaWiki $wgVersion parser test suite
+Usage: php parserTests.php [--quick] [--quiet] [--color[=(yes|no|light)]]
+                           [--regex <expression>] [--help]
+Options:
+  --quick  Suppress diff output of failed tests
+  --quiet  Suppress notification of passed tests (shows only failed tests)
+  --color  Override terminal detection and force color output on or off
+           'light' option is similar to 'yes' but with color for dark backgrounds
+  --regex  Only run tests whose descriptions which match given regex
+  --help   Show this help message
+
+
+END;
+       exit( 0 );
 }
 
-$wgTitle = Title::newFromText( 'Parser test script' );
+# There is a convention that the parser should never
+# refer to $wgTitle directly, but instead use the title
+# passed to it.
+$wgTitle = Title::newFromText( 'Parser test script do not use' );
 $tester =& new ParserTest();
 
 # Note: the command line setup changes the current working directory