summaryrefslogtreecommitdiff
path: root/tests/phpunit/includes/parser/MagicVariableTest.php
blob: 31645313b9898a21d0c6b32855b76ac0971db68e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<?php
/**
 * This file is intended to test magic variables in the parser
 * It was inspired by Raymond & Matěj Grabovský commenting about r66200
 *
 * As of february 2011, it only tests some revisions and date related
 * magic variables.
 *
 * @author Antoine Musso
 * @copyright Copyright © 2011, Antoine Musso
 * @file
 */

/** */
class MagicVariableTest extends MediaWikiTestCase {
	/** Will contains a parser object*/
	private $testParser = null;

	/**
	 * An array of magicword returned as type integer by the parser
	 * They are usually returned as a string for i18n since we support
	 * persan numbers for example, but some magic explicitly return
	 * them as integer.
	 * @see MagicVariableTest::assertMagic()
	 */
	private $expectedAsInteger = array(
		'revisionday',
		'revisionmonth1',
	);

	/** setup a basic parser object */
	function setUp() {
		global $wgContLang;
		$wgContLang = Language::factory( 'en' );

		$this->testParser = new Parser();
		$this->testParser->Options( new ParserOptions() );

		# initialize parser output
		$this->testParser->clearState();

		# Needs a title to do magic word stuff
		$title = Title::newFromText( 'Tests' );
		$title->mRedirect = false; # Else it needs a db connection just to check if it's a redirect (when deciding the page language)

		$this->testParser->setTitle( $title );
	}

	/** destroy parser (TODO: is it really neded?)*/
	function tearDown() {
		unset( $this->testParser );
	}

	############### TESTS #############################################
	# @todo FIXME:
	#  - those got copy pasted, we can probably make them cleaner
	#  - tests are lacking useful messages

	# day

	/** @dataProvider MediaWikiProvide::Days */
	function testCurrentdayIsUnPadded( $day ) {
		$this->assertUnPadded( 'currentday', $day );
	}
	/** @dataProvider MediaWikiProvide::Days */
	function testCurrentdaytwoIsZeroPadded( $day ) {
		$this->assertZeroPadded( 'currentday2', $day );
	}
	/** @dataProvider MediaWikiProvide::Days */
	function testLocaldayIsUnPadded( $day ) {
		$this->assertUnPadded( 'localday', $day );
	}
	/** @dataProvider MediaWikiProvide::Days */
	function testLocaldaytwoIsZeroPadded( $day ) {
		$this->assertZeroPadded( 'localday2', $day );
	}
	
	# month

	/** @dataProvider MediaWikiProvide::Months */
	function testCurrentmonthIsZeroPadded( $month ) {
		$this->assertZeroPadded( 'currentmonth', $month );
	}
	/** @dataProvider MediaWikiProvide::Months */
	function testCurrentmonthoneIsUnPadded( $month ) {
		$this->assertUnPadded( 'currentmonth1', $month );
	}
	/** @dataProvider MediaWikiProvide::Months */
	function testLocalmonthIsZeroPadded( $month ) {
		$this->assertZeroPadded( 'localmonth', $month );
	}
	/** @dataProvider MediaWikiProvide::Months */
	function testLocalmonthoneIsUnPadded( $month ) {
		$this->assertUnPadded( 'localmonth1', $month );
	}


	# revision day

	/** @dataProvider MediaWikiProvide::Days */
	function testRevisiondayIsUnPadded( $day ) {
		$this->assertUnPadded( 'revisionday', $day );
	}
	/** @dataProvider MediaWikiProvide::Days */
	function testRevisiondaytwoIsZeroPadded( $day ) {
		$this->assertZeroPadded( 'revisionday2', $day );
	}
	
	# revision month

	/** @dataProvider MediaWikiProvide::Months */
	function testRevisionmonthIsZeroPadded( $month ) {
		$this->assertZeroPadded( 'revisionmonth', $month );
	}
	/** @dataProvider MediaWikiProvide::Months */
	function testRevisionmonthoneIsUnPadded( $month ) {
		$this->assertUnPadded( 'revisionmonth1', $month );
	}

	/**
	 * Rough tests for {{SERVERNAME}} magic word
	 * Bug 31176
	 */
	function testServernameFromDifferentProtocols() {
		global $wgServer;
		$saved_wgServer= $wgServer;

		$wgServer = 'http://localhost/';
		$this->assertMagic( 'localhost', 'servername' );
		$wgServer = 'https://localhost/';
		$this->assertMagic( 'localhost', 'servername' );
		$wgServer = '//localhost/';  # bug 31176
		$this->assertMagic( 'localhost', 'servername' );

		$wgServer = $saved_wgServer;
	}

	############### HELPERS ############################################

	/** assertion helper expecting a magic output which is zero padded */
	PUBLIC function assertZeroPadded( $magic, $value ) {
		$this->assertMagicPadding( $magic, $value, '%02d' );
	}

	/** assertion helper expecting a magic output which is unpadded */
	PUBLIC function assertUnPadded( $magic, $value ) {
		$this->assertMagicPadding( $magic, $value, '%d' );
	}

	/**
	 * Main assertion helper for magic variables padding
	 * @param $magic string Magic variable name 
	 * @param $value mixed Month or day
	 * @param $format string sprintf format for $value 
	 */
	private function assertMagicPadding( $magic, $value, $format ) {
		# Initialize parser timestamp as year 2010 at 12h34 56s.
		# month and day are given by the caller ($value). Month < 12!
		if( $value > 12 ) { $month = $value % 12; }
		else { $month = $value; }
	
		$this->setParserTS(
			sprintf( '2010%02d%02d123456', $month, $value )
		);

		# please keep the following commented line of code. It helps debugging.	
		//print "\nDEBUG (value $value):" . sprintf( '2010%02d%02d123456', $value, $value ) . "\n";

		# format expectation and test it
		$expected = sprintf( $format, $value );
		$this->assertMagic( $expected, $magic ); 
	}

	/** helper to set the parser timestamp and revision timestamp */
	private function setParserTS( $ts ) {
		$this->testParser->Options()->setTimestamp( $ts );
		$this->testParser->mRevisionTimestamp = $ts;
	}

	/**
	 * Assertion helper to test a magic variable output
	 */
	private function assertMagic( $expected, $magic ) {
		if( in_array( $magic, $this->expectedAsInteger ) ) {
			$expected = (int) $expected;
		}

		# Generate a message for the assertion
		$msg = sprintf( "Magic %s should be <%s:%s>",
			$magic,
			$expected,
			gettype( $expected )
		);

		$this->assertSame(
			$expected,
			$this->testParser->getVariableValue( $magic ),
			$msg
		);
	}
}