eb8823743c
This will allow constructing API modules that need services. This overhauls some of the internals of the ApiModuleManager, but the public interface remains unchanged. The $class parameter of addModule, (now called $spec) also allows passing an array with the spec of the module. Note that this spec requires the attribute 'class' to be present, even when 'factory' is specified. This is the same as before, where $class was always required. In a perfect DI world ObjectFactory would be injected into ApiMain::__construct and ApiMain would pass that to its instance of ApiModuleManager, but that is currently not possible, so for now it is injected in ApiModuleManager by having ApiMain::__construct call the service locator. Bug: T222388 Change-Id: Iee04afc27283547dd68d6db93f44ac2e0ebf1258
100 lines
3 KiB
PHP
100 lines
3 KiB
PHP
<?php
|
|
|
|
abstract class ApiFormatTestBase extends MediaWikiTestCase {
|
|
|
|
/**
|
|
* Name of the formatter being tested
|
|
* @var string
|
|
*/
|
|
protected $printerName;
|
|
|
|
/**
|
|
* Return general data to be encoded for testing
|
|
* @return array See self::testGeneralEncoding
|
|
* @throws BadMethodCallException
|
|
*/
|
|
public static function provideGeneralEncoding() {
|
|
throw new BadMethodCallException( static::class . ' must implement ' . __METHOD__ );
|
|
}
|
|
|
|
/**
|
|
* Get the formatter output for the given input data
|
|
* @param array $params Query parameters
|
|
* @param array $data Data to encode
|
|
* @param array $options Options. If passed a string, the string is treated
|
|
* as the 'class' option.
|
|
* - name: Format name, rather than $this->printerName
|
|
* - class: If set, register 'name' with this class (and 'factory', if that's set)
|
|
* - factory: Used with 'class' to register at runtime
|
|
* - returnPrinter: Return the printer object
|
|
* @return string|array The string if $options['returnPrinter'] isn't set, or an array if it is:
|
|
* - text: Output text string
|
|
* - printer: ApiFormatBase
|
|
* @throws Exception
|
|
*/
|
|
protected function encodeData( array $params, array $data, $options = [] ) {
|
|
if ( is_string( $options ) ) {
|
|
$options = [ 'class' => $options ];
|
|
}
|
|
$printerName = $options['name'] ?? $this->printerName;
|
|
$flags = $options['flags'] ?? 0;
|
|
|
|
$context = new RequestContext;
|
|
$context->setRequest( new FauxRequest( $params, true ) );
|
|
$main = new ApiMain( $context );
|
|
if ( isset( $options['class'] ) ) {
|
|
$spec = [
|
|
'class' => $options['class']
|
|
];
|
|
|
|
if ( isset( $options['factory'] ) ) {
|
|
$spec['factory'] = $options['factory'];
|
|
}
|
|
|
|
$main->getModuleManager()->addModule( $printerName, 'format', $spec );
|
|
}
|
|
$result = $main->getResult();
|
|
$result->addArrayType( null, 'default' );
|
|
foreach ( $data as $k => $v ) {
|
|
$result->addValue( null, $k, $v, $flags );
|
|
}
|
|
|
|
$ret = [];
|
|
$printer = $main->createPrinterByName( $printerName );
|
|
$printer->initPrinter();
|
|
$printer->execute();
|
|
ob_start();
|
|
try {
|
|
$printer->closePrinter();
|
|
$ret['text'] = ob_get_clean();
|
|
} catch ( Exception $ex ) {
|
|
ob_end_clean();
|
|
throw $ex;
|
|
}
|
|
|
|
if ( !empty( $options['returnPrinter'] ) ) {
|
|
$ret['printer'] = $printer;
|
|
}
|
|
|
|
return count( $ret ) === 1 ? $ret['text'] : $ret;
|
|
}
|
|
|
|
/**
|
|
* @dataProvider provideGeneralEncoding
|
|
* @param array $data Data to be encoded
|
|
* @param string|Exception $expect String to expect, or exception expected to be thrown
|
|
* @param array $params Query parameters to set in the FauxRequest
|
|
* @param array $options Options to pass to self::encodeData()
|
|
*/
|
|
public function testGeneralEncoding(
|
|
array $data, $expect, array $params = [], array $options = []
|
|
) {
|
|
if ( $expect instanceof Exception ) {
|
|
$this->setExpectedException( get_class( $expect ), $expect->getMessage() );
|
|
$this->encodeData( $params, $data, $options ); // Should throw
|
|
} else {
|
|
$this->assertSame( $expect, $this->encodeData( $params, $data, $options ) );
|
|
}
|
|
}
|
|
|
|
}
|