tests/phpunit/includes/parser/MagicVariableTest.php

   1 <?php
   2 /**
   3  * This file is intended to test magic variables in the parser
   4  * It was inspired by Raymond & Matěj Grabovský commenting about r66200
   5  *
   6  * As of february 2011, it only tests some revisions and date related
   7  * magic variables.
   8  *
   9  * @author Antoine Musso
  10  * @copyright Copyright © 2011, Antoine Musso
  11  * @file
  12  */
  13
  14 /** */
  15 class MagicVariableTest extends MediaWikiTestCase {
  16         /** Will contains a parser object*/
  17         private $testParser = null;
  18
  19         /**
  20          * An array of magicword returned as type integer by the parser
  21          * They are usually returned as a string for i18n since we support
  22          * persan numbers for example, but some magic explicitly return
  23          * them as integer.
  24          * @see MagicVariableTest::assertMagic()
  25          */
  26         private $expectedAsInteger = array(
  27                 'revisionday',
  28                 'revisionmonth1',
  29         );
  30
  31         /** setup a basic parser object */
  32         protected function setUp() {
  33                 parent::setUp();
  34
  35                 $contLang = Language::factory( 'en' );
  36                 $this->setMwGlobals( array(
  37                         'wgLanguageCode' => 'en',
  38                         'wgContLang' => $contLang,
  39                 ) );
  40
  41                 $this->testParser = new Parser();
  42                 $this->testParser->Options( ParserOptions::newFromUserAndLang( new User, $contLang ) );
  43
  44                 # initialize parser output
  45                 $this->testParser->clearState();
  46
  47                 # Needs a title to do magic word stuff
  48                 $title = Title::newFromText( 'Tests' );
  49                 $title->mRedirect = false; # Else it needs a db connection just to check if it's a redirect (when deciding the page language)
  50
  51                 $this->testParser->setTitle( $title );
  52         }
  53
  54         /** destroy parser (TODO: is it really neded?)*/
  55         protected function tearDown() {
  56                 unset( $this->testParser );
  57
  58                 parent::tearDown();
  59         }
  60
  61         ############### TESTS #############################################
  62         # @todo FIXME:
  63         #  - those got copy pasted, we can probably make them cleaner
  64         #  - tests are lacking useful messages
  65
  66         # day
  67
  68         /** @dataProvider MediaWikiProvide::Days */
  69         function testCurrentdayIsUnPadded( $day ) {
  70                 $this->assertUnPadded( 'currentday', $day );
  71         }
  72
  73         /** @dataProvider MediaWikiProvide::Days */
  74         function testCurrentdaytwoIsZeroPadded( $day ) {
  75                 $this->assertZeroPadded( 'currentday2', $day );
  76         }
  77
  78         /** @dataProvider MediaWikiProvide::Days */
  79         function testLocaldayIsUnPadded( $day ) {
  80                 $this->assertUnPadded( 'localday', $day );
  81         }
  82
  83         /** @dataProvider MediaWikiProvide::Days */
  84         function testLocaldaytwoIsZeroPadded( $day ) {
  85                 $this->assertZeroPadded( 'localday2', $day );
  86         }
  87
  88         # month
  89
  90         /** @dataProvider MediaWikiProvide::Months */
  91         function testCurrentmonthIsZeroPadded( $month ) {
  92                 $this->assertZeroPadded( 'currentmonth', $month );
  93         }
  94
  95         /** @dataProvider MediaWikiProvide::Months */
  96         function testCurrentmonthoneIsUnPadded( $month ) {
  97                 $this->assertUnPadded( 'currentmonth1', $month );
  98         }
  99
 100         /** @dataProvider MediaWikiProvide::Months */
 101         function testLocalmonthIsZeroPadded( $month ) {
 102                 $this->assertZeroPadded( 'localmonth', $month );
 103         }
 104
 105         /** @dataProvider MediaWikiProvide::Months */
 106         function testLocalmonthoneIsUnPadded( $month ) {
 107                 $this->assertUnPadded( 'localmonth1', $month );
 108         }
 109
 110
 111         # revision day
 112
 113         /** @dataProvider MediaWikiProvide::Days */
 114         function testRevisiondayIsUnPadded( $day ) {
 115                 $this->assertUnPadded( 'revisionday', $day );
 116         }
 117
 118         /** @dataProvider MediaWikiProvide::Days */
 119         function testRevisiondaytwoIsZeroPadded( $day ) {
 120                 $this->assertZeroPadded( 'revisionday2', $day );
 121         }
 122
 123         # revision month
 124
 125         /** @dataProvider MediaWikiProvide::Months */
 126         function testRevisionmonthIsZeroPadded( $month ) {
 127                 $this->assertZeroPadded( 'revisionmonth', $month );
 128         }
 129
 130         /** @dataProvider MediaWikiProvide::Months */
 131         function testRevisionmonthoneIsUnPadded( $month ) {
 132                 $this->assertUnPadded( 'revisionmonth1', $month );
 133         }
 134
 135         /**
 136          * Rough tests for {{SERVERNAME}} magic word
 137          * Bug 31176
 138          * @group Database
 139          * @dataProvider dataServernameFromDifferentProtocols
 140          */
 141         function testServernameFromDifferentProtocols( $server ) {
 142                 $this->setMwGlobals( 'wgServer', $server );
 143
 144                 $this->assertMagic( 'localhost', 'servername' );
 145         }
 146
 147         function dataServernameFromDifferentProtocols() {
 148                 return array(
 149                         array( 'http://localhost/' ),
 150                         array( 'https://localhost/' ),
 151                         array( '//localhost/' ), # bug 31176
 152                 );
 153         }
 154
 155         ############### HELPERS ############################################
 156
 157         /** assertion helper expecting a magic output which is zero padded */
 158         PUBLIC function assertZeroPadded( $magic, $value ) {
 159                 $this->assertMagicPadding( $magic, $value, '%02d' );
 160         }
 161
 162         /** assertion helper expecting a magic output which is unpadded */
 163         PUBLIC function assertUnPadded( $magic, $value ) {
 164                 $this->assertMagicPadding( $magic, $value, '%d' );
 165         }
 166
 167         /**
 168          * Main assertion helper for magic variables padding
 169          * @param $magic string Magic variable name
 170          * @param $value mixed Month or day
 171          * @param $format string sprintf format for $value
 172          */
 173         private function assertMagicPadding( $magic, $value, $format ) {
 174                 # Initialize parser timestamp as year 2010 at 12h34 56s.
 175                 # month and day are given by the caller ($value). Month < 12!
 176                 if ( $value > 12 ) {
 177                         $month = $value % 12;
 178                 } else {
 179                         $month = $value;
 180                 }
 181
 182                 $this->setParserTS(
 183                         sprintf( '2010%02d%02d123456', $month, $value )
 184                 );
 185
 186                 # please keep the following commented line of code. It helps debugging.
 187                 //print "\nDEBUG (value $value):" . sprintf( '2010%02d%02d123456', $value, $value ) . "\n";
 188
 189                 # format expectation and test it
 190                 $expected = sprintf( $format, $value );
 191                 $this->assertMagic( $expected, $magic );
 192         }
 193
 194         /** helper to set the parser timestamp and revision timestamp */
 195         private function setParserTS( $ts ) {
 196                 $this->testParser->Options()->setTimestamp( $ts );
 197                 $this->testParser->mRevisionTimestamp = $ts;
 198         }
 199
 200         /**
 201          * Assertion helper to test a magic variable output
 202          */
 203         private function assertMagic( $expected, $magic ) {
 204                 if ( in_array( $magic, $this->expectedAsInteger ) ) {
 205                         $expected = (int)$expected;
 206                 }
 207
 208                 # Generate a message for the assertion
 209                 $msg = sprintf( "Magic %s should be <%s:%s>",
 210                         $magic,
 211                         $expected,
 212                         gettype( $expected )
 213                 );
 214
 215                 $this->assertSame(
 216                         $expected,
 217                         $this->testParser->getVariableValue( $magic ),
 218                         $msg
 219                 );
 220         }
 221 }