Page MenuHomeWickedGov Phorge
Files F5961917

SpecialLintErrorsTest.php
No OneTemporary
Actions

Size
15 KB
Referenced Files
None
Subscribers
None

SpecialLintErrorsTest.php
View Options

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace MediaWiki\Linter\Test;
use Exception;
use MediaWiki\Content\ContentHandler;
use MediaWiki\Linter\RecordLintJob;
use MediaWiki\Linter\SpecialLintErrors;
use MediaWiki\Page\PageReference;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Title\Title;
use SpecialPageTestBase;
/**
* @covers \MediaWiki\Linter\SpecialLintErrors
*
* @group Database
*/
class SpecialLintErrorsTest extends SpecialPageTestBase {
private function getDatabase() {
return $this->getServiceContainer()->get( 'Linter.Database' );
}
private function newRecordLintJob( PageReference $page, array $params ) {
$services = $this->getServiceContainer();
return new RecordLintJob(
$page,
$params,
$services->get( 'Linter.TotalsLookup' ),
$this->getDatabase(),
$services->get( 'Linter.CategoryManager' )
);
}
protected function newSpecialPage() {
$services = $this->getServiceContainer();
return new SpecialLintErrors(
$services->getNamespaceInfo(),
$services->getTitleParser(),
$services->getLinkCache(),
$services->getPermissionManager(),
$services->get( 'Linter.CategoryManager' ),
$services->get( 'Linter.TotalsLookup' )
);
}
public function testExecute() {
$categoryManager =
$this->getServiceContainer()->get( 'Linter.CategoryManager' );
$category = $categoryManager->getVisibleCategories()[0];
// Basic
$html = $this->executeSpecialPage( '', null, 'qqx' )[0];
$this->assertStringContainsString( '(linterrors-summary)', $html );
$this->assertStringContainsString( "(linter-category-$category)", $html );
$this->assertStringContainsString(
"(linter-category-$category-desc)",
$this->executeSpecialPage( $category, null, 'qqx' )[0]
);
// Verify new tag and template interfaces are present
$html = $this->executeSpecialPage( 'misnested-tag', null, 'qqx' )[0];
$this->assertStringContainsString( 'linter-form-template', $html );
$this->assertStringContainsString( 'linter-form-tag', $html );
}
/**
* @param string $titleText
* @param int|null $ns
* @return array
*/
private function createTitleAndPage(
string $titleText = 'SpecialLintErrorsTest test page',
?int $ns = null
): array {
$ns ??= $this->getDefaultWikitextNS();
$title = Title::newFromText( $titleText, $ns );
$page = $this->getExistingTestPage( $title );
return [
'title' => $title,
'pageID' => $page->getRevisionRecord()->getPageId(),
'revID' => $page->getRevisionRecord()->getID(),
'page' => $page,
];
}
public function testContentModelChange() {
$error = [
'type' => 'obsolete-tag',
'location' => [ 0, 10 ],
'params' => [],
'dbid' => null,
];
$titleAndPage = $this->createTitleAndPage();
$job = $this->newRecordLintJob( $titleAndPage['title'], [
'errors' => [ $error ],
'revision' => $titleAndPage['revID']
] );
$this->assertTrue( $job->run() );
$pageId = $titleAndPage['pageID'];
$db = $this->getDatabase();
$errorsFromDb = array_values( $db->getForPage( $pageId ) );
$this->assertCount( 1, $errorsFromDb );
$cssText = 'css content model change test page content';
$content = ContentHandler::makeContent(
$cssText,
$titleAndPage['title'],
'css'
);
$page = $titleAndPage['page'];
$this->editPage(
$page,
$content,
"update with css content model to trigger onRevisionFromEditComplete hook"
);
$errorsFromDb = array_values( $db->getForPage( $pageId ) );
$this->assertCount( 0, $errorsFromDb );
}
public function testContentModelChangeWithBlankPage() {
$error = [
'type' => 'obsolete-tag',
'location' => [ 0, 10 ],
'params' => [],
'dbid' => null,
];
$titleAndPage = $this->createTitleAndPage();
$job = $this->newRecordLintJob( $titleAndPage['title'], [
'errors' => [ $error ],
'revision' => $titleAndPage['revID']
] );
$this->assertTrue( $job->run() );
$pageId = $titleAndPage['pageID'];
$db = $this->getDatabase();
$errorsFromDb = array_values( $db->getForPage( $pageId ) );
$this->assertCount( 1, $errorsFromDb );
// This test recreates the bug mentioned in T280193 of not
// calling the onRevisionFromEditComplete hook with the "mw-contentmodelchange"
// tag set when the new content text is literally blank.
$blankText = '';
$content = ContentHandler::makeContent(
$blankText,
$titleAndPage['title'],
'text'
);
$page = $titleAndPage['page'];
$this->editPage(
$page,
$content,
"update with blank text content model to trigger onRevisionFromEditComplete hook"
);
$errorsFromDb = array_values( $db->getForPage( $pageId ) );
$this->assertCount( 0, $errorsFromDb );
}
/**
* @param array $pageData
*/
private function createPagesWithLintErrorsFromData( array $pageData ) {
foreach ( $pageData as $data ) {
$titleAndPage = $this->createTitleAndPage( $data[ 'name' ], $data[ 'ns' ] );
$errors = [];
foreach ( $data[ 'lintErrors' ] as $lintError ) {
$errors[] = [
'type' => $lintError[ 'type' ],
'location' => $lintError[ 'location' ],
'params' => [],
'dbid' => null
];
}
$job = $this->newRecordLintJob( $titleAndPage[ 'title' ], [
'errors' => $errors,
'revision' => $titleAndPage[ 'revID' ]
] );
$job->run();
}
}
/**
* @return array
*/
private function createTitleAndPageAndLintErrorData(): array {
$pageData = [];
$pageData[] = [ 'name' => 'Lint Error One', 'ns' => 0,
'lintErrors' => [
[ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ],
[ 'type' => 'misnested-tag', 'location' => [ 20, 30 ] ]
]
];
$pageData[] = [ 'name' => 'LintErrorTwo', 'ns' => 3,
'lintErrors' => [ [ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ] ]
];
$pageData[] = [ 'name' => 'NotANamespace:LintErrorThree', 'ns' => 0,
'lintErrors' => [
[ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ],
[ 'type' => 'misnested-tag', 'location' => [ 20, 30 ] ]
]
];
$pageData[] = [ 'name' => 'NotANamespace:LintErrorFour', 'ns' => 0,
'lintErrors' => [
[ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ],
[ 'type' => 'misnested-tag', 'location' => [ 20, 30 ] ]
]
];
$pageData[] = [ 'name' => 'Some other page', 'ns' => 0,
'lintErrors' => [ [ 'type' => 'bogus-image-options', 'location' => [ 30, 40 ] ] ]
];
$pageData[] = [ 'name' => 'FooBar:ErrorFive', 'ns' => 3,
'lintErrors' => [ [ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ] ]
];
$pageData[] = [ 'name' => 'ErrorSix', 'ns' => 3,
'lintErrors' => [
[ 'type' => 'obsolete-tag', 'location' => [ 0, 10 ] ],
[ 'type' => 'misnested-tag', 'location' => [ 20, 30 ] ]
]
];
return $pageData;
}
// namespaces specified: all, Main, Talk and User talk (defined in config as null, int 0, 1 and 3)
// Titles exact matched and searched by tests include: empty - "", "L", "Lint Error One", "User Talk:L",
// "User talk:LintErrorTwo", "NotANamespace:L", "NotANamespace:LintErrorThree", "NotANamespace:LintErrorFour"
//
// Tests are grouped into three categories: empty title for all tests, namespace all for half and User talk for
// the rest, with exact match booleans cycling.
//
// The second group is similar, the title being either "NotANamespace:L" or "NotANamespace:LintErrorThree" or
// "NotANamespace:LintErrorFour" with half namespace set all or User talk and exact match booleans
// cycling.
//
// The third group is composed of tests against main, talk, User Talk and all namespaces. This test also includes
// titles with and without namespace prefixes, some which match the drop-down namespace and some which conflict
// depending on the combination of namespace definitions.
//
// The forth test covers the use of ':title' (main namespace) as the search text to ensure 'all' and 'main'
// are handled properly.
//
// The fifth test covers the user of an editor defined, (non wiki defined namespace with a namespace ID), but
// which was created in the User_talk wiki defined namespace ID 3.
//
// The sixth test covers accessing the search mechanism through the misnested-tag subpage. It verifies that
// LintErrorTwo, which has no misnested-tag errors is not in any search results, but other searches are as expected.
/**
* @param string|null $subpage
* @return array
*/
private function createLinterSearchTestConfigurations( ?string $subpage ): array {
$testConfigurations = [];
if ( $subpage !== 'misnested-tag' ) {
$testConfigurations[ 1 ] = [
'namespaces' => [ 0, 3 ],
'titles' => [ '' ],
'cases' => [ [ 'iterations' => [ 0, 1, 2, 3 ], 'message' => 'linter-invalid-title' ]
]
];
$testConfigurations[ 2 ] = [
'namespaces' => [ 0, 3 ],
'titles' => [ 'NotANamespace:L', 'NotANamespace:LintErrorFour' ],
'cases' => [
[ 'iterations' => [ 1 ], 'message' => 'NotANamespace:LintErrorThree' ],
[ 'iterations' => [ 1, 2, 3 ], 'message' => 'NotANamespace:LintErrorFour' ],
[ 'iterations' => [ 0, 4, 5, 6, 7 ], 'message' => 'table_pager_empty' ]
]
];
$testConfigurations[ 3 ] = [
'namespaces' => [ 0, 1, 3 ],
'titles' => [ 'L', 'Lint Error One', 'LintErrorTwo', 'User talk:L', 'User talk:LintErrorTwo',
'Talk:L' ],
'cases' => [
[ 'iterations' => [ 1, 2, 3 ],
'message' => 'Lint Error One' ],
[ 'iterations' => [ 25, 28, 29, 31, 32, 33 ],
'message' => 'LintErrorTwo' ],
[ 'iterations' => [ 0, 4, 5, 12, 13, 14, 15, 16, 17, 22, 23, 24, 26, 27, 30 ],
'message' => 'table_pager_empty' ],
[ 'iterations' => [ 6, 7, 8, 9, 10, 11, 18, 19, 20, 21, 34, 35 ],
'message' => 'linter-namespace-mismatch' ]
]
];
$testConfigurations[ 4 ] = [
'namespaces' => [ 0, 3 ],
'titles' => [ ':Lint Error One' ],
'cases' => [
[ 'iterations' => [ 0, 1 ],
'message' => 'Lint Error One' ],
[ 'iterations' => [ 2, 3 ],
'message' => 'linter-namespace-mismatch' ]
]
];
$testConfigurations[ 5 ] = [
'namespaces' => [ 0, 3 ],
'titles' => [ 'FooBar:ErrorFive' ],
'cases' => [
[ 'iterations' => [ 2, 3 ],
'message' => 'FooBar:ErrorFive' ],
[ 'iterations' => [ 0, 1 ],
'message' => 'table_pager_empty' ],
]
];
// check both NS0 and NS3 at the same time
$testConfigurations[ 6 ] = [
'namespaces' => [ [ 0, 3 ] ],
'titles' => [ 'L', 'Lint Error One', 'LintErrorTwo' ],
'cases' => [
[ 'iterations' => [ 1, 2, 3 ],
'message' => 'Lint Error One' ],
[ 'iterations' => [ 1, 4, 5 ],
'message' => 'LintErrorTwo' ],
[ 'iterations' => [ 0 ],
'message' => 'table_pager_empty' ],
]
];
} else {
$testConfigurations[ 7 ] = [
'namespaces' => [ 0, 3 ],
'titles' => [ 'L', 'Lint Error One', 'NotANamespace:L' ],
'cases' => [
[ 'iterations' => [ 1, 2, 3 ], 'message' => 'title="Lint Error One">' ],
[ 'iterations' => [], 'message' => 'title="LintErrorTwo">' ],
[ 'iterations' => [ 5 ], 'message' => 'title="NotANamespace:LintErrorThree">' ],
[ 'iterations' => [ 5 ], 'message' => 'title="NotANamespace:LintErrorFour">' ],
[ 'iterations' => [ 0, 4, 6, 7, 8, 9, 10, 11 ], 'message' => '(table_pager_empty)' ]
]
];
$testConfigurations[ 8 ] = [
'namespaces' => [ [ 0, 3 ] ],
'titles' => [ 'L', 'Lint Error One', 'NotANamespace:L', 'ErrorSix' ],
'cases' => [
[ 'iterations' => [ 1, 2, 3 ], 'message' => 'title="Lint Error One">' ],
[ 'iterations' => [], 'message' => 'title="LintErrorTwo">' ],
[ 'iterations' => [ 5 ], 'message' => 'title="NotANamespace:LintErrorThree">' ],
[ 'iterations' => [ 5 ], 'message' => 'title="NotANamespace:LintErrorFour">' ],
[ 'iterations' => [ 6, 7 ], 'message' => ':ErrorSix">' ],
[ 'iterations' => [ 0, 4 ], 'message' => '(table_pager_empty)' ]
]
];
}
return $testConfigurations;
}
/**
* @param array $testConfig
* @param string|null $subPage
* @param string $titleSearchString
* @return void
* @throws Exception
*/
private function performLinterSearchTests( array $testConfig, ?string $subPage, string $titleSearchString ): void {
foreach ( $testConfig as $groupIndex => $group ) {
$testIndex = 0;
foreach ( $group[ 'namespaces' ] as $namespace ) {
foreach ( $group[ 'titles' ] as $title ) {
$exact = true;
do {
if ( $namespace === null ) {
$params = [ $titleSearchString => $title, 'exactmatch' => $exact ];
} else {
if ( is_array( $namespace ) ) {
// simulate the same URL string that the multi namespace widget produces
$namespaces = implode( "\r\n", $namespace );
$params = array_merge( [ 'wpNamespaceRestrictions' => $namespaces ],
[ $titleSearchString => $title, 'exactmatch' => $exact ] );
} else {
$params = [ 'wpNamespaceRestrictions' => $namespace, $titleSearchString => $title,
'exactmatch' => $exact ];
}
}
$webRequest = new FauxRequest( $params );
$html = $this->executeSpecialPage( $subPage, $webRequest, 'qqx' )[ 0 ];
foreach ( $group[ 'cases' ] as $caseIndex => $case ) {
$exactString = [ 'prefix', 'exact' ][ $exact ];
$message = $case[ 'message' ];
$descriptionNamespace = implode( ',', (array)$namespace );
$description = "On group [$groupIndex], namespace [$descriptionNamespace], " .
"case [$caseIndex], iteration [$testIndex] " .
"for a [$exactString] match with search title [$title] and test text [$message] ";
if ( in_array( $testIndex, $case[ 'iterations' ] ) ) {
if ( empty( $debugTests ) ) {
$this->assertStringContainsString( $message, $html, $description .
"was not found." );
} else {
// code to aid in debugging test conditions
if ( !str_contains( $html, $message ) ) {
echo $description . "was not found.\n";
}
}
} else {
if ( empty( $debugTests ) ) {
$this->assertStringNotContainsString( $message, $html, $description .
"was not supposed to be found." );
} else {
// code to aid in debugging test conditions
if ( str_contains( $html, $message ) ) {
echo $description . "was not supposed to be found.\n";
}
}
}
}
$testIndex++;
$exact = !$exact;
} while ( !$exact );
}
}
}
}
/**
* @throws Exception
*/
public function testLinterSearchVariations(): void {
$this->createTitleAndPage();
$pageData = $this->createTitleAndPageAndLintErrorData();
$this->createPagesWithLintErrorsFromData( $pageData );
$testConfigurations = $this->createLinterSearchTestConfigurations( null );
$this->performLinterSearchTests( $testConfigurations, null, 'titlesearch' );
$testConfigurations = $this->createLinterSearchTestConfigurations( 'misnested-tag' );
$this->performLinterSearchTests( $testConfigurations, 'misnested-tag', 'titlecategorysearch' );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 08:30 (1 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
88/4f/d7a8271c3f460b94872b93b97adb
Default Alt Text
SpecialLintErrorsTest.php (15 KB)

Event Timeline