gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/PostProcHandlerTest.php

<?php

namespace SMW\Tests;

use MediaWiki\Parser\ParserOutput;
use MediaWiki\Request\WebRequest;
use MediaWiki\Title\Title;
use Onoi\Cache\Cache;
use SMW\DependencyValidator;
use SMW\DIWikiPage;
use SMW\EntityCache;
use SMW\NamespaceExaminer;
use SMW\PostProcHandler;
use SMW\SQLStore\ChangeOp\ChangeDiff;
use SMW\SQLStore\ChangeOp\FieldChangeOp;
use SMW\SQLStore\ChangeOp\TableChangeOp;
use SMW\SQLStore\QueryDependency\DependencyLinksValidator;
use SMWQuery;

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

	use PHPUnitCompat;

	private $parserOutput;
	private $cache;

	protected function setUp(): void {
		parent::setUp();

		$this->parserOutput = $this->createMock( ParserOutput::class );

		$this->cache = $this->createMock( Cache::class );
	}

	public function testCanConstruct() {
		$this->assertInstanceOf(
			PostProcHandler::class,
			new PostProcHandler( $this->parserOutput, $this->cache )
		);
	}

	public function testGetHtmlOnCookie() {
		$this->parserOutput->expects( $this->once() )
			->method( 'getExtensionData' )
			->with( PostProcHandler::POST_EDIT_UPDATE )
			->willReturn( [ 'Bar' => true ] );

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$title = $this->createMock( Title::class );

		$title->expects( $this->atLeastOnce() )
			->method( 'getDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$title->expects( $this->atLeastOnce() )
			->method( 'getLatestRevID' )
			->willReturn( 42 );

		$webRequest = $this->createMock( WebRequest::class );

		$webRequest->expects( $this->once() )
			->method( 'getCookie' )
			->willReturn( 'FakeCookie' );

		$this->assertContains(
			'<div class="smw-postproc" data-subject="Foo#0##" data-ref="[&quot;Bar&quot;]"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	public function testGetHtml_CheckQuery() {
		$this->cache->expects( $this->atLeastOnce() )
			->method( 'fetch' )
			->willReturn( true );

		$this->parserOutput->expects( $this->exactly( 2 ) )
			->method( 'getExtensionData' )
			->withConsecutive(
				[ $this->equalTo( PostProcHandler::POST_EDIT_UPDATE ) ],
				[ $this->equalTo( PostProcHandler::POST_EDIT_CHECK ) ]
			)
			->willReturnOnConsecutiveCalls(
				[ 'Bar' => true ],
				[ 'Foobar' ]
			);

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->setOptions(
			[
				'check-query' => true
			]
		);

		$title = $this->createMock( Title::class );

		$title->expects( $this->atLeastOnce() )
			->method( 'getDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$title->expects( $this->atLeastOnce() )
			->method( 'getLatestRevID' )
			->willReturn( 42 );

		$webRequest = $this->createMock( WebRequest::class );

		$webRequest->expects( $this->once() )
			->method( 'getCookie' )
			->willReturn( 'FakeCookie' );

		$this->assertContains(
			'<div class="smw-postproc" data-subject="Foo#0##" data-ref="[&quot;Bar&quot;]" data-query="[&quot;Foobar&quot;]"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	public function testGetHtml_DifferentExtensionData() {
		// inverse testing - Mocking the data to ensure that the html has DifferentExtensionData
		$this->cache->expects( $this->atLeastOnce() )
			->method( 'fetch' )
			->willReturn( true );

		$this->parserOutput->expects( $this->exactly( 2 ) )
			->method( 'getExtensionData' )
			->withConsecutive(
				[ $this->equalTo( PostProcHandler::POST_EDIT_UPDATE ) ],
				[ $this->equalTo( PostProcHandler::POST_EDIT_CHECK ) ]
			)
			->willReturnOnConsecutiveCalls(
				[ 'TestValue' => true ],
				[]
		);

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->setOptions(
			[
				'check-query' => true
			]
		);

		$title = $this->createMock( Title::class );

		$title->expects( $this->atLeastOnce() )
			->method( 'getDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$title->expects( $this->atLeastOnce() )
			->method( 'getLatestRevID' )
			->willReturn( 42 );

		$webRequest = $this->createMock( WebRequest::class );

		$webRequest->expects( $this->once() )
			->method( 'getCookie' )
			->willReturn( 'FakeCookie' );

		// Check that the returned HTML does not contain the expected data attributes - inverse testing
		$this->assertNotContains(
			'<div class="smw-postproc" data-subject="Foo#0##" data-ref="[&quot;Bar&quot;]" data-query="[&quot;Foobar&quot;]"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	public function testRunJobs() {
		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->setOptions(
			[
				'run-jobs' => [ 'fooJob' => 2 ]
			]
		);

		$title = $this->createMock( Title::class );

		$title->expects( $this->atLeastOnce() )
			->method( 'getDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$title->expects( $this->atLeastOnce() )
			->method( 'getLatestRevID' )
			->willReturn( 42 );

		$webRequest = $this->createMock( WebRequest::class );

		$webRequest->expects( $this->once() )
			->method( 'getCookie' )
			->willReturn( 'FakeCookie' );

		$this->assertContains(
			'<div class="smw-postproc" data-subject="Foo#0##" data-jobs="{&quot;fooJob&quot;:2}"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	public function testPurgePageOnQueryDependency() {
		$this->parserOutput->expects( $this->any() )
			->method( 'getExtensionData' )
			->with( PostProcHandler::POST_EDIT_UPDATE )
			->willReturn( [ 'Bar' ] );

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->setOptions(
			[
				'run-jobs' => [ 'fooJob' => 2 ],
				'purge-page' => [ 'on-outdated-query-dependency' => true ]
			]
		);

		$title = $this->createMock( Title::class );

		$dependencyLinksValidator = $this->createMock( DependencyLinksValidator::class );
		$namespaceExaminer = $this->createMock( NamespaceExaminer::class );
		$entityCache = $this->createMock( EntityCache::class );
		$dependencyValidator = new DependencyValidator(
			$namespaceExaminer,
			$dependencyLinksValidator,
			$entityCache
		);
		$dependencyValidator->markTitle( $title );

		$title->expects( $this->atLeastOnce() )
			->method( 'getPrefixedDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$webRequest = $this->createMock( WebRequest::class );

		$this->assertContains(
			'<div class="smw-postproc page-purge" data-subject="#0##" data-title="Foo" data-msg="smw-purge-update-dependencies" data-forcelinkupdate="1"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	/**
	 * @dataProvider validPropertyKeyProvider
	 */
	public function testGetHtmlOnCookieAndValidChangeDiff( $key ) {
		$fieldChangeOp = $this->createMock( FieldChangeOp::class );

		$fieldChangeOp->expects( $this->any() )
			->method( 'get' )
			->willReturn( 42 );

		$tableChangeOp = $this->createMock( TableChangeOp::class );

		$tableChangeOp->expects( $this->any() )
			->method( 'getFieldChangeOps' )
			->willReturn( [ $fieldChangeOp ] );

		$changeDiff = new ChangeDiff(
			DIWikiPage::newFromText( 'Foo' ),
			[ $tableChangeOp ],
			[],
			[ $key => 42 ]
		);

		$this->cache->expects( $this->once() )
			->method( 'fetch' )
			->willReturn( $changeDiff->serialize() );

		$this->parserOutput->expects( $this->once() )
			->method( 'getExtensionData' )
			->with( PostProcHandler::POST_EDIT_UPDATE )
			->willReturn( [ 'Bar' ] );

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$title = $this->createMock( Title::class );

		$title->expects( $this->atLeastOnce() )
			->method( 'getDBKey' )
			->willReturn( 'Foo' );

		$title->expects( $this->atLeastOnce() )
			->method( 'getNamespace' )
			->willReturn( NS_MAIN );

		$title->expects( $this->atLeastOnce() )
			->method( 'getLatestRevID' )
			->willReturn( 42 );

		$webRequest = $this->createMock( WebRequest::class );

		$webRequest->expects( $this->once() )
			->method( 'getCookie' )
			->willReturn( 'FakeCookie' );

		$this->assertContains(
			'<div class="smw-postproc" data-subject="Foo#0##" data-ref="[0]"></div>',
			$instance->getHtml( $title, $webRequest )
		);
	}

	/**
	 * @dataProvider queryProvider
	 */
	public function testAddUpdate( $gExtensionData, $sExtensionData, $query ) {
		$this->parserOutput->expects( $this->once() )
			->method( 'getExtensionData' )
			->with( PostProcHandler::POST_EDIT_UPDATE )
			->willReturn( $gExtensionData );

		$this->parserOutput->expects( $this->once() )
			->method( 'setExtensionData' )
			->with( PostProcHandler::POST_EDIT_UPDATE );

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->addUpdate( $query );
	}

	/**
	 * @dataProvider queryProvider
	 */
	public function testAddCheck( $gExtensionData, $sExtensionData, $query ) {
		$this->parserOutput->expects( $this->once() )
			->method( 'getExtensionData' )
			->with( PostProcHandler::POST_EDIT_CHECK )
			->willReturn( $gExtensionData );

		$this->parserOutput->expects( $this->once() )
			->method( 'setExtensionData' )
			->with( PostProcHandler::POST_EDIT_CHECK );

		$instance = new PostProcHandler(
			$this->parserOutput,
			$this->cache
		);

		$instance->setOptions(
			[
				'check-query' => true
			]
		);

		$instance->addCheck( $query );
	}

	public function queryProvider() {
		$query = $this->createMock( SMWQuery::class );

		$query->expects( $this->any() )
			->method( 'toArray' )
			->willReturn( [ 'Foo' ] );

		$provider[] = [
			null,
			[ 'Foo' => true ],
			$query
		];

		$provider[] = [
			[ 'Bar' => true ],
			[ 'Bar' => true, 'Foo' => true ],
			$query
		];

		return $provider;
	}

	public function validPropertyKeyProvider() {
		yield [
			'Foo'
		];

		yield [
			'_INST'
		];

		yield [
			'_ASK'
		];
	}

}