tests/phpunit/includes/specials/SpecialSearchTest.php

   1 <?php
   2 /**
   3  * Test class for SpecialSearch class
   4  * Copyright © 2012, Antoine Musso
   5  *
   6  * @author Antoine Musso
   7  * @group Database
   8  */
   9
  10 class SpecialSearchTest extends MediaWikiTestCase {
  11         private $search;
  12
  13         /**
  14          * @covers SpecialSearch::load
  15          * @dataProvider provideSearchOptionsTests
  16          * @param $requested Array Request parameters. For example array( 'ns5' => true, 'ns6' => true). NULL to use default options.
  17          * @param $userOptions Array User options to test with. For example array('searchNs5' => 1 );. NULL to use default options.
  18          * @param $expectedProfile An expected search profile name
  19          * @param $expectedNs Array Expected namespaces
  20          */
  21         function testProfileAndNamespaceLoading(
  22                 $requested, $userOptions, $expectedProfile, $expectedNS,
  23                 $message = 'Profile name and namespaces mismatches!'
  24         ) {
  25                 $context = new RequestContext;
  26                 $context->setUser(
  27                         $this->newUserWithSearchNS( $userOptions )
  28                 );
  29                 /*
  30                 $context->setRequest( new FauxRequest( array(
  31                         'ns5'=>true,
  32                         'ns6'=>true,
  33                 ) ));
  34                  */
  35                 $context->setRequest( new FauxRequest( $requested ) );
  36                 $search = new SpecialSearch();
  37                 $search->setContext( $context );
  38                 $search->load();
  39
  40                 /**
  41                  * Verify profile name and namespace in the same assertion to make
  42                  * sure we will be able to fully compare the above code. PHPUnit stop
  43                  * after an assertion fail.
  44                  */
  45                 $this->assertEquals(
  46                         array( /** Expected: */
  47                                 'ProfileName' => $expectedProfile,
  48                                 'Namespaces' => $expectedNS,
  49                         )
  50                         , array( /** Actual: */
  51                                 'ProfileName' => $search->getProfile(),
  52                                 'Namespaces' => $search->getNamespaces(),
  53                         )
  54                         , $message
  55                 );
  56         }
  57
  58         public static function provideSearchOptionsTests() {
  59                 $defaultNS = SearchEngine::defaultNamespaces();
  60                 $EMPTY_REQUEST = array();
  61                 $NO_USER_PREF = null;
  62
  63                 return array(
  64                         /**
  65                          * Parameters:
  66                          *     <Web Request>, <User options>
  67                          * Followed by expected values:
  68                          *     <ProfileName>, <NSList>
  69                          * Then an optional message.
  70                          */
  71                         array(
  72                                 $EMPTY_REQUEST, $NO_USER_PREF,
  73                                 'default', $defaultNS,
  74                                 'Bug 33270: No request nor user preferences should give default profile'
  75                         ),
  76                         array(
  77                                 array( 'ns5' => 1 ), $NO_USER_PREF,
  78                                 'advanced', array( 5 ),
  79                                 'Web request with specific NS should override user preference'
  80                         ),
  81                         array(
  82                                 $EMPTY_REQUEST, array(
  83                                 'searchNs2' => 1,
  84                                 'searchNs14' => 1,
  85                         ) + array_fill_keys( array_map( function ( $ns ) {
  86                                 return "searchNs$ns";
  87                         }, $defaultNS ), 0 ),
  88                                 'advanced', array( 2, 14 ),
  89                                 'Bug 33583: search with no option should honor User search preferences'
  90                                         . ' and have all other namespace disabled'
  91                         ),
  92                 );
  93         }
  94
  95         /**
  96          * Helper to create a new User object with given options
  97          * User remains anonymous though
  98          */
  99         function newUserWithSearchNS( $opt = null ) {
 100                 $u = User::newFromId( 0 );
 101                 if ( $opt === null ) {
 102                         return $u;
 103                 }
 104                 foreach ( $opt as $name => $value ) {
 105                         $u->setOption( $name, $value );
 106                 }
 107
 108                 return $u;
 109         }
 110
 111         /**
 112          * Verify we do not expand search term in <title> on search result page
 113          * https://gerrit.wikimedia.org/r/4841
 114          */
 115         function testSearchTermIsNotExpanded() {
 116
 117                 # Initialize [[Special::Search]]
 118                 $search = new SpecialSearch();
 119                 $search->getContext()->setTitle( Title::newFromText( 'Special:Search' ) );
 120                 $search->load();
 121
 122                 # Simulate a user searching for a given term
 123                 $term = '{{SITENAME}}';
 124                 $search->showResults( $term );
 125
 126                 # Lookup the HTML page title set for that page
 127                 $pageTitle = $search
 128                         ->getContext()
 129                         ->getOutput()
 130                         ->getHTMLTitle();
 131
 132                 # Compare :-]
 133                 $this->assertRegExp(
 134                         '/' . preg_quote( $term ) . '/',
 135                         $pageTitle,
 136                         "Search term '{$term}' should not be expanded in Special:Search <title>"
 137                 );
 138         }
 139 }