tests/phpunit/includes/api/ApiOpenSearchTest.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Api;
   4
   5 use MediaWiki\Api\ApiMain;
   6 use MediaWiki\Api\ApiOpenSearch;
   7 use MediaWiki\Context\RequestContext;
   8 use MediaWikiIntegrationTestCase;
   9 use SearchEngine;
  10 use SearchEngineConfig;
  11 use SearchEngineFactory;
  12 use Wikimedia\ParamValidator\ParamValidator;
  13
  14 /**
  15  * TODO convert to unit test, no integration is needed
  16  *
  17  * @covers \MediaWiki\Api\ApiOpenSearch
  18  */
  19 class ApiOpenSearchTest extends MediaWikiIntegrationTestCase {
  20         public function testGetAllowedParams() {
  21                 $config = $this->replaceSearchEngineConfig();
  22                 $config->method( 'getSearchTypes' )
  23                         ->willReturn( [ 'the one ring' ] );
  24
  25                 [ $engine, $engineFactory ] = $this->replaceSearchEngine();
  26
  27                 $ctx = new RequestContext();
  28                 $apiMain = new ApiMain( $ctx );
  29                 $api = new ApiOpenSearch(
  30                         $apiMain,
  31                         'opensearch',
  32                         $this->getServiceContainer()->getLinkBatchFactory(),
  33                         $config,
  34                         $engineFactory,
  35                         $this->getServiceContainer()->getUrlUtils()
  36                 );
  37
  38                 $engine->method( 'getProfiles' )
  39                         ->willReturnMap( [
  40                                 [ SearchEngine::COMPLETION_PROFILE_TYPE, $api->getUser(), [
  41                                         [
  42                                                 'name' => 'normal',
  43                                                 'desc-message' => 'normal-message',
  44                                                 'default' => true,
  45                                         ],
  46                                         [
  47                                                 'name' => 'strict',
  48                                                 'desc-message' => 'strict-message',
  49                                         ],
  50                                 ] ],
  51                         ] );
  52
  53                 $params = $api->getAllowedParams();
  54
  55                 $this->assertArrayNotHasKey( 'offset', $params );
  56                 $this->assertArrayHasKey( 'profile', $params, print_r( $params, true ) );
  57                 $this->assertEquals( 'normal', $params['profile'][ParamValidator::PARAM_DEFAULT] );
  58         }
  59
  60         private function replaceSearchEngineConfig() {
  61                 $config = $this->createMock( SearchEngineConfig::class );
  62                 $this->setService( 'SearchEngineConfig', $config );
  63
  64                 return $config;
  65         }
  66
  67         private function replaceSearchEngine() {
  68                 $engine = $this->createMock( SearchEngine::class );
  69                 $engineFactory = $this->createMock( SearchEngineFactory::class );
  70                 $engineFactory->method( 'create' )
  71                         ->willReturn( $engine );
  72                 $this->setService( 'SearchEngineFactory', $engineFactory );
  73
  74                 return [ $engine, $engineFactory ];
  75         }
  76 }