gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/MediaWiki/Hooks/ArticleProtectCompleteTest.php

<?php

namespace SMW\Tests\MediaWiki\Hooks;

use SMW\DataItemFactory;
use SMW\Localizer\Message;
use SMW\MediaWiki\Hooks\ArticleProtectComplete;
use SMW\Property\Annotators\EditProtectedPropertyAnnotator;
use SMW\Tests\PHPUnitCompat;
use SMW\Tests\TestEnvironment;

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

	use PHPUnitCompat;

	private $spyLogger;
	private $testEnvironment;
	private $semanticDataFactory;
	private $dataItemFactory;
	private $editInfo;

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

		$this->testEnvironment = new TestEnvironment();
		$this->dataItemFactory = new DataItemFactory();

		$this->spyLogger = $this->testEnvironment->getUtilityFactory()->newSpyLogger();
		$this->semanticDataFactory = $this->testEnvironment->getUtilityFactory()->newSemanticDataFactory();

		$propertySpecificationLookup = $this->getMockBuilder( '\SMW\Property\SpecificationLookup' )
			->disableOriginalConstructor()
			->getMock();

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

		$idTable = $this->getMockBuilder( '\stdClass' )
			->setMethods( [ 'exists', 'findAssociatedRev' ] )
			->getMock();

		$store = $this->getMockBuilder( '\SMW\SQLStore\SQLStore' )
			->disableOriginalConstructor()
			->setMethods( [ 'getObjectIds' ] )
			->getMock();

		$store->expects( $this->any() )
			->method( 'getObjectIds' )
			->willReturn( $idTable );

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

		$this->editInfo = $this->getMockBuilder( '\SMW\MediaWiki\EditInfo' )
			->disableOriginalConstructor()
			->getMock();
	}

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

	public function testCanConstruct() {
		$title = $this->getMockBuilder( '\MediaWiki\Title\Title' )
			->disableOriginalConstructor()
			->getMock();

		$this->assertInstanceOf(
			ArticleProtectComplete::class,
			new ArticleProtectComplete( $title, $this->editInfo )
		);
	}

	public function testProcessOnSelfInvokedReason() {
		$title = $this->getMockBuilder( '\MediaWiki\Title\Title' )
			->disableOriginalConstructor()
			->getMock();

		$instance = new ArticleProtectComplete(
			$title,
			$this->editInfo
		);

		$instance->setLogger( $this->spyLogger );

		$protections = [];
		$reason = Message::get( 'smw-edit-protection-auto-update' );

		$instance->process( $protections, $reason );

		$this->assertContains(
			'No changes required, invoked by own process',
			$this->spyLogger->getMessagesAsString()
		);
	}

	public function testProcessOnMatchableEditProtectionToAddAnnotation() {
		$parserOutput = $this->getMockBuilder( '\MediaWiki\Parser\ParserOutput' )
			->disableOriginalConstructor()
			->getMock();

		$title = $this->getMockBuilder( '\MediaWiki\Title\Title' )
			->disableOriginalConstructor()
			->getMock();

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

		$title->expects( $this->any() )
			->method( 'getNamespace' )
			->willReturn( NS_SPECIAL );

		$title->expects( $this->any() )
			->method( 'getLatestRevID' )
			->willReturn( 9900 );

		$this->editInfo->expects( $this->once() )
			->method( 'getOutput' )
			->willReturn( $parserOutput );

		$instance = new ArticleProtectComplete(
			$title,
			$this->editInfo
		);

		$instance->setLogger( $this->spyLogger );

		$instance->setOptions(
			[
				'smwgEditProtectionRight' => 'Foo'
			]
		);

		$protections = [ 'edit' => 'Foo' ];
		$reason = '';

		$instance->process( $protections, $reason );

		$this->assertContains(
			'ArticleProtectComplete addProperty `Is edit protected`',
			$this->spyLogger->getMessagesAsString()
		);
	}

	public function testProcessOnUnmatchableEditProtectionToRemoveAnnotation() {
		$semanticData = $this->semanticDataFactory->newEmptySemanticData(
			$this->dataItemFactory->newDIWikiPage( __METHOD__, NS_SPECIAL )
		);

		$dataItem = $this->dataItemFactory->newDIBoolean( true );
		$dataItem->setOption( EditProtectedPropertyAnnotator::SYSTEM_ANNOTATION, true );

		$semanticData->addPropertyObjectValue(
			$this->dataItemFactory->newDIProperty( '_EDIP' ),
			$dataItem
		);

		$parserOutput = $this->getMockBuilder( '\MediaWiki\Parser\ParserOutput' )
			->disableOriginalConstructor()
			->getMock();

		$parserOutput->expects( $this->once() )
			->method( 'getExtensionData' )
			->willReturn( $semanticData );

		$title = $this->getMockBuilder( '\MediaWiki\Title\Title' )
			->disableOriginalConstructor()
			->getMock();

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

		$title->expects( $this->any() )
			->method( 'getLatestRevID' )
			->willReturn( 9901 );

		$title->expects( $this->any() )
			->method( 'getNamespace' )
			->willReturn( NS_SPECIAL );

		$this->editInfo->expects( $this->once() )
			->method( 'getOutput' )
			->willReturn( $parserOutput );

		$instance = new ArticleProtectComplete(
			$title,
			$this->editInfo
		);

		$instance->setLogger( $this->spyLogger );

		$instance->setOptions(
			[
				'smwgEditProtectionRight' => 'Foo2'
			]
		);

		$protections = [ 'edit' => 'Foo' ];
		$reason = '';

		$instance->process( $protections, $reason );

		$this->assertContains(
			'ArticleProtectComplete removeProperty `Is edit protected`',
			$this->spyLogger->getMessagesAsString()
		);
	}

}