Base class for tests of PageArchive against different database schemas. More...

Inheritance diagram for PageArchiveTestBase:

[legend]

Collaboration diagram for PageArchiveTestBase:

[legend]

Public Member Functions
	__construct ( $name=null, array $data=[], $dataName='')

	provideGetTextFromRowThrowsInvalidArgumentException ()

	testGetArchivedRevision ()
	PageArchive::getRevision.

	testGetLastRevisionId ()
	PageArchive::getLastRevisionId.

	testGetLastRevisionText ()
	PageArchive::getLastRevisionText.

	testGetPreviousRevision ()
	PageArchive::getPreviousRevision.

	testGetRevision ()
	PageArchive::getRevision.

	testGetTextFromRowThrowsInvalidArgumentException (array $row)
	provideGetTextFromRowThrowsInvalidArgumentException PageArchive::getTextFromRow

	testIsDeleted ()
	PageArchive::isDeleted.

	testListPagesByPrefix ()
	PageArchive::listPagesBySearch.

	testListPagesBySearch ()
	PageArchive::listPagesBySearch.

	testListRevisions ()
	PageArchive::listRevisions.

	testUndeleteRevisions ()
	PageArchive::undelete PageArchive::undeleteRevisions.

Public Member Functions inherited from MediaWikiTestCase
	__destruct ()

	addDBData ()
	Stub.

	addDBDataOnce ()
	Stub.

	copyTestData (IDatabase $source, IDatabase $target)
	Copy test data from one database connection to another.

	dbPrefix ()

	getCliArg ( $offset)

	hideDeprecated ( $function)
	Don't throw a warning if $function is deprecated and called later.

	needsDB ()

	run (PHPUnit_Framework_TestResult $result=null)

	setCliArg ( $offset, $value)

	setContentLang ( $lang)

	setGroupPermissions ( $newPerms, $newKey=null, $newValue=null)
	Alters $wgGroupPermissions for the duration of the test.

	setupAllTestDBs ()
	Set up all test DBs.

	setUserLang ( $lang)

	testMediaWikiTestCaseParentSetupCalled ()
	Make sure MediaWikiTestCase extending classes have called their parent setUp method.

	usesTemporaryTables ()

Protected Member Functions
	addCoreDBData ()

	getContentHandlerUseDB ()

	getExpectedArchiveRows ()

	getMcrMigrationStage ()

	getMcrTablesToReset ()

	setUp ()

Protected Member Functions inherited from MediaWikiTestCase
	addTmpFiles ( $files)

	arrayWrap (array $elements)
	Utility method taking an array of elements and wrapping each element in its own array.

	assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false)
	Assert that two arrays are equal.

	assertFileContains ( $fileName, $actualData, $createIfMissing=false, $msg='')
	Check whether file contains given data.

	assertHTMLEquals ( $expected, $actual, $msg='')
	Put each HTML element on its own line and then equals() the results.

	assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
	Asserts that the given database query yields the rows given by $expectedRows.

	assertType ( $type, $actual, $message='')
	Asserts the type of the provided value.

	assertTypeOrValue ( $type, $actual, $value=false, $message='')
	Asserts that the provided variable is of the specified internal type or equals the $value argument.

	checkDbIsSupported ()

	checkPHPExtension ( $extName)
	Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded.

	editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
	Edits or creates a page/revision.

	ensureMockDatabaseConnection (IDatabase $db)

	getDefaultWikitextNS ()
	Returns the ID of a namespace that defaults to Wikitext.

	getExistingTestPage ( $title=null)
	Returns a WikiPage representing an existing page.

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getNonexistingTestPage ( $title=null)
	Returns a WikiPage representing a non-existing page.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

	insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
	Insert a new page.

	isTestInDatabaseGroup ()

	isWikitextNS ( $ns)
	Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels.

	markTestSkippedIfDbType ( $type)
	Skip the test if using the specified database type.

	markTestSkippedIfNoDiff3 ()
	Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready.

	mergeMwGlobalArrayValue ( $name, $values)
	Merges the given values into a MW global array variable.

	objectAssociativeSort (array &$array)
	Does an associative sort that works for objects.

	overrideMwServices (Config $configOverrides=null, array $services=[])
	Stashes the global instance of MediaWikiServices, and installs a new one, allowing test cases to override settings and services.

	revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='')
	Revision-deletes a revision.

	setIniSetting ( $name, $value)
	Set an ini setting for the duration of the test.

	setLogger ( $channel, LoggerInterface $logger)
	Sets the logger for a specified channel, for the duration of the test.

	setMwGlobals ( $pairs, $value=null)
	Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.

	setService ( $name, $object)
	Sets a service, maintaining a stashed version of the previous service to be restored in tearDown.

	setTemporaryHook ( $hookName, $handler)
	Create a temporary hook handler which will be reset by tearDown.

	stashMwGlobals ( $globalKeys)
	Stashes the global, will be restored in tearDown()

	tearDown ()

	truncateTable ( $tableName, IDatabase $db=null)
	Empties the given table and resets any auto-increment counters.

Protected Attributes
	$archivedPage

RevisionRecord	$firstRev
	Revision of the first (initial) edit.

	$ipEditor
	A logged out user who edited the page before it was archived.

RevisionRecord	$ipRev
	Revision of the IP edit (the second edit)

int	$pageId

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Additional Inherited Members
Static Public Member Functions inherited from MediaWikiTestCase
static	getMutableTestUser ( $groups=[])
	Convenience method for getting a mutable test user.

static	getTestPrefixFor (IDatabase $db)

static	getTestSysop ()
	Convenience method for getting an immutable admin test user.

static	getTestUser ( $groups=[])
	Convenience method for getting an immutable test user.

static	installMockMwServices (Config $configOverrides=null)
	Creates a new "mock" MediaWikiServices instance, and installs it.

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)

static	resetNonServiceCaches ()
	Resets some non-service singleton instances and other static caches.

static	restoreMwServices ()
	Restores the original, non-mock MediaWikiServices instance.

static	setUpBeforeClass ()

static	setupTestDB (Database $db, $prefix)
	Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix.

static	teardownTestDB ()
	Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called.

static	wfResetOutputBuffersBarrier ( $buffer)
	Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit.

Public Attributes inherited from MediaWikiTestCase
const	DB_PREFIX = 'unittest_'
	Table name prefixes.

const	ORA_DB_PREFIX = 'ut_'

Static Public Attributes inherited from MediaWikiTestCase
static TestUser[]	$users

Static Protected Member Functions inherited from MediaWikiTestCase
static	getExternalStoreDatabaseConnections ()
	Gets master database connections for all of the ExternalStoreDB stores configured in $wgDefaultExternalStore.

static	isUsingExternalStoreDB ()
	Check whether ExternalStoreDB is being used.

static	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null)
	Setups a database with cloned tables using the given prefix.

static	setupExternalStoreTestDBs ( $testPrefix=null)
	Clones the External Store database(s) for testing.

static	stripStringKeys (&$r)
	Utility function for eliminating all string keys from an array.

Detailed Description

Base class for tests of PageArchive against different database schemas.

Definition at line 8 of file PageArchiveTestBase.php.

Constructor & Destructor Documentation

◆ __construct()

PageArchiveTestBase::__construct	(		$name = null,
		array	$data = [],
			$dataName = '' )

Reimplemented from MediaWikiTestCase.

Definition at line 38 of file PageArchiveTestBase.php.

Member Function Documentation

◆ addCoreDBData()

PageArchiveTestBase::addCoreDBData ( )

protected

Since: 1.32

Reimplemented from MediaWikiTestCase.

Definition at line 56 of file PageArchiveTestBase.php.

◆ getContentHandlerUseDB()

PageArchiveTestBase::getContentHandlerUseDB ( )

protected

Returns: bool

Definition at line 74 of file PageArchiveTestBase.php.

Referenced by setUp().

◆ getExpectedArchiveRows()

PageArchiveTestBase::getExpectedArchiveRows ( )

abstractprotected

Reimplemented in PageArchiveMcrTest, and PageArchivePreMcrTest.

Referenced by testListRevisions().

◆ getMcrMigrationStage()

PageArchiveTestBase::getMcrMigrationStage ( )

abstractprotected

Returns: int

Referenced by setUp().

◆ getMcrTablesToReset()

PageArchiveTestBase::getMcrTablesToReset ( )

abstractprotected

Returns: string[]

Referenced by setUp().

◆ provideGetTextFromRowThrowsInvalidArgumentException()

PageArchiveTestBase::provideGetTextFromRowThrowsInvalidArgumentException ( )

Definition at line 247 of file PageArchiveTestBase.php.

◆ setUp()

PageArchiveTestBase::setUp ( )

protected

Reimplemented from MediaWikiTestCase.

Definition at line 78 of file PageArchiveTestBase.php.

References $content, $rev, CONTENT_MODEL_WIKITEXT, DB_MASTER, EDIT_NEW, getContentHandlerUseDB(), getMcrMigrationStage(), getMcrTablesToReset(), MediaWikiTestCase\getTestUser(), MIGRATION_OLD, MediaWikiTestCase\overrideMwServices(), SCHEMA_COMPAT_OLD, MediaWikiTestCase\setMwGlobals(), wfGetDB(), and wfTimestamp().

◆ testGetArchivedRevision()

PageArchiveTestBase::testGetArchivedRevision ( )

PageArchive::getRevision.

Definition at line 305 of file PageArchiveTestBase.php.

References $rev.

◆ testGetLastRevisionId()

PageArchiveTestBase::testGetLastRevisionId ( )

PageArchive::getLastRevisionId.

Definition at line 278 of file PageArchiveTestBase.php.

◆ testGetLastRevisionText()

PageArchiveTestBase::testGetLastRevisionText ( )

PageArchive::getLastRevisionText.

Definition at line 268 of file PageArchiveTestBase.php.

References MediaWikiTestCase\hideDeprecated().

◆ testGetPreviousRevision()

PageArchiveTestBase::testGetPreviousRevision ( )

PageArchive::getPreviousRevision.

Definition at line 318 of file PageArchiveTestBase.php.

References $content, $newRev, $rev, CONTENT_MODEL_WIKITEXT, EDIT_NEW, MediaWikiTestCase\getTestUser(), and wfTimestamp().

◆ testGetRevision()

PageArchiveTestBase::testGetRevision ( )

PageArchive::getRevision.

Definition at line 293 of file PageArchiveTestBase.php.

References $rev.

◆ testGetTextFromRowThrowsInvalidArgumentException()

PageArchiveTestBase::testGetTextFromRowThrowsInvalidArgumentException ( array $row )

provideGetTextFromRowThrowsInvalidArgumentException PageArchive::getTextFromRow

Definition at line 258 of file PageArchiveTestBase.php.

References MediaWikiTestCase\hideDeprecated().

◆ testIsDeleted()

PageArchiveTestBase::testIsDeleted ( )

PageArchive::isDeleted.

Definition at line 286 of file PageArchiveTestBase.php.

◆ testListPagesByPrefix()

PageArchiveTestBase::testListPagesByPrefix ( )

PageArchive::listPagesBySearch.

Definition at line 231 of file PageArchiveTestBase.php.

References array(), and PageArchive\listPagesByPrefix().

◆ testListPagesBySearch()

PageArchiveTestBase::testListPagesBySearch ( )

PageArchive::listPagesBySearch.

Definition at line 212 of file PageArchiveTestBase.php.

References array(), and PageArchive\listPagesBySearch().

◆ testListRevisions()

PageArchiveTestBase::testListRevisions ( )

PageArchive::listRevisions.

Definition at line 189 of file PageArchiveTestBase.php.

References array(), and getExpectedArchiveRows().

◆ testUndeleteRevisions()

PageArchiveTestBase::testUndeleteRevisions ( )

PageArchive::undelete PageArchive::undeleteRevisions.

Definition at line 138 of file PageArchiveTestBase.php.

References $dbr, $revQuery, DB_REPLICA, Revision\getArchiveQueryInfo(), Revision\getQueryInfo(), and wfGetDB().

Member Data Documentation

◆ $archivedPage

PageArchive PageArchiveTestBase::$archivedPage

protected

Definition at line 18 of file PageArchiveTestBase.php.

◆ $firstRev

RevisionRecord PageArchiveTestBase::$firstRev

protected

Revision of the first (initial) edit.

Definition at line 30 of file PageArchiveTestBase.php.

◆ $ipEditor

string PageArchiveTestBase::$ipEditor

protected

A logged out user who edited the page before it was archived.

Definition at line 24 of file PageArchiveTestBase.php.

Referenced by PageArchiveMcrTest\getExpectedArchiveRows(), and PageArchivePreMcrTest\getExpectedArchiveRows().

◆ $ipRev

RevisionRecord PageArchiveTestBase::$ipRev

protected

Revision of the IP edit (the second edit)

Definition at line 36 of file PageArchiveTestBase.php.

◆ $pageId

int PageArchiveTestBase::$pageId

protected

Definition at line 13 of file PageArchiveTestBase.php.

The documentation for this class was generated from the following file:

tests/phpunit/includes/page/PageArchiveTestBase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCoreDBData()

◆ getContentHandlerUseDB()

◆ getExpectedArchiveRows()

◆ getMcrMigrationStage()

◆ getMcrTablesToReset()

◆ provideGetTextFromRowThrowsInvalidArgumentException()

◆ setUp()

◆ testGetArchivedRevision()

◆ testGetLastRevisionId()

◆ testGetLastRevisionText()

◆ testGetPreviousRevision()

◆ testGetRevision()

◆ testGetTextFromRowThrowsInvalidArgumentException()

◆ testIsDeleted()

◆ testListPagesByPrefix()

◆ testListPagesBySearch()

◆ testListRevisions()

◆ testUndeleteRevisions()

Member Data Documentation

◆ $archivedPage

◆ $firstRev

◆ $ipEditor

◆ $ipRev

◆ $pageId