Tests for log dumps of BackupDumper. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\BackupDumperLoggerTest:

[legend]

Collaboration diagram for MediaWiki\Tests\Maintenance\BackupDumperLoggerTest:

[legend]

Public Member Functions
	addDBData ()
	Stub.

	testPlain ()

	testXmlDumpsBackupUseCaseLogging ()

Public Member Functions inherited from MediaWiki\Tests\Maintenance\DumpTestCase
	expectETAOutput ()
	Checks for test output consisting only of lines containing ETA announcements.

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

	__destruct ()

	addDBDataOnce ()
	Stub.

	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 ()

Private Member Functions
	addLogEntry ( $type, $subtype, User $user, $ns, $title, $comment=null, $parameters=null)
	adds a log entry to the database.

	assertLogItem ( $id, $user_name, $user_id, $comment, $type, $subtype, $title, $parameters=[])
	asserts that the xml reader is at the beginning of a log entry and skips over it while analyzing it.

Private Attributes
	$logId1

	$logId2

	$logId3

	$userId1

	$userId2

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

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

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

static	listTables (IMaintainableDatabase $db)

static	prepareServices (Config $bootstrapConfig)
	Prepare service configuration for unit testing.

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

Protected Member Functions inherited from MediaWiki\Tests\Maintenance\DumpTestCase
	addRevision (Page $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT)
	Adds a revision to a page, while returning the resuting revision's id.

	assertDumpEnd ( $name="mediawiki")
	Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.

	assertDumpStart ( $fname, $skip_siteinfo=true)
	Opens an XML file to analyze and optionally skips past siteinfo.

	assertNodeEnd ( $name, $skip=true)
	Asserts that the xml reader is at an closing element of given name, and optionally skips past it.

	assertNodeStart ( $name, $skip=true)
	Asserts that the xml reader is at an element of given name, and optionally skips past it.

	assertPageEnd ()
	Asserts that the xml reader is at the page's closing element and skips to the next element.

	assertPageStart ( $id, $ns, $name)
	Asserts that the xml reader is at the start of a page element and skips over the first tags, after checking them.

	assertRevision ( $id, $summary, $text_id, $text_bytes, $text_sha1, $text=false, $parentid=false, $model=CONTENT_MODEL_WIKITEXT, $format=CONTENT_FORMAT_WIKITEXT)
	Asserts that the xml reader is at a revision and checks its representation before skipping over it.

	assertText ( $id, $text_id, $text_bytes, $text)

	assertTextNode ( $name, $text, $skip_ws=true)
	Asserts that the xml reader is at an element of given tag that contains a given text, and skips over the element.

	checkHasGzip ()
	Skip the test if 'gzip' is not in $PATH.

	gunzip ( $fname)
	gunzips the given file and stores the result in the original file name

	setUp ()
	Default set up function.

	skipPastNodeEnd ( $name)
	Step the current XML reader to the first element start after the node end of a given name.

	skipToNodeEnd ( $name)
	Step the current XML reader until node end of given name is found.

	skipWhitespace ()
	Steps the xml reader over white space.

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=true, $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.

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

	getNewTempDirectory ()
	obtains a new temporary directory

	getNewTempFile ()
	Obtains a new temporary file name.

	getSchemaOverrides (IMaintainableDatabase $db)
	Stub.

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

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

	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.

	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 ()

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	resetGlobalServices (Config $bootstrapConfig=null)
	Reset global services, and install testing environment.

static	setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix)
	Setups a database with the given prefix.

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

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

Protected Attributes inherited from MediaWiki\Tests\Maintenance\DumpTestCase
Exception null	$exceptionFromAddDBData = null
	exception to be rethrown once in sound PHPUnit surrounding

XMLReader null	$xml = null
	Holds the XMLReader used for analyzing an XML dump.

Protected Attributes inherited from MediaWikiTestCase
Database	$db
	Primary database.

array	$supportedDBs

array	$tablesUsed = []

Static Protected Attributes inherited from MediaWiki\Tests\Maintenance\DumpTestCase
static bool null	$hasGzip = null
	Whether the 'gzip' utility is available.

Detailed Description

Tests for log dumps of BackupDumper.

Some of these tests use the old constuctor for TextPassDumper and the dump() function, while others use the new loadWithArgv( $args ) function and execute(). This is to ensure both the old and new methods work properly.

Database Dump BackupDumper

Definition at line 23 of file backup_LogTest.php.

Member Function Documentation

◆ addDBData()

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::addDBData ( )

Stub.

Subclasses may override this to prepare the database. Called before every test run (test function or data set).

See also: addDBDataOnce(); resetDB()

Since: 1.18

Reimplemented from MediaWikiTestCase.

Definition at line 59 of file backup_LogTest.php.

References $e, MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\addLogEntry(), User\newFromName(), NS_MAIN, and NS_TALK.

◆ addLogEntry()

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::addLogEntry	(		$type,
			$subtype,
		User	$user,
			$ns,
			$title,
			$comment = null,
			$parameters = null )

private

adds a log entry to the database.

Parameters

string	$type	Type of the log entry
string	$subtype	Subtype of the log entry
User	$user	User that performs the logged operation
int	$ns	Number of the namespace for the entry's target's title
string	$title	Title of the entry's target
string	$comment	Comment of the log entry
array	$parameters	(optional) accompanying data that is attached to the entry

Returns: int Id of the added log entry

Definition at line 43 of file backup_LogTest.php.

References $type.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\addDBData().

◆ assertLogItem()

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::assertLogItem	(	$id,
		$user_name,
		$user_id,
		$comment,
		$type,
		$subtype,
		$title,
		$parameters = [] )

private

asserts that the xml reader is at the beginning of a log entry and skips over it while analyzing it.

Parameters

int	$id	Id of the log entry
string	$user_name	User name of the log entry's performer
int	$user_id	User id of the log entry 's performer
string \| null	$comment	Comment of the log entry. If null, the comment text is ignored.
string	$type	Type of the log entry
string	$subtype	Subtype of the log entry
string	$title	Title of the log entry's target
array	$parameters	(optional) unserialized data accompanying the log entry

Definition at line 113 of file backup_LogTest.php.

References $type, MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertNodeStart(), MediaWiki\Tests\Maintenance\DumpTestCase\assertTextNode(), MediaWiki\Tests\Maintenance\DumpTestCase\skipWhitespace(), and unserialize().

Referenced by MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testPlain(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ testPlain()

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::testPlain ( )

Definition at line 147 of file backup_LogTest.php.

References $fname, MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\$logId1, $wgContLang, MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpStart(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), MediaWikiTestCase\getNewTempFile(), and NS_TALK.

◆ testXmlDumpsBackupUseCaseLogging()

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::testXmlDumpsBackupUseCaseLogging ( )

Definition at line 183 of file backup_LogTest.php.

References $fname, MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\$logId1, $wgContLang, MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpStart(), MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\assertLogItem(), MediaWiki\Tests\Maintenance\DumpTestCase\checkHasGzip(), MediaWikiTestCase\getNewTempFile(), MediaWiki\Tests\Maintenance\DumpTestCase\gunzip(), and NS_TALK.

Member Data Documentation

◆ $logId1

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::$logId1

private

Definition at line 28 of file backup_LogTest.php.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testPlain(), and MediaWiki\Tests\Maintenance\BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

◆ $logId2

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::$logId2

private

Definition at line 28 of file backup_LogTest.php.

◆ $logId3

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::$logId3

private

Definition at line 28 of file backup_LogTest.php.

◆ $userId1

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::$userId1

private

Definition at line 27 of file backup_LogTest.php.

◆ $userId2

MediaWiki\Tests\Maintenance\BackupDumperLoggerTest::$userId2

private

Definition at line 27 of file backup_LogTest.php.

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

tests/phpunit/maintenance/backup_LogTest.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addDBData()

◆ addLogEntry()

◆ assertLogItem()

◆ testPlain()

◆ testXmlDumpsBackupUseCaseLogging()

Member Data Documentation

◆ $logId1

◆ $logId2

◆ $logId3

◆ $userId1

◆ $userId2