1 files changed, 93 insertions, 0 deletions
diff --git a/www/wiki/tests/phpunit/includes/api/format/ApiFormatTestBase.php b/www/wiki/tests/phpunit/includes/api/format/ApiFormatTestBase.php
new file mode 100644
index 00000000..4169dab2
--- /dev/null
+++ b/www/wiki/tests/phpunit/includes/api/format/ApiFormatTestBase.php
@@ -0,0 +1,93 @@
+<?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
+	 * @param callable|null $factory Factory to use instead of the normal one
+	 * @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 = isset( $options['name'] ) ? $options['name'] : $this->printerName;
+
+		$context = new RequestContext;
+		$context->setRequest( new FauxRequest( $params, true ) );
+		$main = new ApiMain( $context );
+		if ( isset( $options['class'] ) ) {
+			$factory = isset( $options['factory'] ) ? $options['factory'] : null;
+			$main->getModuleManager()->addModule( $printerName, 'format', $options['class'], $factory );
+		}
+		$result = $main->getResult();
+		$result->addArrayType( null, 'default' );
+		foreach ( $data as $k => $v ) {
+			$result->addValue( null, $k, $v );
+		}
+
+		$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 ) );
+		}
+	}
+
+}