mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Linter
synced 2024-11-23 23:44:17 +00:00
0ba87557d5
Use the methods provided by MediaWikiIntegrationTestCase to more simply create an existing test page. The manual user creation could be replaced by getTestUser, but it turns out these tests don't really need a specific account, so we can let IntegrationTestCase use whatever account it wants to use. Also remove @var annotations that can easily be inferred by the doc comment on the relevant methods. Change-Id: I8bfd0799b79721c7c9de0d2a10a97c498d192a15
411 lines
15 KiB
PHP
411 lines
15 KiB
PHP
<?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 MediaWiki\Linter\Database;
|
|
use MediaWiki\Linter\LintError;
|
|
use MediaWiki\Linter\RecordLintJob;
|
|
use MediaWiki\Title\Title;
|
|
use MediaWikiIntegrationTestCase;
|
|
use Wikimedia\Rdbms\SelectQueryBuilder;
|
|
|
|
/**
|
|
* @group Database
|
|
* @covers \MediaWiki\Linter\RecordLintJob
|
|
*/
|
|
class RecordLintJobTest extends MediaWikiIntegrationTestCase {
|
|
/**
|
|
* @param string $titleText
|
|
* @param int|null $ns
|
|
* @return array
|
|
*/
|
|
private function createTitleAndPage( string $titleText, ?int $ns = 0 ) {
|
|
$title = Title::newFromText( $titleText, $ns );
|
|
$page = $this->getExistingTestPage( $title );
|
|
|
|
return [
|
|
'title' => $title,
|
|
'pageID' => $page->getRevisionRecord()->getPageId(),
|
|
'revID' => $page->getRevisionRecord()->getID()
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Get just the lint error linter_tag field value for a page
|
|
*
|
|
* @param int $pageId
|
|
* @return mixed
|
|
*/
|
|
private function getTagForPage( int $pageId ) {
|
|
$queryPageTag = new SelectQueryBuilder( $this->db );
|
|
$queryPageTag
|
|
->select( 'linter_tag' )
|
|
->table( 'linter' )
|
|
->where( [ 'linter_page' => $pageId ] )
|
|
->caller( __METHOD__ );
|
|
return $queryPageTag->fetchField();
|
|
}
|
|
|
|
/**
|
|
* Get just the lint error linter_template field value for a page
|
|
*
|
|
* @param int $pageId
|
|
* @return mixed
|
|
*/
|
|
private function getTemplateForPage( int $pageId ) {
|
|
$queryPageTemplate = new SelectQueryBuilder( $this->db );
|
|
$queryPageTemplate
|
|
->select( 'linter_template' )
|
|
->table( 'linter' )
|
|
->where( [ 'linter_page' => $pageId ] )
|
|
->caller( __METHOD__ );
|
|
return $queryPageTemplate->fetchField();
|
|
}
|
|
|
|
/**
|
|
* Get just the linter_namespace field value from the linter table for a page
|
|
*
|
|
* @param int $pageId
|
|
* @return mixed
|
|
*/
|
|
private function getNamespaceForPage( int $pageId ) {
|
|
$queryLinterPageNamespace = new SelectQueryBuilder( $this->db );
|
|
$queryLinterPageNamespace
|
|
->select( 'linter_namespace' )
|
|
->table( 'linter' )
|
|
->where( [ 'linter_page' => $pageId ] )
|
|
->caller( __METHOD__ );
|
|
return $queryLinterPageNamespace->fetchField();
|
|
}
|
|
|
|
public function testRun() {
|
|
$error = [
|
|
'type' => 'fostered',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPage = $this->createTitleAndPage( 'TestPage' );
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
$db = new Database( $titleAndPage[ 'pageID' ] );
|
|
$errorsFromDb = array_values( $db->getForPage() );
|
|
$this->assertCount( 1, $errorsFromDb );
|
|
$this->assertInstanceOf( LintError::class, $errorsFromDb[ 0 ] );
|
|
$this->assertEquals( $error[ 'type' ], $errorsFromDb[ 0 ]->category );
|
|
$this->assertEquals( $error[ 'location' ], $errorsFromDb[ 0 ]->location );
|
|
$this->assertEquals( $error[ 'params' ], $errorsFromDb[ 0 ]->params );
|
|
}
|
|
|
|
public function testWriteTagAndTemplate() {
|
|
$this->overrideConfigValue( 'LinterWriteTagAndTemplateColumnsStage', true );
|
|
$error = [
|
|
'type' => 'obsolete-tag',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [
|
|
"name" => "center",
|
|
"templateInfo" => [ "name" => "Template:Echo" ]
|
|
],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPage = $this->createTitleAndPage( 'TestPage2' );
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
$pageId = $titleAndPage[ 'pageID' ];
|
|
$db = new Database( $pageId );
|
|
$errorsFromDb = array_values( $db->getForPage() );
|
|
$this->assertCount( 1, $errorsFromDb );
|
|
$this->assertInstanceOf( LintError::class, $errorsFromDb[0] );
|
|
$this->assertEquals( $error[ 'type' ], $errorsFromDb[0]->category );
|
|
$this->assertEquals( $error[ 'location' ], $errorsFromDb[0]->location );
|
|
$this->assertEquals( $error[ 'params' ], $errorsFromDb[0]->params );
|
|
$tag = $this->getTagForPage( $pageId );
|
|
$this->assertEquals( $error[ 'params' ][ 'name' ], $tag );
|
|
$template = $this->getTemplateForPage( $pageId );
|
|
$this->assertEquals( $error[ 'params' ][ 'templateInfo' ][ 'name' ], $template );
|
|
}
|
|
|
|
public function testWriteTagAndTemplateLengthExceeded() {
|
|
$this->overrideConfigValue( 'LinterWriteTagAndTemplateColumnsStage', true );
|
|
|
|
// Verify special case test for write code encountering params with tag and template string lengths exceeded
|
|
$tagWithMoreThan30Characters = "center tag exceeding 30 characters";
|
|
$tagTruncated = "center tag exceeding 30 charac";
|
|
$templateWithMoreThan250Characters = str_repeat( "Template:Echo longer than 250 characters ", 8 );
|
|
$templateTruncated = "Template:Echo longer than 250 characters Template:Echo longer than 250 characters " .
|
|
"Template:Echo longer than 250 characters Template:Echo longer than 250 characters " .
|
|
"Template:Echo longer than 250 characters Template:Echo longer than 250 characters Temp";
|
|
|
|
$error = [
|
|
'type' => 'obsolete-tag',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [
|
|
"name" => $tagWithMoreThan30Characters,
|
|
"templateInfo" => [ "name" => $templateWithMoreThan250Characters ]
|
|
],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPage = $this->createTitleAndPage( 'TestPage2' );
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
$pageId = $titleAndPage[ 'pageID' ];
|
|
$db = new Database( $pageId );
|
|
$errorsFromDb = array_values( $db->getForPage() );
|
|
$this->assertCount( 1, $errorsFromDb );
|
|
$this->assertInstanceOf( LintError::class, $errorsFromDb[0] );
|
|
$this->assertEquals( $error[ 'type' ], $errorsFromDb[0]->category );
|
|
$this->assertEquals( $error[ 'location' ], $errorsFromDb[0]->location );
|
|
$this->assertEquals( $error[ 'params' ], $errorsFromDb[0]->params );
|
|
$tag = $this->getTagForPage( $pageId );
|
|
$this->assertEquals( $tagTruncated, $tag );
|
|
$template = $this->getTemplateForPage( $pageId );
|
|
$this->assertEquals( $templateTruncated, $template );
|
|
}
|
|
|
|
/**
|
|
* @param string $titleText
|
|
* @param int $namespace
|
|
* @return array
|
|
*/
|
|
private function createTitleAndPageAndRunJob( string $titleText, int $namespace ): array {
|
|
$titleAndPage = $this->createTitleAndPage( $titleText, $namespace );
|
|
$error = [
|
|
'type' => 'fostered',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [],
|
|
'dbid' => null,
|
|
];
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
return $titleAndPage;
|
|
}
|
|
|
|
/**
|
|
* @param array $namespaceIds
|
|
* @param array $writeEnables
|
|
* @return array
|
|
*/
|
|
private function createPagesWithNamespace( array $namespaceIds, array $writeEnables ): array {
|
|
$titleAndPages = [];
|
|
foreach ( $namespaceIds as $index => $namespaceId ) {
|
|
// enable/disable writing the namespace field in the linter table during page creation
|
|
$this->overrideConfigValue( 'LinterWriteNamespaceColumnStage', $writeEnables[ $index ] );
|
|
$titleAndPages[] = $this->createTitleAndPageAndRunJob(
|
|
'TestPageNamespace' . $index,
|
|
intval( $namespaceId ) );
|
|
}
|
|
return $titleAndPages;
|
|
}
|
|
|
|
/**
|
|
* @param array $pages
|
|
* @param array $namespaceIds
|
|
* @return void
|
|
*/
|
|
private function checkPagesNamespace( array $pages, array $namespaceIds ) {
|
|
foreach ( $pages as $index => $page ) {
|
|
$pageId = $page[ 'pageID' ];
|
|
$namespace = $this->getNamespaceForPage( $pageId );
|
|
$namespaceId = $namespaceIds[ $index ];
|
|
$this->assertSame( "$namespaceId", $namespace );
|
|
}
|
|
}
|
|
|
|
public function testMigrateNamespace() {
|
|
// Create groups of records that do not need migrating to ensure batching works properly
|
|
$namespaceIds = [ '0', '1', '2', '3', '4', '5', '4', '3', '2', '1', '0', '1', '2' ];
|
|
$writeEnables = [ false, true, true, true, false, false, true, true, false, false, false, true, false ];
|
|
|
|
$titleAndPages = $this->createPagesWithNamespace( $namespaceIds, $writeEnables );
|
|
|
|
// Verify the create page function did not populate the linter_namespace field for TestPageNamespace0
|
|
$pageId = $titleAndPages[ 0 ][ 'pageID' ];
|
|
$namespace = $this->getNamespaceForPage( $pageId );
|
|
$this->assertNull( $namespace );
|
|
|
|
// migrate unpopulated namespace_id(s) from the page table to linter table
|
|
Database::migrateNamespace( 2, 3, 0, true );
|
|
|
|
// Verify all linter records now have proper namespace IDs in the linter_namespace field
|
|
$this->checkPagesNamespace( $titleAndPages, $namespaceIds );
|
|
}
|
|
|
|
/**
|
|
* @param string $titleText
|
|
* @param array $error
|
|
* @return array
|
|
*/
|
|
private function createTitleAndPageForTagsAndRunJob( string $titleText, array $error ): array {
|
|
$titleAndPage = $this->createTitleAndPage( $titleText );
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
return $titleAndPage;
|
|
}
|
|
|
|
/**
|
|
* @param array $writeEnables
|
|
* @param array $error
|
|
* @return array
|
|
*/
|
|
private function createPagesWithTagAndTemplate( array $writeEnables, array $error ): array {
|
|
$titleAndPages = [];
|
|
foreach ( $writeEnables as $index => $enable ) {
|
|
// enable/disable writing the tag and template fields in the linter table during page creation
|
|
$this->overrideConfigValue( 'LinterWriteTagAndTemplateColumnsStage', $enable );
|
|
$titleAndPages[] = $this->createTitleAndPageForTagsAndRunJob( 'TestPage' . $index, $error );
|
|
}
|
|
return $titleAndPages;
|
|
}
|
|
|
|
/**
|
|
* @param array $pages
|
|
* @return void
|
|
*/
|
|
private function checkPagesTagAndTemplate( array $pages ) {
|
|
foreach ( $pages as $page ) {
|
|
$pageId = $page[ 'pageID' ];
|
|
$tag = $this->getTagForPage( $pageId );
|
|
$this->assertEquals( "center", $tag );
|
|
$template = $this->getTemplateForPage( $pageId );
|
|
$this->assertEquals( "Template:Echo", $template );
|
|
}
|
|
}
|
|
|
|
public function testMigrateTagAndTemplate() {
|
|
$error = [
|
|
'type' => 'obsolete-tag',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [ "name" => "center",
|
|
"templateInfo" => [ "name" => "Template:Echo" ] ],
|
|
'dbid' => null,
|
|
];
|
|
|
|
// Create groups of records that do not need migrating to ensure batching works properly
|
|
$writeEnables = [ false, true, true, true, false, false, true, true, false, false, false, true, false ];
|
|
$titleAndPages = $this->createPagesWithTagAndTemplate( $writeEnables, $error );
|
|
|
|
// Create special case test of migrate code encountering brackets - linter_params = '[]'
|
|
$this->overrideConfigValue( 'LinterWriteTagAndTemplateColumnsStage', false );
|
|
$error = [
|
|
'type' => 'wikilink-in-extlink',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPageBrackets = $this->createTitleAndPageForTagsAndRunJob(
|
|
'TestPageTagAndTemplateBrackets',
|
|
$error );
|
|
|
|
// Create special case test for migrate code encountering 'multi-part-template-block'
|
|
$error = [
|
|
'type' => 'obsolete-tag',
|
|
'location' => [ 0, 10 ],
|
|
'params' => '{"name":"center","templateInfo":{"multiPartTemplateBlock":true}}',
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPageMultipart = $this->createTitleAndPageForTagsAndRunJob(
|
|
'TestPageTagAndTemplateMultipart',
|
|
$error );
|
|
|
|
// Create special case test for params containing tag and template info strings exceeding the fields lengths
|
|
$tagWithMoreThan30Characters = "center tag exceeding 30 characters";
|
|
$templateWithMoreThan250Characters = str_repeat( "Template:Echo longer than 250 characters ", 8 );
|
|
$error = [
|
|
'type' => 'obsolete-tag',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [ "name" => $tagWithMoreThan30Characters,
|
|
"templateInfo" => $templateWithMoreThan250Characters ],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPageLengthExceeded = $this->createTitleAndPageForTagsAndRunJob(
|
|
'TestPageTagAndTemplateLengthExceeded',
|
|
$error );
|
|
|
|
// Verify the create page function did not populate the linter_tag and linter_template field for TestPage0
|
|
$pageId = $titleAndPages[ 0 ][ 'pageID' ];
|
|
$tag = $this->getTagForPage( $pageId );
|
|
$this->assertSame( "", $tag );
|
|
$template = $this->getTemplateForPage( $pageId );
|
|
$this->assertSame( "", $template );
|
|
|
|
// Migrate unpopulated tag and template info from the params field
|
|
Database::migrateTemplateAndTagInfo( 3, 0, true );
|
|
|
|
// Verify all linter records have the proper tag and template field info migrated from the params field
|
|
$this->checkPagesTagAndTemplate( $titleAndPages );
|
|
|
|
// Verify special case test of migrate code encountering brackets - linter_params = '[]'
|
|
$tag = $this->getTagForPage( $titleAndPageBrackets[ 'pageID' ] );
|
|
$this->assertSame( "", $tag );
|
|
$template = $this->getTemplateForPage( $titleAndPageBrackets[ 'pageID' ] );
|
|
$this->assertSame( "", $template );
|
|
|
|
// Verify special case test for migrate code encountering 'multi-part-template-block'
|
|
$tag = $this->getTagForPage( $titleAndPageMultipart[ 'pageID' ] );
|
|
$this->assertEquals( "center", $tag );
|
|
$template = $this->getTemplateForPage( $titleAndPageMultipart[ 'pageID' ] );
|
|
$this->assertEquals( "multi-part-template-block", $template );
|
|
|
|
// Verify special case test for migrate code encountering params with tag and template string length exceeded
|
|
$tagTruncated = "center tag exceeding 30 charac";
|
|
$templateTruncated = "Template:Echo longer than 250 characters Template:Echo longer than 250 characters " .
|
|
"Template:Echo longer than 250 characters Template:Echo longer than 250 characters " .
|
|
"Template:Echo longer than 250 characters Template:Echo longer than 250 characters Temp";
|
|
|
|
$tag = $this->getTagForPage( $titleAndPageLengthExceeded[ 'pageID' ] );
|
|
$this->assertEquals( $tagTruncated, $tag );
|
|
$template = $this->getTemplateForPage( $titleAndPageLengthExceeded[ 'pageID' ] );
|
|
$this->assertEquals( $templateTruncated, $template );
|
|
}
|
|
|
|
public function testDropInlineMediaCaptionLints() {
|
|
$error = [
|
|
'type' => 'inline-media-caption',
|
|
'location' => [ 0, 10 ],
|
|
'params' => [],
|
|
'dbid' => null,
|
|
];
|
|
$titleAndPage = $this->createTitleAndPage( 'TestPageMediaCaption' );
|
|
$job = new RecordLintJob( $titleAndPage[ 'title' ], [
|
|
'errors' => [ $error ],
|
|
'revision' => $titleAndPage[ 'revID' ]
|
|
] );
|
|
$this->assertTrue( $job->run() );
|
|
$errorsFromDb = array_values( ( new Database( $titleAndPage['pageID'] ) )->getForPage() );
|
|
$this->assertCount( 0, $errorsFromDb );
|
|
}
|
|
}
|