MediaWiki REL1_32
MediaWiki\Tests\Maintenance\BackupDumperPageTest Class Reference

Tests for page dumps of BackupDumper. More...

Inheritance diagram for MediaWiki\Tests\Maintenance\BackupDumperPageTest:
Collaboration diagram for MediaWiki\Tests\Maintenance\BackupDumperPageTest:

Public Member Functions

 addDBData ()
 Stub.
 
 testCurrentStubGzip ()
 
 testCurrentStubPlain ()
 
 testFullStubPlain ()
 
 testFullTextPlain ()
 
 testXmlDumpsBackupUseCase ()
 xmldumps-backup typically performs a single dump that that writes out three files
 
- 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.
 
 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

 setUp ()
 Default set up function.
 
- 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
 
 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
 addCoreDBData ()
 
 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.
 

Private Attributes

 $namespace
 
 $pageId1
 
 $pageId2
 
 $pageId3
 
 $pageId4
 
 $pageTitle1
 
 $pageTitle2
 
 $pageTitle3
 
 $pageTitle4
 
 $revId1_1
 
 $revId2_1
 
 $revId2_2
 
 $revId2_3
 
 $revId2_4
 
 $revId3_1
 
 $revId3_2
 
 $revId4_1
 
 $talk_namespace
 
 $textId1_1
 
 $textId2_1
 
 $textId2_2
 
 $textId2_3
 
 $textId2_4
 
 $textId3_1
 
 $textId3_2
 
 $textId4_1
 

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.
 
- 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 page dumps of BackupDumper.

Database Dump BackupDumper

Definition at line 17 of file backup_PageTest.php.

Member Function Documentation

◆ addDBData()

MediaWiki\Tests\Maintenance\BackupDumperPageTest::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 30 of file backup_PageTest.php.

References $e, MediaWiki\Tests\Maintenance\DumpTestCase\addRevision(), MediaWikiTestCase\getDefaultWikitextNS(), list, NS_TALK, and MediaWikiTestCase\setContentLang().

◆ setUp()

MediaWiki\Tests\Maintenance\BackupDumperPageTest::setUp ( )
protected

Default set up function.

Clears $wgUser, and reports errors from addDBData to PHPUnit

Reimplemented from MediaWiki\Tests\Maintenance\DumpTestCase.

Definition at line 91 of file backup_PageTest.php.

◆ testCurrentStubGzip()

◆ testCurrentStubPlain()

◆ testFullStubPlain()

◆ testFullTextPlain()

◆ testXmlDumpsBackupUseCase()

MediaWiki\Tests\Maintenance\BackupDumperPageTest::testXmlDumpsBackupUseCase ( )

xmldumps-backup typically performs a single dump that that writes out three files

  • gzipped stubs of everything (meta-history)
  • gzipped stubs of latest revisions of all pages (meta-current)
  • gzipped stubs of latest revisions of all pages of namespage 0 (articles)

We reproduce such a setup with our mini fixture, although we omit chunks, and all the other gimmicks of xmldumps-backup.

Definition at line 312 of file backup_PageTest.php.

References MediaWiki\Tests\Maintenance\BackupDumperPageTest\$pageId1, MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertDumpStart(), MediaWiki\Tests\Maintenance\DumpTestCase\assertPageEnd(), MediaWiki\Tests\Maintenance\DumpTestCase\assertPageStart(), MediaWiki\Tests\Maintenance\DumpTestCase\assertRevision(), MediaWiki\Tests\Maintenance\DumpTestCase\checkHasGzip(), MediaWiki\Tests\Maintenance\DumpTestCase\expectETAOutput(), MediaWikiTestCase\getNewTempFile(), and MediaWiki\Tests\Maintenance\DumpTestCase\gunzip().

Member Data Documentation

◆ $namespace

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$namespace
private

Definition at line 28 of file backup_PageTest.php.

◆ $pageId1

◆ $pageId2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageId2
private

Definition at line 21 of file backup_PageTest.php.

◆ $pageId3

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageId3
private

Definition at line 21 of file backup_PageTest.php.

◆ $pageId4

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageId4
private

Definition at line 21 of file backup_PageTest.php.

◆ $pageTitle1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageTitle1
private

Definition at line 22 of file backup_PageTest.php.

◆ $pageTitle2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageTitle2
private

Definition at line 22 of file backup_PageTest.php.

◆ $pageTitle3

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageTitle3
private

Definition at line 22 of file backup_PageTest.php.

◆ $pageTitle4

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$pageTitle4
private

Definition at line 22 of file backup_PageTest.php.

◆ $revId1_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId1_1
private

Definition at line 23 of file backup_PageTest.php.

◆ $revId2_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId2_1
private

Definition at line 24 of file backup_PageTest.php.

◆ $revId2_2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId2_2
private

Definition at line 24 of file backup_PageTest.php.

◆ $revId2_3

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId2_3
private

Definition at line 25 of file backup_PageTest.php.

◆ $revId2_4

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId2_4
private

Definition at line 25 of file backup_PageTest.php.

◆ $revId3_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId3_1
private

Definition at line 26 of file backup_PageTest.php.

◆ $revId3_2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId3_2
private

Definition at line 26 of file backup_PageTest.php.

◆ $revId4_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$revId4_1
private

Definition at line 27 of file backup_PageTest.php.

◆ $talk_namespace

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$talk_namespace
private

Definition at line 28 of file backup_PageTest.php.

◆ $textId1_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId1_1
private

Definition at line 23 of file backup_PageTest.php.

◆ $textId2_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId2_1
private

Definition at line 24 of file backup_PageTest.php.

◆ $textId2_2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId2_2
private

Definition at line 24 of file backup_PageTest.php.

◆ $textId2_3

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId2_3
private

Definition at line 25 of file backup_PageTest.php.

◆ $textId2_4

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId2_4
private

Definition at line 25 of file backup_PageTest.php.

◆ $textId3_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId3_1
private

Definition at line 26 of file backup_PageTest.php.

◆ $textId3_2

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId3_2
private

Definition at line 26 of file backup_PageTest.php.

◆ $textId4_1

MediaWiki\Tests\Maintenance\BackupDumperPageTest::$textId4_1
private

Definition at line 27 of file backup_PageTest.php.


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