Fix.
[lhc/web/wiklou.git] / maintenance / parserTests.inc
index 19c48b7..d4f09eb 100644 (file)
@@ -20,8 +20,7 @@
 /**
  * @todo Make this more independent of the configuration (and if possible the database)
  * @todo document
- * @package MediaWiki
- * @subpackage Maintenance
+ * @addtogroup Maintenance
  */
 
 /** */
@@ -29,16 +28,12 @@ $options = array( 'quick', 'color', 'quiet', 'help', 'show-output', 'record' );
 $optionsWithArgs = array( 'regex' );
 
 require_once( 'commandLine.inc' );
-require_once( "$IP/includes/ObjectCache.php" );
-require_once( "$IP/includes/BagOStuff.php" );
-require_once( "$IP/includes/Hooks.php" );
 require_once( "$IP/maintenance/parserTestsParserHook.php" );
 require_once( "$IP/maintenance/parserTestsStaticParserHook.php" );
 require_once( "$IP/maintenance/parserTestsParserTime.php" );
 
 /**
- * @package MediaWiki
- * @subpackage Maintenance
+ * @addtogroup Maintenance
  */
 class ParserTest {
        /**
@@ -47,12 +42,6 @@ class ParserTest {
         */
        var $color;
 
-       /**
-        * boolean $lightcolor whereas output should use light colors
-        * @private
-        */
-       var $lightcolor;
-
        /**
         * boolean $showOutput Show test output
         */
@@ -68,7 +57,6 @@ class ParserTest {
                global $options;
 
                # Only colorize output if stdout is a terminal.
-               $this->lightcolor = false;
                $this->color = !wfIsWindows() && posix_isatty(1);
 
                if( isset( $options['color'] ) ) {
@@ -76,9 +64,6 @@ class ParserTest {
                        case 'no':
                                $this->color = false;
                                break;
-                       case 'light':
-                               $this->lightcolor = true;
-                               # Fall through
                        case 'yes':
                        default:
                                $this->color = true;
@@ -86,11 +71,16 @@ class ParserTest {
                        }
                }
                $this->term = $this->color
-                       ? new AnsiTermColorer( $this->lightcolor )
+                       ? new AnsiTermColorer()
                        : new DummyTermColorer();
 
                $this->showDiffs = !isset( $options['quick'] );
-               $this->quiet = isset( $options['quiet'] );
+               $this->showProgress = !isset( $options['quiet'] );
+               $this->showFailure = !(
+                       isset( $options['quiet'] )
+                       && ( isset( $options['record'] )
+                               || isset( $options['compare'] ) ) ); // redundant output
+               
                $this->showOutput = isset( $options['show-output'] );
 
 
@@ -100,13 +90,15 @@ class ParserTest {
                        # Matches anything
                        $this->regex = '';
                }
-               
+
                if( isset( $options['record'] ) ) {
                        $this->recorder = new DbTestRecorder( $this->term );
+               } elseif( isset( $options['compare'] ) ) {
+                       $this->recorder = new DbTestPreviewer( $this->term );
                } else {
                        $this->recorder = new TestRecorder( $this->term );
                }
-               
+
                $this->hooks = array();
                $this->functionHooks = array();
        }
@@ -142,18 +134,20 @@ class ParserTest {
                foreach( $filenames as $filename ) {
                        $ok = $this->runFile( $filename ) && $ok;
                }
-               $this->recorder->end();
                $this->recorder->report();
+               $this->recorder->end();
                return $ok;
        }
-       
+
        private function runFile( $filename ) {
                $infile = fopen( $filename, 'rt' );
                if( !$infile ) {
                        wfDie( "Couldn't open $filename\n" );
                } else {
+                       global $IP;
+                       $relative = wfRelativePath( $filename, $IP );
                        print $this->term->color( 1 ) .
-                               "Reading tests from \"$filename\"..." .
+                               "Reading tests from \"$relative\"..." .
                                $this->term->reset() .
                                "\n";
                }
@@ -164,6 +158,7 @@ class ParserTest {
                $ok = true;
                while( false !== ($line = fgets( $infile ) ) ) {
                        $n++;
+                       $matches = array();
                        if( preg_match( '/^!!\s*(\w+)/', $line, $matches ) ) {
                                $section = strtolower( $matches[1] );
                                if( $section == 'endarticle') {
@@ -264,7 +259,7 @@ class ParserTest {
         * @return bool
         */
        function runTest( $desc, $input, $result, $opts ) {
-               if( !$this->quiet ) {
+               if( $this->showProgress ) {
                        $this->showTesting( $desc );
                }
 
@@ -278,6 +273,7 @@ class ParserTest {
                        $options->setUseTex(true);
                }
 
+               $m = array();
                if (preg_match('/title=\[\[(.*)\]\]/', $opts, $m)) {
                        $titleText = $m[1];
                }
@@ -295,9 +291,10 @@ class ParserTest {
                        $parser->setFunctionHook( $tag, $callback );
                }
                wfRunHooks( 'ParserTestParser', array( &$parser ) );
-               
+
                $title =& Title::makeTitle( NS_MAIN, $titleText );
 
+               $matches = array();
                if (preg_match('/\\bpst\\b/i', $opts)) {
                        $out = $parser->preSaveTransform( $input, $title, $user, $options );
                } elseif (preg_match('/\\bmsg\\b/i', $opts)) {
@@ -349,13 +346,21 @@ class ParserTest {
                if( !isset( $this->uploadDir ) ) {
                        $this->uploadDir = $this->setupUploadDir();
                }
-               
+
+               $m = array();
                if( preg_match( '/language=([a-z]+(?:_[a-z]+)?)/', $opts, $m ) ) {
                        $lang = $m[1];
                } else {
                        $lang = 'en';
                }
 
+               if( preg_match( '/variant=([a-z]+(?:-[a-z]+)?)/', $opts, $m ) ) {
+                       $variant = $m[1];
+               } else {
+                       $variant = false;
+               }
+
+
                $settings = array(
                        'wgServer' => 'http://localhost',
                        'wgScript' => '/index.php',
@@ -370,7 +375,7 @@ class ParserTest {
                        'wgLanguageCode' => $lang,
                        'wgContLanguageCode' => $lang,
                        'wgDBprefix' => 'parsertest_',
-
+                       'wgRawHtml' => preg_match('/\\brawhtml\\b/i', $opts),
                        'wgLang' => null,
                        'wgContLang' => null,
                        'wgNamespacesWithSubpages' => array( 0 => preg_match('/\\bsubpage\\b/i', $opts)),
@@ -382,6 +387,8 @@ class ParserTest {
                        'wgLocaltimezone' => 'UTC',
                        'wgAllowExternalImages' => true,
                        'wgUseTidy' => false,
+                       'wgDefaultLanguageVariant' => $variant,
+                       'wgVariantArticlePath' => false,
                        );
                $this->savedGlobals = array();
                foreach( $settings as $var => $val ) {
@@ -403,7 +410,7 @@ class ParserTest {
        # List of temporary tables to create, without prefix
        # Some of these probably aren't necessary
        function listTables() {
-               $tables = array('user', 'page', 'revision', 'text',
+               $tables = array('user', 'page', 'page_restrictions', 'revision', 'text',
                        'pagelinks', 'imagelinks', 'categorylinks',
                        'templatelinks', 'externallinks', 'langlinks',
                        'site_stats', 'hitcounter',
@@ -517,7 +524,7 @@ class ParserTest {
                                'img_minor_mime'  => "jpeg",
                                'img_metadata'    => serialize( array() ),
                                ) );
-                               
+
                        # Update certain things in site_stats
                        $db->insert( 'site_stats', array( 'ss_row_id' => 1, 'ss_images' => 1, 'ss_good_articles' => 1 ) );
 
@@ -571,19 +578,54 @@ class ParserTest {
         * @private
         */
        function teardownUploadDir( $dir ) {
-               unlink( "$dir/3/3a/Foobar.jpg" );
-               rmdir( "$dir/3/3a" );
-               rmdir( "$dir/3" );
-               @rmdir( "$dir/thumb/6/65" );
-               @rmdir( "$dir/thumb/6" );
+               // delete the files first, then the dirs.
+               self::deleteFiles(
+                       array (
+                               "$dir/3/3a/Foobar.jpg",
+                               "$dir/thumb/3/3a/Foobar.jpg/180px-Foobar.jpg",
+                               "$dir/thumb/3/3a/Foobar.jpg/200px-Foobar.jpg",
+                               "$dir/thumb/3/3a/Foobar.jpg/640px-Foobar.jpg",
+                               "$dir/thumb/3/3a/Foobar.jpg/120px-Foobar.jpg",
+                       )
+               );
+
+               self::deleteDirs(
+                       array (
+                               "$dir/3/3a",
+                               "$dir/3",
+                               "$dir/thumb/6/65",
+                               "$dir/thumb/6",
+                               "$dir/thumb/3/3a/Foobar.jpg",
+                               "$dir/thumb/3/3a",
+                               "$dir/thumb/3",
+                               "$dir/thumb",
+                               "$dir",
+                       )
+               );
+       }
+
+       /**
+        * @desc delete the specified files, if they exist.
+        * @param array $files full paths to files to delete.
+        */
+       private static function deleteFiles( $files ) {
+               foreach( $files as $file ) {
+                       if( file_exists( $file ) ) {
+                               unlink( $file );
+                       }
+               }
+       }
 
-               @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" );
+       /**
+        * @desc delete the specified directories, if they exist. Must be empty.
+        * @param array $dirs full paths to directories to delete.
+        */
+       private static function deleteDirs( $dirs ) {
+               foreach( $dirs as $dir ) {
+                       if( is_dir( $dir ) ) {
+                               rmdir( $dir );
+                       }
+               }
        }
 
        /**
@@ -602,7 +644,7 @@ class ParserTest {
         * @private
         */
        function showSuccess( $desc ) {
-               if( !$this->quiet ) {
+               if( $this->showProgress ) {
                        print $this->term->color( '1;32' ) . 'PASSED' . $this->term->reset() . "\n";
                }
                return true;
@@ -619,19 +661,21 @@ class ParserTest {
         * @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->term->color( '1;31' ) . 'FAILED!' . $this->term->reset() . "\n";
-               if ( $this->showOutput ) {
-                       print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
-               }
-               if( $this->showDiffs ) {
-                       print $this->quickDiff( $result, $html );
-                       if( !$this->wellFormed( $html ) ) {
-                               print "XML error: $this->mXmlError\n";
+               if( $this->showFailure ) {
+                       if( !$this->showProgress ) {
+                               # 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->term->color( '31' ) . 'FAILED!' . $this->term->reset() . "\n";
+                       if ( $this->showOutput ) {
+                               print "--- Expected ---\n$result\n--- Actual ---\n$html\n";
+                       }
+                       if( $this->showDiffs ) {
+                               print $this->quickDiff( $result, $html );
+                               if( !$this->wellFormed( $html ) ) {
+                                       print "XML error: $this->mXmlError\n";
+                               }
                        }
                }
                return false;
@@ -716,7 +760,7 @@ class ParserTest {
                $art->insertNewArticle($text, '', false, false );
                $this->teardownGlobals();
        }
-       
+
        /**
         * Steal a callback function from the primary parser, save it for
         * application to our scary parser. If the hook is not installed,
@@ -732,7 +776,6 @@ class ParserTest {
                }
        }
 
-       
        /**
         * Steal a callback function from the primary parser, save it for
         * application to our scary parser. If the hook is not installed,
@@ -812,14 +855,12 @@ class ParserTest {
                        $this->term->color( 0 );
                return "$display\n$caret";
        }
-       
 }
 
 class AnsiTermColorer {
-       function __construct( $light ) {
-               $this->light = $light;
+       function __construct() {
        }
-       
+
        /**
         * Return ANSI terminal escape code for changing text attribs/color
         *
@@ -828,7 +869,8 @@ class AnsiTermColorer {
         * @private
         */
        function color( $color ) {
-               $light = $this->light ? "1;" : "";
+               global $wgCommandLineDarkBg;
+               $light = $wgCommandLineDarkBg ? "1;" : "0;";
                return "\x1b[{$light}{$color}m";
        }
 
@@ -839,15 +881,16 @@ class AnsiTermColorer {
         * @private
         */
        function reset() {
-               return "\x1b[0m";
+               return $this->color( 0 );
        }
 }
 
+/* A colour-less terminal */
 class DummyTermColorer {
        function color( $color ) {
                return '';
        }
-       
+
        function reset() {
                return '';
        }
@@ -857,21 +900,21 @@ class TestRecorder {
        function __construct( $term ) {
                $this->term = $term;
        }
-       
+
        function start() {
                $this->total = 0;
                $this->success = 0;
        }
-       
+
        function record( $test, $result ) {
                $this->total++;
                $this->success += ($result ? 1 : 0);
        }
-       
+
        function end() {
                // dummy
        }
-       
+
        function report() {
                if( $this->total > 0 ) {
                        $this->reportPercentage( $this->success, $this->total );
@@ -879,14 +922,15 @@ class TestRecorder {
                        wfDie( "No tests found.\n" );
                }
        }
-       
+
        function reportPercentage( $success, $total ) {
                $ratio = wfPercent( 100 * $success / $total );
-               print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio) ";
+               print $this->term->color( 1 ) . "Passed $success of $total tests ($ratio)... ";
                if( $success == $total ) {
-                       print $this->term->color( 32 ) . "PASSED!";
+                       print $this->term->color( 32 ) . "ALL TESTS PASSED!";
                } else {
-                       print $this->term->color( 31 ) . "FAILED!";
+                       $failed = $total - $success ;
+                       print $this->term->color( 31 ) . "$failed tests failed!";
                }
                print $this->term->reset() . "\n";
                return ($success == $total);
@@ -894,27 +938,33 @@ class TestRecorder {
 }
 
 class DbTestRecorder extends TestRecorder  {
-       var $db; ///< Database connection to the main DB
-       var $curRun; ///< run ID number for the current run
-       var $prevRun; ///< run ID number for the previous run, if any
-       
+       protected $db;      ///< Database connection to the main DB
+       protected $curRun;  ///< run ID number for the current run
+       protected $prevRun; ///< run ID number for the previous run, if any
+
        function __construct( $term ) {
                parent::__construct( $term );
                $this->db = wfGetDB( DB_MASTER );
        }
-       
+
        /**
         * Set up result recording; insert a record for the run with the date
         * and all that fun stuff
         */
        function start() {
                parent::start();
-               
+
                $this->db->begin();
-               
+
+               if( ! $this->db->tableExists( 'testrun' ) or ! $this->db->tableExists( 'testitem') ) {
+                       print "WARNING> `testrun` table not found in database. Trying to create table.\n";
+                       dbsource( 'testRunner.sql',  $this->db );
+                       echo "OK, resuming.\n";
+               }
+
                // We'll make comparisons against the previous run later...
                $this->prevRun = $this->db->selectField( 'testrun', 'MAX(tr_id)' );
-               
+
                $this->db->insert( 'testrun',
                        array(
                                'tr_date'        => $this->db->timestamp(),
@@ -926,7 +976,7 @@ class DbTestRecorder extends TestRecorder  {
                        __METHOD__ );
                $this->curRun = $this->db->insertId();
        }
-       
+
        /**
         * Record an individual test item's success or failure to the db
         * @param string $test
@@ -942,7 +992,7 @@ class DbTestRecorder extends TestRecorder  {
                        ),
                        __METHOD__ );
        }
-       
+
        /**
         * Commit transaction and clean up for result recording
         */
@@ -950,45 +1000,52 @@ class DbTestRecorder extends TestRecorder  {
                $this->db->commit();
                parent::end();
        }
-       
+
        function report() {
                if( $this->prevRun ) {
                        $table = array(
                                array( 'previously failing test(s) now PASSING! :)', 0, 1 ),
                                array( 'previously PASSING test(s) removed o_O', 1, null ),
                                array( 'new PASSING test(s) :)', null, 1 ),
-                               
+
                                array( 'previously passing test(s) now FAILING! :(', 1, 0 ),
                                array( 'previously FAILING test(s) removed O_o', 0, null ),
                                array( 'new FAILING test(s) :(', null, 0 ),
+                               array( 'still FAILING test(s) :(', 0, 0 ),
                        );
-                       foreach( $table as $blah ) {
-                               list( $label, $before, $after ) = $blah;
-                               $count = $this->comparisonCount( $before, $after );
-                               if( $count ) {
+                       foreach( $table as $criteria ) {
+                               list( $label, $before, $after ) = $criteria;
+                               $differences = $this->compareResult( $before, $after );
+                               if( $differences ) {
+                                       $count = count($differences);
                                        printf( "%4d %s\n", $count, $label );
+                                       foreach ($differences as $differing_test_name) {
+                                               print "      * $differing_test_name\n";
+                                       }
                                }
                        }
                } else {
                        print "No previous test runs to compare against.\n";
                }
+               print "\n";
                parent::report();
        }
-       
+
        /**
-        * :P
+        ** @desc: Returns an array of the test names with changed results, based on the specified
+        **        before/after criteria.
         */
-       private function comparisonCount( $before, $after ) {
+       private function compareResult( $before, $after ) {
                $testitem = $this->db->tableName( 'testitem' );
                $prevRun = intval( $this->prevRun );
                $curRun = intval( $this->curRun );
                $prevStatus = $this->condition( $before );
                $curStatus = $this->condition( $after );
-               
-               // note: requires a current mysql for subselects
+
+               // note: requires mysql >= ver 4.1 for subselects
                if( is_null( $after ) ) {
                        $sql = "
-                               select count(*) as c from $testitem as prev
+                               select prev.ti_name as t from $testitem as prev
                                        where prev.ti_run=$prevRun and
                                                prev.ti_success $prevStatus and
                                                (select current.ti_success from $testitem as current
@@ -996,7 +1053,7 @@ class DbTestRecorder extends TestRecorder  {
                                                                and prev.ti_name=current.ti_name) $curStatus";
                } else {
                        $sql = "
-                               select count(*) as c from $testitem as current 
+                               select current.ti_name as t from $testitem as current 
                                        where current.ti_run=$curRun and
                                                current.ti_success $curStatus and
                                                (select prev.ti_success from $testitem as prev
@@ -1004,11 +1061,17 @@ class DbTestRecorder extends TestRecorder  {
                                                                and prev.ti_name=current.ti_name) $prevStatus";
                }
                $result = $this->db->query( $sql, __METHOD__ );
-               $row = $this->db->fetchObject( $result );
+               $retval = array();
+               while ($row = $this->db->fetchObject( $result )) {
+                       $retval[] = $row->t;
+               }
                $this->db->freeResult( $result );
-               return $row->c;
+               return $retval;
        }
-       
+
+       /**
+        ** @desc: Helper function for compareResult() database querying.
+        */
        private function condition( $value ) {
                if( is_null( $value ) ) {
                        return 'IS NULL';
@@ -1019,4 +1082,14 @@ class DbTestRecorder extends TestRecorder  {
 
 }
 
+class DbTestPreviewer extends DbTestRecorder  {
+       /**
+        * Commit transaction and clean up for result recording
+        */
+       function end() {
+               $this->db->rollback();
+               TestRecorder::end();
+       }
+}
+
 ?>