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
|
<?php
namespace SMW\Tests\Integration\JSONScript;
use FauxRequest;
use Language;
use OutputPage;
use RequestContext;
use SMW\Tests\Utils\File\ContentsReader;
use SMW\Tests\Utils\Mock\MockSuperUser;
use SpecialPage;
use SpecialPageFactory;
/**
* @group semantic-mediawiki
* @group medium
*
* @license GNU GPL v2+
* @since 2.4
*
* @author mwjames
*/
class SpecialPageTestCaseProcessor extends \PHPUnit_Framework_TestCase {
/**
* @var Store
*/
private $store;
/**
* @var StringValidator
*/
private $stringValidator;
/**
* @var boolean
*/
private $debug = false;
/**
* @var string
*/
private $testCaseLocation = '';
/**
* @param Store
* @param StringValidator
*/
public function __construct( $store, $stringValidator ) {
$this->store = $store;
$this->stringValidator = $stringValidator;
}
/**
* @since 2.4
*/
public function setDebugMode( $debugMode ) {
$this->debug = $debugMode;
}
/**
* @since 3.0
*
* @param string $testCaseLocation
*/
public function setTestCaseLocation( $testCaseLocation ) {
$this->testCaseLocation = $testCaseLocation;
}
/**
* @since 2.4
*
* @param array $case
*/
public function process( array $case ) {
if ( !isset( $case['special-page'] ) ) {
return;
}
if ( isset( $case['special-page']['query-parameters'] ) ) {
$queryParameters = $case['special-page']['query-parameters'];
} else {
$queryParameters = [];
}
$text = $this->getTextForRequestBy(
SpecialPageFactory::getPage( $case['special-page']['page'] ),
new FauxRequest( $case['special-page']['request-parameters'] ),
$queryParameters
);
$this->assertOutputForCase( $case, $text );
}
private function getTextForRequestBy( $page, $request, $queryParameters ) {
$response = $request->response();
$page->setContext( $this->makeRequestContext(
$request,
new MockSuperUser,
$this->getTitle( $page )
) );
$out = $page->getOutput();
ob_start();
$page->execute( $queryParameters );
if ( $out->getRedirect() !== '' ) {
$out->output();
$text = ob_get_contents();
} elseif ( $out->isDisabled() ) {
$text = ob_get_contents();
} else {
$text = $out->getHTML();
}
ob_end_clean();
$code = $response->getStatusCode();
if ( $code > 0 ) {
$response->header( "Status: " . $code . ' ' . \HttpStatus::getMessage( $code ) );
}
return $text;
}
private function assertOutputForCase( $case, $text ) {
// Avoid issue with \r carriage return and \n new line
$text = str_replace( "\r\n", "\n", $text );
if ( isset( $case['assert-output']['to-contain'] ) ) {
if ( isset( $case['assert-output']['to-contain']['contents-file'] ) ) {
$contents = ContentsReader::readContentsFrom(
$this->testCaseLocation . $case['assert-output']['to-contain']['contents-file']
);
} else {
$contents = $case['assert-output']['to-contain'];
}
$this->stringValidator->assertThatStringContains(
$contents,
$text,
$case['about']
);
}
if ( isset( $case['assert-output']['not-contain'] ) ) {
if ( isset( $case['assert-output']['not-contain']['contents-file'] ) ) {
$contents = ContentsReader::readContentsFrom(
$this->testCaseLocation . $case['assert-output']['not-contain']['contents-file']
);
} else {
$contents = $case['assert-output']['not-contain'];
}
$this->stringValidator->assertThatStringNotContains(
$contents,
$text,
$case['about']
);
}
}
/**
* @return RequestContext
*/
private function makeRequestContext( \WebRequest $request, $user, $title ) {
$context = new RequestContext();
$context->setRequest( $request );
$out = new OutputPage( $context );
$out->setTitle( $title );
$context->setOutput( $out );
$context->setLanguage( Language::factory( $GLOBALS['wgLanguageCode'] ) );
$user = $user === null ? new MockSuperUser() : $user;
$context->setUser( $user );
return $context;
}
/**
* Deprecated: Use of SpecialPage::getTitle was deprecated in MediaWiki 1.23
*
* @return Title
*/
private function getTitle( SpecialPage $page ) {
return method_exists( $page, 'getPageTitle') ? $page->getPageTitle() : $page->getTitle();
}
}
|
