ApiOpenSearchTest.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

class ApiOpenSearchTest extends MediaWikiTestCase {
    public function testGetAllowedParams() {
        $config = $this->replaceSearchEngineConfig();
        $config->expects( $this->any() )
            ->method( 'getSearchTypes' )
            ->will( $this->returnValue( [ 'the one ring' ] ) );

        $api = $this->createApi();
        $engine = $this->replaceSearchEngine();
        $engine->expects( $this->any() )
            ->method( 'getProfiles' )
            ->will( $this->returnValueMap( [
                [ SearchEngine::COMPLETION_PROFILE_TYPE, $api->getUser(), [
                    [
                        'name' => 'normal',
                        'desc-message' => 'normal-message',
                        'default' => true,
                    ],
                    [
                        'name' => 'strict',
                        'desc-message' => 'strict-message',
                    ],
                ] ],
            ] ) );

        $params = $api->getAllowedParams();

        $this->assertArrayNotHasKey( 'offset', $params );
        $this->assertArrayHasKey( 'profile', $params, print_r( $params, true ) );
        $this->assertEquals( 'normal', $params['profile'][ApiBase::PARAM_DFLT] );
    }

    private function replaceSearchEngineConfig() {
        $config = $this->getMockBuilder( 'SearchEngineConfig' )
            ->disableOriginalConstructor()
            ->getMock();
        $this->setService( 'SearchEngineConfig', $config );

        return $config;
    }

    private function replaceSearchEngine() {
        $engine = $this->getMockBuilder( 'SearchEngine' )
            ->disableOriginalConstructor()
            ->getMock();
        $engineFactory = $this->getMockBuilder( 'SearchEngineFactory' )
            ->disableOriginalConstructor()
            ->getMock();
        $engineFactory->expects( $this->any() )
            ->method( 'create' )
            ->will( $this->returnValue( $engine ) );
        $this->setService( 'SearchEngineFactory', $engineFactory );

        return $engine;
    }

    private function createApi() {
        $ctx = new RequestContext();
        $apiMain = new ApiMain( $ctx );
        return new ApiOpenSearch( $apiMain, 'opensearch', '' );
    }
}