gplx/mediawiki/extensions/SemanticMediaWiki/tests/phpunit/MediaWiki/Jobs/UpdateDispatcherJobTest.php

<?php

namespace SMW\Tests\MediaWiki\Jobs;

use MediaWiki\MediaWikiServices;
use SMW\DIProperty;
use SMW\DIWikiPage;
use SMW\MediaWiki\Jobs\UpdateDispatcherJob;
use SMW\SemanticData;
use SMW\Services\ServicesFactory as ApplicationFactory;
use SMW\Tests\TestEnvironment;

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

	protected $expectedProperty;
	protected $expectedSubjects;
	private $semanticDataSerializer;
	private $testEnvironment;

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

		$this->semanticDataSerializer = ApplicationFactory::getInstance()->newSerializerFactory()->newSemanticDataSerializer();

		$this->testEnvironment = new TestEnvironment( [
			'smwgMainCacheType'        => 'hash',
			'smwgEnableUpdateJobs' => false
		] );

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

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

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

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

		$this->assertInstanceOf(
			'SMW\MediaWiki\Jobs\UpdateDispatcherJob',
			new UpdateDispatcherJob( $title )
		);
	}

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

		$instance = new UpdateDispatcherJob( $title, [] );
		$instance->isEnabledJobQueue( false );

		$this->assertNull( $instance->pushToJobQueue() );
	}

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

		$instance = new UpdateDispatcherJob( $title, [
			'job-list' => [
				'Foo#0##' => true,
				'Bar#102##'
			]
		] );

		$instance->isEnabledJobQueue( false );
		$instance->run();

		$this->assertEquals(
			2,
			$instance->getJobCount()
		);
	}

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

		$instance = new UpdateDispatcherJob( $title, [
			'job-list' => [
				'|nulltitle#0##' => true,
				'deserlizeerror#0' => true
			]
		] );

		$instance->isEnabledJobQueue( false );
		$instance->run();

		$this->assertSame(
			0,
			$instance->getJobCount()
		);
	}

	public function testJobRunOnMainNamespace() {
		$title = MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__, NS_MAIN );

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->setMethods( [
				'getProperties',
				'getInProperties' ] )
			->getMockForAbstractClass();

		$store->expects( $this->any() )
			->method( 'getProperties' )
			->willReturn( [] );

		$store->expects( $this->any() )
			->method( 'getInProperties' )
			->willReturn( [] );

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

		$instance = new UpdateDispatcherJob( $title, [] );
		$instance->isEnabledJobQueue( false );

		$this->assertTrue( $instance->run() );
	}

	public function testJobRunOnPropertyNamespace() {
		$title = MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__, SMW_NS_PROPERTY );

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->setMethods( [
				'getProperties',
				'getInProperties',
				'getAllPropertySubjects',
				'getPropertySubjects' ] )
			->getMockForAbstractClass();

		$store->expects( $this->any() )
			->method( 'getProperties' )
			->willReturn( [] );

		$store->expects( $this->any() )
			->method( 'getInProperties' )
			->willReturn( [] );

		$store->expects( $this->any() )
			->method( 'getAllPropertySubjects' )
			->willReturn( [] );

		$store->expects( $this->any() )
			->method( 'getPropertySubjects' )
			->willReturn( [] );

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

		$instance = new UpdateDispatcherJob( $title, [] );
		$instance->isEnabledJobQueue( false );

		$this->assertTrue( $instance->run() );
	}

	public function testJobRunOnRestrictedPool() {
		$title = MediaWikiServices::getInstance()->getTitleFactory()->newFromText( __METHOD__ );
		$subject = DIWikiPage::newFromText( 'Foo' );

		$semanticData = new SemanticData( $subject );
		$semanticData->addPropertyObjectValue( new DIProperty( '42' ), $subject );

		$parameters = [
			'semanticData' => $this->semanticDataSerializer->serialize( $semanticData ),
			UpdateDispatcherJob::RESTRICTED_DISPATCH_POOL => true
		];

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->setMethods( [
				'getAllPropertySubjects',
				] )
			->getMockForAbstractClass();

		$store->expects( $this->once() )
			->method( 'getAllPropertySubjects' )
			->willReturn( [] );

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

		$instance = new UpdateDispatcherJob( $title, $parameters );
		$instance->isEnabledJobQueue( false );

		$this->assertTrue(
			$instance->run()
		);
	}

	/**
	 * @dataProvider subjectDataProvider
	 */
	public function testRunJobOnMockWithOutParameters( $setup, $expected ) {
		$this->expectedProperty = $setup['property'];
		$this->expectedSubjects = $setup['subjects'];

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->setMethods( [
				'getAllPropertySubjects',
				'getPropertyValues',
				'getProperties',
				'getInProperties',
				'getPropertySubjects' ] )
			->getMockForAbstractClass();

		$store->expects( $this->any() )
			->method( 'getAllPropertySubjects' )
			->willReturnCallback( [ $this, 'mockStoreAllPropertySubjectsCallback' ] );

		$store->expects( $this->any() )
			->method( 'getPropertyValues' )
			->willReturn( [ DIWikiPage::newFromTitle( $setup['title'] ) ] );

		$store->expects( $this->any() )
			->method( 'getProperties' )
			->willReturn( $setup['properties'] );

		$store->expects( $this->any() )
			->method( 'getInProperties' )
			->willReturn( $setup['properties'] );

		$store->expects( $this->any() )
			->method( 'getPropertySubjects' )
			->willReturn( [] );

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

		$instance = new UpdateDispatcherJob( $setup['title'], $setup['parameters'] );
		$instance->isEnabledJobQueue( false );
		$instance->run();

		$this->assertEquals(
			$expected['count'],
			$instance->getJobCount()
		);
	}

	/**
	 * @dataProvider subjectDataProvider
	 */
	public function testRunJobOnMockWithParameters( $setup, $expected ) {
		$semanticData = new SemanticData(
			DIWikiPage::newFromTitle( $setup['title'] )
		);

		$parameters = [
			'semanticData' => $this->semanticDataSerializer->serialize( $semanticData )
		] + $setup['parameters'];

		$this->expectedProperty = $setup['property'];
		$this->expectedSubjects = $setup['subjects'];

		$store = $this->getMockBuilder( '\SMW\Store' )
			->disableOriginalConstructor()
			->setMethods( [
				'getAllPropertySubjects',
				'getPropertyValues',
				'getProperties',
				'getInProperties',
				'getPropertySubjects' ] )
			->getMockForAbstractClass();

		$store->expects( $this->any() )
			->method( 'getAllPropertySubjects' )
			->willReturnCallback( [ $this, 'mockStoreAllPropertySubjectsCallback' ] );

		$store->expects( $this->any() )
			->method( 'getPropertyValues' )
			->willReturn( [ DIWikiPage::newFromTitle( $setup['title'] ) ] );

		$store->expects( $this->any() )
			->method( 'getProperties' )
			->willReturn( $setup['properties'] );

		$store->expects( $this->any() )
			->method( 'getInProperties' )
			->willReturn( $setup['properties'] );

		$store->expects( $this->any() )
			->method( 'getPropertySubjects' )
			->willReturn( [] );

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

		$instance = new UpdateDispatcherJob( $setup['title'], $parameters );
		$instance->isEnabledJobQueue( false );
		$instance->run();

		$this->assertEquals(
			$expected['count'],
			$instance->getJobCount()
		);
	}

	public function subjectDataProvider() {
		$titleFactory = MediaWikiServices::getInstance()->getTitleFactory();

		$provider = [];

		$duplicate = DIWikiPage::newFromText( 'Foo' );

		$subjects = [
			$duplicate,
			DIWikiPage::newFromText( 'Bar' ),
			DIWikiPage::newFromText( 'Baz' ),
			$duplicate,
			DIWikiPage::newFromText( 'Yon' ),
			DIWikiPage::newFromText( 'Yon' ),
			DIWikiPage::newFromText( __METHOD__, SMW_NS_PROPERTY )
		];

		$count = count( $subjects ) - 1; // eliminate duplicate count
		$title = $titleFactory->newFromText( __METHOD__, SMW_NS_PROPERTY );
		$property = DIProperty::newFromUserLabel( $title->getText() );

		# 0
		$provider[] = [
			[
				'title'      => $title,
				'subjects'   => $subjects,
				'property'   => $property,
				'properties' => [],
				'parameters' => []
			],
			[
				'count' => 6
			]
		];

		$title = $titleFactory->newFromText( __METHOD__, NS_MAIN );
		$property = DIProperty::newFromUserLabel( $title->getText() );

		# 1
		$provider[] = [
			[
				'title'      => $title,
				'subjects'   => [ DIWikiPage::newFromTitle( $title ) ],
				'property'   => $property,
				'properties' => [ $property ],
				'parameters' => []
			],
			[
				'count' => 1
			]
		];

		# 2
		$duplicate = DIWikiPage::newFromText( 'Foo' );

		$subjects = [
			$duplicate,
			DIWikiPage::newFromText( 'Bar' ),
			DIWikiPage::newFromText( 'Baz' ),
			$duplicate,
			DIWikiPage::newFromText( 'Yon' ),
			DIWikiPage::newFromText( 'Yon' ),
			DIWikiPage::newFromText( __METHOD__, SMW_NS_PROPERTY )
		];

		$title = $titleFactory->newFromText( __METHOD__, SMW_NS_PROPERTY );
		$property = DIProperty::newFromUserLabel( $title->getText() );

		$provider[] = [
			[
				'title'      => $title,
				'subjects'   => $subjects,
				'property'   => $property,
				'properties' => [],
				'parameters' => [ UpdateDispatcherJob::RESTRICTED_DISPATCH_POOL => true ]
			],
			[
				'count' => 6
			]
		];

		return $provider;
	}

	/**
	 * Returns an array of DIWikiPage objects if the expected property
	 * and the argument property are identical
	 *
	 * @see Store::getAllPropertySubjects
	 *
	 * @return DIWikiPage[]
	 */
	public function mockStoreAllPropertySubjectsCallback( DIProperty $property ) {
		return $this->expectedSubjects;
	}

}