Tests for TextPassDumper that rely on the database. More...
Public Member Functions | |
| addDBData () | |
| Stub. More... | |
| testCheckpointGzip () | |
| tests for working checkpoint generation in gzip format work. More... | |
| testCheckpointPlain () | |
| Broken per T70653. More... | |
| testPlain () | |
| testPrefetchPlain () | |
 Public Member Functions inherited from MediaWiki\Tests\Maintenance\DumpTestCase | |
| expectETAOutput () | |
| Checks for test output consisting only of lines containing ETA announcements. More... | |
| Public Member Functions inherited from MediaWikiTestCase | |
| __construct ( $name=null, array $data=[], $dataName='') | |
| __destruct () | |
| addDBDataOnce () | |
| Stub. More... | |
| copyTestData (IDatabase $source, IDatabase $target) | |
| Copy test data from one database connection to another. More... | |
| dbPrefix () | |
| getCliArg ( $offset) | |
| hideDeprecated ( $function) | |
| Don't throw a warning if $function is deprecated and called later. More... | |
| 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. More... | |
| setupAllTestDBs () | |
| Set up all test DBs. More... | |
| setUserLang ( $lang) | |
| testMediaWikiTestCaseParentSetupCalled () | |
| Make sure MediaWikiTestCase extending classes have called their parent setUp method. More... | |
| usesTemporaryTables () | |
Public Attributes | |
| $pageId2 | |
| $pageId3 | |
| $pageId4 | |
| $revId2_2 | |
| $revId2_4 | |
| $revId3_2 | |
| $textId1_1 | |
| $textId2_1 | |
| $textId2_2 | |
| $textId2_3 | |
| $textId2_4 | |
| $textId3_1 | |
| $textId3_2 | |
| $textId4_1 | |
| Public Attributes inherited from MediaWikiTestCase | |
| const | DB_PREFIX = 'unittest_' |
| Table name prefixes. More... | |
| const | ORA_DB_PREFIX = 'ut_' |
Protected Member Functions | |
| setUp () | |
| Default set up function. More... | |
| Protected Member Functions inherited from MediaWiki\Tests\Maintenance\DumpTestCase | |
| addRevision (WikiPage $page, $text, $summary, $model=CONTENT_MODEL_WIKITEXT) | |
| Adds a revision to a page, while returning the resuting revision's id. More... | |
| assertDumpSchema ( $fname, $schemaFile) | |
| Checks an XML file against an XSD schema. More... | |
| checkHasGzip () | |
| Skip the test if 'gzip' is not in $PATH. More... | |
| getDumpAsserter ( $schemaVersion=null) | |
| getXmlSchemaPath ( $schemaVersion=null) | |
| Returns the path to the XML schema file for the given schema version. More... | |
| gunzip ( $fname) | |
| gunzips the given file and stores the result in the original file name More... | |
| 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. More... | |
| assertArrayEquals (array $expected, array $actual, $ordered=false, $named=false) | |
| Assert that two arrays are equal. More... | |
| assertFileContains ( $fileName, $actualData, $createIfMissing=false, $msg='') | |
| Check whether file contains given data. More... | |
| assertHTMLEquals ( $expected, $actual, $msg='') | |
| Put each HTML element on its own line and then equals() the results. More... | |
| assertSelect ( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[]) | |
| Asserts that the given database query yields the rows given by $expectedRows. More... | |
| assertType ( $type, $actual, $message='') | |
| Asserts the type of the provided value. More... | |
| assertTypeOrValue ( $type, $actual, $value=false, $message='') | |
| Asserts that the provided variable is of the specified internal type or equals the $value argument. More... | |
| checkDbIsSupported () | |
| checkPHPExtension ( $extName) | |
| Check if $extName is a loaded PHP extension, will skip the test whenever it is not loaded. More... | |
| editPage ( $pageName, $text, $summary='', $defaultNs=NS_MAIN) | |
| Edits or creates a page/revision. More... | |
| ensureMockDatabaseConnection (IDatabase $db) | |
| getDefaultWikitextNS () | |
| Returns the ID of a namespace that defaults to Wikitext. More... | |
| getExistingTestPage ( $title=null) | |
| Returns a WikiPage representing an existing page. More... | |
| getNewTempDirectory () | |
| obtains a new temporary directory More... | |
| getNewTempFile () | |
| Obtains a new temporary file name. More... | |
| getNonexistingTestPage ( $title=null) | |
| Returns a WikiPage representing a non-existing page. More... | |
| getSchemaOverrides (IMaintainableDatabase $db) | |
| Stub. More... | |
| insertPage ( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null) | |
| Insert a new page. More... | |
| isTestInDatabaseGroup () | |
| isWikitextNS ( $ns) | |
| Returns true if the given namespace defaults to Wikitext according to $wgNamespaceContentModels. More... | |
| markTestSkippedIfDbType ( $type) | |
| Skip the test if using the specified database type. More... | |
| markTestSkippedIfNoDiff3 () | |
| Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped, if not ready. More... | |
| mergeMwGlobalArrayValue ( $name, $values) | |
| Merges the given values into a MW global array variable. More... | |
| objectAssociativeSort (array &$array) | |
| Does an associative sort that works for objects. More... | |
| 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. More... | |
| revisionDelete ( $rev, array $value=[Revision::DELETED_TEXT=> 1], $comment='') | |
| Revision-deletes a revision. More... | |
| setIniSetting ( $name, $value) | |
| Set an ini setting for the duration of the test. More... | |
| setLogger ( $channel, LoggerInterface $logger) | |
| Sets the logger for a specified channel, for the duration of the test. More... | |
| setMwGlobals ( $pairs, $value=null) | |
| Sets a global, maintaining a stashed version of the previous global to be restored in tearDown. More... | |
| setService ( $name, $object) | |
| Sets a service, maintaining a stashed version of the previous service to be restored in tearDown. More... | |
| setTemporaryHook ( $hookName, $handler) | |
| Create a temporary hook handler which will be reset by tearDown. More... | |
| stashMwGlobals ( $globalKeys) | |
| Stashes the global, will be restored in tearDown() More... | |
| tearDown () | |
| truncateTable ( $tableName, IDatabase $db=null) | |
| Empties the given table and resets any auto-increment counters. More... | |
Private Member Functions | |
| checkpointHelper ( $checkpointFormat="file") | |
| Ensures that checkpoint dumps are used and written, by successively increasing the stub size and dumping until the duration crosses a threshold. More... | |
| setUpStub ( $fname=null, $iterations=1) | |
| Creates a stub file that is used for testing the text pass of dumps. More... | |
Private Attributes | |
| $pageId1 | |
| $revId1_1 | |
| $revId2_1 | |
| $revId2_3 | |
| $revId3_1 | |
| $revId4_1 | |
Static Private Attributes | |
| static | $numOfPages = 4 |
| static | $numOfRevs = 8 |
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\Tests\Maintenance\DumpTestCase | |
| static | setUpBeforeClass () |
| Static Public Member Functions inherited from MediaWikiTestCase | |
| static | getMutableTestUser ( $groups=[]) |
| Convenience method for getting a mutable test user. More... | |
| static | getTestPrefixFor (IDatabase $db) |
| static | getTestSysop () |
| Convenience method for getting an immutable admin test user. More... | |
| static | getTestUser ( $groups=[]) |
| Convenience method for getting an immutable test user. More... | |
| static | installMockMwServices (Config $configOverrides=null) |
| Creates a new "mock" MediaWikiServices instance, and installs it. More... | |
| static | listTables (IMaintainableDatabase $db) |
| static | prepareServices (Config $bootstrapConfig) |
| static | resetNonServiceCaches () |
| Resets some non-service singleton instances and other static caches. More... | |
| static | restoreMwServices () |
| Restores the original, non-mock MediaWikiServices instance. More... | |
| static | setupTestDB (IMaintainableDatabase $db, $prefix) |
| Creates an empty skeleton of the wiki database by cloning its structure to equivalent tables using the given $prefix. More... | |
| static | teardownTestDB () |
| Restores MediaWiki to using the table set (table prefix) it was using before setupTestDB() was called. More... | |
| static | wfResetOutputBuffersBarrier ( $buffer) |
| Used as a marker to prevent wfResetOutputBuffers from breaking PHPUnit. More... | |
| 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. More... | |
| static | isUsingExternalStoreDB () |
| Check whether ExternalStoreDB is being used. More... | |
| static | setupDatabaseWithTestPrefix (IMaintainableDatabase $db, $prefix=null) |
| Setups a database with cloned tables using the given prefix. More... | |
| static | setupExternalStoreTestDBs ( $testPrefix=null) |
| Clones the External Store database(s) for testing. More... | |
| static | stripStringKeys (&$r) |
| Utility function for eliminating all string keys from an array. More... | |
| Protected Attributes inherited from MediaWiki\Tests\Maintenance\DumpTestCase | |
| Exception null | $exceptionFromAddDBData = null |
| exception to be rethrown once in sound PHPUnit surrounding More... | |
| Protected Attributes inherited from MediaWikiTestCase | |
| Database | $db |
| Primary database. More... | |
| array | $supportedDBs |
| array | $tablesUsed = [] |
| Static Protected Attributes inherited from MediaWiki\Tests\Maintenance\DumpTestCase | |
| static bool null | $hasGzip = null |
| Whether the 'gzip' utility is available. More... | |
Detailed Description
Tests for TextPassDumper that rely on the database.
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 TextPassDumper
Definition at line 26 of file backupTextPassTest.php.
Member Function Documentation
◆ addDBData()
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::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 39 of file backupTextPassTest.php.
References $e, $title, MediaWiki\Tests\Maintenance\DumpTestCase\addRevision(), class, WikiPage\factory(), MediaWikiTestCase\getDefaultWikitextNS(), list, MediaWikiTestCase\mergeMwGlobalArrayValue(), Title\newFromText(), and NS_TALK.
◆ checkpointHelper()
|
private |
Ensures that checkpoint dumps are used and written, by successively increasing the stub size and dumping until the duration crosses a threshold.
- Parameters
-
string $checkpointFormat Either "file" for plain text or "gzip" for gzipped checkpoint files.
Definition at line 259 of file backupTextPassTest.php.
References $fname, MediaWiki\Tests\Maintenance\DumpTestCase\expectETAOutput(), MediaWiki\Tests\Maintenance\DumpTestCase\getDumpAsserter(), MediaWikiTestCase\getNewTempDirectory(), MediaWikiTestCase\getNewTempFile(), MediaWiki\Tests\Maintenance\DumpTestCase\gunzip(), NS_MAIN, NS_TALK, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub(), wfMkdirParents(), and wfRecursiveRemoveDir().
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testCheckpointGzip(), and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testCheckpointPlain().
◆ setUp()
|
protected |
Default set up function.
Clears $wgUser, and reports errors from addDBData to PHPUnit
Reimplemented from MediaWiki\Tests\Maintenance\DumpTestCase.
Definition at line 107 of file backupTextPassTest.php.
◆ setUpStub()
|
private |
Creates a stub file that is used for testing the text pass of dumps.
- Parameters
-
string $fname (Optional) Absolute name of the file to write the stub into. If this parameter is null, a new temporary file is generated that is automatically removed upon tearDown. int $iterations (Optional) specifies how often the block of 3 pages should go into the stub file. The page and revision id increase further and further, while the text id of the first iteration is reused. The pages and revision of iteration > 1 have no corresponding representation in the database.
- Returns
- string Absolute filename of the stub
Definition at line 524 of file backupTextPassTest.php.
References $content, $fname, $header, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$numOfPages, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$numOfRevs, $username, MediaWikiTestCase\getNewTempFile(), and MediaWikiTestCase\getTestUser().
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper(), MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPlain(), and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain().
◆ testCheckpointGzip()
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::testCheckpointGzip | ( | ) |
tests for working checkpoint generation in gzip format work.
We keep this test in addition to the simpler self::testCheckpointPlain, as there were once problems when the used sinks were DumpPipeOutputs.
xmldumps-backup typically uses bzip2 instead of gzip. However, as bzip2 requires PHP extensions, we go for gzip instead, which triggers the same relevant code paths while still being testable on more systems.
Broken per T70653.
large Broken
Definition at line 506 of file backupTextPassTest.php.
References MediaWiki\Tests\Maintenance\DumpTestCase\checkHasGzip(), and MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper().
◆ testCheckpointPlain()
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::testCheckpointPlain | ( | ) |
Broken per T70653.
large Broken
Definition at line 487 of file backupTextPassTest.php.
References MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\checkpointHelper().
◆ testPlain()
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::testPlain | ( | ) |
Definition at line 120 of file backupTextPassTest.php.
References WikiExporter\FULL, MediaWiki\Tests\Maintenance\DumpTestCase\getDumpAsserter(), MediaWikiTestCase\getNewTempFile(), NS_MAIN, NS_TALK, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub(), and WikiExporter\TEXT.
◆ testPrefetchPlain()
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::testPrefetchPlain | ( | ) |
Definition at line 175 of file backupTextPassTest.php.
References MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$pageId1, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$pageId2, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$revId1_1, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\$revId2_3, class, WikiExporter\FULL, MediaWiki\Tests\Maintenance\DumpTestCase\getDumpAsserter(), MediaWikiTestCase\getNewTempFile(), NS_MAIN, NS_TALK, MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub(), and WikiExporter\TEXT.
Member Data Documentation
◆ $numOfPages
|
staticprivate |
Definition at line 31 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub().
◆ $numOfRevs
|
staticprivate |
Definition at line 37 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\setUpStub().
◆ $pageId1
|
private |
Definition at line 30 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain().
◆ $pageId2
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$pageId2 |
Definition at line 30 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain().
◆ $pageId3
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$pageId3 |
Definition at line 30 of file backupTextPassTest.php.
◆ $pageId4
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$pageId4 |
Definition at line 30 of file backupTextPassTest.php.
◆ $revId1_1
|
private |
Definition at line 32 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain().
◆ $revId2_1
|
private |
Definition at line 33 of file backupTextPassTest.php.
◆ $revId2_2
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$revId2_2 |
Definition at line 33 of file backupTextPassTest.php.
◆ $revId2_3
|
private |
Definition at line 34 of file backupTextPassTest.php.
Referenced by MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest\testPrefetchPlain().
◆ $revId2_4
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$revId2_4 |
Definition at line 34 of file backupTextPassTest.php.
◆ $revId3_1
|
private |
Definition at line 35 of file backupTextPassTest.php.
◆ $revId3_2
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$revId3_2 |
Definition at line 35 of file backupTextPassTest.php.
◆ $revId4_1
|
private |
Definition at line 36 of file backupTextPassTest.php.
◆ $textId1_1
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId1_1 |
Definition at line 32 of file backupTextPassTest.php.
◆ $textId2_1
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId2_1 |
Definition at line 33 of file backupTextPassTest.php.
◆ $textId2_2
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId2_2 |
Definition at line 33 of file backupTextPassTest.php.
◆ $textId2_3
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId2_3 |
Definition at line 34 of file backupTextPassTest.php.
◆ $textId2_4
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId2_4 |
Definition at line 34 of file backupTextPassTest.php.
◆ $textId3_1
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId3_1 |
Definition at line 35 of file backupTextPassTest.php.
◆ $textId3_2
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId3_2 |
Definition at line 35 of file backupTextPassTest.php.
◆ $textId4_1
| MediaWiki\Tests\Maintenance\TextPassDumperDatabaseTest::$textId4_1 |
Definition at line 36 of file backupTextPassTest.php.
The documentation for this class was generated from the following file:
- tests/phpunit/maintenance/backupTextPassTest.php
