tests/phpunit/includes/changes/RCCacheEntryFactoryTest.php

   1 <?php
   2
   3 /**
   4  * @covers RCCacheEntryFactory
   5  *
   6  * @group Database
   7  *
   8  * @licence GNU GPL v2+
   9  * @author Katie Filbert < aude.wiki@gmail.com >
  10  */
  11 class RCCacheEntryFactoryTest extends MediaWikiLangTestCase {
  12
  13         /**
  14          * @var TestRecentChangesHelper
  15          */
  16         private $testRecentChangesHelper;
  17
  18         public function __construct( $name = null, array $data = array(), $dataName = '' ) {
  19                 parent::__construct( $name, $data, $dataName );
  20
  21                 $this->testRecentChangesHelper = new TestRecentChangesHelper();
  22         }
  23
  24         protected function setUp() {
  25                 parent::setUp();
  26
  27                 $this->setMwGlobals( array(
  28                         'wgArticlePath' => '/wiki/$1'
  29                 ) );
  30         }
  31
  32         /**
  33          * @dataProvider editChangeProvider
  34          */
  35         public function testNewFromRecentChange( $expected, $context, $messages,
  36                 $recentChange, $watched
  37         ) {
  38                 $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
  39                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );
  40
  41                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
  42
  43                 $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
  44                 $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
  45                 $this->assertEquals(
  46                         $expected['numberofWatchingusers'], $cacheEntry->numberofWatchingusers,
  47                         'watching users'
  48                 );
  49                 $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );
  50
  51                 $this->assertUserLinks( 'TestRecentChangesUser', $cacheEntry );
  52                 $this->assertTitleLink( 'Xyz', $cacheEntry );
  53
  54                 $this->assertQueryLink( 'cur', $expected['cur'], $cacheEntry->curlink, 'cur link' );
  55                 $this->assertQueryLink( 'prev', $expected['diff'], $cacheEntry->lastlink, 'prev link' );
  56                 $this->assertQueryLink( 'diff', $expected['diff'], $cacheEntry->difflink, 'diff link' );
  57         }
  58
  59         public function editChangeProvider() {
  60                 return array(
  61                         array(
  62                                 array(
  63                                         'title' => 'Xyz',
  64                                         'user' => 'TestRecentChangesUser',
  65                                         'diff' => array( 'curid' => 5, 'diff' => 191, 'oldid' => 190 ),
  66                                         'cur' => array( 'curid' => 5, 'diff' => 0, 'oldid' => 191 ),
  67                                         'timestamp' => '21:21',
  68                                         'numberofWatchingusers' => 0,
  69                                         'unpatrolled' => false
  70                                 ),
  71                                 $this->getContext(),
  72                                 $this->getMessages(),
  73                                 $this->testRecentChangesHelper->makeEditRecentChange(
  74                                         $this->getTestUser(),
  75                                         'Xyz',
  76                                         5, // curid
  77                                         191, // thisid
  78                                         190, // lastid
  79                                         '20131103212153',
  80                                         0, // counter
  81                                         0 // number of watching users
  82                                 ),
  83                                 false
  84                         )
  85                 );
  86         }
  87
  88         /**
  89          * @dataProvider deleteChangeProvider
  90          */
  91         public function testNewForDeleteChange( $expected, $context, $messages, $recentChange, $watched ) {
  92                 $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
  93                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );
  94
  95                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
  96
  97                 $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
  98                 $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
  99                 $this->assertEquals(
 100                         $expected['numberofWatchingusers'],
 101                         $cacheEntry->numberofWatchingusers, 'watching users'
 102                 );
 103                 $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );
 104
 105                 $this->assertDeleteLogLink( $cacheEntry );
 106                 $this->assertUserLinks( 'TestRecentChangesUser', $cacheEntry );
 107
 108                 $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
 109                 $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
 110                 $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
 111         }
 112
 113         public function deleteChangeProvider() {
 114                 return array(
 115                         array(
 116                                 array(
 117                                         'title' => 'Abc',
 118                                         'user' => 'TestRecentChangesUser',
 119                                         'timestamp' => '21:21',
 120                                         'numberofWatchingusers' => 0,
 121                                         'unpatrolled' => false
 122                                 ),
 123                                 $this->getContext(),
 124                                 $this->getMessages(),
 125                                 $this->testRecentChangesHelper->makeLogRecentChange(
 126                                         'delete',
 127                                         $this->getTestUser(),
 128                                         'Abc',
 129                                         '20131103212153',
 130                                         0, // counter
 131                                         0 // number of watching users
 132                                 ),
 133                                 false
 134                         )
 135                 );
 136         }
 137
 138         /**
 139          * @dataProvider revUserDeleteProvider
 140          */
 141         public function testNewForRevUserDeleteChange( $expected, $context, $messages,
 142                 $recentChange, $watched
 143         ) {
 144                 $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
 145                 $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );
 146
 147                 $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );
 148
 149                 $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
 150                 $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
 151                 $this->assertEquals(
 152                         $expected['numberofWatchingusers'],
 153                         $cacheEntry->numberofWatchingusers, 'watching users'
 154                 );
 155                 $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );
 156
 157                 $this->assertRevDel( $cacheEntry );
 158                 $this->assertTitleLink( 'Zzz', $cacheEntry );
 159
 160                 $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
 161                 $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
 162                 $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
 163         }
 164
 165         public function revUserDeleteProvider() {
 166                 return array(
 167                         array(
 168                                 array(
 169                                         'title' => 'Zzz',
 170                                         'user' => 'TestRecentChangesUser',
 171                                         'diff' => '',
 172                                         'cur' => '',
 173                                         'timestamp' => '21:21',
 174                                         'numberofWatchingusers' => 0,
 175                                         'unpatrolled' => false
 176                                 ),
 177                                 $this->getContext(),
 178                                 $this->getMessages(),
 179                                 $this->testRecentChangesHelper->makeDeletedEditRecentChange(
 180                                         $this->getTestUser(),
 181                                         'Zzz',
 182                                         '20131103212153',
 183                                         191, // thisid
 184                                         190, // lastid
 185                                         '20131103212153',
 186                                         0, // counter
 187                                         0 // number of watching users
 188                                 ),
 189                                 false
 190                         )
 191                 );
 192         }
 193
 194         private function assertUserLinks( $user, $cacheEntry ) {
 195                 $this->assertTag(
 196                         array(
 197                                 'tag' => 'a',
 198                                 'attributes' => array(
 199                                         'class' => 'new mw-userlink'
 200                                 ),
 201                                 'content' => $user
 202                         ),
 203                         $cacheEntry->userlink,
 204                         'verify user link'
 205                 );
 206
 207                 $this->assertTag(
 208                         array(
 209                                 'tag' => 'span',
 210                                 'attributes' => array(
 211                                         'class' => 'mw-usertoollinks'
 212                                 ),
 213                                 'child' => array(
 214                                         'tag' => 'a',
 215                                         'content' => 'Talk',
 216                                 )
 217                         ),
 218                         $cacheEntry->usertalklink,
 219                         'verify user talk link'
 220                 );
 221
 222                 $this->assertTag(
 223                         array(
 224                                 'tag' => 'span',
 225                                 'attributes' => array(
 226                                         'class' => 'mw-usertoollinks'
 227                                 ),
 228                                 'child' => array(
 229                                         'tag' => 'a',
 230                                         'content' => 'contribs',
 231                                 )
 232                         ),
 233                         $cacheEntry->usertalklink,
 234                         'verify user tool links'
 235                 );
 236         }
 237
 238         private function assertDeleteLogLink( $cacheEntry ) {
 239                 $this->assertTag(
 240                         array(
 241                                 'tag' => 'a',
 242                                 'attributes' => array(
 243                                         'href' => '/wiki/Special:Log/delete',
 244                                         'title' => 'Special:Log/delete'
 245                                 ),
 246                                 'content' => 'Deletion log'
 247                         ),
 248                         $cacheEntry->link,
 249                         'verify deletion log link'
 250                 );
 251         }
 252
 253         private function assertRevDel( $cacheEntry ) {
 254                 $this->assertTag(
 255                         array(
 256                                 'tag' => 'span',
 257                                 'attributes' => array(
 258                                         'class' => 'history-deleted'
 259                                 ),
 260                                 'content' => '(username removed)'
 261                         ),
 262                         $cacheEntry->userlink,
 263                         'verify user link for change with deleted revision and user'
 264                 );
 265         }
 266
 267         private function assertTitleLink( $title, $cacheEntry ) {
 268                 $this->assertTag(
 269                         array(
 270                                 'tag' => 'a',
 271                                 'attributes' => array(
 272                                         'href' => '/wiki/' . $title,
 273                                         'title' => $title
 274                                 ),
 275                                 'content' => $title
 276                         ),
 277                         $cacheEntry->link,
 278                         'verify title link'
 279                 );
 280         }
 281
 282         private function assertQueryLink( $content, $params, $link ) {
 283                 $this->assertTag(
 284                         array(
 285                                 'tag' => 'a',
 286                                 'content' => $content
 287                         ),
 288                         $link,
 289                         'assert query link element'
 290                 );
 291
 292                 foreach ( $params as $key => $value ) {
 293                         $this->assertRegExp( '/' . $key . '=' . $value . '/', $link, "verify $key link params" );
 294                 }
 295         }
 296
 297         private function getMessages() {
 298                 return array(
 299                         'cur' => 'cur',
 300                         'diff' => 'diff',
 301                         'hist' => 'hist',
 302                         'enhancedrc-history' => 'history',
 303                         'last' => 'prev',
 304                         'blocklink' => 'block',
 305                         'history' => 'Page history',
 306                         'semicolon-separator' => '; ',
 307                         'pipe-separator' => ' | '
 308                 );
 309         }
 310
 311         private function getTestUser() {
 312                 $user = User::newFromName( 'TestRecentChangesUser' );
 313
 314                 if ( !$user->getId() ) {
 315                         $user->addToDatabase();
 316                 }
 317
 318                 return $user;
 319         }
 320
 321         private function getContext() {
 322                 $user = $this->getTestUser();
 323                 $context = $this->testRecentChangesHelper->getTestContext( $user );
 324
 325                 $title = Title::newFromText( 'RecentChanges', NS_SPECIAL );
 326                 $context->setTitle( $title );
 327
 328                 return $context;
 329         }
 330 }