Repository navigation
Expand file tree
/
Copy pathPhpBrowser.php
More file actions
299 lines (270 loc) · 8.03 KB
/
Copy pathPhpBrowser.php
File metadata and controls
299 lines (270 loc) · 8.03 KB
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
<?php
namespace Codeception\Module;
use Codeception\Exception\ModuleException;
use Codeception\Lib\InnerBrowser;
use Codeception\Lib\Interfaces\MultiSession;
use Codeception\Lib\Interfaces\Remote;
use Codeception\TestInterface;
use Codeception\Util\Uri;
use GuzzleHttp\Client as GuzzleClient;
/**
* Uses [Guzzle](http://guzzlephp.org/) to interact with your application over CURL.
* Module works over CURL and requires **PHP CURL extension** to be enabled.
*
* Use to perform web acceptance tests with non-javascript browser.
*
* If test fails stores last shown page in 'output' dir.
*
* ## Status
*
* * Maintainer: **davert**
* * Stability: **stable**
* * Contact: davert.codecept@mailican.com
* * Works with [Guzzle](http://guzzlephp.org/)
*
* *Please review the code of non-stable modules and provide patches if you have issues.*
*
* ## Configuration
*
* * url *required* - start url of your app
* * curl - curl options
* * headers - ...
* * cookies - ...
* * auth - ...
* * verify - ...
* * .. those and other [Guzzle Request options](http://docs.guzzlephp.org/en/latest/request-options.html)
*
*
* ### Example (`acceptance.suite.yml`)
*
* modules:
* enabled:
* - PhpBrowser:
* url: 'http://localhost'
* auth: ['admin', '123345']
* curl:
* CURLOPT_RETURNTRANSFER: true
* cookies:
* cookie-1:
* Name: userName
* Value: john.doe
* cookie-2:
* Name: authToken
* Value: 1abcd2345
* Domain: subdomain.domain.com
* Path: /admin/
* Expires: 1292177455
* Secure: true
* HttpOnly: false
*
*
* All SSL certification checks are disabled by default.
* Use Guzzle request options to configure certifications and others.
*
* ## Public API
*
* Those properties and methods are expected to be used in Helper classes:
*
* Properties:
*
* * `guzzle` - contains [Guzzle](http://guzzlephp.org/) client instance: `\GuzzleHttp\Client`
* * `client` - Symfony BrowserKit instance.
*
*/
class PhpBrowser extends InnerBrowser implements Remote, MultiSession
{
private $isGuzzlePsr7;
protected $requiredFields = ['url'];
protected $config = [
'verify' => false,
'expect' => false,
'timeout' => 30,
'curl' => [],
'refresh_max_interval' => 10,
// required defaults (not recommended to change)
'allow_redirects' => false,
'http_errors' => false,
'cookies' => true
];
protected $guzzleConfigFields = [
'headers',
'auth',
'proxy',
'verify',
'cert',
'query',
'ssl_key',
'proxy',
'expect',
'version',
'timeout',
'connect_timeout'
];
/**
* @var \Codeception\Lib\Connector\Guzzle6
*/
public $client;
/**
* @var GuzzleClient
*/
public $guzzle;
public function _initialize()
{
$this->client = $this->guessGuzzleConnector();
$this->_initializeSession();
}
protected function guessGuzzleConnector()
{
if (!class_exists('GuzzleHttp\Client')) {
throw new ModuleException($this, "Guzzle is not installed. Please install `guzzlehttp/guzzle` with composer");
}
if (class_exists('GuzzleHttp\Url')) {
$this->isGuzzlePsr7 = false;
return new \Codeception\Lib\Connector\Guzzle();
}
$this->isGuzzlePsr7 = true;
return new \Codeception\Lib\Connector\Guzzle6();
}
public function _before(TestInterface $test)
{
if (!$this->client) {
$this->client = $this->guessGuzzleConnector();
}
$this->_initializeSession();
}
public function _getUrl()
{
return $this->config['url'];
}
/**
* Sets the HTTP header to the passed value - which is used on
* subsequent HTTP requests through PhpBrowser.
*
* Example:
* ```php
* <?php
* $I->setHeader('X-Requested-With', 'Codeception');
* $I->amOnPage('test-headers.php');
* ?>
* ```
*
* @param string $name the name of the request header
* @param string $value the value to set it to for subsequent
* requests
*/
public function setHeader($name, $value)
{
$this->client->setHeader($name, $value);
}
/**
* Deletes the header with the passed name. Subsequent requests
* will not have the deleted header in its request.
*
* Example:
* ```php
* <?php
* $I->setHeader('X-Requested-With', 'Codeception');
* $I->amOnPage('test-headers.php');
* // ...
* $I->deleteHeader('X-Requested-With');
* $I->amOnPage('some-other-page.php');
* ?>
* ```
*
* @param string $name the name of the header to delete.
*/
public function deleteHeader($name)
{
$this->client->deleteHeader($name);
}
public function amHttpAuthenticated($username, $password)
{
$this->client->setAuth($username, $password);
}
public function amOnUrl($url)
{
$host = Uri::retrieveHost($url);
$this->_reconfigure(['url' => $host]);
$page = substr($url, strlen($host));
$this->debugSection('Host', $host);
$this->amOnPage($page);
}
public function amOnSubdomain($subdomain)
{
$url = $this->config['url'];
$url = preg_replace('~(https?:\/\/)(.*\.)(.*\.)~', "$1$3", $url); // removing current subdomain
$url = preg_replace('~(https?:\/\/)(.*)~', "$1$subdomain.$2", $url); // inserting new
$this->_reconfigure(['url' => $url]);
}
protected function onReconfigure()
{
$this->_initializeSession();
}
/**
* Low-level API method.
* If Codeception commands are not enough, use [Guzzle HTTP Client](http://guzzlephp.org/) methods directly
*
* Example:
*
* ``` php
* <?php
* $I->executeInGuzzle(function (\GuzzleHttp\Client $client) {
* $client->get('/get', ['query' => ['foo' => 'bar']]);
* });
* ?>
* ```
*
* It is not recommended to use this command on a regular basis.
* If Codeception lacks important Guzzle Client methods, implement them and submit patches.
*
* @param callable $function
*/
public function executeInGuzzle(\Closure $function)
{
return $function($this->guzzle);
}
public function _getResponseCode()
{
return $this->getResponseStatusCode();
}
public function _initializeSession()
{
$defaults = array_intersect_key($this->config, array_flip($this->guzzleConfigFields));
$curlOptions = [];
foreach ($this->config['curl'] as $key => $val) {
if (defined($key)) {
$curlOptions[constant($key)] = $val;
}
}
$this->setCookiesFromOptions();
if ($this->isGuzzlePsr7) {
$defaults['base_uri'] = $this->config['url'];
$defaults['curl'] = $curlOptions;
$this->guzzle = new GuzzleClient($defaults);
} else {
$defaults['config']['curl'] = $curlOptions;
$this->guzzle = new GuzzleClient(['base_url' => $this->config['url'], 'defaults' => $defaults]);
$this->client->setBaseUri($this->config['url']);
}
$this->client->setRefreshMaxInterval($this->config['refresh_max_interval']);
$this->client->setClient($this->guzzle);
}
public function _backupSession()
{
return [
'client' => $this->client,
'guzzle' => $this->guzzle,
'crawler' => $this->crawler
];
}
public function _loadSession($session)
{
foreach ($session as $key => $val) {
$this->$key = $val;
}
}
public function _closeSession($session)
{
unset($session);
}
}