7295100773
Bug: T305043 Depends-On: Ic7c1b19b86e8a151e2d42aaec00ef0e89db77f08 Change-Id: Ic6bd48b400ecd839ef99b518ef955781470cd05c
101 lines
2.7 KiB
PHP
101 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Tests\Rest\Handler;
|
|
|
|
use ApiBase;
|
|
use ApiMain;
|
|
use Exception;
|
|
use FauxRequest;
|
|
use Language;
|
|
use PHPUnit\Framework\MockObject\MockBuilder;
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
|
use RequestContext;
|
|
|
|
/**
|
|
* A trait providing utility functions for testing Handler classes
|
|
* derived from ActionModuleBasedHandler.
|
|
* This trait is intended to be used on subclasses of MediaWikiUnitTestCase
|
|
* or MediaWikiIntegrationTestCase.
|
|
*
|
|
* @package MediaWiki\Tests\Rest\Handler
|
|
*/
|
|
trait ActionModuleBasedHandlerTestTrait {
|
|
|
|
use HandlerTestTrait;
|
|
|
|
/**
|
|
* Expected to be provided by the class, probably inherited from TestCase.
|
|
*
|
|
* @param string $className
|
|
*
|
|
* @return MockBuilder
|
|
*/
|
|
abstract protected function getMockBuilder( $className ): MockBuilder;
|
|
|
|
/**
|
|
* @param ApiMain $main
|
|
* @param string $name
|
|
* @param array $resultData
|
|
* @param Exception|null $throwException
|
|
*
|
|
* @return ApiBase|MockObject
|
|
*/
|
|
private function getDummyApiModule(
|
|
ApiMain $main,
|
|
$name,
|
|
$resultData,
|
|
Exception $throwException = null
|
|
) {
|
|
/** @var ApiBase|MockObject $module */
|
|
$module = $this->getMockBuilder( ApiBase::class )
|
|
->setConstructorArgs( [ $main, $name ] )
|
|
->onlyMethods( [ 'execute' ] )
|
|
->getMock();
|
|
|
|
$module->method( 'execute' )
|
|
->willReturnCallback(
|
|
static function () use ( $module, $resultData, $throwException ) {
|
|
if ( $throwException ) {
|
|
throw $throwException;
|
|
}
|
|
|
|
$res = $module->getResult();
|
|
foreach ( $resultData as $key => $value ) {
|
|
$res->addValue( null, $key, $value );
|
|
}
|
|
}
|
|
);
|
|
|
|
return $module;
|
|
}
|
|
|
|
/**
|
|
* @param bool $csrfSafe
|
|
* @return ApiMain
|
|
*/
|
|
private function getApiMain( $csrfSafe = false ) {
|
|
$session = $this->getSession( $csrfSafe );
|
|
|
|
// NOTE: This being a FauxRequest instance triggers special case behavior
|
|
// in ApiMain, causing ApiMain::isInternalMode() to return true. Among other things,
|
|
// this causes ApiMain to throw errors rather than encode them in the result data.
|
|
/** @var MockObject|FauxRequest $fauxRequest */
|
|
$fauxRequest = $this->getMockBuilder( FauxRequest::class )
|
|
->onlyMethods( [ 'getSession', 'getSessionId' ] )
|
|
->getMock();
|
|
$fauxRequest->method( 'getSession' )->willReturn( $session );
|
|
$fauxRequest->method( 'getSessionId' )->willReturn( $session->getSessionId() );
|
|
|
|
/** @var Language|MockObject $language */
|
|
$language = $this->createNoOpMock( Language::class );
|
|
$testContext = RequestContext::getMain();
|
|
|
|
$fauxContext = new RequestContext();
|
|
$fauxContext->setRequest( $fauxRequest );
|
|
$fauxContext->setUser( $testContext->getUser() );
|
|
$fauxContext->setLanguage( $language );
|
|
|
|
return new ApiMain( $fauxContext, true );
|
|
}
|
|
|
|
}
|