Merge "Update docs/hooks.txt for ShowSearchHitTitle"

[mediawiki.git] / tests / phpunit / includes / ExtraParserTest.php

<?php

/**
 * Parser-related tests that don't suit for parserTests.txt
 *
 * @group Database
 */
class ExtraParserTest extends MediaWikiTestCase {

        /** @var ParserOptions */
        protected $options;
        /** @var Parser */
        protected $parser;

        protected function setUp() {
                parent::setUp();

                $contLang = Language::factory( 'en' );
                $this->setMwGlobals( [
                        'wgShowDBErrorBacktrace' => true,
                        'wgCleanSignatures' => true,
                ] );
                $this->setUserLang( 'en' );
                $this->setContentLang( $contLang );

                // FIXME: This test should pass without setting global content language
                $this->options = ParserOptions::newFromUserAndLang( new User, $contLang );
                $this->options->setTemplateCallback( [ __CLASS__, 'statelessFetchTemplate' ] );
                $this->parser = new Parser;

                MagicWord::clearCache();
        }

        /**
         * @see Bug 8689
         * @covers Parser::parse
         */
        public function testLongNumericLinesDontKillTheParser() {
                $longLine = '1.' . str_repeat( '1234567890', 100000 ) . "\n";

                $title = Title::newFromText( 'Unit test' );
                $options = ParserOptions::newFromUser( new User() );
                $this->assertEquals( "<p>$longLine</p>",
                        $this->parser->parse( $longLine, $title, $options )->getText() );
        }

        /**
         * Test the parser entry points
         * @covers Parser::parse
         */
        public function testParse() {
                $title = Title::newFromText( __FUNCTION__ );
                $parserOutput = $this->parser->parse( "Test\n{{Foo}}\n{{Bar}}", $title, $this->options );
                $this->assertEquals(
                        "<p>Test\nContent of <i>Template:Foo</i>\nContent of <i>Template:Bar</i>\n</p>",
                        $parserOutput->getText()
                );
        }

        /**
         * @covers Parser::preSaveTransform
         */
        public function testPreSaveTransform() {
                $title = Title::newFromText( __FUNCTION__ );
                $outputText = $this->parser->preSaveTransform(
                        "Test\r\n{{subst:Foo}}\n{{Bar}}",
                        $title,
                        new User(),
                        $this->options
                );

                $this->assertEquals( "Test\nContent of ''Template:Foo''\n{{Bar}}", $outputText );
        }

        /**
         * @covers Parser::preprocess
         */
        public function testPreprocess() {
                $title = Title::newFromText( __FUNCTION__ );
                $outputText = $this->parser->preprocess( "Test\n{{Foo}}\n{{Bar}}", $title, $this->options );

                $this->assertEquals(
                        "Test\nContent of ''Template:Foo''\nContent of ''Template:Bar''",
                        $outputText
                );
        }

        /**
         * cleanSig() makes all templates substs and removes tildes
         * @covers Parser::cleanSig
         */
        public function testCleanSig() {
                $title = Title::newFromText( __FUNCTION__ );
                $outputText = $this->parser->cleanSig( "{{Foo}} ~~~~" );

                $this->assertEquals( "{{SUBST:Foo}} ", $outputText );
        }

        /**
         * cleanSig() should do nothing if disabled
         * @covers Parser::cleanSig
         */
        public function testCleanSigDisabled() {
                $this->setMwGlobals( 'wgCleanSignatures', false );

                $title = Title::newFromText( __FUNCTION__ );
                $outputText = $this->parser->cleanSig( "{{Foo}} ~~~~" );

                $this->assertEquals( "{{Foo}} ~~~~", $outputText );
        }

        /**
         * cleanSigInSig() just removes tildes
         * @dataProvider provideStringsForCleanSigInSig
         * @covers Parser::cleanSigInSig
         */
        public function testCleanSigInSig( $in, $out ) {
                $this->assertEquals( Parser::cleanSigInSig( $in ), $out );
        }

        public static function provideStringsForCleanSigInSig() {
                return [
                        [ "{{Foo}} ~~~~", "{{Foo}} " ],
                        [ "~~~", "" ],
                        [ "~~~~~", "" ],
                ];
        }

        /**
         * @covers Parser::getSection
         */
        public function testGetSection() {
                $outputText2 = $this->parser->getSection(
                        "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
                                . "Section 2\n== Heading 3 ==\nSection 3\n",
                        2
                );
                $outputText1 = $this->parser->getSection(
                        "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
                                . "Section 2\n== Heading 3 ==\nSection 3\n",
                        1
                );

                $this->assertEquals( "=== Heading 2 ===\nSection 2", $outputText2 );
                $this->assertEquals( "== Heading 1 ==\nSection 1\n=== Heading 2 ===\nSection 2", $outputText1 );
        }

        /**
         * @covers Parser::replaceSection
         */
        public function testReplaceSection() {
                $outputText = $this->parser->replaceSection(
                        "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
                                . "Section 2\n== Heading 3 ==\nSection 3\n",
                        1,
                        "New section 1"
                );

                $this->assertEquals( "Section 0\nNew section 1\n\n== Heading 3 ==\nSection 3", $outputText );
        }

        /**
         * Templates and comments are not affected, but noinclude/onlyinclude is.
         * @covers Parser::getPreloadText
         */
        public function testGetPreloadText() {
                $title = Title::newFromText( __FUNCTION__ );
                $outputText = $this->parser->getPreloadText(
                        "{{Foo}}<noinclude> censored</noinclude> information <!-- is very secret -->",
                        $title,
                        $this->options
                );

                $this->assertEquals( "{{Foo}} information <!-- is very secret -->", $outputText );
        }

        /**
         * @param Title $title
         * @param bool $parser
         *
         * @return array
         */
        static function statelessFetchTemplate( $title, $parser = false ) {
                $text = "Content of ''" . $title->getFullText() . "''";
                $deps = [];

                return [
                        'text' => $text,
                        'finalTitle' => $title,
                        'deps' => $deps ];
        }

        /**
         * @group Database
         * @covers Parser::parse
         */
        public function testTrackingCategory() {
                $title = Title::newFromText( __FUNCTION__ );
                $catName = wfMessage( 'broken-file-category' )->inContentLanguage()->text();
                $cat = Title::makeTitleSafe( NS_CATEGORY, $catName );
                $expected = [ $cat->getDBkey() ];
                $parserOutput = $this->parser->parse( "[[file:nonexistent]]", $title, $this->options );
                $result = $parserOutput->getCategoryLinks();
                $this->assertEquals( $expected, $result );
        }

        /**
         * @group Database
         * @covers Parser::parse
         */
        public function testTrackingCategorySpecial() {
                // Special pages shouldn't have tracking cats.
                $title = SpecialPage::getTitleFor( 'Contributions' );
                $parserOutput = $this->parser->parse( "[[file:nonexistent]]", $title, $this->options );
                $result = $parserOutput->getCategoryLinks();
                $this->assertEmpty( $result );
        }
}