MediaWiki  1.28.0
ApiMainTest.php
Go to the documentation of this file.
1 <?php
2 
9 class ApiMainTest extends ApiTestCase {
10 
14  public function testApi() {
15  $api = new ApiMain(
16  new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] )
17  );
18  $api->execute();
19  $data = $api->getResult()->getResultData();
20  $this->assertInternalType( 'array', $data );
21  $this->assertArrayHasKey( 'query', $data );
22  }
23 
24  public static function provideAssert() {
25  return [
26  [ false, [], 'user', 'assertuserfailed' ],
27  [ true, [], 'user', false ],
28  [ true, [], 'bot', 'assertbotfailed' ],
29  [ true, [ 'bot' ], 'user', false ],
30  [ true, [ 'bot' ], 'bot', false ],
31  ];
32  }
33 
44  public function testAssert( $registered, $rights, $assert, $error ) {
45  $user = new User();
46  if ( $registered ) {
47  $user->setId( 1 );
48  }
49  $user->mRights = $rights;
50  try {
51  $this->doApiRequest( [
52  'action' => 'query',
53  'assert' => $assert,
54  ], null, null, $user );
55  $this->assertFalse( $error ); // That no error was expected
56  } catch ( UsageException $e ) {
57  $this->assertEquals( $e->getCodeString(), $error );
58  }
59  }
60 
66  public function testAssertUser() {
67  $user = $this->getTestUser()->getUser();
68  $this->doApiRequest( [
69  'action' => 'query',
70  'assertuser' => $user->getName(),
71  ], null, null, $user );
72 
73  try {
74  $this->doApiRequest( [
75  'action' => 'query',
76  'assertuser' => $user->getName() . 'X',
77  ], null, null, $user );
78  $this->fail( 'Expected exception not thrown' );
79  } catch ( UsageException $e ) {
80  $this->assertEquals( $e->getCodeString(), 'assertnameduserfailed' );
81  }
82  }
83 
87  public function testClassNamesInModuleManager() {
89 
90  // wgAutoloadLocalClasses has precedence, just like in includes/AutoLoader.php
91  $classes = $wgAutoloadLocalClasses + $wgAutoloadClasses;
92 
93  $api = new ApiMain(
94  new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] )
95  );
96  $modules = $api->getModuleManager()->getNamesWithClasses();
97  foreach ( $modules as $name => $class ) {
98  $this->assertArrayHasKey(
99  $class,
100  $classes,
101  'Class ' . $class . ' for api module ' . $name . ' not in autoloader (with exact case)'
102  );
103  }
104  }
105 
117  $headers, $conditions, $status, $post = false
118  ) {
119  $request = new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ], $post );
120  $request->setHeaders( $headers );
121  $request->response()->statusHeader( 200 ); // Why doesn't it default?
122 
123  $context = $this->apiContext->newTestContext( $request, null );
124  $api = new ApiMain( $context );
125  $priv = TestingAccessWrapper::newFromObject( $api );
126  $priv->mInternalMode = false;
127 
128  $module = $this->getMockBuilder( 'ApiBase' )
129  ->setConstructorArgs( [ $api, 'mock' ] )
130  ->setMethods( [ 'getConditionalRequestData' ] )
131  ->getMockForAbstractClass();
132  $module->expects( $this->any() )
133  ->method( 'getConditionalRequestData' )
134  ->will( $this->returnCallback( function ( $condition ) use ( $conditions ) {
135  return isset( $conditions[$condition] ) ? $conditions[$condition] : null;
136  } ) );
137 
138  $ret = $priv->checkConditionalRequestHeaders( $module );
139 
140  $this->assertSame( $status, $request->response()->getStatusCode() );
141  $this->assertSame( $status === 200, $ret );
142  }
143 
144  public static function provideCheckConditionalRequestHeaders() {
145  $now = time();
146 
147  return [
148  // Non-existing from module is ignored
149  [ [ 'If-None-Match' => '"foo", "bar"' ], [], 200 ],
150  [ [ 'If-Modified-Since' => 'Tue, 18 Aug 2015 00:00:00 GMT' ], [], 200 ],
151 
152  // No headers
153  [
154  [],
155  [
156  'etag' => '""',
157  'last-modified' => '20150815000000',
158  ],
159  200
160  ],
161 
162  // Basic If-None-Match
163  [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"bar"' ], 304 ],
164  [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"baz"' ], 200 ],
165  [ [ 'If-None-Match' => '"foo"' ], [ 'etag' => 'W/"foo"' ], 304 ],
166  [ [ 'If-None-Match' => 'W/"foo"' ], [ 'etag' => '"foo"' ], 304 ],
167  [ [ 'If-None-Match' => 'W/"foo"' ], [ 'etag' => 'W/"foo"' ], 304 ],
168 
169  // Pointless, but supported
170  [ [ 'If-None-Match' => '*' ], [], 304 ],
171 
172  // Basic If-Modified-Since
173  [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
174  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 304 ],
175  [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
176  [ 'last-modified' => wfTimestamp( TS_MW, $now ) ], 304 ],
177  [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
178  [ 'last-modified' => wfTimestamp( TS_MW, $now + 1 ) ], 200 ],
179 
180  // If-Modified-Since ignored when If-None-Match is given too
181  [ [ 'If-None-Match' => '""', 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
182  [ 'etag' => '"x"', 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 200 ],
183  [ [ 'If-None-Match' => '""', 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
184  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 304 ],
185 
186  // Ignored for POST
187  [ [ 'If-None-Match' => '"foo", "bar"' ], [ 'etag' => '"bar"' ], 200, true ],
188  [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) ],
189  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 200, true ],
190 
191  // Other date formats allowed by the RFC
192  [ [ 'If-Modified-Since' => gmdate( 'l, d-M-y H:i:s', $now ) . ' GMT' ],
193  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 304 ],
194  [ [ 'If-Modified-Since' => gmdate( 'D M j H:i:s Y', $now ) ],
195  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 304 ],
196 
197  // Old browser extension to HTTP/1.0
198  [ [ 'If-Modified-Since' => wfTimestamp( TS_RFC2822, $now ) . '; length=123' ],
199  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 304 ],
200 
201  // Invalid date formats should be ignored
202  [ [ 'If-Modified-Since' => gmdate( 'Y-m-d H:i:s', $now ) . ' GMT' ],
203  [ 'last-modified' => wfTimestamp( TS_MW, $now - 1 ) ], 200 ],
204  ];
205  }
206 
216  $conditions, $headers, $isError = false, $post = false
217  ) {
218  $request = new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ], $post );
219  $response = $request->response();
220 
221  $api = new ApiMain( $request );
222  $priv = TestingAccessWrapper::newFromObject( $api );
223  $priv->mInternalMode = false;
224 
225  $module = $this->getMockBuilder( 'ApiBase' )
226  ->setConstructorArgs( [ $api, 'mock' ] )
227  ->setMethods( [ 'getConditionalRequestData' ] )
228  ->getMockForAbstractClass();
229  $module->expects( $this->any() )
230  ->method( 'getConditionalRequestData' )
231  ->will( $this->returnCallback( function ( $condition ) use ( $conditions ) {
232  return isset( $conditions[$condition] ) ? $conditions[$condition] : null;
233  } ) );
234  $priv->mModule = $module;
235 
236  $priv->sendCacheHeaders( $isError );
237 
238  foreach ( [ 'Last-Modified', 'ETag' ] as $header ) {
239  $this->assertEquals(
240  isset( $headers[$header] ) ? $headers[$header] : null,
241  $response->getHeader( $header ),
242  $header
243  );
244  }
245  }
246 
247  public static function provideConditionalRequestHeadersOutput() {
248  return [
249  [
250  [],
251  []
252  ],
253  [
254  [ 'etag' => '"foo"' ],
255  [ 'ETag' => '"foo"' ]
256  ],
257  [
258  [ 'last-modified' => '20150818000102' ],
259  [ 'Last-Modified' => 'Tue, 18 Aug 2015 00:01:02 GMT' ]
260  ],
261  [
262  [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
263  [ 'ETag' => '"foo"', 'Last-Modified' => 'Tue, 18 Aug 2015 00:01:02 GMT' ]
264  ],
265  [
266  [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
267  [],
268  true,
269  ],
270  [
271  [ 'etag' => '"foo"', 'last-modified' => '20150818000102' ],
272  [],
273  false,
274  true,
275  ],
276  ];
277  }
278 
282  public function testLacksSameOriginSecurity() {
283  // Basic test
284  $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) );
285  $this->assertFalse( $main->lacksSameOriginSecurity(), 'Basic test, should have security' );
286 
287  // JSONp
288  $main = new ApiMain(
289  new FauxRequest( [ 'action' => 'query', 'format' => 'xml', 'callback' => 'foo' ] )
290  );
291  $this->assertTrue( $main->lacksSameOriginSecurity(), 'JSONp, should lack security' );
292 
293  // Header
294  $request = new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] );
295  $request->setHeader( 'TrEaT-As-UnTrUsTeD', '' ); // With falsey value!
296  $main = new ApiMain( $request );
297  $this->assertTrue( $main->lacksSameOriginSecurity(), 'Header supplied, should lack security' );
298 
299  // Hook
300  $this->mergeMwGlobalArrayValue( 'wgHooks', [
301  'RequestHasSameOriginSecurity' => [ function () {
302  return false;
303  } ]
304  ] );
305  $main = new ApiMain( new FauxRequest( [ 'action' => 'query', 'meta' => 'siteinfo' ] ) );
306  $this->assertTrue( $main->lacksSameOriginSecurity(), 'Hook, should lack security' );
307  }
308 }
mergeMwGlobalArrayValue($name, $values)
Merges the given values into a MW global array variable.
$context
Definition: load.php:50
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1936
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
testApi()
Test that the API will accept a FauxRequest and execute.
Definition: ApiMainTest.php:14
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.
Definition: defines.php:21
this hook is for auditing only $response
Definition: hooks.txt:802
API medium.
Definition: ApiMainTest.php:9
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
testCheckConditionalRequestHeaders($headers, $conditions, $status, $post=false)
Test HTTP precondition headers.
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
$modules
static provideCheckConditionalRequestHeaders()
testAssertUser()
Tests the assertuser= functionality.
Definition: ApiMainTest.php:66
This is the main API class, used for both external and internal processing.
Definition: ApiMain.php:43
testLacksSameOriginSecurity()
ApiMain::lacksSameOriginSecurity.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
global $wgAutoloadClasses
$header
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
testConditionalRequestHeadersOutput($conditions, $headers, $isError=false, $post=false)
Test conditional headers output provideConditionalRequestHeadersOutput.
static getTestUser($groups=[])
Convenience method for getting an immutable test user.
testAssert($registered, $rights, $assert, $error)
Tests the assert={user|bot} functionality.
Definition: ApiMainTest.php:44
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
doApiRequest(array $params, array $session=null, $appendModule=false, User $user=null)
Does the API request and returns the result.
Definition: ApiTestCase.php:71
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
global $wgAutoloadLocalClasses
Definition: autoload.php:4
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
static provideConditionalRequestHeadersOutput()
static newFromObject($object)
Return the same object, without access restrictions.
static provideAssert()
Definition: ApiMainTest.php:24
testClassNamesInModuleManager()
Test if all classes in the main module manager exists.
Definition: ApiMainTest.php:87
This exception will be thrown when dieUsage is called to stop module execution.
Definition: ApiMain.php:1837
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300