EntityRetrievingClosestReferencedEntityIdLookupTest

Complexity

Total Complexity

24

Size/Duplication

Total Lines	443
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	18

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	maskEntityLookup()	0	11	2
A	getEntityPrefetcher()	0	8	1
A	getReferencingStatementList()	0	11	2
B	getReferencingEntityStructure()	0	40	1
B	getCircularReferencingEntityStructure()	0	25	1
B	provideGetReferencedEntityIdNoError()	0	113	1
B	testGetReferencedEntityIdNoError()	0	28	2
A	provideGetReferencedEntityIdMaxDepthExceeded()	0	17	3
B	testGetReferencedEntityIdMaxDepthExceeded()	0	24	2
A	provideGetReferencedEntityIdMaxEntityVisitsExceeded()	0	17	3
B	testGetReferencedEntityIdMaxEntityVisitsExceeded()	0	24	2
B	provideGetReferencedEntityIdTestInvalidSnak()	0	32	1
A	testGetReferencedEntityIdTestInvalidSnak()	0	17	1
A	testGetReferencedEntityIdEntityLookupException()	0	23	2

<?php

namespace Wikibase\DataModel\Services\Tests\Lookup;

use DataValues\StringValue;
use PHPUnit_Framework_TestCase;
use Wikibase\DataModel\Entity\EntityId;
use Wikibase\DataModel\Entity\EntityIdValue;
use Wikibase\DataModel\Entity\Item;
use Wikibase\DataModel\Entity\ItemId;
use Wikibase\DataModel\Entity\PropertyId;
use Wikibase\DataModel\Services\Entity\EntityPrefetcher;
use Wikibase\DataModel\Services\Entity\NullEntityPrefetcher;
use Wikibase\DataModel\Services\Lookup\EntityLookup;
use Wikibase\DataModel\Services\Lookup\EntityLookupException;
use Wikibase\DataModel\Services\Lookup\EntityRetrievingClosestReferencedEntityIdLookup;
use Wikibase\DataModel\Services\Lookup\InMemoryEntityLookup;
use Wikibase\DataModel\Services\Lookup\MaxReferenceDepthExhaustedException;
use Wikibase\DataModel\Services\Lookup\MaxReferencedEntityVisitsExhaustedException;
use Wikibase\DataModel\Services\Lookup\ReferencedEntityIdLookupException;
use Wikibase\DataModel\Services\Lookup\RestrictedEntityLookup;
use Wikibase\DataModel\Snak\PropertyNoValueSnak;
use Wikibase\DataModel\Snak\PropertyValueSnak;
use Wikibase\DataModel\Statement\Statement;
use Wikibase\DataModel\Statement\StatementList;

/**
 * @covers Wikibase\DataModel\Services\Lookup\EntityRetrievingClosestReferencedEntityIdLookup
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 *
 * @license GPL-2.0-or-later
 * @author Marius Hoch
 */
class EntityRetrievingClosestReferencedEntityIdLookupTest extends PHPUnit_Framework_TestCase {

	/**
	 * @param EntityLookup $entityLookup
	 * @param int $expectedNumberOfGetEntityCalls
	 * @return EntityLookup
	 */
	private function maskEntityLookup( EntityLookup $entityLookup, $expectedNumberOfGetEntityCalls ) {
		if ( $expectedNumberOfGetEntityCalls > 0 ) {
			$entityLookup = new RestrictedEntityLookup( $entityLookup, $expectedNumberOfGetEntityCalls );
		} else {
			$entityLookup = $this->getMock( EntityLookup::class );
			$entityLookup->expects( $this->never() )
				->method( 'getEntity' );
		}

		return $entityLookup;
	}

	/**
	 * @param int $expectedPrefetches
	 * @return EntityPrefetcher
	 */
	private function getEntityPrefetcher( $expectedPrefetches ) {
		$entityPrefetcher = $this->getMock( EntityPrefetcher::class );
		$entityPrefetcher->expects( $this->exactly( $expectedPrefetches ) )
			->method( 'prefetch' )
			->with( $this->isType( 'array' ) );

		return $entityPrefetcher;
	}

	/**
	 * @param PropertyId $via
	 * @param EntityId[] $to
	 *
	 * @return StatementList
	 */
	private function getReferencingStatementList( PropertyId $via, array $to ) {
		$statementList = new StatementList();

		foreach ( $to as $toId ) {
			$value = new EntityIdValue( $toId );
			$mainSnak = new PropertyValueSnak( $via, $value );
			$statementList->addStatement( new Statement( $mainSnak ) );
		}

		return $statementList;
	}

	/**
	 * @return InMemoryEntityLookup
	 */
	private function getReferencingEntityStructure() {
		// This returns the following entity structure (all entities linked by P599)
		// Q1 -> Q5 -> Q599 -> Q1234
		//   \             \
		//    \             -- Q12 -> Q404
		//     --- Q90 -> Q3
		// Note: Q404 doesn't exist

		$pSubclassOf = new PropertyId( 'P599' );
		$q1 = new ItemId( 'Q1' );
		$q5 = new ItemId( 'Q5' );
		$q599 = new ItemId( 'Q599' );
		$q12 = new ItemId( 'Q12' );
		$q404 = new ItemId( 'Q404' );
		$q1234 = new ItemId( 'Q1234' );
		$q90 = new ItemId( 'Q90' );
		$q3 = new ItemId( 'Q3' );

		$lookup = new InMemoryEntityLookup();

		$lookup->addEntity(
			new Item( $q1, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q5, $q90 ] ) )
		);
		$lookup->addEntity(
			new Item( $q5, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q599 ] ) )
		);
		$lookup->addEntity(
			new Item( $q599, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q12, $q1234 ] ) )
		);
		$lookup->addEntity(
			new Item( $q12, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q404 ] ) )
		);
		$lookup->addEntity(
			new Item( $q90, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q3 ] ) )
		);
		$lookup->addEntity( new Item( $q1234, null, null, null ) );
		$lookup->addEntity( new Item( $q3, null, null, null ) );

		return $lookup;
	}

	/**
	 * @return InMemoryEntityLookup
	 */
	private function getCircularReferencingEntityStructure() {
		// This returns the following entity structure (all entities linked by P599)
		// Q1 -> Q5 -> Q1 -> Q5 -> …
		//   \           \
		//    --- Q90     --- Q90

		$pSubclassOf = new PropertyId( 'P599' );
		$q1 = new ItemId( 'Q1' );
		$q5 = new ItemId( 'Q5' );
		$q90 = new ItemId( 'Q90' );

		$lookup = new InMemoryEntityLookup();

		$lookup->addEntity(
			new Item( $q1, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q5, $q90 ] ) )
		);
		$lookup->addEntity(
			new Item( $q5, null, null, $this->getReferencingStatementList( $pSubclassOf, [ $q1 ] ) )
		);
		$lookup->addEntity(
			new Item( $q90, null, null, null )
		);

		return $lookup;
	}

	/**
	 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
	 */
	public function provideGetReferencedEntityIdNoError() {
		$pSubclassOf = new PropertyId( 'P599' );
		$q1 = new ItemId( 'Q1' );
		$q3 = new ItemId( 'Q3' );
		$q5 = new ItemId( 'Q5' );
		$q12 = new ItemId( 'Q12' );
		$q403 = new ItemId( 'Q403' );
		$q404 = new ItemId( 'Q404' );
		$referencingEntityStructureLookup = $this->getReferencingEntityStructure();
		$circularReferencingEntityStructure = $this->getCircularReferencingEntityStructure();

		return [
			'empty list of target ids' => [
				null,
				0,
				0,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[]
			],
			'no such statement' => [
				null,
				1,
				0,
				$referencingEntityStructureLookup,
				$q1,
				new PropertyId( 'P12345' ),
				[ $q5 ]
			],
			'from id does not exist' => [
				null,
				1,
				0,
				$referencingEntityStructureLookup,
				$q404,
				$pSubclassOf,
				[ $q5 ]
			],
			'directly referenced entity #1' => [
				$q5,
				1,
				0,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q5 ]
			],
			'directly referenced entity #2' => [
				$q1,
				1,
				0,
				$circularReferencingEntityStructure,
				$q5,
				$pSubclassOf,
				[ $q12, $q403, $q1, $q404 ]
			],
			'directly referenced entity, two target ids' => [
				$q5,
				1,
				0,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q5, $q404 ]
			],
			'indirectly referenced entity #1' => [
				$q3,
				3,
				1,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q3 ]
			],
			'indirectly referenced entity #2' => [
				$q12,
				4,
				2,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q12 ]
			],
			'indirectly referenced entity, multiple target ids' => [
				$q12,
				4,
				2,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q12, $q403, $q404 ]
			],
			'indirectly referenced entity, multiple target ids' => [
				$q12,
				4,
				2,
				$referencingEntityStructureLookup,
				$q1,
				$pSubclassOf,
				[ $q12, $q403, $q404 ]
			],
			'circular reference detection' => [
				null,
				3,
				1,
				$circularReferencingEntityStructure,
				$q1,
				$pSubclassOf,
				[ $q403, $q404 ]
			],
		];
	}

	/**
	 * @dataProvider provideGetReferencedEntityIdNoError
	 */
	public function testGetReferencedEntityIdNoError(
		EntityId $expectedToId = null,
		$maxEntityVisits,
		$maxDepth,
		EntityLookup $entityLookup,
		EntityId $fromId,
		PropertyId $propertyId,
		array $toIds
	) {
		// Number of prefetching operations to expect (Note: We call getReferencedEntityId twice)
		$expectedNumberOfPrefetches = $maxEntityVisits ? ( $maxDepth + 1 ) * 2 : 0;

		$lookup = new EntityRetrievingClosestReferencedEntityIdLookup(
			$this->maskEntityLookup( $entityLookup, $maxEntityVisits ),
			$this->getEntityPrefetcher( $expectedNumberOfPrefetches ),
			$maxDepth,
			$maxEntityVisits
		);
		$result = $lookup->getReferencedEntityId( $fromId, $propertyId, $toIds );

		$this->assertEquals( $expectedToId, $result );

		// Run again to see if the maxDepth/visitedEntityRelated state is properly resetted
		$this->assertEquals(
			$expectedToId,
			$lookup->getReferencedEntityId( $fromId, $propertyId, $toIds )
		);
	}

	public function provideGetReferencedEntityIdMaxDepthExceeded() {
		$cases = $this->provideGetReferencedEntityIdNoError();

		foreach ( $cases as $caseName => $case ) {
			if ( end( $case ) === [] ) {
				// In case we search for nothing, the max depth can't ever be exceeded
				continue;
			}

			// Remove expected to id
			array_shift( $case );
			// Reduce max depth by 1
			$case[1]--;

			yield $caseName => $case;
		}
	}

	/**
	 * @dataProvider provideGetReferencedEntityIdMaxDepthExceeded
	 */
	public function testGetReferencedEntityIdMaxDepthExceeded(
		$maxEntityVisits,
		$maxDepth,
		EntityLookup $entityLookup,
		EntityId $fromId,
		PropertyId $propertyId,
		array $toIds
	) {
		$lookup = new EntityRetrievingClosestReferencedEntityIdLookup(
			$this->maskEntityLookup( $entityLookup, $maxEntityVisits ),
			new NullEntityPrefetcher(),
			$maxDepth,
			$maxEntityVisits
		);

		try {
			$lookup->getReferencedEntityId( $fromId, $propertyId, $toIds );
		} catch ( MaxReferenceDepthExhaustedException $exception ) {
			$this->assertSame( $maxDepth, $exception->getMaxDepth() );

			return;
		}
		$this->fail( 'No expection thrown!' );
	}

	public function provideGetReferencedEntityIdMaxEntityVisitsExceeded() {
		$cases = $this->provideGetReferencedEntityIdNoError();

		foreach ( $cases as $caseName => $case ) {
			if ( end( $case ) === [] ) {
				// In case we search for nothing, no entity will ever be loaded
				continue;
			}

			// Remove expected to id
			array_shift( $case );
			// Reduce max entity visits by 1
			$case[0]--;

			yield $caseName => $case;
		}
	}

	/**
	 * @dataProvider provideGetReferencedEntityIdMaxEntityVisitsExceeded
	 */
	public function testGetReferencedEntityIdMaxEntityVisitsExceeded(
		$maxEntityVisits,
		$maxDepth,
		EntityLookup $entityLookup,
		EntityId $fromId,
		PropertyId $propertyId,
		array $toIds
	) {
		$lookup = new EntityRetrievingClosestReferencedEntityIdLookup(
			$this->maskEntityLookup( $entityLookup, $maxEntityVisits ),
			new NullEntityPrefetcher(),
			$maxDepth,
			$maxEntityVisits
		);

		try {
			$lookup->getReferencedEntityId( $fromId, $propertyId, $toIds );
		} catch ( MaxReferencedEntityVisitsExhaustedException $exception ) {
			$this->assertSame( $maxEntityVisits, $exception->getMaxEntityVisits() );

			return;
		}
		$this->fail( 'No expection thrown!' );
	}

	public function provideGetReferencedEntityIdTestInvalidSnak() {
		$q42 = new ItemId( 'Q42' );
		$p1 = new PropertyId( 'P1' );
		$p2 = new PropertyId( 'P2' );
		$statementList = new StatementList();

		$statementList->addStatement(
			new Statement( new PropertyNoValueSnak( $p1 ) )
		);

		$statementList->addStatement(
			new Statement( new PropertyValueSnak( $p2, new StringValue( '12' ) ) )
		);

		$entityLookup = new InMemoryEntityLookup();
		$entityLookup->addEntity( new Item( $q42, null, null, $statementList ) );

		return [
			'no value snak' => [
				$entityLookup,
				$q42,
				$p1,
				[ $q42 ]
			],
			'wrong datatype' => [
				$entityLookup,
				$q42,
				$p2,
				[ $q42 ]
			],
		];
	}

	/**
	 * @dataProvider provideGetReferencedEntityIdTestInvalidSnak
	 */
	public function testGetReferencedEntityIdTestInvalidSnak(
		EntityLookup $entityLookup,
		EntityId $fromId,
		PropertyId $propertyId,
		array $toIds
	) {
		$lookup = new EntityRetrievingClosestReferencedEntityIdLookup(
			$this->maskEntityLookup( $entityLookup, 1 ),
			new NullEntityPrefetcher(),
			0,
			1
		);

		$this->assertNull(
			$lookup->getReferencedEntityId( $fromId, $propertyId, $toIds )
		);
	}

	public function testGetReferencedEntityIdEntityLookupException() {
		$q2013 = new ItemId( 'Q2013' );

		$entityLookupException = new EntityLookupException( $q2013 );
		$entityLookup = new InMemoryEntityLookup();
		$entityLookup->addException( $entityLookupException );

		$lookup = new EntityRetrievingClosestReferencedEntityIdLookup(
			$entityLookup,
			new NullEntityPrefetcher(),
			50,
			50
		);

		try {
			$lookup->getReferencedEntityId( $q2013, new PropertyId( 'P31' ), [ new ItemId( 'Q154187' ) ] );
		} catch ( ReferencedEntityIdLookupException $exception ) {
			$this->assertInstanceOf( EntityLookupException::class, $exception->getPrevious() );

			return;
		}
		$this->fail( 'No expection thrown!' );
	}

}