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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<?php
namespace MediaWiki\Tests\ResourceLoader;
use Generator;
use MediaWiki\Config\HashConfig;
use MediaWiki\MainConfigNames;
use MediaWiki\Message\Message;
use MediaWiki\Request\FauxRequest;
use MediaWiki\Request\WebRequest;
use MediaWiki\ResourceLoader\Context;
use MediaWiki\ResourceLoader\ResourceLoader;
use MediaWiki\User\User;
use MediaWikiCoversValidator;
use MediaWikiTestCaseTrait;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
/**
* See also:
* - ImageModuleTest::testContext
*
* @group ResourceLoader
* @covers \MediaWiki\ResourceLoader\Context
*/
class ContextTest extends TestCase {
use MediaWikiCoversValidator;
use MediaWikiTestCaseTrait;
protected static function getResourceLoader() {
return new EmptyResourceLoader( new HashConfig( [
MainConfigNames::ResourceLoaderDebug => false,
MainConfigNames::LoadScript => '/w/load.php',
] ) );
}
public function testEmpty() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
// Request parameters
$this->assertEquals( [], $ctx->getModules() );
$this->assertEquals( 'qqx', $ctx->getLanguage() );
$this->assertSame( 0, $ctx->getDebug() );
$this->assertNull( $ctx->getOnly() );
$this->assertEquals( 'fallback', $ctx->getSkin() );
$this->assertNull( $ctx->getUser() );
$this->assertNull( $ctx->getContentOverrideCallback() );
// Misc
$this->assertEquals( 'ltr', $ctx->getDirection() );
$this->assertEquals( 'qqx|fallback|0|||||||', $ctx->getHash() );
$this->assertSame( [], $ctx->getReqBase() );
$this->assertInstanceOf( User::class, $ctx->getUserObj() );
$this->assertNull( $ctx->getUserIdentity() );
}
public function testDummy() {
$this->assertInstanceOf(
Context::class,
Context::newDummyContext()
);
}
public function testAccessors() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
$this->assertInstanceOf( ResourceLoader::class, $ctx->getResourceLoader() );
$this->assertInstanceOf( WebRequest::class, $ctx->getRequest() );
$this->assertInstanceOf( LoggerInterface::class, $ctx->getLogger() );
}
public function testTypicalRequest() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [
'debug' => 'false',
'lang' => 'zh',
'modules' => 'foo|foo.quux,baz,bar|baz.quux',
'only' => 'styles',
'skin' => 'fallback',
] ) );
// Request parameters
$this->assertEquals(
[ 'foo', 'foo.quux', 'foo.baz', 'foo.bar', 'baz.quux' ],
$ctx->getModules()
);
$this->assertSame( 0, $ctx->getDebug() );
$this->assertEquals( 'zh', $ctx->getLanguage() );
$this->assertEquals( 'styles', $ctx->getOnly() );
$this->assertEquals( 'fallback', $ctx->getSkin() );
$this->assertNull( $ctx->getUser() );
// Misc
$this->assertEquals( 'ltr', $ctx->getDirection() );
$this->assertEquals( 'zh|fallback|0||styles|||||', $ctx->getHash() );
$this->assertSame( [ 'lang' => 'zh' ], $ctx->getReqBase() );
}
public static function provideDirection() {
yield 'LTR language' => [
[ 'lang' => 'en' ],
'ltr',
];
yield 'RTL language' => [
[ 'lang' => 'he' ],
'rtl',
];
yield 'explicit LTR' => [
[ 'lang' => 'he', 'dir' => 'ltr' ],
'ltr',
];
yield 'explicit RTL' => [
[ 'lang' => 'en', 'dir' => 'rtl' ],
'rtl',
];
// Not supported, but tested to cover the case and detect change
yield 'invalid dir' => [
[ 'lang' => 'he', 'dir' => 'xyz' ],
'rtl',
];
}
/**
* @dataProvider provideDirection
*/
public function testDirection( array $params, $expected ) {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( $params ) );
$this->assertEquals( $expected, $ctx->getDirection() );
}
public function testShouldInclude() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
$this->assertTrue( $ctx->shouldIncludeScripts(), 'Scripts in combined' );
$this->assertTrue( $ctx->shouldIncludeStyles(), 'Styles in combined' );
$this->assertTrue( $ctx->shouldIncludeMessages(), 'Messages in combined' );
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [
'only' => 'styles'
] ) );
$this->assertFalse( $ctx->shouldIncludeScripts(), 'Scripts not in styles-only' );
$this->assertTrue( $ctx->shouldIncludeStyles(), 'Styles in styles-only' );
$this->assertFalse( $ctx->shouldIncludeMessages(), 'Messages not in styles-only' );
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [
'only' => 'scripts'
] ) );
$this->assertTrue( $ctx->shouldIncludeScripts(), 'Scripts in scripts-only' );
$this->assertFalse( $ctx->shouldIncludeStyles(), 'Styles not in scripts-only' );
$this->assertFalse( $ctx->shouldIncludeMessages(), 'Messages not in scripts-only' );
}
public function testGetUser() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
$this->assertSame( null, $ctx->getUser() );
$this->assertFalse( $ctx->getUserObj()->isRegistered() );
$this->assertNull( $ctx->getUserIdentity() );
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [
'user' => 'Example'
] ) );
$this->assertSame( 'Example', $ctx->getUser() );
$this->assertEquals( 'Example', $ctx->getUserObj()->getName() );
$this->assertEquals( 'Example', $ctx->getUserIdentity()->getName() );
}
public function testMsg() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [
'lang' => 'en'
] ) );
$msg = $ctx->msg( 'mainpage' );
$this->assertInstanceOf( Message::class, $msg );
$this->assertSame( 'Main Page', $msg->useDatabase( false )->plain() );
}
public function testEncodeJson() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
$json = $ctx->encodeJson( [ 'x' => 'A' ] );
$this->assertSame( '{"x":"A"}', $json );
// Regression: https://phabricator.wikimedia.org/T329330
$json = @$ctx->encodeJson( [
'x' => 'A',
'y' => "Foo\x80\xf0Bar",
'z' => 'C',
] );
$this->assertSame( '{"x":"A","y":null,"z":"C"}', $json, 'Ignore invalid UTF-8' );
}
public function testEncodeJsonWarning() {
$ctx = new Context( self::getResourceLoader(), new FauxRequest( [] ) );
$this->expectPHPError(
E_USER_WARNING,
static function () use ( $ctx ) {
$ctx->encodeJson( [
'x' => 'A',
'y' => "Foo\x80\xf0Bar",
'z' => 'C',
] );
},
'encodeJson partially failed: Malformed UTF-8'
);
}
public static function skinsProvider(): Generator {
// expected skin, supplied skin, installed skins
yield 'keep validated' => [
'example',
[ 'skin' => 'example' ],
[ 'example', 'foo', 'bar' ]
];
yield 'fallback invalid' => [
'fallback',
[ 'skin' => 'not-example' ],
[ 'example', 'foo', 'bar' ]
];
yield 'keep anything without validation' => [
'not-example',
[ 'skin' => 'not-example' ],
null
];
}
/**
* @dataProvider skinsProvider
*/
public function testContextWithSkinsValidation(
string $expectedSkin, array $suppliedSkin, ?array $installedSkins
) {
$context = new Context(
self::getResourceLoader(), new FauxRequest( $suppliedSkin ), $installedSkins
);
$this->assertSame( $expectedSkin, $context->getSkin() );
}
}
|
