wiki.techinc.nl/tests/phpunit/includes/RevisionTest.php
Thiemo Mättig 2aa67db39d Fix "@param null $param" documentations
... and very few other documentation details that are closely connected
to these mistakes.

Change-Id: I5b2691948e196124c77f0cc04d0ed5a7167cac25
2014-04-09 12:33:55 +02:00

479 lines
14 KiB
PHP

<?php
/**
* @group ContentHandler
*/
class RevisionTest extends MediaWikiTestCase {
protected function setUp() {
global $wgContLang;
parent::setUp();
$this->setMwGlobals( array(
'wgContLang' => Language::factory( 'en' ),
'wgLanguageCode' => 'en',
'wgLegacyEncoding' => false,
'wgCompressRevisions' => false,
'wgContentHandlerTextFallback' => 'ignore',
) );
$this->mergeMwGlobalArrayValue(
'wgExtraNamespaces',
array(
12312 => 'Dummy',
12313 => 'Dummy_talk',
)
);
$this->mergeMwGlobalArrayValue(
'wgNamespaceContentModels',
array(
12312 => 'testing',
)
);
$this->mergeMwGlobalArrayValue(
'wgContentHandlers',
array(
'testing' => 'DummyContentHandlerForTesting',
'RevisionTestModifyableContent' => 'RevisionTestModifyableContentHandler',
)
);
MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
$wgContLang->resetNamespaces(); # reset namespace cache
}
function tearDown() {
global $wgContLang;
MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
$wgContLang->resetNamespaces(); # reset namespace cache
parent::tearDown();
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionText() {
$row = new stdClass;
$row->old_flags = '';
$row->old_text = 'This is a bunch of revision text.';
$this->assertEquals(
'This is a bunch of revision text.',
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionTextGzip() {
$this->checkPHPExtension( 'zlib' );
$row = new stdClass;
$row->old_flags = 'gzip';
$row->old_text = gzdeflate( 'This is a bunch of revision text.' );
$this->assertEquals(
'This is a bunch of revision text.',
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionTextUtf8Native() {
$row = new stdClass;
$row->old_flags = 'utf-8';
$row->old_text = "Wiki est l'\xc3\xa9cole superieur !";
$GLOBALS['wgLegacyEncoding'] = 'iso-8859-1';
$this->assertEquals(
"Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionTextUtf8Legacy() {
$row = new stdClass;
$row->old_flags = '';
$row->old_text = "Wiki est l'\xe9cole superieur !";
$GLOBALS['wgLegacyEncoding'] = 'iso-8859-1';
$this->assertEquals(
"Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionTextUtf8NativeGzip() {
$this->checkPHPExtension( 'zlib' );
$row = new stdClass;
$row->old_flags = 'gzip,utf-8';
$row->old_text = gzdeflate( "Wiki est l'\xc3\xa9cole superieur !" );
$GLOBALS['wgLegacyEncoding'] = 'iso-8859-1';
$this->assertEquals(
"Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::getRevisionText
*/
public function testGetRevisionTextUtf8LegacyGzip() {
$this->checkPHPExtension( 'zlib' );
$row = new stdClass;
$row->old_flags = 'gzip';
$row->old_text = gzdeflate( "Wiki est l'\xe9cole superieur !" );
$GLOBALS['wgLegacyEncoding'] = 'iso-8859-1';
$this->assertEquals(
"Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ) );
}
/**
* @covers Revision::compressRevisionText
*/
public function testCompressRevisionTextUtf8() {
$row = new stdClass;
$row->old_text = "Wiki est l'\xc3\xa9cole superieur !";
$row->old_flags = Revision::compressRevisionText( $row->old_text );
$this->assertTrue( false !== strpos( $row->old_flags, 'utf-8' ),
"Flags should contain 'utf-8'" );
$this->assertFalse( false !== strpos( $row->old_flags, 'gzip' ),
"Flags should not contain 'gzip'" );
$this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
$row->old_text, "Direct check" );
$this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ), "getRevisionText" );
}
/**
* @covers Revision::compressRevisionText
*/
public function testCompressRevisionTextUtf8Gzip() {
$this->checkPHPExtension( 'zlib' );
$this->setMwGlobals( 'wgCompressRevisions', true );
$row = new stdClass;
$row->old_text = "Wiki est l'\xc3\xa9cole superieur !";
$row->old_flags = Revision::compressRevisionText( $row->old_text );
$this->assertTrue( false !== strpos( $row->old_flags, 'utf-8' ),
"Flags should contain 'utf-8'" );
$this->assertTrue( false !== strpos( $row->old_flags, 'gzip' ),
"Flags should contain 'gzip'" );
$this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
gzinflate( $row->old_text ), "Direct check" );
$this->assertEquals( "Wiki est l'\xc3\xa9cole superieur !",
Revision::getRevisionText( $row ), "getRevisionText" );
}
# =================================================================================================================
/**
* @param string $text
* @param string $title
* @param string $model
* @param string $format
*
* @return Revision
*/
function newTestRevision( $text, $title = "Test", $model = CONTENT_MODEL_WIKITEXT, $format = null ) {
if ( is_string( $title ) ) {
$title = Title::newFromText( $title );
}
$content = ContentHandler::makeContent( $text, $title, $model, $format );
$rev = new Revision(
array(
'id' => 42,
'page' => 23,
'title' => $title,
'content' => $content,
'length' => $content->getSize(),
'comment' => "testing",
'minor_edit' => false,
'content_format' => $format,
)
);
return $rev;
}
function dataGetContentModel() {
//NOTE: we expect the help namespace to always contain wikitext
return array(
array( 'hello world', 'Help:Hello', null, null, CONTENT_MODEL_WIKITEXT ),
array( 'hello world', 'User:hello/there.css', null, null, CONTENT_MODEL_CSS ),
array( serialize( 'hello world' ), 'Dummy:Hello', null, null, "testing" ),
);
}
/**
* @group Database
* @dataProvider dataGetContentModel
* @covers Revision::getContentModel
*/
public function testGetContentModel( $text, $title, $model, $format, $expectedModel ) {
$rev = $this->newTestRevision( $text, $title, $model, $format );
$this->assertEquals( $expectedModel, $rev->getContentModel() );
}
function dataGetContentFormat() {
//NOTE: we expect the help namespace to always contain wikitext
return array(
array( 'hello world', 'Help:Hello', null, null, CONTENT_FORMAT_WIKITEXT ),
array( 'hello world', 'Help:Hello', CONTENT_MODEL_CSS, null, CONTENT_FORMAT_CSS ),
array( 'hello world', 'User:hello/there.css', null, null, CONTENT_FORMAT_CSS ),
array( serialize( 'hello world' ), 'Dummy:Hello', null, null, "testing" ),
);
}
/**
* @group Database
* @dataProvider dataGetContentFormat
* @covers Revision::getContentFormat
*/
public function testGetContentFormat( $text, $title, $model, $format, $expectedFormat ) {
$rev = $this->newTestRevision( $text, $title, $model, $format );
$this->assertEquals( $expectedFormat, $rev->getContentFormat() );
}
function dataGetContentHandler() {
//NOTE: we expect the help namespace to always contain wikitext
return array(
array( 'hello world', 'Help:Hello', null, null, 'WikitextContentHandler' ),
array( 'hello world', 'User:hello/there.css', null, null, 'CssContentHandler' ),
array( serialize( 'hello world' ), 'Dummy:Hello', null, null, 'DummyContentHandlerForTesting' ),
);
}
/**
* @group Database
* @dataProvider dataGetContentHandler
* @covers Revision::getContentHandler
*/
public function testGetContentHandler( $text, $title, $model, $format, $expectedClass ) {
$rev = $this->newTestRevision( $text, $title, $model, $format );
$this->assertEquals( $expectedClass, get_class( $rev->getContentHandler() ) );
}
function dataGetContent() {
//NOTE: we expect the help namespace to always contain wikitext
return array(
array( 'hello world', 'Help:Hello', null, null, Revision::FOR_PUBLIC, 'hello world' ),
array( serialize( 'hello world' ), 'Hello', "testing", null, Revision::FOR_PUBLIC, serialize( 'hello world' ) ),
array( serialize( 'hello world' ), 'Dummy:Hello', null, null, Revision::FOR_PUBLIC, serialize( 'hello world' ) ),
);
}
/**
* @group Database
* @dataProvider dataGetContent
* @covers Revision::getContent
*/
public function testGetContent( $text, $title, $model, $format, $audience, $expectedSerialization ) {
$rev = $this->newTestRevision( $text, $title, $model, $format );
$content = $rev->getContent( $audience );
$this->assertEquals( $expectedSerialization, is_null( $content ) ? null : $content->serialize( $format ) );
}
function dataGetText() {
//NOTE: we expect the help namespace to always contain wikitext
return array(
array( 'hello world', 'Help:Hello', null, null, Revision::FOR_PUBLIC, 'hello world' ),
array( serialize( 'hello world' ), 'Hello', "testing", null, Revision::FOR_PUBLIC, null ),
array( serialize( 'hello world' ), 'Dummy:Hello', null, null, Revision::FOR_PUBLIC, null ),
);
}
/**
* @group Database
* @dataProvider dataGetText
* @covers Revision::getText
*/
public function testGetText( $text, $title, $model, $format, $audience, $expectedText ) {
$this->hideDeprecated( 'Revision::getText' );
$rev = $this->newTestRevision( $text, $title, $model, $format );
$this->assertEquals( $expectedText, $rev->getText( $audience ) );
}
/**
* @group Database
* @dataProvider dataGetText
* @covers Revision::getRawText
*/
public function testGetRawText( $text, $title, $model, $format, $audience, $expectedText ) {
$this->hideDeprecated( 'Revision::getRawText' );
$rev = $this->newTestRevision( $text, $title, $model, $format );
$this->assertEquals( $expectedText, $rev->getRawText( $audience ) );
}
public function dataGetSize() {
return array(
array( "hello world.", CONTENT_MODEL_WIKITEXT, 12 ),
array( serialize( "hello world." ), "testing", 12 ),
);
}
/**
* @covers Revision::getSize
* @group Database
* @dataProvider dataGetSize
*/
public function testGetSize( $text, $model, $expected_size ) {
$rev = $this->newTestRevision( $text, 'RevisionTest_testGetSize', $model );
$this->assertEquals( $expected_size, $rev->getSize() );
}
public function dataGetSha1() {
return array(
array( "hello world.", CONTENT_MODEL_WIKITEXT, Revision::base36Sha1( "hello world." ) ),
array( serialize( "hello world." ), "testing", Revision::base36Sha1( serialize( "hello world." ) ) ),
);
}
/**
* @covers Revision::getSha1
* @group Database
* @dataProvider dataGetSha1
*/
public function testGetSha1( $text, $model, $expected_hash ) {
$rev = $this->newTestRevision( $text, 'RevisionTest_testGetSha1', $model );
$this->assertEquals( $expected_hash, $rev->getSha1() );
}
/**
* @covers Revision::__construct
*/
public function testConstructWithText() {
$this->hideDeprecated( "Revision::getText" );
$rev = new Revision( array(
'text' => 'hello world.',
'content_model' => CONTENT_MODEL_JAVASCRIPT
) );
$this->assertNotNull( $rev->getText(), 'no content text' );
$this->assertNotNull( $rev->getContent(), 'no content object available' );
$this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContent()->getModel() );
$this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
}
/**
* @covers Revision::__construct
*/
public function testConstructWithContent() {
$this->hideDeprecated( "Revision::getText" );
$title = Title::newFromText( 'RevisionTest_testConstructWithContent' );
$rev = new Revision( array(
'content' => ContentHandler::makeContent( 'hello world.', $title, CONTENT_MODEL_JAVASCRIPT ),
) );
$this->assertNotNull( $rev->getText(), 'no content text' );
$this->assertNotNull( $rev->getContent(), 'no content object available' );
$this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContent()->getModel() );
$this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
}
/**
* Tests whether $rev->getContent() returns a clone when needed.
*
* @group Database
* @covers Revision::getContent
*/
public function testGetContentClone() {
$content = new RevisionTestModifyableContent( "foo" );
$rev = new Revision(
array(
'id' => 42,
'page' => 23,
'title' => Title::newFromText( "testGetContentClone_dummy" ),
'content' => $content,
'length' => $content->getSize(),
'comment' => "testing",
'minor_edit' => false,
)
);
$content = $rev->getContent( Revision::RAW );
$content->setText( "bar" );
$content2 = $rev->getContent( Revision::RAW );
$this->assertNotSame( $content, $content2, "expected a clone" ); // content is mutable, expect clone
$this->assertEquals( "foo", $content2->getText() ); // clone should contain the original text
$content2->setText( "bla bla" );
$this->assertEquals( "bar", $content->getText() ); // clones should be independent
}
/**
* Tests whether $rev->getContent() returns the same object repeatedly if appropriate.
*
* @group Database
* @covers Revision::getContent
*/
public function testGetContentUncloned() {
$rev = $this->newTestRevision( "hello", "testGetContentUncloned_dummy", CONTENT_MODEL_WIKITEXT );
$content = $rev->getContent( Revision::RAW );
$content2 = $rev->getContent( Revision::RAW );
// for immutable content like wikitext, this should be the same object
$this->assertSame( $content, $content2 );
}
}
class RevisionTestModifyableContent extends TextContent {
public function __construct( $text ) {
parent::__construct( $text, "RevisionTestModifyableContent" );
}
public function copy() {
return new RevisionTestModifyableContent( $this->mText );
}
public function getText() {
return $this->mText;
}
public function setText( $text ) {
$this->mText = $text;
}
}
class RevisionTestModifyableContentHandler extends TextContentHandler {
public function __construct() {
parent::__construct( "RevisionTestModifyableContent", array( CONTENT_FORMAT_TEXT ) );
}
public function unserializeContent( $text, $format = null ) {
$this->checkFormat( $format );
return new RevisionTestModifyableContent( $text );
}
public function makeEmptyContent() {
return new RevisionTestModifyableContent( '' );
}
}