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
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Testing
*/
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
use PHPUnit\Framework\Exception;
use PHPUnit\Framework\TestCase;
use Wikimedia\ObjectFactory;
/**
* Base class for unit tests.
*
* Extend this class if you are testing classes which use dependency injection and do not access
* global functions, variables, services or a storage backend.
*
* @since 1.34
*/
abstract class MediaWikiUnitTestCase extends TestCase {
use MediaWikiCoversValidator;
use MediaWikiTestCaseTrait;
private static $originalGlobals;
private static $unitGlobals;
private static $temporaryHooks;
/**
* Whitelist of globals to allow in MediaWikiUnitTestCase.
*
* Please, keep this list to the bare minimum.
*
* @return string[]
*/
private static function getGlobalsWhitelist() {
return [
// The autoloader may change between bootstrap and the first test,
// so (lazily) capture these here instead.
'wgAutoloadClasses',
'wgAutoloadLocalClasses',
// Need for LoggerFactory. Default is NullSpi.
'wgMWLoggerDefaultSpi',
'wgAutoloadAttemptLowercase',
'wgLegalTitleChars',
'wgDevelopmentWarnings',
];
}
public static function setUpBeforeClass() : void {
parent::setUpBeforeClass();
$reflection = new ReflectionClass( static::class );
$dirSeparator = DIRECTORY_SEPARATOR;
if ( stripos( $reflection->getFilename(), "${dirSeparator}unit${dirSeparator}" ) === false ) {
self::fail( 'This unit test needs to be in "tests/phpunit/unit"!' );
}
self::$unitGlobals =& TestSetup::$bootstrapGlobals;
foreach ( self::getGlobalsWhitelist() as $global ) {
self::$unitGlobals[ $global ] =& $GLOBALS[ $global ];
}
self::$temporaryHooks = [];
// Would be nice if we could simply replace $GLOBALS as a whole,
// but un-setting or re-assigning that breaks the reference of this magic
// variable. Thus we have to modify it in place.
self::$originalGlobals = [];
foreach ( $GLOBALS as $key => $_ ) {
// Stash current values
self::$originalGlobals[$key] =& $GLOBALS[$key];
// Remove globals not part of the snapshot (see bootstrap.php, phpunit.php).
if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$unitGlobals ) ) {
unset( $GLOBALS[$key] );
}
}
// Restore values from the early snapshot
// Not by ref because tests must not be able to modify the snapshot.
foreach ( self::$unitGlobals as $key => $value ) {
$GLOBALS[ $key ] = $value;
}
}
/**
* @inheritDoc
*/
protected function runTest() {
try {
return parent::runTest();
} catch ( ConfigException $exception ) {
throw new Exception(
'Config variables must be mocked, they cannot be accessed directly in tests which extend '
. self::class,
$exception->getCode(),
$exception
);
}
// Don't let LoggerFactory::getProvider() access globals or other things we don't want.
LoggerFactory::registerProvider( ObjectFactory::getObjectFromSpec( [
'class' => \MediaWiki\Logger\NullSpi::class
] ) );
}
protected function tearDown() : void {
// Quick reset between tests
foreach ( $GLOBALS as $key => $_ ) {
if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$unitGlobals ) ) {
unset( $GLOBALS[$key] );
}
}
foreach ( self::$unitGlobals as $key => $value ) {
$GLOBALS[ $key ] = $value;
}
self::$temporaryHooks = [];
parent::tearDown();
}
public static function tearDownAfterClass() : void {
// Remove globals created by the test
foreach ( $GLOBALS as $key => $_ ) {
if ( $key !== 'GLOBALS' && !array_key_exists( $key, self::$originalGlobals ) ) {
unset( $GLOBALS[$key] );
}
}
// Restore values (including reference!)
foreach ( self::$originalGlobals as $key => &$value ) {
$GLOBALS[ $key ] =& $value;
}
parent::tearDownAfterClass();
}
/**
* Create a temporary hook handler which will be reset by tearDown.
* @param string $hookName Hook name
* @param mixed $handler Value suitable for a hook handler
* @since 1.34
*/
protected function setTemporaryHook( $hookName, $handler ) {
// Adds handler to list of hook handlers
$hookContainer = MediaWikiServices::getInstance()->getHookContainer();
$hookToRemove = $hookContainer->scopedRegister( $hookName, $handler, true );
// Keep reference to the ScopedCallback
self::$temporaryHooks[] = $hookToRemove;
}
protected function getMockMessage( $text, ...$params ) {
if ( isset( $params[0] ) && is_array( $params[0] ) ) {
$params = $params[0];
}
$msg = $this->getMockBuilder( Message::class )
->disableOriginalConstructor()
->setMethods( [] )
->getMock();
$msg->method( 'toString' )->willReturn( $text );
$msg->method( '__toString' )->willReturn( $text );
$msg->method( 'text' )->willReturn( $text );
$msg->method( 'parse' )->willReturn( $text );
$msg->method( 'plain' )->willReturn( $text );
$msg->method( 'parseAsBlock' )->willReturn( $text );
$msg->method( 'escaped' )->willReturn( $text );
$msg->method( 'title' )->willReturn( $msg );
$msg->method( 'inLanguage' )->willReturn( $msg );
$msg->method( 'inContentLanguage' )->willReturn( $msg );
$msg->method( 'useDatabase' )->willReturn( $msg );
$msg->method( 'setContext' )->willReturn( $msg );
$msg->method( 'exists' )->willReturn( true );
$msg->method( 'content' )->willReturn( new MessageContent( $msg ) );
return $msg;
}
}
|
