MediaWiki REL1_31
SpecialSearchTest Class Reference

Test class for SpecialSearch class Copyright © 2012, Antoine Musso. More...

Inheritance diagram for SpecialSearchTest:
Collaboration diagram for SpecialSearchTest:

Public Member Functions

 newUserWithSearchNS ( $opt=null)
 Helper to create a new User object with given options User remains anonymous though.
 
 provideRewriteQueryWithSuggestion ()
 
 testProfileAndNamespaceLoading ( $requested, $userOptions, $expectedProfile, $expectedNS, $message='Profile name and namespaces mismatches!')
 SpecialSearch::load provideSearchOptionsTests.
 
 testRewriteQueryWithSuggestion ( $message, $expectRegex, $suggestion, $rewrittenQuery, array $resultTitles)
 provideRewriteQueryWithSuggestion
 
 testSearchTermIsNotExpanded ()
 Verify we do not expand search term in <title> on search result page https://gerrit.wikimedia.org/r/4841.
 
 testSubPageRedirect ()
 
- Public Member Functions inherited from MediaWikiTestCase
 __construct ( $name=null, array $data=[], $dataName='')
 
 __destruct ()
 
 addDBData ()
 Stub.
 
 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 ()
 

Static Public Member Functions

static provideSearchOptionsTests ()
 
- 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.
 

Protected Member Functions

 mockSearchEngine ( $results)
 
- 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.
 
 setUp ()
 
 stashMwGlobals ( $globalKeys)
 Stashes the global, will be restored in tearDown()
 
 tearDown ()
 

Additional Inherited Members

- 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 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 MediaWikiTestCase
Database $db
 Primary database.
 
array $supportedDBs
 
array $tablesUsed = []
 

Detailed Description

Test class for SpecialSearch class Copyright © 2012, Antoine Musso.

Author
Antoine Musso Database

Definition at line 11 of file SpecialSearchTest.php.

Member Function Documentation

◆ mockSearchEngine()

SpecialSearchTest::mockSearchEngine (   $results)
protected

Definition at line 215 of file SpecialSearchTest.php.

Referenced by testRewriteQueryWithSuggestion().

◆ newUserWithSearchNS()

SpecialSearchTest::newUserWithSearchNS (   $opt = null)

Helper to create a new User object with given options User remains anonymous though.

Parameters
array | null$opt

Definition at line 102 of file SpecialSearchTest.php.

References $name, $opt, $value, as, and User\newFromId().

Referenced by testProfileAndNamespaceLoading().

◆ provideRewriteQueryWithSuggestion()

SpecialSearchTest::provideRewriteQueryWithSuggestion ( )

Definition at line 148 of file SpecialSearchTest.php.

◆ provideSearchOptionsTests()

static SpecialSearchTest::provideSearchOptionsTests ( )
static

Definition at line 60 of file SpecialSearchTest.php.

◆ testProfileAndNamespaceLoading()

SpecialSearchTest::testProfileAndNamespaceLoading (   $requested,
  $userOptions,
  $expectedProfile,
  $expectedNS,
  $message = 'Profile name and namespaces mismatches!' 
)

SpecialSearch::load provideSearchOptionsTests.

Parameters
array$requestedRequest parameters. For example: array( 'ns5' => true, 'ns6' => true). Null to use default options.
array$userOptionsUser options to test with. For example: array('searchNs5' => 1 );. Null to use default options.
string$expectedProfileAn expected search profile name
array$expectedNSExpected namespaces
string$message

Definition at line 24 of file SpecialSearchTest.php.

References $context, and newUserWithSearchNS().

◆ testRewriteQueryWithSuggestion()

SpecialSearchTest::testRewriteQueryWithSuggestion (   $message,
  $expectRegex,
  $suggestion,
  $rewrittenQuery,
array  $resultTitles 
)

provideRewriteQueryWithSuggestion

Definition at line 179 of file SpecialSearchTest.php.

References $html, $title, array(), as, mockSearchEngine(), and NS_SPECIAL.

◆ testSearchTermIsNotExpanded()

SpecialSearchTest::testSearchTermIsNotExpanded ( )

Verify we do not expand search term in <title> on search result page https://gerrit.wikimedia.org/r/4841.

Definition at line 118 of file SpecialSearchTest.php.

References $term, and MediaWikiTestCase\setMwGlobals().

◆ testSubPageRedirect()

SpecialSearchTest::testSubPageRedirect ( )

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