wiki.techinc.nl/tests/phpunit/includes/content/ContentHandlerTest.php
Timo Tijhof 447ce7e39a phpunit: Avoid use of deprecated getMock for PHPUnit 5 compat
The default will remain PHPUnit 4.x due to PHP 5.5 support.

But, we should allow developers to run tests with newer PHPUnit
versions which are noticably faster (especially for code coverage
reports).

* <https://github.com/sebastianbergmann/phpunit/wiki/Release-Announcement-for-PHPUnit-5.4.0>
  PHPUnit 5 deprecates the getMock() shortcut for getMockBuilder()->getMock().
  It instead introduces the shortcut createMock() which has better defaults
  than getMockBuilder(). For example, it sets 'disableArgumentCloning' and
  other things by default.

  Going forward, code should either use getMockBuilder directly and configure
  it using the setter methods (instead of the confusing variadic arguments
  of getMock) or simply use the new minimalistic createMock method. This patch
  backports the createMock method to MediaWikiTestCase so that we can start
  using it.

Change-Id: I091c0289b21d2b1c876adba89529dc3e72b99af2
2017-04-06 00:44:32 +00:00

478 lines
14 KiB
PHP

<?php
use MediaWiki\MediaWikiServices;
/**
* @group ContentHandler
* @group Database
*/
class ContentHandlerTest extends MediaWikiTestCase {
protected function setUp() {
global $wgContLang;
parent::setUp();
$this->setMwGlobals( [
'wgExtraNamespaces' => [
12312 => 'Dummy',
12313 => 'Dummy_talk',
],
// The below tests assume that namespaces not mentioned here (Help, User, MediaWiki, ..)
// default to CONTENT_MODEL_WIKITEXT.
'wgNamespaceContentModels' => [
12312 => 'testing',
],
'wgContentHandlers' => [
CONTENT_MODEL_WIKITEXT => 'WikitextContentHandler',
CONTENT_MODEL_JAVASCRIPT => 'JavaScriptContentHandler',
CONTENT_MODEL_JSON => 'JsonContentHandler',
CONTENT_MODEL_CSS => 'CssContentHandler',
CONTENT_MODEL_TEXT => 'TextContentHandler',
'testing' => 'DummyContentHandlerForTesting',
'testing-callbacks' => function( $modelId ) {
return new DummyContentHandlerForTesting( $modelId );
}
],
] );
// Reset namespace cache
MWNamespace::getCanonicalNamespaces( true );
$wgContLang->resetNamespaces();
// And LinkCache
MediaWikiServices::getInstance()->resetServiceForTesting( 'LinkCache' );
}
protected function tearDown() {
global $wgContLang;
// Reset namespace cache
MWNamespace::getCanonicalNamespaces( true );
$wgContLang->resetNamespaces();
// And LinkCache
MediaWikiServices::getInstance()->resetServiceForTesting( 'LinkCache' );
parent::tearDown();
}
public function addDBDataOnce() {
$this->insertPage( 'Not_Main_Page', 'This is not a main page' );
$this->insertPage( 'Smithee', 'A smithee is one who smiths. See also [[Alan Smithee]]' );
}
public static function dataGetDefaultModelFor() {
return [
[ 'Help:Foo', CONTENT_MODEL_WIKITEXT ],
[ 'Help:Foo.js', CONTENT_MODEL_WIKITEXT ],
[ 'Help:Foo.css', CONTENT_MODEL_WIKITEXT ],
[ 'Help:Foo.json', CONTENT_MODEL_WIKITEXT ],
[ 'Help:Foo/bar.js', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo.js', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo.css', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo.json', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo/bar.js', CONTENT_MODEL_JAVASCRIPT ],
[ 'User:Foo/bar.css', CONTENT_MODEL_CSS ],
[ 'User:Foo/bar.json', CONTENT_MODEL_JSON ],
[ 'User:Foo/bar.json.nope', CONTENT_MODEL_WIKITEXT ],
[ 'User talk:Foo/bar.css', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo/bar.js.xxx', CONTENT_MODEL_WIKITEXT ],
[ 'User:Foo/bar.xxx', CONTENT_MODEL_WIKITEXT ],
[ 'MediaWiki:Foo.js', CONTENT_MODEL_JAVASCRIPT ],
[ 'MediaWiki:Foo.JS', CONTENT_MODEL_WIKITEXT ],
[ 'MediaWiki:Foo.css', CONTENT_MODEL_CSS ],
[ 'MediaWiki:Foo.css.xxx', CONTENT_MODEL_WIKITEXT ],
[ 'MediaWiki:Foo.CSS', CONTENT_MODEL_WIKITEXT ],
[ 'MediaWiki:Foo.json', CONTENT_MODEL_JSON ],
[ 'MediaWiki:Foo.JSON', CONTENT_MODEL_WIKITEXT ],
];
}
/**
* @dataProvider dataGetDefaultModelFor
* @covers ContentHandler::getDefaultModelFor
*/
public function testGetDefaultModelFor( $title, $expectedModelId ) {
$title = Title::newFromText( $title );
$this->assertEquals( $expectedModelId, ContentHandler::getDefaultModelFor( $title ) );
}
/**
* @dataProvider dataGetDefaultModelFor
* @covers ContentHandler::getForTitle
*/
public function testGetForTitle( $title, $expectedContentModel ) {
$title = Title::newFromText( $title );
LinkCache::singleton()->addBadLinkObj( $title );
$handler = ContentHandler::getForTitle( $title );
$this->assertEquals( $expectedContentModel, $handler->getModelID() );
}
public static function dataGetLocalizedName() {
return [
[ null, null ],
[ "xyzzy", null ],
// XXX: depends on content language
[ CONTENT_MODEL_JAVASCRIPT, '/javascript/i' ],
];
}
/**
* @dataProvider dataGetLocalizedName
* @covers ContentHandler::getLocalizedName
*/
public function testGetLocalizedName( $id, $expected ) {
$name = ContentHandler::getLocalizedName( $id );
if ( $expected ) {
$this->assertNotNull( $name, "no name found for content model $id" );
$this->assertTrue( preg_match( $expected, $name ) > 0,
"content model name for #$id did not match pattern $expected"
);
} else {
$this->assertEquals( $id, $name, "localization of unknown model $id should have "
. "fallen back to use the model id directly."
);
}
}
public static function dataGetPageLanguage() {
global $wgLanguageCode;
return [
[ "Main", $wgLanguageCode ],
[ "Dummy:Foo", $wgLanguageCode ],
[ "MediaWiki:common.js", 'en' ],
[ "User:Foo/common.js", 'en' ],
[ "MediaWiki:common.css", 'en' ],
[ "User:Foo/common.css", 'en' ],
[ "User:Foo", $wgLanguageCode ],
[ CONTENT_MODEL_JAVASCRIPT, 'javascript' ],
];
}
/**
* @dataProvider dataGetPageLanguage
* @covers ContentHandler::getPageLanguage
*/
public function testGetPageLanguage( $title, $expected ) {
if ( is_string( $title ) ) {
$title = Title::newFromText( $title );
LinkCache::singleton()->addBadLinkObj( $title );
}
$expected = wfGetLangObj( $expected );
$handler = ContentHandler::getForTitle( $title );
$lang = $handler->getPageLanguage( $title );
$this->assertEquals( $expected->getCode(), $lang->getCode() );
}
public static function dataGetContentText_Null() {
return [
[ 'fail' ],
[ 'serialize' ],
[ 'ignore' ],
];
}
/**
* @dataProvider dataGetContentText_Null
* @covers ContentHandler::getContentText
*/
public function testGetContentText_Null( $contentHandlerTextFallback ) {
$this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
$content = null;
$text = ContentHandler::getContentText( $content );
$this->assertEquals( '', $text );
}
public static function dataGetContentText_TextContent() {
return [
[ 'fail' ],
[ 'serialize' ],
[ 'ignore' ],
];
}
/**
* @dataProvider dataGetContentText_TextContent
* @covers ContentHandler::getContentText
*/
public function testGetContentText_TextContent( $contentHandlerTextFallback ) {
$this->setMwGlobals( 'wgContentHandlerTextFallback', $contentHandlerTextFallback );
$content = new WikitextContent( "hello world" );
$text = ContentHandler::getContentText( $content );
$this->assertEquals( $content->getNativeData(), $text );
}
/**
* ContentHandler::getContentText should have thrown an exception for non-text Content object
* @expectedException MWException
* @covers ContentHandler::getContentText
*/
public function testGetContentText_NonTextContent_fail() {
$this->setMwGlobals( 'wgContentHandlerTextFallback', 'fail' );
$content = new DummyContentForTesting( "hello world" );
ContentHandler::getContentText( $content );
}
/**
* @covers ContentHandler::getContentText
*/
public function testGetContentText_NonTextContent_serialize() {
$this->setMwGlobals( 'wgContentHandlerTextFallback', 'serialize' );
$content = new DummyContentForTesting( "hello world" );
$text = ContentHandler::getContentText( $content );
$this->assertEquals( $content->serialize(), $text );
}
/**
* @covers ContentHandler::getContentText
*/
public function testGetContentText_NonTextContent_ignore() {
$this->setMwGlobals( 'wgContentHandlerTextFallback', 'ignore' );
$content = new DummyContentForTesting( "hello world" );
$text = ContentHandler::getContentText( $content );
$this->assertNull( $text );
}
/*
public static function makeContent( $text, Title $title, $modelId = null, $format = null ) {}
*/
public static function dataMakeContent() {
return [
[ 'hallo', 'Help:Test', null, null, CONTENT_MODEL_WIKITEXT, 'hallo', false ],
[ 'hallo', 'MediaWiki:Test.js', null, null, CONTENT_MODEL_JAVASCRIPT, 'hallo', false ],
[ serialize( 'hallo' ), 'Dummy:Test', null, null, "testing", 'hallo', false ],
[
'hallo',
'Help:Test',
null,
CONTENT_FORMAT_WIKITEXT,
CONTENT_MODEL_WIKITEXT,
'hallo',
false
],
[
'hallo',
'MediaWiki:Test.js',
null,
CONTENT_FORMAT_JAVASCRIPT,
CONTENT_MODEL_JAVASCRIPT,
'hallo',
false
],
[ serialize( 'hallo' ), 'Dummy:Test', null, "testing", "testing", 'hallo', false ],
[ 'hallo', 'Help:Test', CONTENT_MODEL_CSS, null, CONTENT_MODEL_CSS, 'hallo', false ],
[
'hallo',
'MediaWiki:Test.js',
CONTENT_MODEL_CSS,
null,
CONTENT_MODEL_CSS,
'hallo',
false
],
[
serialize( 'hallo' ),
'Dummy:Test',
CONTENT_MODEL_CSS,
null,
CONTENT_MODEL_CSS,
serialize( 'hallo' ),
false
],
[ 'hallo', 'Help:Test', CONTENT_MODEL_WIKITEXT, "testing", null, null, true ],
[ 'hallo', 'MediaWiki:Test.js', CONTENT_MODEL_CSS, "testing", null, null, true ],
[ 'hallo', 'Dummy:Test', CONTENT_MODEL_JAVASCRIPT, "testing", null, null, true ],
];
}
/**
* @dataProvider dataMakeContent
* @covers ContentHandler::makeContent
*/
public function testMakeContent( $data, $title, $modelId, $format,
$expectedModelId, $expectedNativeData, $shouldFail
) {
$title = Title::newFromText( $title );
LinkCache::singleton()->addBadLinkObj( $title );
try {
$content = ContentHandler::makeContent( $data, $title, $modelId, $format );
if ( $shouldFail ) {
$this->fail( "ContentHandler::makeContent should have failed!" );
}
$this->assertEquals( $expectedModelId, $content->getModel(), 'bad model id' );
$this->assertEquals( $expectedNativeData, $content->getNativeData(), 'bads native data' );
} catch ( MWException $ex ) {
if ( !$shouldFail ) {
$this->fail( "ContentHandler::makeContent failed unexpectedly: " . $ex->getMessage() );
} else {
// dummy, so we don't get the "test did not perform any assertions" message.
$this->assertTrue( true );
}
}
}
/*
* Test if we become a "Created blank page" summary from getAutoSummary if no Content added to
* page.
*/
public function testGetAutosummary() {
$this->setMwGlobals( 'wgContLang', Language::factory( 'en' ) );
$content = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT );
$title = Title::newFromText( 'Help:Test' );
// Create a new content object with no content
$newContent = ContentHandler::makeContent( '', $title, null, null, CONTENT_MODEL_WIKITEXT );
// first check, if we become a blank page created summary with the right bitmask
$autoSummary = $content->getAutosummary( null, $newContent, 97 );
$this->assertEquals( $autoSummary, 'Created blank page' );
// now check, what we become with another bitmask
$autoSummary = $content->getAutosummary( null, $newContent, 92 );
$this->assertEquals( $autoSummary, '' );
}
/*
public function testSupportsSections() {
$this->markTestIncomplete( "not yet implemented" );
}
*/
public function testSupportsCategories() {
$handler = new DummyContentHandlerForTesting( CONTENT_MODEL_WIKITEXT );
$this->assertTrue( $handler->supportsCategories(), 'content model supports categories' );
}
public function testSupportsDirectEditing() {
$handler = new DummyContentHandlerForTesting( CONTENT_MODEL_JSON );
$this->assertFalse( $handler->supportsDirectEditing(), 'direct editing is not supported' );
}
public static function dummyHookHandler( $foo, &$text, $bar ) {
if ( $text === null || $text === false ) {
return false;
}
$text = strtoupper( $text );
return true;
}
public function provideGetModelForID() {
return [
[ CONTENT_MODEL_WIKITEXT, 'WikitextContentHandler' ],
[ CONTENT_MODEL_JAVASCRIPT, 'JavaScriptContentHandler' ],
[ CONTENT_MODEL_JSON, 'JsonContentHandler' ],
[ CONTENT_MODEL_CSS, 'CssContentHandler' ],
[ CONTENT_MODEL_TEXT, 'TextContentHandler' ],
[ 'testing', 'DummyContentHandlerForTesting' ],
[ 'testing-callbacks', 'DummyContentHandlerForTesting' ],
];
}
/**
* @dataProvider provideGetModelForID
*/
public function testGetModelForID( $modelId, $handlerClass ) {
$handler = ContentHandler::getForModelID( $modelId );
$this->assertInstanceOf( $handlerClass, $handler );
}
public function testGetFieldsForSearchIndex() {
$searchEngine = $this->newSearchEngine();
$handler = ContentHandler::getForModelID( CONTENT_MODEL_WIKITEXT );
$fields = $handler->getFieldsForSearchIndex( $searchEngine );
$this->assertArrayHasKey( 'category', $fields );
$this->assertArrayHasKey( 'external_link', $fields );
$this->assertArrayHasKey( 'outgoing_link', $fields );
$this->assertArrayHasKey( 'template', $fields );
$this->assertArrayHasKey( 'content_model', $fields );
}
private function newSearchEngine() {
$searchEngine = $this->getMockBuilder( 'SearchEngine' )
->getMock();
$searchEngine->expects( $this->any() )
->method( 'makeSearchFieldMapping' )
->will( $this->returnCallback( function( $name, $type ) {
return new DummySearchIndexFieldDefinition( $name, $type );
} ) );
return $searchEngine;
}
/**
* @covers ContentHandler::getDataForSearchIndex
*/
public function testDataIndexFields() {
$mockEngine = $this->createMock( 'SearchEngine' );
$title = Title::newFromText( 'Not_Main_Page', NS_MAIN );
$page = new WikiPage( $title );
$this->setTemporaryHook( 'SearchDataForIndex',
function (
&$fields,
ContentHandler $handler,
WikiPage $page,
ParserOutput $output,
SearchEngine $engine
) {
$fields['testDataField'] = 'test content';
} );
$output = $page->getContent()->getParserOutput( $title );
$data = $page->getContentHandler()->getDataForSearchIndex( $page, $output, $mockEngine );
$this->assertArrayHasKey( 'text', $data );
$this->assertArrayHasKey( 'text_bytes', $data );
$this->assertArrayHasKey( 'language', $data );
$this->assertArrayHasKey( 'testDataField', $data );
$this->assertEquals( 'test content', $data['testDataField'] );
$this->assertEquals( 'wikitext', $data['content_model'] );
}
/**
* @covers ContentHandler::getParserOutputForIndexing
*/
public function testParserOutputForIndexing() {
$title = Title::newFromText( 'Smithee', NS_MAIN );
$page = new WikiPage( $title );
$out = $page->getContentHandler()->getParserOutputForIndexing( $page );
$this->assertInstanceOf( ParserOutput::class, $out );
$this->assertContains( 'one who smiths', $out->getRawText() );
}
/**
* @covers ContentHandler::getContentModels
*/
public function testGetContentModelsHook() {
$this->setTemporaryHook( 'GetContentModels', function ( &$models ) {
$models[] = 'Ferrari';
} );
$this->assertContains( 'Ferrari', ContentHandler::getContentModels() );
}
}