ResponseFactoryTest.php
No OneTemporary
Actions

Size

8 KB

Referenced Files

None

Subscribers

None

ResponseFactoryTest.php
View Options

	<?php

	namespace MediaWiki\Tests\Rest;

	use ArrayIterator;
	use Exception;
	use InvalidArgumentException;
	use MediaWiki\Rest\HttpException;
	use MediaWiki\Rest\LocalizedHttpException;
	use MediaWiki\Rest\RedirectException;
	use MediaWiki\Rest\ResponseException;
	use MediaWiki\Rest\ResponseFactory;
	use MediaWiki\Tests\Unit\DummyServicesTrait;
	use MediaWikiUnitTestCase;
	use Wikimedia\Message\MessageValue;

	/** @covers \MediaWiki\Rest\ResponseFactory */
	class ResponseFactoryTest extends MediaWikiUnitTestCase {
	use DummyServicesTrait;

	public static function provideEncodeJson() {
	return [
	[ (object)[], '{}' ],
	[ '/', '"/"' ],
	[ '£', '"£"' ],
	[ [], '[]' ],
	[ "\xc0", "\"\u{FFFD}\"" ] // T289597
	];
	}

	private function createResponseFactory() {
	return new ResponseFactory( [ $this->getDummyTextFormatter() ] );
	}

	/** @dataProvider provideEncodeJson */
	public function testEncodeJson( $input, $expected ) {
	$rf = $this->createResponseFactory();
	$this->assertSame( $expected, $rf->encodeJson( $input ) );
	}

	public function testCreateJson() {
	$rf = $this->createResponseFactory();
	$response = $rf->createJson( [] );
	$response->getBody()->rewind();
	$this->assertSame( 'application/json', $response->getHeaderLine( 'Content-Type' ) );
	$this->assertSame( '[]', $response->getBody()->getContents() );
	// Make sure getSize() is functional, since testCreateNoContent() depends on it
	$this->assertSame( 2, $response->getBody()->getSize() );
	}

	public static function provideUseException() {
	return [ [ false ], [ true ] ];
	}

	/** @dataProvider provideUseException */
	public function testCreateNoContent( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new HttpException( '', 204 ) ) :
	$rf->createNoContent();
	$this->assertSame( [], $response->getHeader( 'Content-Type' ) );
	$this->assertSame( 0, $response->getBody()->getSize() );
	$this->assertSame( 204, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreatePermanentRedirect( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new RedirectException(
	301, 'http://www.example.com/'
	) ) :
	$rf->createPermanentRedirect( 'http://www.example.com/' );
	$this->assertSame( [ 'http://www.example.com/' ], $response->getHeader( 'Location' ) );
	$this->assertSame( 301, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreateLegacyTemporaryRedirect( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new RedirectException(
	302, 'http://www.example.com/'
	) ) :
	$rf->createLegacyTemporaryRedirect( 'http://www.example.com/' );
	$this->assertSame( [ 'http://www.example.com/' ], $response->getHeader( 'Location' ) );
	$this->assertSame( 302, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreateRedirect( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new RedirectException(
	333, 'http://www.example.com/'
	) ) :
	$rf->createRedirect( 'http://www.example.com/', 333 );
	$this->assertSame( [ 'http://www.example.com/' ], $response->getHeader( 'Location' ) );
	$this->assertSame( 333, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreateTemporaryRedirect( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new RedirectException(
	307, 'http://www.example.com/'
	) ) :
	$rf->createTemporaryRedirect( 'http://www.example.com/' );
	$this->assertSame( [ 'http://www.example.com/' ], $response->getHeader( 'Location' ) );
	$this->assertSame( 307, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreateSeeOther( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new RedirectException(
	303, 'http://www.example.com/'
	) ) :
	$rf->createSeeOther( 'http://www.example.com/' );
	$this->assertSame( [ 'http://www.example.com/' ], $response->getHeader( 'Location' ) );
	$this->assertSame( 303, $response->getStatusCode() );
	}

	/** @dataProvider provideUseException */
	public function testCreateNotModified( $useException ) {
	$rf = $this->createResponseFactory();
	$response = $useException ?
	$rf->createFromException( new HttpException( '', 304 ) ) :
	$rf->createNotModified();
	$this->assertSame( 0, $response->getBody()->getSize() );
	$this->assertSame( 304, $response->getStatusCode() );
	}

	public function testCreateHttpErrorInvalid() {
	$rf = $this->createResponseFactory();
	$this->expectException( InvalidArgumentException::class );
	$rf->createHttpError( 200 );
	}

	public function testCreateHttpError() {
	$rf = $this->createResponseFactory();
	$response = $rf->createHttpError( 415, [ 'message' => '...' ] );
	$this->assertSame( 415, $response->getStatusCode() );
	$body = $response->getBody();
	$body->rewind();
	$data = json_decode( $body->getContents(), true );
	$this->assertSame( 415, $data['httpCode'] );
	$this->assertSame( '...', $data['message'] );
	}

	public function testCreateFromExceptionUnlogged() {
	$rf = $this->createResponseFactory();
	$response = $rf->createFromException( new HttpException( 'hello', 415 ) );
	$this->assertSame( 415, $response->getStatusCode() );
	$body = $response->getBody();
	$body->rewind();
	$data = json_decode( $body->getContents(), true );
	$this->assertSame( 415, $data['httpCode'] );
	$this->assertSame( 'hello', $data['message'] );
	}

	public function testCreateFromExceptionLogged() {
	$rf = $this->createResponseFactory();
	$response = $rf->createFromException( new Exception( "hello", 415 ) );
	$this->assertSame( 500, $response->getStatusCode() );
	$body = $response->getBody();
	$body->rewind();
	$data = json_decode( $body->getContents(), true );
	$this->assertSame( 500, $data['httpCode'] );
	$this->assertSame( 'Error: exception of type Exception', $data['message'] );
	}

	public function testCreateFromExceptionWrapped() {
	$rf = $this->createResponseFactory();
	$wrapped = $rf->create();
	$response = $rf->createFromException( new ResponseException( $wrapped ) );
	$this->assertSame( $wrapped, $response );
	}

	public function testCreateFromExceptionWithExtraData() {
	$rf = $this->createResponseFactory();
	$e = new LocalizedHttpException( new MessageValue( 'rftest' ), 404 );
	$response = $rf->createFromException( $e, [ 'foo' => 'bar' ] );
	$body = $response->getBody();
	$body->rewind();
	$data = json_decode( $body->getContents(), true );
	$this->assertArrayHasKey( 'foo', $data );
	$this->assertSame( 'bar', $data['foo'] );
	}

	public static function provideCreateFromReturnValue() {
	return [
	[ 'hello', '{"value":"hello"}' ],
	[ true, '{"value":true}' ],
	[ [ 'x' => 'y' ], '{"x":"y"}' ],
	[ [ 'x', 'y' ], '["x","y"]' ],
	[ [ 'a', 'x' => 'y' ], '{"0":"a","x":"y"}' ],
	[ (object)[ 'a', 'x' => 'y' ], '{"0":"a","x":"y"}' ],
	[ [], '[]' ],
	[ (object)[], '{}' ],
	];
	}

	/** @dataProvider provideCreateFromReturnValue */
	public function testCreateFromReturnValue( $input, $expected ) {
	$rf = $this->createResponseFactory();
	$response = $rf->createFromReturnValue( $input );
	$body = $response->getBody();
	$body->rewind();
	$this->assertSame( $expected, $body->getContents() );
	}

	public function testCreateFromReturnValueInvalid() {
	$rf = $this->createResponseFactory();
	$this->expectException( InvalidArgumentException::class );
	$rf->createFromReturnValue( new ArrayIterator );
	}

	public function testCreateLocalizedHttpError() {
	$rf = $this->createResponseFactory();
	$response = $rf->createLocalizedHttpError( 404, new MessageValue( 'rftest' ) );
	$body = $response->getBody();
	$body->rewind();
	$this->assertSame(
	'{"messageTranslations":{"qqx":"rftest"},"httpCode":404,"httpReason":"Not Found"}',
	$body->getContents() );
	}

	public function testFormatMessage() {
	$rf = $this->createResponseFactory();
	$mv = new MessageValue( 'rftest' );
	$ret = $rf->formatMessage( $mv );
	$this->assertIsArray( $ret );
	$this->assertArrayHasKey( 'messageTranslations', $ret );
	$this->assertIsArray( $ret['messageTranslations'] );
	$this->assertArrayHasKey( 'qqx', $ret['messageTranslations'] );
	$this->assertSame( 'rftest', $ret['messageTranslations']['qqx'] );
	}

	public function testGetFormattedMessage() {
	$rf = $this->createResponseFactory();
	$mv = new MessageValue( 'rftest' );

	$ret = $rf->getFormattedMessage( $mv );
	$this->assertIsString( $ret );
	$this->assertSame( 'rftest', $ret );

	$ret = $rf->getFormattedMessage( $mv, 'doesnotexist' );
	$this->assertIsString( $ret );
	$this->assertSame( 'rftest', $ret );
	}
	}

File Metadata

Mime Type: text/x-php
Expires: Tue, Aug 18, 14:11 (4 w, 31 m ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 6d/40/af59a7a4ce158a84c1b51f444903
Default Alt Text: ResponseFactoryTest.php (8 KB)

ResponseFactoryTest.phpNo OneTemporaryActions

ResponseFactoryTest.phpView Options

File Metadata

Event Timeline

ResponseFactoryTest.php
No OneTemporary
Actions

ResponseFactoryTest.php
View Options