gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/MediaWiki/EditInfoTest.php

<?php

namespace SMW\Tests\MediaWiki;

use MediaWiki\Edit\PreparedEdit;
use MediaWiki\Parser\ParserOutput;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use MediaWiki\User\User;
use SMW\MediaWiki\EditInfo;
use SMW\ParserData;
use SMW\SemanticData;
use WikiPage;

/**
 * @covers \SMW\MediaWiki\EditInfo
 * @group semantic-mediawiki
 *
 * @license GPL-2.0-or-later
 * @since   2.0
 *
 * @author mwjames
 */
class EditInfoTest extends \PHPUnit\Framework\TestCase {

	public function testCanConstruct() {
		$wikiPage = $this->getMockBuilder( WikiPage::class )
			->disableOriginalConstructor()
			->getMock();

		$revision = $this->getMockBuilder( RevisionRecord::class )
			->disableOriginalConstructor()
			->getMock();

		$user = $this->getMockBuilder( User::class )
			->disableOriginalConstructor()
			->getMock();

		$this->assertInstanceOf(
			EditInfo::class,
			new EditInfo( $wikiPage, $revision, $user )
		);
	}

	/**
	 * @dataProvider wikiPageDataProvider
	 */
	public function testFetchContentInfo( $parameters, $expected ) {
		$instance = new EditInfo(
			$parameters['wikiPage'],
			$parameters['revision'],
			$parameters['user']
		);

		$this->assertEquals(
			$expected,
			$instance->fetchEditInfo()->getOutput()
		);
	}

	public function testFetchSemanticData() {
		$semanticData = $this->getMockBuilder( SemanticData::class )
			->disableOriginalConstructor()
			->getMock();

		$output = new ParserOutput();
		$output->setExtensionData( ParserData::DATA_ID, $semanticData );

		$editInfo = $this->createMock( PreparedEdit::class );
		$editInfo->expects( $this->any() )
			->method( 'getOutput' )
			->willReturn( $output );

		$wikiPage = $this->getMockBuilder( WikiPage::class )
			->disableOriginalConstructor()
			->getMock();

		$wikiPage->expects( $this->any() )
			->method( 'prepareContentForEdit' )
			->willReturn( $editInfo );

		$user = $this->getMockBuilder( User::class )
			->disableOriginalConstructor()
			->getMock();

		$instance = new EditInfo(
			$wikiPage,
			$this->newRevisionStub(),
			$user
		);

		$this->assertInstanceOf(
			'\SMW\SemanticData',
			$instance->fetchSemanticData()
		);
	}

	/**
	 * @dataProvider wikiPageDataProvider
	 */
	public function testFetchContentInfoWithDisabledContentHandler( $parameters, $expected ) {
		$instance = new EditInfo(
			$parameters['wikiPage'],
			$parameters['revision'],
			$parameters['user']
		);

		$this->assertEquals(
			$expected,
			$instance->fetchEditInfo()->getOutput()
		);
	}

	public function wikiPageDataProvider() {
		$user = $this->getMockBuilder( User::class )
			->disableOriginalConstructor()
			->getMock();

		$title = $this->getMockBuilder( Title::class )
			->disableOriginalConstructor()
			->getMock();

		$title->expects( $this->any() )
			  ->method( 'canExist' )
			  ->willReturn( true );

		# 0 No parserOutput object
		$editInfo = $this->createMock( PreparedEdit::class );
		$editInfo->expects( $this->any() )
			->method( 'getOutput' )
			->willReturn( null );

		$wikiPage = $this->getMockBuilder( '\WikiPage' )
			->setConstructorArgs( [ $title ] )
			->getMock();

		$wikiPage->expects( $this->any() )
			->method( 'prepareContentForEdit' )
			->willReturn( $editInfo );

		$provider[] = [
			[
				'editInfo' => $editInfo,
				'wikiPage' => $wikiPage,
				'revision' => $this->newRevisionStub(),
				'user' => $user
			],
			null
		];

		$output = new ParserOutput();

		$editInfo = $this->createMock( PreparedEdit::class );
		$editInfo->expects( $this->any() )
			->method( 'getOutput' )
			->willReturn( $output );

		$wikiPage = $this->getMockBuilder( '\WikiPage' )
			->setConstructorArgs( [ $title ] )
			->getMock();

		$wikiPage->expects( $this->any() )
			->method( 'prepareContentForEdit' )
			->willReturn( $editInfo );

		$provider[] = [
			[
				'editInfo' => $editInfo,
				'wikiPage' => $wikiPage,
				'revision' => $this->newRevisionStub(),
				'user' => $user
			],
			$editInfo->getOutput()
		];

		return $provider;
	}

	private function newRevisionStub() {
		$revision = $this->getMockBuilder( '\MediaWiki\Revision\RevisionRecord' )
			->disableOriginalConstructor()
			->getMock();

		// Needed for the abstract class
		$revision->expects( $this->any() )
			->method( 'getSize' )
			->willReturn( strlen( 'Foo' ) );

		// Needed for the abstract class
		$revision->expects( $this->any() )
			->method( 'getSha1' )
			->willReturn( \Wikimedia\base_convert( sha1( 'Foo' ), 16, 36 ) );

		$revision->expects( $this->any() )
			->method( 'getContent' )
			->willReturnMap( [
				[ SlotRecord::MAIN, RevisionRecord::RAW, null, 'Foo' ],
				[ SlotRecord::MAIN, RevisionRecord::FOR_PUBLIC, null, $this->newContentStub() ],
			] );

		return $revision;
	}

	private function newContentStub() {
		$contentHandler = $this->getMockBuilder( '\MediaWiki\Content\ContentHandler' )
			->disableOriginalConstructor()
			->getMock();

		$contentHandler->expects( $this->atLeastOnce() )
			->method( 'getDefaultFormat' )
			->willReturn( 'Foo' );

		$content = $this->getMockBuilder( '\MediaWiki\Content\Content' )
			->disableOriginalConstructor()
			->getMock();

		$content->expects( $this->atLeastOnce() )
			->method( 'getContentHandler' )
			->willReturn( $contentHandler );

		return $content;
	}

}