-
Notifications
You must be signed in to change notification settings - Fork 821
/
TestSession.php
345 lines (312 loc) · 9.65 KB
/
TestSession.php
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<?php
namespace SilverStripe\Dev;
use Exception;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Cookie_Backend;
use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\HTTPResponse_Exception;
use SilverStripe\Control\Session;
use SilverStripe\Core\Extensible;
use SilverStripe\Core\Injector\Injector;
use SimpleByName;
use SimplePage;
use SimplePageBuilder;
/**
* Represents a test usage session of a web-app
* It will maintain session-state from request to request
*/
class TestSession
{
use Extensible;
/**
* @var Session
*/
private $session;
/**
* @var Cookie_Backend
*/
private $cookies;
/**
* @var HTTPResponse
*/
private $lastResponse;
/**
* Necessary to use the mock session
* created in {@link session} in the normal controller stack,
* e.g. to overwrite Security::getCurrentUser() with custom login data.
*
* @var Controller
*/
protected $controller;
/**
* Fake HTTP Referer Tracking, set in {@link get()} and {@link post()}.
*
* @var string
*/
private $lastUrl;
public function __construct()
{
$this->session = Injector::inst()->create(Session::class, []);
$this->cookies = Injector::inst()->create(Cookie_Backend::class);
$request = new HTTPRequest('GET', '/');
$request->setSession($this->session());
$this->controller = new Controller();
$this->controller->setRequest($request);
$this->controller->pushCurrent();
$this->controller->doInit();
}
public function __destruct()
{
// Shift off anything else that's on the stack. This can happen if something throws
// an exception that causes a premature TestSession::__destruct() call
while (Controller::has_curr() && Controller::curr() !== $this->controller) {
Controller::curr()->popCurrent();
}
if (Controller::has_curr()) {
$this->controller->popCurrent();
}
}
/**
* Submit a get request
*
* @uses Director::test()
* @param string $url
* @param Session $session
* @param array $headers
* @param array $cookies
* @return HTTPResponse
*/
public function get($url, $session = null, $headers = null, $cookies = null)
{
$this->extend('updateGetURL', $url, $session, $headers, $cookies);
$headers = (array) $headers;
if ($this->lastUrl && !isset($headers['Referer'])) {
$headers['Referer'] = $this->lastUrl;
}
$this->lastResponse = Director::test(
$url,
null,
$session ?: $this->session,
'GET',
null,
$headers,
$cookies ?: $this->cookies
);
$this->lastUrl = $url;
if (!$this->lastResponse) {
user_error("Director::test($url) returned null", E_USER_WARNING);
}
return $this->lastResponse;
}
/**
* Submit a post request
*
* @uses Director::test()
* @param string $url
* @param array $data
* @param array $headers
* @param Session $session
* @param string $body
* @param array $cookies
* @return HTTPResponse
* @throws HTTPResponse_Exception
*/
public function post($url, $data, $headers = null, $session = null, $body = null, $cookies = null)
{
$this->extend('updatePostURL', $url, $data, $headers, $session, $body, $cookies);
$headers = (array) $headers;
if ($this->lastUrl && !isset($headers['Referer'])) {
$headers['Referer'] = $this->lastUrl;
}
$this->lastResponse = Director::test(
$url,
$data,
$session ?: $this->session,
'POST',
$body,
$headers,
$cookies ?: $this->cookies
);
$this->lastUrl = $url;
if (!$this->lastResponse) {
user_error("Director::test($url) returned null", E_USER_WARNING);
}
return $this->lastResponse;
}
/**
* Submit a request of any type
*
* @uses Director::test()
* @param string $method
* @param string $url
* @param array $data
* @param array $headers
* @param Session $session
* @param string $body
* @param array $cookies
* @return HTTPResponse
* @throws HTTPResponse_Exception
*/
public function sendRequest($method, $url, $data, $headers = null, $session = null, $body = null, $cookies = null)
{
$this->extend('updateRequestURL', $method, $url, $data, $headers, $session, $body, $cookies);
$headers = (array) $headers;
if ($this->lastUrl && !isset($headers['Referer'])) {
$headers['Referer'] = $this->lastUrl;
}
$this->lastResponse = Director::test(
$url,
$data,
$session ?: $this->session,
$method,
$body,
$headers,
$cookies ?: $this->cookies
);
$this->lastUrl = $url;
if (!$this->lastResponse) {
user_error("Director::test($url) returned null", E_USER_WARNING);
}
return $this->lastResponse;
}
/**
* Submit the form with the given HTML ID, filling it out with the given data.
* Acts on the most recent response.
*
* Any data parameters have to be present in the form, with exact form field name
* and values, otherwise they are removed from the submission.
*
* Caution: Parameter names have to be formatted
* as they are in the form submission, not as they are interpreted by PHP.
* Wrong: array('mycheckboxvalues' => array(1 => 'one', 2 => 'two'))
* Right: array('mycheckboxvalues[1]' => 'one', 'mycheckboxvalues[2]' => 'two')
*
* @see http://www.simpletest.org/en/form_testing_documentation.html
*
* @param string $formID HTML 'id' attribute of a form (loaded through a previous response)
* @param string $button HTML 'name' attribute of the button (NOT the 'id' attribute)
* @param array $data Map of GET/POST data.
* @return HTTPResponse
* @throws Exception
*/
public function submitForm($formID, $button = null, $data = [])
{
$page = $this->lastPage();
if ($page) {
$form = $page->getFormById($formID);
if (!$form) {
user_error("TestSession::submitForm failed to find the form {$formID}");
}
foreach ($data as $k => $v) {
$form->setField(new SimpleByName($k), $v);
}
if ($button) {
$submission = $form->submitButton(new SimpleByName($button));
if (!$submission) {
throw new Exception("Can't find button '$button' to submit as part of test.");
}
} else {
$submission = $form->submit();
}
$url = Director::makeRelative($form->getAction()->asString());
$postVars = [];
parse_str($submission->_encode() ?? '', $postVars);
return $this->post($url, $postVars);
} else {
user_error("TestSession::submitForm called when there is no form loaded."
. " Visit the page with the form first", E_USER_WARNING);
}
}
/**
* If the last request was a 3xx response, then follow the redirection
*
* @return HTTPResponse The response given, or null if no redirect occurred
*/
public function followRedirection()
{
if ($this->lastResponse->getHeader('Location')) {
$url = Director::makeRelative($this->lastResponse->getHeader('Location'));
$url = strtok($url ?? '', '#');
return $this->get($url);
}
}
/**
* Returns true if the last response was a 3xx redirection
*
* @return bool
*/
public function wasRedirected()
{
$code = $this->lastResponse->getStatusCode();
return $code >= 300 && $code < 400;
}
/**
* Get the most recent response
*
* @return HTTPResponse
*/
public function lastResponse()
{
return $this->lastResponse;
}
/**
* Return the fake HTTP_REFERER; set each time get() or post() is called.
*
* @return string
*/
public function lastUrl()
{
return $this->lastUrl;
}
/**
* Get the most recent response's content
*
* @return string
*/
public function lastContent()
{
if (is_string($this->lastResponse)) {
return $this->lastResponse;
} else {
return $this->lastResponse->getBody();
}
}
/**
* Return a CSSContentParser containing the most recent response
*
* @return CSSContentParser
*/
public function cssParser()
{
return new CSSContentParser($this->lastContent());
}
/**
* Get the last response as a SimplePage object
*
* @return SimplePage The response if available
*/
public function lastPage()
{
require_once("simpletest/http.php");
require_once("simpletest/page.php");
require_once("simpletest/form.php");
$builder = new SimplePageBuilder();
if ($this->lastResponse) {
$page = &$builder->parse(new TestSession_STResponseWrapper($this->lastResponse));
$builder->free();
unset($builder);
return $page;
}
}
/**
* Get the current session, as a Session object
*
* @return Session
*/
public function session()
{
return $this->session;
}
}