gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/ParserFunctions/ShowParserFunctionTest.php

<?php

namespace SMW\Tests\ParserFunctions;

use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\ParserOutput;
use SMW\ParserFunctions\AskParserFunction;
use SMW\ParserFunctions\ShowParserFunction;
use SMW\Services\ServicesFactory as ApplicationFactory;
use SMW\Tests\PHPUnitCompat;
use SMW\Tests\TestEnvironment;

/**
 * @covers \SMW\ParserFunctions\ShowParserFunction
 * @group semantic-mediawiki
 *
 * @license GPL-2.0-or-later
 * @since 1.9
 *
 * @author mwjames
 */
class ShowParserFunctionTest extends \PHPUnit\Framework\TestCase {

	use PHPUnitCompat;

	private $testEnvironment;
	private $semanticDataValidator;
	private $messageFormatter;
	private $circularReferenceGuard;
	private $expensiveFuncExecutionWatcher;

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

		$this->testEnvironment = new TestEnvironment();
		$this->semanticDataValidator = $this->testEnvironment->getUtilityFactory()->newValidatorFactory()->newSemanticDataValidator();

		$this->testEnvironment->addConfiguration( 'smwgQueryProfiler', true );
		$this->testEnvironment->addConfiguration( 'smwgQueryResultCacheType', false );
		$this->testEnvironment->addConfiguration( 'smwgQFilterDuplicates', false );

		$this->messageFormatter = $this->getMockBuilder( '\SMW\MessageFormatter' )
			->disableOriginalConstructor()
			->getMock();

		$this->circularReferenceGuard = $this->getMockBuilder( '\SMW\Utils\CircularReferenceGuard' )
			->disableOriginalConstructor()
			->getMock();

		$this->expensiveFuncExecutionWatcher = $this->getMockBuilder( '\SMW\ParserFunctions\ExpensiveFuncExecutionWatcher' )
			->disableOriginalConstructor()
			->getMock();

		$this->expensiveFuncExecutionWatcher->expects( $this->any() )
			->method( 'hasReachedExpensiveLimit' )
			->willReturn( false );

		$queryResult = $this->getMockBuilder( '\SMW\Query\QueryResult' )
			->disableOriginalConstructor()
			->getMock();

		$queryResult->expects( $this->any() )
			->method( 'getErrors' )
			->willReturn( [] );

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->getMockForAbstractClass();

		$store->expects( $this->any() )
			->method( 'getQueryResult' )
			->willReturn( $queryResult );

		$this->testEnvironment->registerObject( 'Store', $store );
	}

	protected function tearDown(): void {
		$this->testEnvironment->tearDown();
		parent::tearDown();
	}

	public function testCanConstruct() {
		$parserData = $this->getMockBuilder( '\SMW\ParserData' )
			->disableOriginalConstructor()
			->getMock();

		$askParserFunction = new AskParserFunction(
			$parserData,
			$this->messageFormatter,
			$this->circularReferenceGuard,
			$this->expensiveFuncExecutionWatcher
		);

		$this->assertInstanceOf(
			'\SMW\ParserFunctions\ShowParserFunction',
			new ShowParserFunction( $askParserFunction )
		);
	}

	/**
	 * @dataProvider queryDataProvider
	 */
	public function testParse( array $params, array $expected ) {
		$parserData = ApplicationFactory::getInstance()->newParserData(
			MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__ ),
			new ParserOutput()
		);

		$instance = new ShowParserFunction(
			new AskParserFunction(
				$parserData,
				$this->messageFormatter,
				$this->circularReferenceGuard,
				$this->expensiveFuncExecutionWatcher
			)
		);

		$result = $instance->parse( $params );

		if ( $expected['output'] === '' ) {
			$this->assertEmpty( $result, "Actual result: \"$result\"\n" );
		} else {
			$this->assertContains( $expected['output'], $result );
		}
	}

	public function testIsQueryDisabled() {
		$parserData = $this->getMockBuilder( '\SMW\ParserData' )
			->disableOriginalConstructor()
			->getMock();

		$this->messageFormatter->expects( $this->any() )
			->method( 'addFromKey' )
			->willReturnSelf();

		$this->messageFormatter->expects( $this->once() )
			->method( 'getHtml' );

		$instance = new ShowParserFunction(
			new AskParserFunction(
				$parserData,
				$this->messageFormatter,
				$this->circularReferenceGuard,
				$this->expensiveFuncExecutionWatcher
			)
		);

		$instance->isQueryDisabled();
	}

	/**
	 * @dataProvider queryDataProvider
	 */
	public function testInstantiatedQueryData( array $params, array $expected ) {
		$parserData = ApplicationFactory::getInstance()->newParserData(
			MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__ ),
			new ParserOutput()
		);

		$instance = new ShowParserFunction(
			new AskParserFunction(
				$parserData,
				$this->messageFormatter,
				$this->circularReferenceGuard,
				$this->expensiveFuncExecutionWatcher
			)
		);

		$instance->parse( $params );

		foreach ( $parserData->getSemanticData()->getSubSemanticData() as $containerSemanticData ) {
			$this->assertInstanceOf( '\SMW\DataModel\ContainerSemanticData', $containerSemanticData );

			$this->semanticDataValidator->assertThatPropertiesAreSet(
				$expected,
				$containerSemanticData
			);
		}
	}

	public function testQueryWithErroneousData() {
		$parserData = ApplicationFactory::getInstance()->newParserData(
			MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__ ),
			new ParserOutput()
		);

		$instance = new ShowParserFunction(
			new AskParserFunction(
				$parserData,
				$this->messageFormatter,
				$this->circularReferenceGuard,
				$this->expensiveFuncExecutionWatcher
			)
		);

		// #2 [[..]] is not acknowledged therefore displays an error message
		// {{#show: [[File:Fooo]]
		// |?Modification date
		// |default=no results
		// |format=table
		// }}
		$params = [
			'[[File:Fooo]]',
			'?Modification date',
			'default=no results',
			'format=table'
		];

		$instance->parse( $params );

		$expected = [
			'output' => 'class="smwtticon warning"', // lazy content check for the error
			'propertyCount'  => 4,
			'propertyKeys'   => [ '_ASKFO', '_ASKDE', '_ASKSI', '_ASKST' ],
			'propertyValues' => [ 'table', 0, 1, '[[::]]' ]
		];

		$this->semanticDataValidator->assertThatPropertiesAreSet(
			$expected,
			$parserData->getSemanticData()->findSubSemanticData( '_QUERY6ee7d0bb3ac4ed35537bcb89914b30ac' )
		);

		$expected = [
			'propertyCount'  => 2,
			'propertyKeys'   => [ '_ERRP', '_ERRT' ],
		];

		$errorID = null;

		foreach ( $parserData->getSemanticData()->getSubSemanticData() as $subSemanticData ) {
			if ( strpos( $subSemanticData->getSubject()->getSubobjectName(), '_ERR' ) !== false ) {
				$errorID = $subSemanticData->getSubject()->getSubobjectName();
				break;
			}
		}

		$this->semanticDataValidator->assertThatPropertiesAreSet(
			$expected,
			$parserData->getSemanticData()->findSubSemanticData( $errorID )
		);
	}

	public function queryDataProvider() {
		$provider = [];

		// #0
		// {{#show: Foo-show
		// |?Modification date
		// }}
		$provider[] = [
			[
				'Foo-show',
				'?Modification date',
			],
			[
				'output' => '',
				'propertyCount'  => 4,
				'propertyKeys'   => [ '_ASKFO', '_ASKDE', '_ASKSI', '_ASKST' ],
				'propertyValues' => [ 'plainlist', 0, 1, '[[:Foo-show]]' ]
			]
		];

		// #1
		// {{#show: Help:Bar
		// |?Modification date
		// |default=no results
		// }}
		$provider[] = [
			[
				'Help:Bar',
				'?Modification date',
				'default=no results'
			],
			[
				'output' => 'no results',
				'propertyCount'  => 4,
				'propertyKeys'   => [ '_ASKFO', '_ASKDE', '_ASKSI', '_ASKST' ],
				'propertyValues' => [ 'plainlist', 0, 1, '[[:Help:Bar]]' ]
			]
		];

		return $provider;
	}
}