Current File : /home/jvzmxxx/wiki/extensions/Wikibase/client/tests/phpunit/includes/Store/UsageUpdaterTest.php

<?php

namespace Wikibase\Client\Test\Store;

use Wikibase\Client\Store\UsageUpdater;
use Wikibase\Client\Usage\EntityUsage;
use Wikibase\Client\Usage\SubscriptionManager;
use Wikibase\Client\Usage\UsageLookup;
use Wikibase\Client\Usage\UsageTracker;
use Wikibase\DataModel\Entity\ItemId;

/**
 * @covers Wikibase\Client\Store\UsageUpdater
 *
 * @group Wikibase
 * @group WikibaseClient
 * @group WikibaseUsageTracking
 *
 * @license GPL-2.0+
 * @author Daniel Kinzler
 * @author Marius Hoch
 */
class UsageUpdaterTest extends \PHPUnit_Framework_TestCase {

	public function addUsagesForPageProvider() {
		$q1 = new ItemId( 'Q1' );
		$q2 = new ItemId( 'Q2' );

		return array(
			'empty' => array(
				array(),
				array(),
			),

			'add usages' => array(
				array( new EntityUsage( $q1, EntityUsage::LABEL_USAGE ),
					new EntityUsage( $q2, EntityUsage::ALL_USAGE ) ),
				array( $q1, $q2 ),
			),
		);
	}

	/**
	 * @dataProvider addUsagesForPageProvider
	 */
	public function testAddUsagesForPage( $newUsage, $subscribe ) {
		$usageTracker = $this->getMock( UsageTracker::class );
		$usageTracker->expects( $this->once() )
			->method( 'addUsedEntities' )
			->with( 23, $newUsage );

		$usageLookup = $this->getMock( UsageLookup::class );
		$usageLookup->expects( $this->never() )
			->method( 'getUsagesForPage' );
		$usageLookup->expects( $this->never() )
			->method( 'getUnusedEntities' );

		$subscriptionManager = $this->getMock( SubscriptionManager::class );
		$subscriptionManager->expects( $this->never() )
			->method( 'unsubscribe' );

		$subscriptionManager->expects( empty( $subscribe ) ? $this->never() : $this->once() )
			->method( 'subscribe' )
			->with( 'testwiki', $this->callback(
				function ( $actualSubscribe ) use ( $subscribe ) {
					return self::arraysHaveSameContent( $actualSubscribe, $subscribe );
				}
			) );

		$updater = new UsageUpdater(
			'testwiki',
			$usageTracker,
			$usageLookup,
			$subscriptionManager
		);

		// assertions are done by the mock double
		$updater->addUsagesForPage( 23, $newUsage );
	}

	public function pruneUsagesForPageProvider() {
		$q1 = new ItemId( 'Q1' );
		$q2 = new ItemId( 'Q2' );

		return array(
			'empty' => array(
				array(),
				array(),
				array(),
			),

			'pruned usages' => array(
				array( new EntityUsage( $q1, EntityUsage::LABEL_USAGE ),
					new EntityUsage( $q2, EntityUsage::ALL_USAGE ) ),
				array( $q1, $q2 ),
				array( $q2 ),
			),
		);
	}

	/**
	 * @dataProvider pruneUsagesForPageProvider
	 */
	public function testPruneUsagesForPage( $prunedUsages, $prunedEntityIds, $unused ) {
		$usageTracker = $this->getMock( UsageTracker::class );
		$usageTracker->expects( $this->once() )
			->method( 'pruneUsages' )
			->with( 23 )
			->will( $this->returnValue( $prunedUsages ) );

		$usageLookup = $this->getMock( UsageLookup::class );
		$usageLookup->expects( $this->never() )
			->method( 'getUsagesForPage' );
		$usageLookup->expects( $this->once() )
			->method( 'getUnusedEntities' )
			->with( $this->callback(
				function( array $actualEntities ) use ( $prunedEntityIds ) {
					return self::arraysHaveSameContent( $prunedEntityIds, $actualEntities );
				}
			) )
			->will( $this->returnValue( $unused ) );

		$subscriptionManager = $this->getMock( SubscriptionManager::class );
		$subscriptionManager->expects( $this->never() )
			->method( 'subscribe' );

		$subscriptionManager->expects( empty( $prunedUsages ) ? $this->never() : $this->once() )
			->method( 'unsubscribe' )
			->with( 'testwiki', $this->callback(
				function ( $actualUnsubscribe ) use ( $unused ) {
					return self::arraysHaveSameContent( $unused, $actualUnsubscribe );
				}
			) );

		$updater = new UsageUpdater(
			'testwiki',
			$usageTracker,
			$usageLookup,
			$subscriptionManager
		);

		// assertions are done by the mock double
		$updater->pruneUsagesForPage( 23 );
	}

	public function replaceUsagesForPageProvider() {
		$q1 = new ItemId( 'Q1' );
		$q2 = new ItemId( 'Q2' );
		$usages = [
			new EntityUsage( $q1, EntityUsage::LABEL_USAGE ),
			new EntityUsage( $q2, EntityUsage::ALL_USAGE )
		];

		return [
			'empty' => [ [], [], [], ],

			'only new usages' => [
				[],
				$usages,
				[],
			],

			'all usages removed' => [
				$usages,
				[],
				[ $q1 ]
			],

			'new and old usages are the same' => [
				$usages,
				$usages,
				[]
			],

			'new and old usages differ (removal)' => [
				$usages,
				[ $usages[1] ],
				[ $q2 ]
			],

			'new and old usages differ (addition)' => [
				[ $usages[1] ],
				$usages,
				[]
			],

			'new and old usages differ (disjoint)' => [
				[ $usages[1] ],
				[ $usages[0] ],
				[]
			],

			'new and old usages differ (disjoint, unsubscribe)' => [
				[ $usages[1] ],
				[ $usages[0] ],
				[ $q1 ]
			],
		];
	}

	/**
	 * @dataProvider replaceUsagesForPageProvider
	 */
	public function testReplaceUsagesForPage( $oldUsage, $newUsages, $unused ) {
		$newEntityIds = $this->getEntityIds( $newUsages );

		$prunedUsages = array_diff( $oldUsage, $newUsages );
		$prunedEntityIds = $this->getEntityIds( $prunedUsages );

		$usageTracker = $this->getMock( UsageTracker::class );
		$usageTracker->expects( $this->once() )
			->method( 'replaceUsedEntities' )
			->with( 23, $newUsages )
			->will( $this->returnValue( $prunedUsages ) );

		$usageLookup = $this->getMock( UsageLookup::class );
		$usageLookup->expects( $this->never() )
			->method( 'getUsagesForPage' );
		$usageLookup->expects( empty( $prunedEntityIds ) ? $this->never() : $this->once() )
			->method( 'getUnusedEntities' )
			->with( $this->callback(
				function( array $actualEntities ) use ( $prunedEntityIds ) {
					return self::arraysHaveSameContent( $prunedEntityIds, $actualEntities );
				}
			) )
			->will( $this->returnValue( $unused ) );

		$subscriptionManager = $this->getMock( SubscriptionManager::class );
		$subscriptionManager->expects( empty( $newUsages ) ? $this->never() : $this->once() )
			->method( 'subscribe' )
			->with( 'testwiki', $newEntityIds );

		$subscriptionManager->expects( empty( $unused ) ? $this->never() : $this->once() )
			->method( 'unsubscribe' )
			->with( 'testwiki', $this->callback(
				function ( $actualUnsubscribe ) use ( $unused ) {
					return self::arraysHaveSameContent( $unused, $actualUnsubscribe );
				}
			) );

		$updater = new UsageUpdater(
			'testwiki',
			$usageTracker,
			$usageLookup,
			$subscriptionManager
		);

		// assertions are done by the mock double
		$updater->replaceUsagesForPage( 23, $newUsages );
	}

	public static function arraysHaveSameContent( $a, $b ) {
		return !count( array_diff( $a, $b ) ) && !count( array_diff( $b, $a ) );
	}

	/**
	 * @param EntityUsage[] $entityUsages
	 *
	 * @return EntityId[]
	 */
	private function getEntityIds( array $entityUsages ) {
		$entityIds = array();

		foreach ( $entityUsages as $usage ) {
			$id = $usage->getEntityId();
			$key = $id->getSerialization();

			$entityIds[$key] = $id;
		}

		return $entityIds;
	}

}