tests/phpunit/includes/specials/SpecialSearchTest.php

   1 <?php
   2 use MediaWiki\MediaWikiServices;
   3
   4 /**
   5  * Test class for SpecialSearch class
   6  * Copyright © 2012, Antoine Musso
   7  *
   8  * @author Antoine Musso
   9  * @group Database
  10  */
  11 class SpecialSearchTest extends MediaWikiTestCase {
  12
  13         /**
  14          * @covers SpecialSearch::load
  15          * @dataProvider provideSearchOptionsTests
  16          * @param array $requested Request parameters. For example:
  17          *   array( 'ns5' => true, 'ns6' => true). Null to use default options.
  18          * @param array $userOptions User options to test with. For example:
  19          *   array('searchNs5' => 1 );. Null to use default options.
  20          * @param string $expectedProfile An expected search profile name
  21          * @param array $expectedNS Expected namespaces
  22          * @param string $message
  23          */
  24         public function testProfileAndNamespaceLoading( $requested, $userOptions,
  25                 $expectedProfile, $expectedNS, $message = 'Profile name and namespaces mismatches!'
  26         ) {
  27                 $context = new RequestContext;
  28                 $context->setUser(
  29                         $this->newUserWithSearchNS( $userOptions )
  30                 );
  31                 /*
  32                 $context->setRequest( new FauxRequest( [
  33                         'ns5'=>true,
  34                         'ns6'=>true,
  35                 ] ));
  36                  */
  37                 $context->setRequest( new FauxRequest( $requested ) );
  38                 $search = new SpecialSearch();
  39                 $search->setContext( $context );
  40                 $search->load();
  41
  42                 /**
  43                  * Verify profile name and namespace in the same assertion to make
  44                  * sure we will be able to fully compare the above code. PHPUnit stop
  45                  * after an assertion fail.
  46                  */
  47                 $this->assertEquals(
  48                         [ /** Expected: */
  49                                 'ProfileName' => $expectedProfile,
  50                                 'Namespaces' => $expectedNS,
  51                         ],
  52                         [ /** Actual: */
  53                                 'ProfileName' => $search->getProfile(),
  54                                 'Namespaces' => $search->getNamespaces(),
  55                         ],
  56                         $message
  57                 );
  58         }
  59
  60         public static function provideSearchOptionsTests() {
  61                 $defaultNS = MediaWikiServices::getInstance()->getSearchEngineConfig()->defaultNamespaces();
  62                 $EMPTY_REQUEST = [];
  63                 $NO_USER_PREF = null;
  64
  65                 return [
  66                         /**
  67                          * Parameters:
  68                          *     <Web Request>, <User options>
  69                          * Followed by expected values:
  70                          *     <ProfileName>, <NSList>
  71                          * Then an optional message.
  72                          */
  73                         [
  74                                 $EMPTY_REQUEST, $NO_USER_PREF,
  75                                 'default', $defaultNS,
  76                                 'Bug 33270: No request nor user preferences should give default profile'
  77                         ],
  78                         [
  79                                 [ 'ns5' => 1 ], $NO_USER_PREF,
  80                                 'advanced', [ 5 ],
  81                                 'Web request with specific NS should override user preference'
  82                         ],
  83                         [
  84                                 $EMPTY_REQUEST, [
  85                                 'searchNs2' => 1,
  86                                 'searchNs14' => 1,
  87                         ] + array_fill_keys( array_map( function ( $ns ) {
  88                                 return "searchNs$ns";
  89                         }, $defaultNS ), 0 ),
  90                                 'advanced', [ 2, 14 ],
  91                                 'Bug 33583: search with no option should honor User search preferences'
  92                                         . ' and have all other namespace disabled'
  93                         ],
  94                 ];
  95         }
  96
  97         /**
  98          * Helper to create a new User object with given options
  99          * User remains anonymous though
 100          * @param array|null $opt
 101          */
 102         function newUserWithSearchNS( $opt = null ) {
 103                 $u = User::newFromId( 0 );
 104                 if ( $opt === null ) {
 105                         return $u;
 106                 }
 107                 foreach ( $opt as $name => $value ) {
 108                         $u->setOption( $name, $value );
 109                 }
 110
 111                 return $u;
 112         }
 113
 114         /**
 115          * Verify we do not expand search term in <title> on search result page
 116          * https://gerrit.wikimedia.org/r/4841
 117          */
 118         public function testSearchTermIsNotExpanded() {
 119                 $this->setMwGlobals( [
 120                         'wgSearchType' => null,
 121                 ] );
 122
 123                 # Initialize [[Special::Search]]
 124                 $search = new SpecialSearch();
 125                 $search->getContext()->setTitle( Title::newFromText( 'Special:Search' ) );
 126                 $search->load();
 127
 128                 # Simulate a user searching for a given term
 129                 $term = '{{SITENAME}}';
 130                 $search->showResults( $term );
 131
 132                 # Lookup the HTML page title set for that page
 133                 $pageTitle = $search
 134                         ->getContext()
 135                         ->getOutput()
 136                         ->getHTMLTitle();
 137
 138                 # Compare :-]
 139                 $this->assertRegExp(
 140                         '/' . preg_quote( $term, '/' ) . '/',
 141                         $pageTitle,
 142                         "Search term '{$term}' should not be expanded in Special:Search <title>"
 143                 );
 144         }
 145
 146         public function provideRewriteQueryWithSuggestion() {
 147                 return [
 148                         [
 149                                 'With suggestion and no rewritten query shows did you mean',
 150                                 '/Did you mean: <a[^>]+>first suggestion/',
 151                                 new SpecialSearchTestMockResultSet( 'first suggestion', null, [
 152                                         SearchResult::newFromTitle( Title::newMainPage() ),
 153                                 ] ),
 154                         ],
 155
 156                         [
 157                                 'With rewritten query informs user of change',
 158                                 '/Showing results for <a[^>]+>first suggestion/',
 159                                 new SpecialSearchTestMockResultSet( 'asdf', 'first suggestion', [
 160                                         SearchResult::newFromTitle( Title::newMainPage() ),
 161                                 ] ),
 162                         ],
 163
 164                         [
 165                                 'When both queries have no results user gets no results',
 166                                 '/There were no results matching the query/',
 167                                 new SpecialSearchTestMockResultSet( 'first suggestion', 'first suggestion', [] ),
 168                         ],
 169                 ];
 170         }
 171
 172         /**
 173          * @dataProvider provideRewriteQueryWithSuggestion
 174          */
 175         public function testRewriteQueryWithSuggestion( $message, $expectRegex, $results ) {
 176                 $mockSearchEngine = $this->mockSearchEngine( $results );
 177                 $search = $this->getMockBuilder( 'SpecialSearch' )
 178                         ->setMethods( [ 'getSearchEngine' ] )
 179                         ->getMock();
 180                 $search->expects( $this->any() )
 181                         ->method( 'getSearchEngine' )
 182                         ->will( $this->returnValue( $mockSearchEngine ) );
 183
 184                 $search->getContext()->setTitle( Title::makeTitle( NS_SPECIAL, 'Search' ) );
 185                 $search->getContext()->setLanguage( Language::factory( 'en' ) );
 186                 $search->load();
 187                 $search->showResults( 'this is a fake search' );
 188
 189                 $html = $search->getContext()->getOutput()->getHTML();
 190                 foreach ( (array)$expectRegex as $regex ) {
 191                         $this->assertRegExp( $regex, $html, $message );
 192                 }
 193         }
 194
 195         protected function mockSearchEngine( $results ) {
 196                 $mock = $this->getMockBuilder( 'SearchEngine' )
 197                         ->setMethods( [ 'searchText', 'searchTitle' ] )
 198                         ->getMock();
 199
 200                 $mock->expects( $this->any() )
 201                         ->method( 'searchText' )
 202                         ->will( $this->returnValue( $results ) );
 203
 204                 return $mock;
 205         }
 206 }
 207
 208 class SpecialSearchTestMockResultSet extends SearchResultSet {
 209         protected $results;
 210         protected $suggestion;
 211
 212         public function __construct(
 213                 $suggestion = null,
 214                 $rewrittenQuery = null,
 215                 array $results = [],
 216                 $containedSyntax = false
 217         ) {
 218                 $this->suggestion = $suggestion;
 219                 $this->rewrittenQuery = $rewrittenQuery;
 220                 $this->results = $results;
 221                 $this->containedSyntax = $containedSyntax;
 222         }
 223
 224         public function numRows() {
 225                 return count( $this->results );
 226         }
 227
 228         public function getTotalHits() {
 229                 return $this->numRows();
 230         }
 231
 232         public function hasSuggestion() {
 233                 return $this->suggestion !== null;
 234         }
 235
 236         public function getSuggestionQuery() {
 237                 return $this->suggestion;
 238         }
 239
 240         public function getSuggestionSnippet() {
 241                 return $this->suggestion;
 242         }
 243
 244         public function hasRewrittenQuery() {
 245                 return $this->rewrittenQuery !== null;
 246         }
 247
 248         public function getQueryAfterRewrite() {
 249                 return $this->rewrittenQuery;
 250         }
 251
 252         public function getQueryAfterRewriteSnippet() {
 253                 return htmlspecialchars( $this->rewrittenQuery );
 254         }
 255 }