wiki.techinc.nl/tests/phpunit/includes/api/query/ApiQueryInfoTest.php
Timo Tijhof 8fca24fdc1 API: Fix flaky ApiQueryInfoTest case
The timestamp in the year 3030 was presumably chosen so as to
always be in the future (since expiry in the past would be ignored).
However, while seemingly clever, this backfires because it gets
shrunk by the default wgWatchlistExpiryMaxDuration value to some
time in August 2021, around the "current" time of day.

And "current" generally is thought of as moving forward at a rate
of 1s/s, bending of spacetime notwithstanding. Thus the test would
sometimes fail in ways such as:

> 1) ApiQueryInfoTest::testExecute
> Failed asserting that two strings are identical.
> --- Expected
> +++ Actual
> @@ @@
> -'2021-08-13T01:23:19Z'
> +'2021-08-13T01:23:18Z'

Fix this by using a mock current time, paired with a suitable
max duration and expiry value.

Also fix some of the other asserted values to not be reflections
of the source code but actually explicit assertions (at least the
details that we know to be constant, given the environment ensured
by ApiTestCase and MediaWikiLangTestCase). This reduces the chances
of false positives from looking at itself too much, and also speeds
up the test a little.

Change-Id: If361aa98bef789b1f841741a7c83bcb2ac9edf05
2021-02-13 03:00:57 +00:00

206 lines
6.4 KiB
PHP

<?php
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\MediaWikiServices;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* @group API
* @group medium
* @group Database
*
* @coversDefaultClass ApiQueryInfo
*/
class ApiQueryInfoTest extends ApiTestCase {
protected function setUp(): void {
parent::setUp();
$this->tablesUsed = array_merge(
$this->tablesUsed,
[ 'watchlist', 'watchlist_expiry' ]
);
$this->setMwGlobals( [
'wgWatchlistExpiry' => true,
'wgWatchlistExpiryMaxDuration' => '6 months',
] );
}
/**
* @covers ::execute
* @covers ::extractPageInfo
*/
public function testExecute() {
// Mock time for a determinstic result, without cut off from dynamic "max duration"
ConvertibleTimestamp::setFakeTime( '2011-01-01T00:00:00Z' );
$page = $this->getExistingTestPage( 'Pluto' );
$title = $page->getTitle();
$user = $this->getTestUser()->getUser();
WatchAction::doWatch(
$title,
$user,
User::CHECK_USER_RIGHTS,
// 3 months later
'2011-04-01T00:00:00Z'
);
$watchItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
list( $data ) = $this->doApiRequest( [
'action' => 'query',
'prop' => 'info',
'inprop' => 'watched|notificationtimestamp',
'titles' => $title->getText() . '|' . 'NonExistingPage_lkasdoiewlmasdoiwem7483',
], null, false, $user );
$this->assertArrayHasKey( 'query', $data );
$this->assertArrayHasKey( 'pages', $data['query'] );
$this->assertArrayHasKey( $page->getId(), $data['query']['pages'] );
$info = $data['query']['pages'][$page->getId()];
$this->assertSame( $page->getId(), $info['pageid'] );
$this->assertSame( NS_MAIN, $info['ns'] );
$this->assertSame( 'Pluto', $info['title'] );
$this->assertSame( 'wikitext', $info['contentmodel'] );
$this->assertSame( 'en', $info['pagelanguage'] );
$this->assertSame( 'en', $info['pagelanguagehtmlcode'] );
$this->assertSame( 'ltr', $info['pagelanguagedir'] );
$this->assertSame( '2011-01-01T00:00:00Z', $info['touched'] );
$this->assertSame( $title->getLatestRevID(), $info['lastrevid'] );
$this->assertSame( $title->getLength(), $info['length'] );
$this->assertSame( true, $info['new'] );
$this->assertSame( true, $info['watched'] );
$this->assertSame( '2011-04-01T00:00:00Z', $info['watchlistexpiry'] );
$this->assertArrayNotHasKey( 'actions', $info );
$this->assertArrayNotHasKey( 'linkclasses', $info );
}
/**
* @covers ::execute
* @covers ::extractPageInfo
*/
public function testExecuteLinkClasses() {
$page = $this->getExistingTestPage( 'Pluto' );
$title = $page->getTitle();
list( $data ) = $this->doApiRequest( [
'action' => 'query',
'prop' => 'info',
'titles' => $title->getText(),
'inprop' => 'linkclasses',
'inlinkcontext' => $title->getText(),
] );
$this->assertArrayHasKey( 'query', $data );
$this->assertArrayHasKey( 'pages', $data['query'] );
$this->assertArrayHasKey( $page->getId(), $data['query']['pages'] );
$info = $data['query']['pages'][$page->getId()];
$this->assertArrayHasKey( 'linkclasses', $info );
$this->assertEquals( [], $info['linkclasses'] );
}
/**
* @covers ::execute
* @covers ::extractPageInfo
*/
public function testExecuteEditActions() {
$page = $this->getExistingTestPage( 'Pluto' );
$title = $page->getTitle();
list( $data ) = $this->doApiRequest( [
'action' => 'query',
'prop' => 'info',
'titles' => $title->getText(),
'intestactions' => 'edit'
] );
$this->assertArrayHasKey( 'query', $data );
$this->assertArrayHasKey( 'pages', $data['query'] );
$this->assertArrayHasKey( $page->getId(), $data['query']['pages'] );
$info = $data['query']['pages'][$page->getId()];
$this->assertArrayHasKey( 'actions', $info );
$this->assertArrayHasKey( 'edit', $info['actions'] );
$this->assertTrue( $info['actions']['edit'] );
}
/**
* @covers ::execute
* @covers ::extractPageInfo
*/
public function testExecuteEditActionsFull() {
$page = $this->getExistingTestPage( 'Pluto' );
$title = $page->getTitle();
list( $data ) = $this->doApiRequest( [
'action' => 'query',
'prop' => 'info',
'titles' => $title->getText(),
'intestactions' => 'edit',
'intestactionsdetail' => 'full',
] );
$this->assertArrayHasKey( 'query', $data );
$this->assertArrayHasKey( 'pages', $data['query'] );
$this->assertArrayHasKey( $page->getId(), $data['query']['pages'] );
$info = $data['query']['pages'][$page->getId()];
$this->assertArrayHasKey( 'actions', $info );
$this->assertArrayHasKey( 'edit', $info['actions'] );
$this->assertIsArray( $info['actions']['edit'] );
$this->assertSame( [], $info['actions']['edit'] );
}
/**
* @covers ::execute
* @covers ::extractPageInfo
*/
public function testExecuteEditActionsFullBlock() {
$badActor = $this->getTestUser()->getUser();
$sysop = $this->getTestSysop()->getUser();
$block = new DatabaseBlock( [
'address' => $badActor->getName(),
'user' => $badActor->getId(),
'by' => $sysop->getId(),
'expiry' => 'infinity',
'sitewide' => 1,
'enableAutoblock' => true,
] );
$blockStore = MediaWikiServices::getInstance()->getDatabaseBlockStore();
$blockStore->insertBlock( $block );
$page = $this->getExistingTestPage( 'Pluto' );
$title = $page->getTitle();
list( $data ) = $this->doApiRequest( [
'action' => 'query',
'prop' => 'info',
'titles' => $title->getText(),
'intestactions' => 'edit',
'intestactionsdetail' => 'full',
], null, false, $badActor );
$blockStore->deleteBlock( $block );
$this->assertArrayHasKey( 'query', $data );
$this->assertArrayHasKey( 'pages', $data['query'] );
$this->assertArrayHasKey( $page->getId(), $data['query']['pages'] );
$info = $data['query']['pages'][$page->getId()];
$this->assertArrayHasKey( 'actions', $info );
$this->assertArrayHasKey( 'edit', $info['actions'] );
$this->assertIsArray( $info['actions']['edit'] );
$this->assertArrayHasKey( 0, $info['actions']['edit'] );
$this->assertArrayHasKey( 'code', $info['actions']['edit'][0] );
$this->assertSame( 'blocked', $info['actions']['edit'][0]['code'] );
$this->assertArrayHasKey( 'data', $info['actions']['edit'][0] );
$this->assertArrayHasKey( 'blockinfo', $info['actions']['edit'][0]['data'] );
$this->assertArrayHasKey( 'blockid', $info['actions']['edit'][0]['data']['blockinfo'] );
$this->assertSame( $block->getId(), $info['actions']['edit'][0]['data']['blockinfo']['blockid'] );
}
}