3 namespace MediaWiki\Tests\Rest
;
5 use GuzzleHttp\Psr7\Uri
;
6 use MediaWiki\Permissions\PermissionManager
;
7 use MediaWiki\Rest\BasicAccess\StaticBasicAuthorizer
;
8 use MediaWiki\Rest\Handler
;
9 use MediaWiki\Rest\HttpException
;
10 use MediaWiki\Rest\RequestData
;
11 use MediaWiki\Rest\RequestInterface
;
12 use MediaWiki\Rest\ResponseFactory
;
13 use MediaWiki\Rest\Router
;
14 use MediaWiki\Rest\Validator\Validator
;
15 use Psr\Container\ContainerInterface
;
16 use Wikimedia\ObjectFactory
;
20 * @covers \MediaWiki\Rest\Router
22 class RouterTest
extends \MediaWikiUnitTestCase
{
24 private function createRouter( RequestInterface
$request, $authError = null ) {
25 $objectFactory = new ObjectFactory(
26 $this->getMockForAbstractClass( ContainerInterface
::class )
28 $permissionManager = $this->createMock( PermissionManager
::class );
30 [ __DIR__
. '/testRoutes.json' ],
33 new \
EmptyBagOStuff(),
34 new ResponseFactory( [] ),
35 new StaticBasicAuthorizer( $authError ),
37 new Validator( $objectFactory, $permissionManager, $request, new User
)
41 public function testPrefixMismatch() {
42 $request = new RequestData( [ 'uri' => new Uri( '/bogus' ) ] );
43 $router = $this->createRouter( $request );
44 $response = $router->execute( $request );
45 $this->assertSame( 404, $response->getStatusCode() );
48 public function testWrongMethod() {
49 $request = new RequestData( [
50 'uri' => new Uri( '/rest/user/joe/hello' ),
53 $router = $this->createRouter( $request );
54 $response = $router->execute( $request );
55 $this->assertSame( 405, $response->getStatusCode() );
56 $this->assertSame( 'Method Not Allowed', $response->getReasonPhrase() );
57 $this->assertSame( 'GET', $response->getHeaderLine( 'Allow' ) );
60 public function testHeadToGet() {
61 $request = new RequestData( [
62 'uri' => new Uri( '/rest/user/joe/hello' ),
65 $router = $this->createRouter( $request );
66 $response = $router->execute( $request );
67 $this->assertSame( 200, $response->getStatusCode() );
70 public function testNoMatch() {
71 $request = new RequestData( [ 'uri' => new Uri( '/rest/bogus' ) ] );
72 $router = $this->createRouter( $request );
73 $response = $router->execute( $request );
74 $this->assertSame( 404, $response->getStatusCode() );
75 // TODO: add more information to the response body and test for its presence here
78 public static function throwHandlerFactory() {
79 return new class extends Handler
{
80 public function execute() {
81 throw new HttpException( 'Mock error', 555 );
86 public function testException() {
87 $request = new RequestData( [ 'uri' => new Uri( '/rest/mock/RouterTest/throw' ) ] );
88 $router = $this->createRouter( $request );
89 $response = $router->execute( $request );
90 $this->assertSame( 555, $response->getStatusCode() );
91 $body = $response->getBody();
93 $data = json_decode( $body->getContents(), true );
94 $this->assertSame( 'Mock error', $data['message'] );
97 public function testBasicAccess() {
98 // Using the throwing handler is a way to assert that the handler is not executed
99 $request = new RequestData( [ 'uri' => new Uri( '/rest/mock/RouterTest/throw' ) ] );
100 $router = $this->createRouter( $request, 'test-error' );
101 $response = $router->execute( $request );
102 $this->assertSame( 403, $response->getStatusCode() );
103 $body = $response->getBody();
105 $data = json_decode( $body->getContents(), true );
106 $this->assertSame( 'test-error', $data['error'] );