tests/phpunit/includes/specialpage/SpecialPageTest.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\SpecialPage;
   4
   5 use MediaWiki\MainConfigNames;
   6 use MediaWiki\Request\FauxRequest;
   7 use MediaWiki\SpecialPage\SpecialPage;
   8 use MediaWiki\Tests\User\TempUser\TempUserTestTrait;
   9 use MediaWiki\Title\Title;
  10 use MediaWiki\User\User;
  11 use MediaWikiIntegrationTestCase;
  12 use UserNotLoggedIn;
  13
  14 /**
  15  * @covers \MediaWiki\SpecialPage\SpecialPage
  16  *
  17  * @group Database
  18  *
  19  * @author Katie Filbert < aude.wiki@gmail.com >
  20  */
  21 class SpecialPageTest extends MediaWikiIntegrationTestCase {
  22
  23         use TempUserTestTrait;
  24
  25         protected function setUp(): void {
  26                 parent::setUp();
  27
  28                 $this->overrideConfigValues( [
  29                         MainConfigNames::Script => '/index.php',
  30                         MainConfigNames::LanguageCode => 'en',
  31                 ] );
  32         }
  33
  34         /**
  35          * @dataProvider getTitleForProvider
  36          */
  37         public function testGetTitleFor( $expectedName, $name ) {
  38                 $title = SpecialPage::getTitleFor( $name );
  39                 $expected = Title::makeTitle( NS_SPECIAL, $expectedName );
  40                 $this->assertEquals( $expected, $title );
  41         }
  42
  43         public static function getTitleForProvider() {
  44                 return [
  45                         [ 'UserLogin', 'Userlogin' ]
  46                 ];
  47         }
  48
  49         public function testInvalidGetTitleFor() {
  50                 $this->expectPHPError(
  51                         E_USER_NOTICE,
  52                         function () {
  53                                 $title = SpecialPage::getTitleFor( 'cat' );
  54                                 $expected = Title::makeTitle( NS_SPECIAL, 'Cat' );
  55                                 $this->assertEquals( $expected, $title );
  56                         }
  57                 );
  58         }
  59
  60         /**
  61          * @dataProvider getTitleForWithWarningProvider
  62          */
  63         public function testGetTitleForWithWarning( $expected, $name ) {
  64                 $this->expectPHPError(
  65                         E_USER_NOTICE,
  66                         function () use ( $name, $expected ) {
  67                                 $title = SpecialPage::getTitleFor( $name );
  68                                 $this->assertEquals( $expected, $title );
  69                         }
  70                 );
  71         }
  72
  73         public static function getTitleForWithWarningProvider() {
  74                 return [
  75                         [ Title::makeTitle( NS_SPECIAL, 'UserLogin' ), 'UserLogin' ]
  76                 ];
  77         }
  78
  79         /**
  80          * @dataProvider requireLoginAnonProvider
  81          */
  82         public function testRequireLoginAnon( $expected, ...$params ) {
  83                 $specialPage = new SpecialPage( 'Watchlist', 'viewmywatchlist' );
  84
  85                 $user = User::newFromId( 0 );
  86                 $specialPage->getContext()->setUser( $user );
  87                 $specialPage->getContext()->setLanguage(
  88                         $this->getServiceContainer()->getLanguageFactory()->getLanguage( 'en' ) );
  89
  90                 $this->expectException( UserNotLoggedIn::class );
  91                 $this->expectExceptionMessage( $expected );
  92
  93                 $specialPage->requireLogin( ...$params );
  94         }
  95
  96         public static function requireLoginAnonProvider() {
  97                 $lang = 'en';
  98
  99                 $expected1 = wfMessage( 'exception-nologin-text' )->inLanguage( $lang )->text();
 100                 $expected2 = wfMessage( 'about' )->inLanguage( $lang )->text();
 101
 102                 return [
 103                         [ $expected1 ],
 104                         [ $expected2, 'about' ],
 105                         [ $expected2, 'about', 'about' ],
 106                 ];
 107         }
 108
 109         public function testRequireLoginNotAnon() {
 110                 $specialPage = new SpecialPage( 'Watchlist', 'viewmywatchlist' );
 111
 112                 $user = $this->getTestSysop()->getUser();
 113                 $specialPage->getContext()->setUser( $user );
 114
 115                 $specialPage->requireLogin();
 116
 117                 // no exception thrown, logged in use can access special page
 118                 $this->assertTrue( true );
 119         }
 120
 121         /**
 122          * @dataProvider provideRequireNamedUserAnon
 123          */
 124         public function testRequireNamedUserAnon( $expected, ...$params ) {
 125                 $specialPage = new SpecialPage( 'Watchlist', 'viewmywatchlist' );
 126
 127                 $user = User::newFromId( 0 );
 128                 $specialPage->getContext()->setUser( $user );
 129                 $specialPage->getContext()->setLanguage(
 130                         $this->getServiceContainer()->getLanguageFactory()->getLanguage( 'en' ) );
 131
 132                 $this->expectException( UserNotLoggedIn::class );
 133                 $this->expectExceptionMessage( $expected );
 134
 135                 $specialPage->requireLogin( ...$params );
 136         }
 137
 138         public static function provideRequireNamedUserAnon() {
 139                 $lang = 'en';
 140
 141                 $expected1 = wfMessage( 'exception-nologin-text' )->inLanguage( $lang )->text();
 142                 $expected2 = wfMessage( 'about' )->inLanguage( $lang )->text();
 143
 144                 return [
 145                         [ $expected1 ],
 146                         [ $expected2, 'about' ],
 147                         [ $expected2, 'about', 'about' ],
 148                 ];
 149         }
 150
 151         public function testRequireNamedUserForTempUser() {
 152                 $this->enableAutoCreateTempUser();
 153                 $specialPage = new SpecialPage( 'Watchlist', 'viewmywatchlist' );
 154
 155                 $user = $this->getServiceContainer()->getTempUserCreator()->create( null, new FauxRequest() )->getUser();
 156                 $specialPage->getContext()->setUser( $user );
 157
 158                 $this->expectException( UserNotLoggedIn::class );
 159                 $specialPage->requireNamedUser();
 160         }
 161
 162         public function testRequireNamedUserForNamedUser() {
 163                 $specialPage = new SpecialPage( 'Watchlist', 'viewmywatchlist' );
 164
 165                 $user = $this->getTestSysop()->getUser();
 166                 $specialPage->getContext()->setUser( $user );
 167
 168                 $specialPage->requireNamedUser();
 169
 170                 // no exception thrown, so the test passes.
 171                 $this->assertTrue( true );
 172         }
 173 }