diff options
Diffstat (limited to 'www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/CoreMockObjectRepository.php')
| -rw-r--r-- | www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/CoreMockObjectRepository.php | 661 |
1 files changed, 661 insertions, 0 deletions
diff --git a/www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/CoreMockObjectRepository.php b/www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/CoreMockObjectRepository.php new file mode 100644 index 00000000..65c502e8 --- /dev/null +++ b/www/wiki/extensions/SemanticMediaWiki/tests/phpunit/Utils/Mock/CoreMockObjectRepository.php @@ -0,0 +1,661 @@ +<?php + +namespace SMW\Tests\Utils\Mock; + +use DataValues\DataValue; +use OutOfBoundsException; +use SMW\ContentParser; +use SMW\DependencyContainer; +use SMW\DependencyObject; +use SMW\DIProperty; +use SMW\DIWikiPage; +use SMW\Factbox\Factbox; +use SMW\MediaWiki\PageInfoProvider; +use SMW\ParserData; +use SMW\Query\Language\Description; +use SMW\Query\PrintRequest; +use SMW\SemanticData; +use SMW\SQLStore\TableDefinition; +use SMW\Store; +use SMW\Store\CacheableResultCollector; +use SMWDataItem; +use SMWDIError; +use SMWQuery; +use SMWQueryResult; +use SMWResultArray; + +/** + * @codeCoverageIgnore + * + * + * @group SMW + * @group SMWExtension + * + * @licence GNU GPL v2+ + * @since 1.9 + * + * @author mwjames + */ +class CoreMockObjectRepository extends \PHPUnit_Framework_TestCase implements MockObjectRepository { + + /** @var MockObjectBuilder */ + protected $builder; + + /** + * @since 1.9 + */ + public function registerBuilder( MockObjectBuilder $builder ) { + $this->builder = $builder; + } + + /** + * Returns a SemanticData object + * + * @since 1.9 + * + * @return SemanticData + */ + public function SemanticData() { + + $semanticData = $this->getMockBuilder( 'SMW\SemanticData' ) + ->disableOriginalConstructor() + ->getMock(); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + $semanticData->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $semanticData; + } + + /** + * Helper method that returns a CacheableResultCollector object + * + * @since 1.9 + * + * @return CacheableResultCollector + */ + public function CacheableResultCollector() { + + // CacheableResultCollector is an abstract class therefore necessary methods + // are declared by default while other methods are only mocked if needed + // because setMethods overrides the original signature + $methods = [ 'cacheSetup', 'runCollector' ]; + + if ( $this->builder->hasValue( 'getResults' ) ) { + $methods[] = 'getResults'; + } + + $collector = $this->getMockBuilder( '\SMW\Store\CacheableResultCollector' ) + ->setMethods( $methods ) + ->getMock(); + + $collector->expects( $this->any() ) + ->method( 'runCollector' ) + ->will( $this->returnValue( $this->builder->setValue( 'runCollector' ) ) ); + + $collector->expects( $this->any() ) + ->method( 'cacheSetup' ) + ->will( $this->returnValue( $this->builder->setValue( 'cacheSetup' ) ) ); + + $collector->expects( $this->any() ) + ->method( 'getResults' ) + ->will( $this->returnValue( $this->builder->setValue( 'getResults' ) ) ); + + return $collector; + } + + /** + * @since 1.9 + * + * @return DependencyObject + */ + public function DependencyObject() { + + $methods = $this->builder->getInvokedMethods(); + + $dependencyObject = $this->getMockBuilder( 'SMW\DependencyObject' ) + ->setMethods( $methods ) + ->getMock(); + + foreach ( $methods as $method ) { + + $dependencyObject->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $dependencyObject; + } + + /** + * @since 1.9 + * + * @return DependencyContainer + */ + public function FakeDependencyContainer() { + + $methods = $this->builder->getInvokedMethods(); + + $dependencyObject = $this->getMockBuilder( 'SMW\NullDependencyContainer' ) + ->setMethods( $methods ) + ->getMock(); + + foreach ( $methods as $method ) { + + $dependencyObject->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $dependencyObject; + } + + /** + * @since 1.9 + * + * @return ParserData + */ + public function ParserData() { + + $methods = $this->builder->getInvokedMethods(); + + $parserData = $this->getMockBuilder( 'SMW\ParserData' ) + ->disableOriginalConstructor() + ->getMock(); + + foreach ( $methods as $method ) { + + $parserData->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $parserData; + } + + /** + * @since 1.9 + * + * @return Factbox + */ + public function Factbox() { + + $factbox = $this->getMockBuilder( '\SMW\Factbox\Factbox' ) + ->disableOriginalConstructor() + ->getMock(); + + $factbox->expects( $this->any() ) + ->method( 'isVisible' ) + ->will( $this->returnValue( $this->builder->setValue( 'isVisible' ) ) ); + + $factbox->expects( $this->any() ) + ->method( 'getContent' ) + ->will( $this->returnValue( $this->builder->setValue( 'getContent' ) ) ); + + return $factbox; + } + + /** + * @since 1.9 + * + * @return SMWQuery + */ + public function Query() { + + $query = $this->getMockBuilder( 'SMWQuery' ) + ->disableOriginalConstructor() + ->getMock(); + + return $query; + } + + /** + * @since 1.9 + * + * @return ContentParser + */ + public function ContentParser() { + + $contentParser = $this->getMockBuilder( '\SMW\ContentParser' ) + ->disableOriginalConstructor() + ->getMock(); + + $contentParser->expects( $this->any() ) + ->method( 'getOutput' ) + ->will( $this->returnValue( $this->builder->setValue( 'getOutput', $this->builder->newObject( 'ParserOutput' ) ) ) ); + + $contentParser->expects( $this->any() ) + ->method( 'getErrors' ) + ->will( $this->returnValue( $this->builder->setValue( 'getErrors', [] ) ) ); + + $contentParser->expects( $this->any() ) + ->method( 'getRevision' ) + ->will( $this->returnValue( $this->builder->setValue( 'getRevision', null ) ) ); + + return $contentParser; + } + + /** + * @since 1.9 + * + * @return DataValue + * @throws OutOfBoundsException + */ + public function DataValue() { + + if ( !$this->builder->hasValue( 'DataValueType' ) ) { + throw new OutOfBoundsException( 'DataValueType is missing' ); + } + + $dataValue = $this->getMockBuilder( $this->builder->setValue( 'DataValueType' ) ) + ->disableOriginalConstructor() + ->getMock(); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + if ( $method === 'DataValueType' ) { + continue; + } + + $dataValue->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $dataValue; + } + + /** + * @since 1.9 + * + * @return SMWQueryResult + */ + public function QueryResult() { + + $queryResult = $this->getMockBuilder( 'SMWQueryResult' ) + ->disableOriginalConstructor() + ->getMock(); + + $queryResult->expects( $this->any() ) + ->method( 'getErrors' ) + ->will( $this->returnValue( $this->builder->setValue( 'getErrors', [] ) ) ); + + // Word of caution, onConsecutiveCalls is used in order to ensure + // that a while() loop is not trapped in an infinite loop and returns + // a false at the end + $queryResult->expects( $this->any() ) + ->method( 'getNext' ) + ->will( $this->onConsecutiveCalls( $this->builder->setValue( 'getNext' ), false ) ); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + $queryResult->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $queryResult; + } + + /** + * @since 1.9 + * + * @return DIWikiPage + */ + public function DIWikiPage() { + + $diWikiPage = $this->getMockBuilder( '\SMW\DIWikiPage' ) + ->disableOriginalConstructor() + ->getMock(); + + $diWikiPage->expects( $this->any() ) + ->method( 'getTitle' ) + ->will( $this->returnValue( $this->builder->setValue( 'getTitle' ) ) ); + + $diWikiPage->expects( $this->any() ) + ->method( 'getDBkey' ) + ->will( $this->returnValue( $this->builder->setValue( 'getDBkey', $this->builder->newRandomString( 10, 'DIWikiPage-auto-dbkey' ) ) ) ); + + $diWikiPage->expects( $this->any() ) + ->method( 'getPrefixedText' ) + ->will( $this->returnValue( $this->builder->setValue( 'getPrefixedText', $this->builder->newRandomString( 10, 'DIWikiPage-auto-prefixedText' ) ) ) ); + + $diWikiPage->expects( $this->any() ) + ->method( 'getDIType' ) + ->will( $this->returnValue( SMWDataItem::TYPE_WIKIPAGE ) ); + + $diWikiPage->expects( $this->any() ) + ->method( 'findPropertyTypeID' ) + ->will( $this->returnValue( $this->builder->setValue( 'findPropertyTypeID', '_wpg' ) ) ); + + $diWikiPage->expects( $this->any() ) + ->method( 'getSubobjectName' ) + ->will( $this->returnValue( $this->builder->setValue( 'getSubobjectName', '' ) ) ); + + return $diWikiPage; + } + + /** + * @since 1.9 + * + * @return DIProperty + */ + public function DIProperty() { + + $property = $this->getMockBuilder( '\SMW\DIProperty' ) + ->disableOriginalConstructor() + ->getMock(); + + $property->expects( $this->any() ) + ->method( 'findPropertyTypeID' ) + ->will( $this->returnValue( $this->builder->setValue( 'findPropertyTypeID', '_wpg' ) ) ); + + $property->expects( $this->any() ) + ->method( 'getKey' ) + ->will( $this->returnValue( $this->builder->setValue( 'getKey', '_wpg' ) ) ); + + $property->expects( $this->any() ) + ->method( 'getDIType' ) + ->will( $this->returnValue( SMWDataItem::TYPE_PROPERTY ) ); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + $property->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $property; + } + + /** + * @note MockStore is based on the abstract Store class which avoids + * dependency on a specific Store implementation (SQLStore etc.), the mock + * object will allow to override necessary methods + * + * @since 1.9 + * + * @return Store + */ + public function Store() { + + // SMW\Store is an abstract class, use setMethods to implement + // required abstract methods + $requiredAbstractMethods = [ + 'setup', + 'drop', + 'getStatisticsTable', + 'getObjectIds', + 'refreshData', + 'getStatistics', + 'getQueryResult', + 'getPropertiesSpecial', + 'getUnusedPropertiesSpecial', + 'getWantedPropertiesSpecial', + 'getPropertyTables', + 'deleteSubject', + 'doDataUpdate', + 'changeTitle', + 'getProperties', + 'getInProperties', + 'getAllPropertySubjects', + 'getSQLConditions', + 'getSemanticData', + 'getPropertyValues', + 'getPropertySubjects', + 'refreshConceptCache', + 'deleteConceptCache', + 'getConceptCacheStatus', + 'clearData', + 'updateData' + ]; + + $methods = array_unique( array_merge( $requiredAbstractMethods, $this->builder->getInvokedMethods() ) ); + + $idTable = $this->getMockBuilder( 'stdClass' ) + ->disableOriginalConstructor() + ->setMethods( [ 'getIdTable' ] ) + ->getMock(); + + $idTable->expects( $this->any() ) + ->method( 'getIdTable' ) + ->will( $this->returnValue( 'smw_id_table_test' ) ); + + $store = $this->getMockBuilder( '\SMW\Store' ) + ->disableOriginalConstructor() + ->setMethods( $methods ) + ->getMock(); + + $store->expects( $this->any() ) + ->method( 'getObjectIds' ) + ->will( $this->returnValue( $idTable ) ); + + $store->expects( $this->any() ) + ->method( 'getProperties' ) + ->will( $this->builder->setCallback( 'getProperties', [] ) ); + + $store->expects( $this->any() ) + ->method( 'getInProperties' ) + ->will( $this->builder->setCallback( 'getInProperties', [] ) ); + + $store->expects( $this->any() ) + ->method( 'getStatisticsTable' ) + ->will( $this->returnValue( 'smw_statistics_table_test' ) ); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + $store->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $store; + } + + /** + * @since 1.9 + * + * @return TableDefinition + */ + public function SQLStoreTableDefinition() { + + $tableDefinition = $this->getMockBuilder( 'SMW\SQLStore\TableDefinition' ) + ->disableOriginalConstructor() + ->getMock(); + + foreach ( $this->builder->getInvokedMethods() as $method ) { + + $tableDefinition->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $tableDefinition; + } + + /** + * @since 1.9 + * + * @return SMWDIError + */ + public function DIError() { + + $errors = $this->getMockBuilder( 'SMWDIError' ) + ->disableOriginalConstructor() + ->getMock(); + + $errors->expects( $this->any() ) + ->method( 'getErrors' ) + ->will( $this->returnValue( $this->builder->setValue( 'getErrors' ) ) ); + + return $errors; + } + + /** + * @since 1.9 + * + * @return SMWDataItem + */ + public function DataItem() { + + $requiredMethods = [ + 'getNumber', + 'getDIType', + 'getSortKey', + 'equals', + 'getSerialization', + ]; + + $methods = array_unique( array_merge( $requiredMethods, $this->builder->getInvokedMethods() ) ); + + $dataItem = $this->getMockBuilder( 'SMWDataItem' ) + ->disableOriginalConstructor() + ->setMethods( $methods ) + ->getMock(); + + foreach ( $methods as $method ) { + + $dataItem->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $dataItem; + } + + /** + * @since 1.9 + * + * @return PrintRequest + */ + public function PrintRequest() { + + $printRequest = $this->getMockBuilder( 'SMW\Query\PrintRequest' ) + ->disableOriginalConstructor() + ->getMock(); + + $printRequest->expects( $this->any() ) + ->method( 'getText' ) + ->will( $this->returnValue( $this->builder->setValue( 'getText', $this->builder->newRandomString( 10, 'Auto-printRequest' ) ) ) ); + + $printRequest->expects( $this->any() ) + ->method( 'getLabel' ) + ->will( $this->returnValue( $this->builder->setValue( 'getLabel' ) ) ); + + $printRequest->expects( $this->any() ) + ->method( 'getMode' ) + ->will( $this->returnValue( $this->builder->setValue( 'getMode', PrintRequest::PRINT_THIS ) ) ); + + $printRequest->expects( $this->any() ) + ->method( 'getTypeID' ) + ->will( $this->returnValue( $this->builder->setValue( 'getTypeID' ) ) ); + + $printRequest->expects( $this->any() ) + ->method( 'getOutputFormat' ) + ->will( $this->returnValue( $this->builder->setValue( 'getOutputFormat' ) ) ); + + $printRequest->expects( $this->any() ) + ->method( 'getParameter' ) + ->will( $this->returnValue( $this->builder->setValue( 'getParameter', 'center' ) ) ); + + return $printRequest; + } + + /** + * @since 1.9 + * + * @return SMWResultArray + */ + public function ResultArray() { + + $resultArray = $this->getMockBuilder( 'SMWResultArray' ) + ->disableOriginalConstructor() + ->getMock(); + + $resultArray->expects( $this->any() ) + ->method( 'getPrintRequest' ) + ->will( $this->returnValue( $this->builder->setValue( 'getPrintRequest' ) ) ); + + $resultArray->expects( $this->any() ) + ->method( 'getContent' ) + ->will( $this->returnValue( $this->builder->setValue( 'getContent' ) ) ); + + $resultArray->expects( $this->any() ) + ->method( 'getNextDataValue' ) + ->will( $this->onConsecutiveCalls( $this->builder->setValue( 'getNextDataValue' ), false ) ); + + $resultArray->expects( $this->any() ) + ->method( 'getNextDataItem' ) + ->will( $this->onConsecutiveCalls( $this->builder->setValue( 'getNextDataItem' ), false ) ); + + return $resultArray; + } + + /** + * @since 1.9 + * + * @return Description + */ + public function QueryDescription() { + + $requiredAbstractMethods = [ + 'getQueryString', + 'isSingleton' + ]; + + $methods = array_unique( array_merge( $requiredAbstractMethods, $this->builder->getInvokedMethods() ) ); + + $queryDescription = $this->getMockBuilder( '\SMWDescription' ) + ->setMethods( $methods ) + ->getMock(); + + foreach ( $methods as $method ) { + + $queryDescription->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $queryDescription; + } + + /** + * @since 1.9 + * + * @return PageInfoProvider + */ + public function PageInfoProvider() { + + $methods = $this->builder->getInvokedMethods(); + + $adapter = $this->getMockBuilder( 'SMW\PageInfoProvider' ) + ->disableOriginalConstructor() + ->getMock(); + + foreach ( $methods as $method ) { + + $adapter->expects( $this->any() ) + ->method( $method ) + ->will( $this->builder->setCallback( $method ) ); + + } + + return $adapter; + } + +} |