6 abstract class MediaWikiTestCase
extends PHPUnit_Framework_TestCase
{
9 * $called tracks whether the setUp and tearDown method has been called.
10 * class extending MediaWikiTestCase usually override setUp and tearDown
11 * but forget to call the parent.
13 * The array format takes a method name as key and anything as a value.
14 * By asserting the key exist, we know the child class has called the
17 * This property must be private, we do not want child to override it,
18 * they should call the appropriate parent method instead.
20 private $called = array();
38 protected $tablesUsed = array(); // tables with data
40 private static $useTemporaryTables = true;
41 private static $reuseDB = false;
42 private static $dbSetup = false;
43 private static $oldTablePrefix = false;
46 * Original value of PHP's error_reporting setting.
50 private $phpErrorLevel;
53 * Holds the paths of temporary files/directories created through getNewTempFile,
54 * and getNewTempDirectory
58 private $tmpFiles = array();
61 * Holds original values of MediaWiki configuration settings
62 * to be restored in tearDown().
63 * See also setMwGlobals().
66 private $mwGlobals = array();
69 * Table name prefixes. Oracle likes it shorter.
71 const DB_PREFIX
= 'unittest_';
72 const ORA_DB_PREFIX
= 'ut_';
78 protected $supportedDBs = array(
85 public function __construct( $name = null, array $data = array(), $dataName = '' ) {
86 parent
::__construct( $name, $data, $dataName );
88 $this->backupGlobals
= false;
89 $this->backupStaticAttributes
= false;
92 public function run( PHPUnit_Framework_TestResult
$result = null ) {
93 /* Some functions require some kind of caching, and will end up using the db,
94 * which we can't allow, as that would open a new connection for mysql.
95 * Replace with a HashBag. They would not be going to persist anyway.
97 ObjectCache
::$instances[CACHE_DB
] = new HashBagOStuff
;
99 $needsResetDB = false;
100 $logName = get_class( $this ) . '::' . $this->getName( false );
102 if ( $this->needsDB() ) {
103 // set up a DB connection for this test to use
105 self
::$useTemporaryTables = !$this->getCliArg( 'use-normal-tables' );
106 self
::$reuseDB = $this->getCliArg( 'reuse-db' );
108 $this->db
= wfGetDB( DB_MASTER
);
110 $this->checkDbIsSupported();
112 if ( !self
::$dbSetup ) {
113 wfProfileIn( $logName . ' (clone-db)' );
115 // switch to a temporary clone of the database
116 self
::setupTestDB( $this->db
, $this->dbPrefix() );
118 if ( ( $this->db
->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
122 wfProfileOut( $logName . ' (clone-db)' );
125 wfProfileIn( $logName . ' (prepare-db)' );
126 $this->addCoreDBData();
128 wfProfileOut( $logName . ' (prepare-db)' );
130 $needsResetDB = true;
133 wfProfileIn( $logName );
134 parent
::run( $result );
135 wfProfileOut( $logName );
137 if ( $needsResetDB ) {
138 wfProfileIn( $logName . ' (reset-db)' );
140 wfProfileOut( $logName . ' (reset-db)' );
149 public function usesTemporaryTables() {
150 return self
::$useTemporaryTables;
154 * Obtains a new temporary file name
156 * The obtained filename is enlisted to be removed upon tearDown
160 * @return string absolute name of the temporary file
162 protected function getNewTempFile() {
163 $fileName = tempnam( wfTempDir(), 'MW_PHPUnit_' . get_class( $this ) . '_' );
164 $this->tmpFiles
[] = $fileName;
170 * obtains a new temporary directory
172 * The obtained directory is enlisted to be removed (recursively with all its contained
173 * files) upon tearDown.
177 * @return string Absolute name of the temporary directory
179 protected function getNewTempDirectory() {
180 // Starting of with a temporary /file/.
181 $fileName = $this->getNewTempFile();
183 // Converting the temporary /file/ to a /directory/
185 // The following is not atomic, but at least we now have a single place,
186 // where temporary directory creation is bundled and can be improved
188 $this->assertTrue( wfMkdirParents( $fileName ) );
193 protected function setUp() {
194 wfProfileIn( __METHOD__
);
196 $this->called
['setUp'] = 1;
198 $this->phpErrorLevel
= intval( ini_get( 'error_reporting' ) );
200 // Cleaning up temporary files
201 foreach ( $this->tmpFiles
as $fileName ) {
202 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
204 } elseif ( is_dir( $fileName ) ) {
205 wfRecursiveRemoveDir( $fileName );
209 if ( $this->needsDB() && $this->db
) {
210 // Clean up open transactions
211 while ( $this->db
->trxLevel() > 0 ) {
212 $this->db
->rollback();
215 // don't ignore DB errors
216 $this->db
->ignoreErrors( false );
219 wfProfileOut( __METHOD__
);
222 protected function tearDown() {
223 wfProfileIn( __METHOD__
);
225 // Cleaning up temporary files
226 foreach ( $this->tmpFiles
as $fileName ) {
227 if ( is_file( $fileName ) ||
( is_link( $fileName ) ) ) {
229 } elseif ( is_dir( $fileName ) ) {
230 wfRecursiveRemoveDir( $fileName );
234 if ( $this->needsDB() && $this->db
) {
235 // Clean up open transactions
236 while ( $this->db
->trxLevel() > 0 ) {
237 $this->db
->rollback();
240 // don't ignore DB errors
241 $this->db
->ignoreErrors( false );
244 // Restore mw globals
245 foreach ( $this->mwGlobals
as $key => $value ) {
246 $GLOBALS[$key] = $value;
248 $this->mwGlobals
= array();
250 $phpErrorLevel = intval( ini_get( 'error_reporting' ) );
252 if ( $phpErrorLevel !== $this->phpErrorLevel
) {
253 ini_set( 'error_reporting', $this->phpErrorLevel
);
255 $oldHex = strtoupper( dechex( $this->phpErrorLevel
) );
256 $newHex = strtoupper( dechex( $phpErrorLevel ) );
257 $message = "PHP error_reporting setting was left dirty: was 0x$oldHex before test, 0x$newHex after test!";
259 $this->fail( $message );
263 wfProfileOut( __METHOD__
);
267 * Make sure MediaWikiTestCase extending classes have called their
268 * parent setUp method
270 final public function testMediaWikiTestCaseParentSetupCalled() {
271 $this->assertArrayHasKey( 'setUp', $this->called
,
272 get_called_class() . "::setUp() must call parent::setUp()"
277 * Sets a global, maintaining a stashed version of the previous global to be
278 * restored in tearDown
280 * The key is added to the array of globals that will be reset afterwards
285 * protected function setUp() {
286 * $this->setMwGlobals( 'wgRestrictStuff', true );
289 * function testFoo() {}
291 * function testBar() {}
292 * $this->assertTrue( self::getX()->doStuff() );
294 * $this->setMwGlobals( 'wgRestrictStuff', false );
295 * $this->assertTrue( self::getX()->doStuff() );
298 * function testQuux() {}
301 * @param array|string $pairs Key to the global variable, or an array
302 * of key/value pairs.
303 * @param mixed $value Value to set the global to (ignored
304 * if an array is given as first argument).
308 protected function setMwGlobals( $pairs, $value = null ) {
309 if ( is_string( $pairs ) ) {
310 $pairs = array( $pairs => $value );
313 $this->stashMwGlobals( array_keys( $pairs ) );
315 foreach ( $pairs as $key => $value ) {
316 $GLOBALS[$key] = $value;
321 * Stashes the global, will be restored in tearDown()
323 * Individual test functions may override globals through the setMwGlobals() function
324 * or directly. When directly overriding globals their keys should first be passed to this
325 * method in setUp to avoid breaking global state for other tests
327 * That way all other tests are executed with the same settings (instead of using the
328 * unreliable local settings for most tests and fix it only for some tests).
330 * @param array|string $globalKeys Key to the global variable, or an array of keys.
332 * @throws Exception when trying to stash an unset global
335 protected function stashMwGlobals( $globalKeys ) {
336 if ( is_string( $globalKeys ) ) {
337 $globalKeys = array( $globalKeys );
340 foreach ( $globalKeys as $globalKey ) {
341 // NOTE: make sure we only save the global once or a second call to
342 // setMwGlobals() on the same global would override the original
344 if ( !array_key_exists( $globalKey, $this->mwGlobals
) ) {
345 if ( !array_key_exists( $globalKey, $GLOBALS ) ) {
346 throw new Exception( "Global with key {$globalKey} doesn't exist and cant be stashed" );
348 // NOTE: we serialize then unserialize the value in case it is an object
349 // this stops any objects being passed by reference. We could use clone
350 // and if is_object but this does account for objects within objects!
352 $this->mwGlobals
[$globalKey] = unserialize( serialize( $GLOBALS[$globalKey] ) );
354 // NOTE; some things such as Closures are not serializable
355 // in this case just set the value!
356 catch( Exception
$e ) {
357 $this->mwGlobals
[$globalKey] = $GLOBALS[$globalKey];
364 * Merges the given values into a MW global array variable.
365 * Useful for setting some entries in a configuration array, instead of
366 * setting the entire array.
368 * @param string $name The name of the global, as in wgFooBar
369 * @param array $values The array containing the entries to set in that global
371 * @throws MWException if the designated global is not an array.
375 protected function mergeMwGlobalArrayValue( $name, $values ) {
376 if ( !isset( $GLOBALS[$name] ) ) {
379 if ( !is_array( $GLOBALS[$name] ) ) {
380 throw new MWException( "MW global $name is not an array." );
383 // NOTE: do not use array_merge, it screws up for numeric keys.
384 $merged = $GLOBALS[$name];
385 foreach ( $values as $k => $v ) {
390 $this->setMwGlobals( $name, $merged );
397 public function dbPrefix() {
398 return $this->db
->getType() == 'oracle' ? self
::ORA_DB_PREFIX
: self
::DB_PREFIX
;
405 public function needsDB() {
406 # if the test says it uses database tables, it needs the database
407 if ( $this->tablesUsed
) {
411 # if the test says it belongs to the Database group, it needs the database
412 $rc = new ReflectionClass( $this );
413 if ( preg_match( '/@group +Database/im', $rc->getDocComment() ) ) {
421 * Stub. If a test needs to add additional data to the database, it should
422 * implement this method and do so
426 public function addDBData() {
429 private function addCoreDBData() {
430 if ( $this->db
->getType() == 'oracle' ) {
432 # Insert 0 user to prevent FK violations
434 $this->db
->insert( 'user', array(
436 'user_name' => 'Anonymous' ), __METHOD__
, array( 'IGNORE' ) );
438 # Insert 0 page to prevent FK violations
440 $this->db
->insert( 'page', array(
442 'page_namespace' => 0,
444 'page_restrictions' => null,
446 'page_is_redirect' => 0,
449 'page_touched' => $this->db
->timestamp(),
451 'page_len' => 0 ), __METHOD__
, array( 'IGNORE' ) );
454 User
::resetIdByNameCache();
457 $user = User
::newFromName( 'UTSysop' );
459 if ( $user->idForName() == 0 ) {
460 $user->addToDatabase();
461 $user->setPassword( 'UTSysopPassword' );
463 $user->addGroup( 'sysop' );
464 $user->addGroup( 'bureaucrat' );
465 $user->saveSettings();
468 //Make 1 page with 1 revision
469 $page = WikiPage
::factory( Title
::newFromText( 'UTPage' ) );
470 if ( !$page->getId() == 0 ) {
471 $page->doEditContent(
472 new WikitextContent( 'UTContent' ),
476 User
::newFromName( 'UTSysop' ) );
481 * Restores MediaWiki to using the table set (table prefix) it was using before
482 * setupTestDB() was called. Useful if we need to perform database operations
483 * after the test run has finished (such as saving logs or profiling info).
487 public static function teardownTestDB() {
488 if ( !self
::$dbSetup ) {
492 CloneDatabase
::changePrefix( self
::$oldTablePrefix );
494 self
::$oldTablePrefix = false;
495 self
::$dbSetup = false;
499 * Creates an empty skeleton of the wiki database by cloning its structure
500 * to equivalent tables using the given $prefix. Then sets MediaWiki to
501 * use the new set of tables (aka schema) instead of the original set.
503 * This is used to generate a dummy table set, typically consisting of temporary
504 * tables, that will be used by tests instead of the original wiki database tables.
508 * @note: the original table prefix is stored in self::$oldTablePrefix. This is used
509 * by teardownTestDB() to return the wiki to using the original table set.
511 * @note: this method only works when first called. Subsequent calls have no effect,
512 * even if using different parameters.
514 * @param DatabaseBase $db The database connection
515 * @param String $prefix The prefix to use for the new table set (aka schema).
517 * @throws MWException if the database table prefix is already $prefix
519 public static function setupTestDB( DatabaseBase
$db, $prefix ) {
521 if ( $wgDBprefix === $prefix ) {
522 throw new MWException(
523 'Cannot run unit tests, the database prefix is already "' . $prefix . '"' );
526 if ( self
::$dbSetup ) {
530 $tablesCloned = self
::listTables( $db );
531 $dbClone = new CloneDatabase( $db, $tablesCloned, $prefix );
532 $dbClone->useTemporaryTables( self
::$useTemporaryTables );
534 self
::$dbSetup = true;
535 self
::$oldTablePrefix = $wgDBprefix;
537 if ( ( $db->getType() == 'oracle' ||
!self
::$useTemporaryTables ) && self
::$reuseDB ) {
538 CloneDatabase
::changePrefix( $prefix );
542 $dbClone->cloneTableStructure();
545 if ( $db->getType() == 'oracle' ) {
546 $db->query( 'BEGIN FILL_WIKI_INFO; END;' );
551 * Empty all tables so they can be repopulated for tests
553 private function resetDB() {
555 if ( $this->db
->getType() == 'oracle' ) {
556 if ( self
::$useTemporaryTables ) {
557 wfGetLB()->closeAll();
558 $this->db
= wfGetDB( DB_MASTER
);
560 foreach ( $this->tablesUsed
as $tbl ) {
561 if ( $tbl == 'interwiki' ) {
564 $this->db
->query( 'TRUNCATE TABLE ' . $this->db
->tableName( $tbl ), __METHOD__
);
568 foreach ( $this->tablesUsed
as $tbl ) {
569 if ( $tbl == 'interwiki' ||
$tbl == 'user' ) {
572 $this->db
->delete( $tbl, '*', __METHOD__
);
581 * @param string $func
585 * @throws MWException
587 public function __call( $func, $args ) {
588 static $compatibility = array(
589 'assertEmpty' => 'assertEmpty2', // assertEmpty was added in phpunit 3.7.32
592 if ( isset( $compatibility[$func] ) ) {
593 return call_user_func_array( array( $this, $compatibility[$func] ), $args );
595 throw new MWException( "Called non-existant $func method on "
596 . get_class( $this ) );
601 * Used as a compatibility method for phpunit < 3.7.32
603 private function assertEmpty2( $value, $msg ) {
604 return $this->assertTrue( $value == '', $msg );
607 private static function unprefixTable( $tableName ) {
610 return substr( $tableName, strlen( $wgDBprefix ) );
613 private static function isNotUnittest( $table ) {
614 return strpos( $table, 'unittest_' ) !== 0;
620 * @param DataBaseBase $db
624 public static function listTables( $db ) {
627 $tables = $db->listTables( $wgDBprefix, __METHOD__
);
629 if ( $db->getType() === 'mysql' ) {
630 # bug 43571: cannot clone VIEWs under MySQL
631 $views = $db->listViews( $wgDBprefix, __METHOD__
);
632 $tables = array_diff( $tables, $views );
634 $tables = array_map( array( __CLASS__
, 'unprefixTable' ), $tables );
636 // Don't duplicate test tables from the previous fataled run
637 $tables = array_filter( $tables, array( __CLASS__
, 'isNotUnittest' ) );
639 if ( $db->getType() == 'sqlite' ) {
640 $tables = array_flip( $tables );
641 // these are subtables of searchindex and don't need to be duped/dropped separately
642 unset( $tables['searchindex_content'] );
643 unset( $tables['searchindex_segdir'] );
644 unset( $tables['searchindex_segments'] );
645 $tables = array_flip( $tables );
652 * @throws MWException
655 protected function checkDbIsSupported() {
656 if ( !in_array( $this->db
->getType(), $this->supportedDBs
) ) {
657 throw new MWException( $this->db
->getType() . " is not currently supported for unit testing." );
664 public function getCliArg( $offset ) {
665 if ( isset( MediaWikiPHPUnitCommand
::$additionalOptions[$offset] ) ) {
666 return MediaWikiPHPUnitCommand
::$additionalOptions[$offset];
673 public function setCliArg( $offset, $value ) {
674 MediaWikiPHPUnitCommand
::$additionalOptions[$offset] = $value;
678 * Don't throw a warning if $function is deprecated and called later
682 * @param string $function
685 public function hideDeprecated( $function ) {
686 wfSuppressWarnings();
687 wfDeprecated( $function );
692 * Asserts that the given database query yields the rows given by $expectedRows.
693 * The expected rows should be given as indexed (not associative) arrays, with
694 * the values given in the order of the columns in the $fields parameter.
695 * Note that the rows are sorted by the columns given in $fields.
699 * @param string|array $table The table(s) to query
700 * @param string|array $fields The columns to include in the result (and to sort by)
701 * @param string|array $condition "where" condition(s)
702 * @param array $expectedRows An array of arrays giving the expected rows.
704 * @throws MWException If this test cases's needsDB() method doesn't return true.
705 * Test cases can use "@group Database" to enable database test support,
706 * or list the tables under testing in $this->tablesUsed, or override the
709 protected function assertSelect( $table, $fields, $condition, array $expectedRows ) {
710 if ( !$this->needsDB() ) {
711 throw new MWException( 'When testing database state, the test cases\'s needDB()' .
712 ' method should return true. Use @group Database or $this->tablesUsed.' );
715 $db = wfGetDB( DB_SLAVE
);
717 $res = $db->select( $table, $fields, $condition, wfGetCaller(), array( 'ORDER BY' => $fields ) );
718 $this->assertNotEmpty( $res, "query failed: " . $db->lastError() );
722 foreach ( $expectedRows as $expected ) {
723 $r = $res->fetchRow();
724 self
::stripStringKeys( $r );
727 $this->assertNotEmpty( $r, "row #$i missing" );
729 $this->assertEquals( $expected, $r, "row #$i mismatches" );
732 $r = $res->fetchRow();
733 self
::stripStringKeys( $r );
735 $this->assertFalse( $r, "found extra row (after #$i)" );
739 * Utility method taking an array of elements and wrapping
740 * each element in it's own array. Useful for data providers
741 * that only return a single argument.
745 * @param array $elements
749 protected function arrayWrap( array $elements ) {
751 function ( $element ) {
752 return array( $element );
759 * Assert that two arrays are equal. By default this means that both arrays need to hold
760 * the same set of values. Using additional arguments, order and associated key can also
761 * be set as relevant.
765 * @param array $expected
766 * @param array $actual
767 * @param bool $ordered If the order of the values should match
768 * @param bool $named If the keys should match
770 protected function assertArrayEquals( array $expected, array $actual, $ordered = false, $named = false ) {
772 $this->objectAssociativeSort( $expected );
773 $this->objectAssociativeSort( $actual );
777 $expected = array_values( $expected );
778 $actual = array_values( $actual );
781 call_user_func_array(
782 array( $this, 'assertEquals' ),
783 array_merge( array( $expected, $actual ), array_slice( func_get_args(), 4 ) )
788 * Put each HTML element on its own line and then equals() the results
790 * Use for nicely formatting of PHPUnit diff output when comparing very
795 * @param string $expected HTML on oneline
796 * @param string $actual HTML on oneline
797 * @param string $msg Optional message
799 protected function assertHTMLEquals( $expected, $actual, $msg = '' ) {
800 $expected = str_replace( '>', ">\n", $expected );
801 $actual = str_replace( '>', ">\n", $actual );
803 $this->assertEquals( $expected, $actual, $msg );
807 * Does an associative sort that works for objects.
811 * @param array $array
813 protected function objectAssociativeSort( array &$array ) {
816 function ( $a, $b ) {
817 return serialize( $a ) > serialize( $b ) ?
1 : -1;
823 * Utility function for eliminating all string keys from an array.
824 * Useful to turn a database result row as returned by fetchRow() into
825 * a pure indexed array.
829 * @param mixed $r The array to remove string keys from.
831 protected static function stripStringKeys( &$r ) {
832 if ( !is_array( $r ) ) {
836 foreach ( $r as $k => $v ) {
837 if ( is_string( $k ) ) {
844 * Asserts that the provided variable is of the specified
845 * internal type or equals the $value argument. This is useful
846 * for testing return types of functions that return a certain
847 * type or *value* when not set or on error.
851 * @param string $type
852 * @param mixed $actual
853 * @param mixed $value
854 * @param string $message
856 protected function assertTypeOrValue( $type, $actual, $value = false, $message = '' ) {
857 if ( $actual === $value ) {
858 $this->assertTrue( true, $message );
860 $this->assertType( $type, $actual, $message );
865 * Asserts the type of the provided value. This can be either
866 * in internal type such as boolean or integer, or a class or
867 * interface the value extends or implements.
871 * @param string $type
872 * @param mixed $actual
873 * @param string $message
875 protected function assertType( $type, $actual, $message = '' ) {
876 if ( class_exists( $type ) ||
interface_exists( $type ) ) {
877 $this->assertInstanceOf( $type, $actual, $message );
879 $this->assertInternalType( $type, $actual, $message );
884 * Returns true if the given namespace defaults to Wikitext
885 * according to $wgNamespaceContentModels
887 * @param int $ns The namespace ID to check
892 protected function isWikitextNS( $ns ) {
893 global $wgNamespaceContentModels;
895 if ( isset( $wgNamespaceContentModels[$ns] ) ) {
896 return $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
;
903 * Returns the ID of a namespace that defaults to Wikitext.
905 * @throws MWException If there is none.
906 * @return int The ID of the wikitext Namespace
909 protected function getDefaultWikitextNS() {
910 global $wgNamespaceContentModels;
912 static $wikitextNS = null; // this is not going to change
913 if ( $wikitextNS !== null ) {
917 // quickly short out on most common case:
918 if ( !isset( $wgNamespaceContentModels[NS_MAIN
] ) ) {
922 // NOTE: prefer content namespaces
923 $namespaces = array_unique( array_merge(
924 MWNamespace
::getContentNamespaces(),
925 array( NS_MAIN
, NS_HELP
, NS_PROJECT
), // prefer these
926 MWNamespace
::getValidNamespaces()
929 $namespaces = array_diff( $namespaces, array(
930 NS_FILE
, NS_CATEGORY
, NS_MEDIAWIKI
, NS_USER
// don't mess with magic namespaces
933 $talk = array_filter( $namespaces, function ( $ns ) {
934 return MWNamespace
::isTalk( $ns );
937 // prefer non-talk pages
938 $namespaces = array_diff( $namespaces, $talk );
939 $namespaces = array_merge( $namespaces, $talk );
941 // check default content model of each namespace
942 foreach ( $namespaces as $ns ) {
943 if ( !isset( $wgNamespaceContentModels[$ns] ) ||
944 $wgNamespaceContentModels[$ns] === CONTENT_MODEL_WIKITEXT
954 // @todo Inside a test, we could skip the test as incomplete.
955 // But frequently, this is used in fixture setup.
956 throw new MWException( "No namespace defaults to wikitext!" );
960 * Check, if $wgDiff3 is set and ready to merge
961 * Will mark the calling test as skipped, if not ready
965 protected function checkHasDiff3() {
968 # This check may also protect against code injection in
969 # case of broken installations.
970 wfSuppressWarnings();
971 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
975 $this->markTestSkipped( "Skip test, since diff3 is not configured" );
980 * Check whether we have the 'gzip' commandline utility, will skip
981 * the test whenever "gzip -V" fails.
983 * Result is cached at the process level.
989 protected function checkHasGzip() {
992 if ( $haveGzip === null ) {
994 wfShellExec( 'gzip -V', $retval );
995 $haveGzip = ( $retval === 0 );
999 $this->markTestSkipped( "Skip test, requires the gzip utility in PATH" );
1006 * Check if $extName is a loaded PHP extension, will skip the
1007 * test whenever it is not loaded.
1011 protected function checkPHPExtension( $extName ) {
1012 $loaded = extension_loaded( $extName );
1014 $this->markTestSkipped( "PHP extension '$extName' is not loaded, skipping." );
1021 * Asserts that an exception of the specified type occurs when running
1022 * the provided code.
1025 * @deprecated since 1.22 Use setExpectedException
1027 * @param callable $code
1028 * @param string $expected
1029 * @param string $message
1031 protected function assertException( $code, $expected = 'Exception', $message = '' ) {
1035 call_user_func( $code );
1036 } catch ( Exception
$pokemons ) {
1037 // Gotta Catch 'Em All!
1040 if ( $message === '' ) {
1041 $message = 'An exception of type "' . $expected . '" should have been thrown';
1044 $this->assertInstanceOf( $expected, $pokemons, $message );
1048 * Asserts that the given string is a valid HTML snippet.
1049 * Wraps the given string in the required top level tags and
1050 * then calls assertValidHtmlDocument().
1051 * The snippet is expected to be HTML 5.
1055 * @note Will mark the test as skipped if the "tidy" module is not installed.
1056 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1057 * when automatic tidying is disabled.
1059 * @param string $html An HTML snippet (treated as the contents of the body tag).
1061 protected function assertValidHtmlSnippet( $html ) {
1062 $html = '<!DOCTYPE html><html><head><title>test</title></head><body>' . $html . '</body></html>';
1063 $this->assertValidHtmlDocument( $html );
1067 * Asserts that the given string is valid HTML document.
1071 * @note Will mark the test as skipped if the "tidy" module is not installed.
1072 * @note This ignores $wgUseTidy, so we can check for valid HTML even (and especially)
1073 * when automatic tidying is disabled.
1075 * @param string $html A complete HTML document
1077 protected function assertValidHtmlDocument( $html ) {
1078 // Note: we only validate if the tidy PHP extension is available.
1079 // In case wgTidyInternal is false, MWTidy would fall back to the command line version
1080 // of tidy. In that case however, we can not reliably detect whether a failing validation
1081 // is due to malformed HTML, or caused by tidy not being installed as a command line tool.
1082 // That would cause all HTML assertions to fail on a system that has no tidy installed.
1083 if ( !$GLOBALS['wgTidyInternal'] ) {
1084 $this->markTestSkipped( 'Tidy extension not installed' );
1088 MWTidy
::checkErrors( $html, $errorBuffer );
1089 $allErrors = preg_split( '/[\r\n]+/', $errorBuffer );
1091 // Filter Tidy warnings which aren't useful for us.
1092 // Tidy eg. often cries about parameters missing which have actually
1093 // been deprecated since HTML4, thus we should not care about them.
1094 $errors = preg_grep(
1095 '/^(.*Warning: (trimming empty|.* lacks ".*?" attribute).*|\s*)$/m',
1096 $allErrors, PREG_GREP_INVERT
1099 $this->assertEmpty( $errors, implode( "\n", $errors ) );