tests/phpunit/includes/linkeddata/PageDataRequestHandlerTest.php

   1 <?php
   2
   3 /**
   4  * @covers PageDataRequestHandler
   5  *
   6  * @group PageData
   7  *
   8  * @license GPL-2.0+
   9  */
  10 class PageDataRequestHandlerTest extends \MediaWikiTestCase {
  11
  12         /**
  13          * @var Title
  14          */
  15         private $interfaceTitle;
  16
  17         /**
  18          * @var int
  19          */
  20         private $obLevel;
  21
  22         protected function setUp() {
  23                 parent::setUp();
  24
  25                 $this->interfaceTitle = Title::newFromText( "Special:PageDataRequestHandlerTest" );
  26
  27                 $this->obLevel = ob_get_level();
  28         }
  29
  30         protected function tearDown() {
  31                 $obLevel = ob_get_level();
  32
  33                 while ( ob_get_level() > $this->obLevel ) {
  34                         ob_end_clean();
  35                 }
  36
  37                 if ( $obLevel !== $this->obLevel ) {
  38                         $this->fail( "Test changed output buffer level: was {$this->obLevel}" .
  39                                 "before test, but $obLevel after test."
  40                         );
  41                 }
  42
  43                 parent::tearDown();
  44         }
  45
  46         /**
  47          * @return PageDataRequestHandler
  48          */
  49         protected function newHandler() {
  50                 return new PageDataRequestHandler( 'json' );
  51         }
  52
  53         /**
  54          * @param array $params
  55          * @param string[] $headers
  56          *
  57          * @return OutputPage
  58          */
  59         protected function makeOutputPage( array $params, array $headers ) {
  60                 // construct request
  61                 $request = new FauxRequest( $params );
  62                 $request->response()->header( 'Status: 200 OK', true, 200 ); // init/reset
  63
  64                 foreach ( $headers as $name => $value ) {
  65                         $request->setHeader( strtoupper( $name ), $value );
  66                 }
  67
  68                 // construct Context and OutputPage
  69                 $context = new DerivativeContext( RequestContext::getMain() );
  70                 $context->setRequest( $request );
  71
  72                 $output = new OutputPage( $context );
  73                 $output->setTitle( $this->interfaceTitle );
  74                 $context->setOutput( $output );
  75
  76                 return $output;
  77         }
  78
  79         public function handleRequestProvider() {
  80                 $cases = [];
  81
  82                 $cases[] = [ '', [], [], '!!', 400 ];
  83
  84                 $cases[] = [ '', [ 'target' => 'Helsinki' ], [], '!!', 303,  [ 'Location' => '!.+!' ] ];
  85
  86                 $subpageCases = [];
  87                 foreach ( $cases as $c ) {
  88                         $case = $c;
  89                         $case[0] = 'main/';
  90
  91                         if ( isset( $case[1]['target'] ) ) {
  92                                 $case[0] .= $case[1]['target'];
  93                                 unset( $case[1]['target'] );
  94                         }
  95
  96                         $subpageCases[] = $case;
  97                 }
  98
  99                 $cases = array_merge( $cases, $subpageCases );
 100
 101                 $cases[] = [
 102                         '',
 103                         [ 'target' => 'Helsinki' ],
 104                         [ 'Accept' => 'text/HTML' ],
 105                         '!!',
 106                         303,
 107                         [ 'Location' => '!Helsinki$!' ]
 108                 ];
 109
 110                 $cases[] = [
 111                         '',
 112                         [
 113                                 'target' => 'Helsinki',
 114                                 'revision' => '4242',
 115                         ],
 116                         [ 'Accept' => 'text/HTML' ],
 117                         '!!',
 118                         303,
 119                         [ 'Location' => '!Helsinki(\?|&)oldid=4242!' ]
 120                 ];
 121
 122                 $cases[] = [
 123                         '/Helsinki',
 124                         [],
 125                         [],
 126                         '!!',
 127                         303,
 128                         [ 'Location' => '!Helsinki&action=raw!' ]
 129                 ];
 130
 131                 // #31: /Q5 with "Accept: text/foobar" triggers a 406
 132                 $cases[] = [
 133                         'main/Helsinki',
 134                         [],
 135                         [ 'Accept' => 'text/foobar' ],
 136                         '!!',
 137                         406,
 138                         [],
 139                 ];
 140
 141                 $cases[] = [
 142                         'main/Helsinki',
 143                         [],
 144                         [ 'Accept' => 'text/HTML' ],
 145                         '!!',
 146                         303,
 147                         [ 'Location' => '!Helsinki$!' ]
 148                 ];
 149
 150                 $cases[] = [
 151                         '/Helsinki',
 152                         [],
 153                         [ 'Accept' => 'text/HTML' ],
 154                         '!!',
 155                         303,
 156                         [ 'Location' => '!Helsinki$!' ]
 157                 ];
 158
 159                 $cases[] = [
 160                         'main/AC/DC',
 161                         [],
 162                         [ 'Accept' => 'text/HTML' ],
 163                         '!!',
 164                         303,
 165                         [ 'Location' => '!AC/DC$!' ]
 166                 ];
 167
 168                 return $cases;
 169         }
 170
 171         /**
 172          * @dataProvider handleRequestProvider
 173          *
 174          * @param string $subpage The subpage to request (or '')
 175          * @param array  $params  Request parameters
 176          * @param array  $headers  Request headers
 177          * @param string $expectedOutput Regex to match the output against.
 178          * @param int $expectedStatusCode Expected HTTP status code.
 179          * @param string[] $expectedHeaders Expected HTTP response headers.
 180          */
 181         public function testHandleRequest(
 182                 $subpage,
 183                 array $params,
 184                 array $headers,
 185                 $expectedOutput,
 186                 $expectedStatusCode = 200,
 187                 array $expectedHeaders = []
 188         ) {
 189                 $output = $this->makeOutputPage( $params, $headers );
 190                 $request = $output->getRequest();
 191
 192                 /* @var FauxResponse $response */
 193                 $response = $request->response();
 194
 195                 // construct handler
 196                 $handler = $this->newHandler();
 197
 198                 try {
 199                         ob_start();
 200                         $handler->handleRequest( $subpage, $request, $output );
 201
 202                         if ( $output->getRedirect() !== '' ) {
 203                                 // hack to apply redirect to web response
 204                                 $output->output();
 205                         }
 206
 207                         $text = ob_get_contents();
 208                         ob_end_clean();
 209
 210                         $this->assertEquals( $expectedStatusCode, $response->getStatusCode(), 'status code' );
 211                         $this->assertRegExp( $expectedOutput, $text, 'output' );
 212
 213                         foreach ( $expectedHeaders as $name => $exp ) {
 214                                 $value = $response->getHeader( $name );
 215                                 $this->assertNotNull( $value, "header: $name" );
 216                                 $this->assertInternalType( 'string', $value, "header: $name" );
 217                                 $this->assertRegExp( $exp, $value, "header: $name" );
 218                         }
 219                 } catch ( HttpError $e ) {
 220                         ob_end_clean();
 221                         $this->assertEquals( $expectedStatusCode, $e->getStatusCode(), 'status code' );
 222                         $this->assertRegExp( $expectedOutput, $e->getHTML(), 'error output' );
 223                 }
 224
 225                 // We always set "Access-Control-Allow-Origin: *"
 226                 $this->assertSame( '*', $response->getHeader( 'Access-Control-Allow-Origin' ) );
 227         }
 228
 229         public function provideHttpContentNegotiation() {
 230                 $helsinki = Title::newFromText( 'Helsinki' );
 231                 return [
 232                         'Accept Header of HTML' => [
 233                                 $helsinki,
 234                                 [ 'ACCEPT' => 'text/html' ], // headers
 235                                 'Helsinki'
 236                         ],
 237                         'Accept Header without weights' => [
 238                                 $helsinki,
 239                                 [ 'ACCEPT' => '*/*, text/html, text/x-wiki' ],
 240                                 'Helsinki&action=raw'
 241                         ],
 242                         'Accept Header with weights' => [
 243                                 $helsinki,
 244                                 [ 'ACCEPT' => 'text/*; q=0.5, text/json; q=0.7, application/rdf+xml; q=0.8' ],
 245                                 'Helsinki&action=raw'
 246                         ],
 247                         'Accept Header accepting evertyhing and HTML' => [
 248                                 $helsinki,
 249                                 [ 'ACCEPT' => 'text/html, */*' ],
 250                                 'Helsinki&action=raw'
 251                         ],
 252                         'No Accept Header' => [
 253                                 $helsinki,
 254                                 [],
 255                                 'Helsinki&action=raw'
 256                         ],
 257                 ];
 258         }
 259
 260         /**
 261          * @dataProvider provideHttpContentNegotiation
 262          *
 263          * @param Title $title
 264          * @param array $headers Request headers
 265          * @param string $expectedRedirectSuffix Expected suffix of the HTTP Location header.
 266          *
 267          * @throws HttpError
 268          */
 269         public function testHttpContentNegotiation(
 270                 Title $title,
 271                 array $headers,
 272                 $expectedRedirectSuffix
 273         ) {
 274                 /* @var FauxResponse $response */
 275                 $output = $this->makeOutputPage( [], $headers );
 276                 $request = $output->getRequest();
 277
 278                 $handler = $this->newHandler();
 279                 $handler->httpContentNegotiation( $request, $output, $title );
 280
 281                 $this->assertStringEndsWith(
 282                         $expectedRedirectSuffix,
 283                         $output->getRedirect(),
 284                         'redirect target'
 285                 );
 286         }
 287 }