Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathSOAP.php
More file actions
504 lines (450 loc) · 14.6 KB
/
Copy pathSOAP.php
File metadata and controls
504 lines (450 loc) · 14.6 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
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
<?php
declare(strict_types=1);
namespace Codeception\Module;
use Codeception\Exception\ModuleException;
use Codeception\Exception\ModuleRequireException;
use Codeception\Lib\Framework;
use Codeception\Lib\InnerBrowser;
use Codeception\Lib\Interfaces\DependsOnModule;
use Codeception\Module;
use Codeception\TestInterface;
use Codeception\Util\Soap as SoapUtils;
use Codeception\Util\XmlBuilder;
use Codeception\Util\XmlStructure;
use DOMDocument;
use DOMNode;
use ErrorException;
use PHPUnit\Framework\Assert;
use Symfony\Component\BrowserKit\AbstractBrowser;
/**
* Module for testing SOAP WSDL web services.
* Send requests and check if response matches the pattern.
*
* This module can be used either with frameworks or PHPBrowser.
* It tries to guess the framework is is attached to.
* If a endpoint is a full url then it uses PHPBrowser.
*
* ### Using Inside Framework
*
* Please note, that PHP SoapServer::handle method sends additional headers.
* This may trigger warning: "Cannot modify header information"
* If you use PHP SoapServer with framework, try to block call to this method in testing environment.
*
* ## Status
*
* * Maintainer: **davert**
* * Stability: **stable**
* * Contact: codecept@davert.mail.ua
*
* ## Configuration
*
* * endpoint *required* - soap wsdl endpoint
* * SOAPAction - replace SOAPAction HTTP header (Set to '' to SOAP 1.2)
*
* ## Public Properties
*
* * xmlRequest - last SOAP request (DOMDocument)
* * xmlResponse - last SOAP response (DOMDocument)
*
*/
class SOAP extends Module implements DependsOnModule
{
/**
* @var array<string, mixed>
*/
protected array $config = [
'schema' => "",
'schema_url' => 'http://schemas.xmlsoap.org/soap/envelope/',
'framework_collect_buffer' => true
];
/**
* @var string[]
*/
protected array $requiredFields = ['endpoint'];
protected string $dependencyMessage = <<<EOF
Example using PhpBrowser as backend for SOAP module.
--
modules:
enabled:
- SOAP:
depends: PhpBrowser
--
Framework modules can be used as well for functional testing of SOAP API.
EOF;
public ?AbstractBrowser $client;
public bool $isFunctional = false;
/**
* @var DOMNode|DOMDocument|null
*/
public $xmlRequest = null;
/**
* @var DOMNode|DOMDocument|null
*/
public $xmlResponse = null;
protected ?XmlStructure $xmlStructure = null;
protected ?InnerBrowser $connectionModule = null;
public function _before(TestInterface $test): void
{
$this->client = &$this->connectionModule->client;
$this->buildRequest();
$this->xmlResponse = null;
$this->xmlStructure = null;
}
protected function onReconfigure(): void
{
$this->buildRequest();
$this->xmlResponse = null;
$this->xmlStructure = null;
}
public function _depends(): array
{
return [InnerBrowser::class => $this->dependencyMessage];
}
public function _inject(InnerBrowser $connectionModule): void
{
$this->connectionModule = $connectionModule;
if ($connectionModule instanceof Framework) {
$this->isFunctional = true;
}
}
private function getClient(): AbstractBrowser
{
if (!$this->client) {
throw new ModuleRequireException($this, 'Connection client is not available.');
}
return $this->client;
}
private function getXmlResponse(): DOMDocument
{
if (!$this->xmlResponse) {
throw new ModuleException($this, "No XML response, use `\$I->sendSoapRequest` to receive it");
}
return $this->xmlResponse;
}
private function getXmlStructure(): XmlStructure
{
if (!$this->xmlStructure) {
$this->xmlStructure = new XmlStructure($this->getXmlResponse());
}
return $this->xmlStructure;
}
/**
* Prepare SOAP header.
* Receives header name and parameters as array.
*
* Example:
*
* ``` php
* <?php
* $I->haveSoapHeader('AuthHeader', array('username' => 'davert', 'password' => '123345'));
* ```
*
* Will produce header:
*
* ```
* <soapenv:Header>
* <SessionHeader>
* <AuthHeader>
* <username>davert</username>
* <password>12345</password>
* </AuthHeader>
* </soapenv:Header>
* ```
*/
public function haveSoapHeader(string $header, array $params = []): void
{
$soap_schema_url = $this->config['schema_url'];
$xml = $this->xmlRequest;
$domElement = $xml->documentElement->getElementsByTagNameNS($soap_schema_url, 'Header')->item(0);
$headerEl = $xml->createElement($header);
SoapUtils::arrayToXml($xml, $headerEl, $params);
$domElement->appendChild($headerEl);
}
/**
* Submits request to endpoint.
*
* Requires of api function name and parameters.
* Parameters can be passed either as DOMDocument, DOMNode, XML string, or array (if no attributes).
*
* You are allowed to execute as much requests as you need inside test.
*
* Example:
*
* ``` php
* $I->sendSoapRequest('UpdateUser', '<user><id>1</id><name>notdavert</name></user>');
* $I->sendSoapRequest('UpdateUser', \Codeception\Utils\Soap::request()->user
* ->id->val(1)->parent()
* ->name->val('notdavert');
* ```
*
* @param string $action
* @param object|string $body
*/
public function sendSoapRequest(string $action, $body = ''): void
{
$soap_schema_url = $this->config['schema_url'];
$xml = $this->xmlRequest;
$call = $xml->createElement('ns:' . $action);
if ($body) {
$bodyXml = SoapUtils::toXml($body);
if ($bodyXml->hasChildNodes()) {
foreach ($bodyXml->childNodes as $bodyChildNode) {
$bodyNode = $xml->importNode($bodyChildNode, true);
$call->appendChild($bodyNode);
}
}
}
$xmlBody = $xml->getElementsByTagNameNS($soap_schema_url, 'Body')->item(0);
// cleanup if body already set
foreach ($xmlBody->childNodes as $node) {
$xmlBody->removeChild($node);
}
$xmlBody->appendChild($call);
$this->debugSection('Request', $req = $xml->C14N());
if ($this->isFunctional && $this->config['framework_collect_buffer']) {
$response = $this->processInternalRequest($action, $req);
} else {
$response = $this->processExternalRequest($action, $req);
}
$this->debugSection('Response', (string) $response);
$this->xmlResponse = SoapUtils::toXml($response);
$this->xmlStructure = null;
}
/**
* Checks XML response equals provided XML.
* Comparison is done by canonicalizing both xml`s.
*
* Parameters can be passed either as DOMDocument, DOMNode, XML string, or array (if no attributes).
*
* Example:
*
* ``` php
* <?php
* $I->seeSoapResponseEquals("<?xml version="1.0" encoding="UTF-8"?><SOAP-ENV:Envelope><SOAP-ENV:Body><result>1</result></SOAP-ENV:Envelope>");
*
* $dom = new \DOMDocument();
* $dom->load($file);
* $I->seeSoapRequestIncludes($dom);
* ```
*/
public function seeSoapResponseEquals(string $xml): void
{
$xml = SoapUtils::toXml($xml);
$this->assertEquals($xml->C14N(), $this->getXmlResponse()->C14N());
}
/**
* Checks XML response includes provided XML.
* Comparison is done by canonicalizing both xml`s.
* Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
*
* Example:
*
* ``` php
* <?php
* $I->seeSoapResponseIncludes("<result>1</result>");
* $I->seeSoapRequestIncludes(\Codeception\Utils\Soap::response()->result->val(1));
*
* $dom = new \DOMDocument();
* $dom->load('template.xml');
* $I->seeSoapRequestIncludes($dom);
* ```
*
* @param XmlBuilder|DOMDocument|string $xml
*/
public function seeSoapResponseIncludes($xml): void
{
$xml = $this->canonicalize($xml);
$this->assertStringContainsString($xml, $this->getXmlResponse()->C14N(), 'found in XML Response');
}
/**
* Checks XML response equals provided XML.
* Comparison is done by canonicalizing both xml`s.
*
* Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
*
*/
public function dontSeeSoapResponseEquals(string $xml): void
{
$xml = SoapUtils::toXml($xml);
Assert::assertXmlStringNotEqualsXmlString($xml->C14N(), $this->getXmlResponse()->C14N());
}
/**
* Checks XML response does not include provided XML.
* Comparison is done by canonicalizing both xml`s.
* Parameter can be passed either as XmlBuilder, DOMDocument, DOMNode, XML string, or array (if no attributes).
*
* @param XmlBuilder|DOMDocument|string $xml
*/
public function dontSeeSoapResponseIncludes($xml): void
{
$xml = $this->canonicalize($xml);
$this->assertStringNotContainsString($xml, $this->getXmlResponse()->C14N(), "found in XML Response");
}
/**
* Checks XML response contains provided structure.
* Response elements will be compared with XML provided.
* Only nodeNames are checked to see elements match.
*
* Example:
*
* ``` php
* <?php
*
* $I->seeSoapResponseContainsStructure("<query><name></name></query>");
* ```
*
* Use this method to check XML of valid structure is returned.
* This method does not use schema for validation.
* This method does not require path from root to match the structure.
*
*/
public function seeSoapResponseContainsStructure(string $xml): void
{
$xml = SoapUtils::toXml($xml);
$this->debugSection("Structure", $xml->saveXML());
$this->assertTrue($this->getXmlStructure()->matchXmlStructure($xml), "this structure is in response");
}
/**
* Opposite to `seeSoapResponseContainsStructure`
*/
public function dontSeeSoapResponseContainsStructure(string $xml): void
{
$xml = SoapUtils::toXml($xml);
$this->debugSection("Structure", $xml->saveXML());
$this->assertFalse($this->getXmlStructure()->matchXmlStructure($xml), "this structure is in response");
}
/**
* Checks XML response with XPath locator
*
* ``` php
* <?php
* $I->seeSoapResponseContainsXPath('//root/user[@id=1]');
* ```
*
* @param string $xPath
*/
public function seeSoapResponseContainsXPath(string $xPath): void
{
$this->assertTrue($this->getXmlStructure()->matchesXpath($xPath));
}
/**
* Checks XML response doesn't contain XPath locator
*
* ``` php
* <?php
* $I->dontSeeSoapResponseContainsXPath('//root/user[@id=1]');
* ```
*
* @param string $xPath
*/
public function dontSeeSoapResponseContainsXPath(string $xPath): void
{
$this->assertFalse($this->getXmlStructure()->matchesXpath($xPath));
}
/**
* Checks response code from server.
*
* @param string $code
*/
public function seeSoapResponseCodeIs(string $code): void
{
$this->assertEquals(
$code,
$this->client->getInternalResponse()->getStatus(),
"soap response code matches expected"
);
}
/**
* Finds and returns text contents of element.
* Element is matched by either CSS or XPath
*
* @version 1.1
*/
public function grabTextContentFrom(string $cssOrXPath): string
{
$el = $this->getXmlStructure()->matchElement($cssOrXPath);
return $el->textContent;
}
/**
* Finds and returns attribute of element.
* Element is matched by either CSS or XPath
*
* @version 1.1
*/
public function grabAttributeFrom(string $cssOrXPath, string $attribute): string
{
$el = $this->getXmlStructure()->matchElement($cssOrXPath);
$elHasAttribute = $el->hasAttribute($attribute);
if (!$elHasAttribute) {
$this->fail(sprintf("Attribute not found in element matched by '%s'", $cssOrXPath));
}
return $el->getAttribute($attribute);
}
protected function getSchema()
{
return $this->config['schema'];
}
/**
* @param XmlBuilder|DOMDocument|string $xml
* @return string
*/
protected function canonicalize($xml): string
{
return SoapUtils::toXml($xml)->C14N();
}
protected function buildRequest(): DOMDocument
{
$soap_schema_url = $this->config['schema_url'];
$xml = new DOMDocument();
$root = $xml->createElement('soapenv:Envelope');
$xml->appendChild($root);
$root->setAttribute('xmlns:ns', $this->getSchema());
$root->setAttribute('xmlns:soapenv', $soap_schema_url);
$body = $xml->createElementNS($soap_schema_url, 'soapenv:Body');
$header = $xml->createElementNS($soap_schema_url, 'soapenv:Header');
$root->appendChild($header);
$root->appendChild($body);
$this->xmlRequest = $xml;
return $xml;
}
protected function processRequest(string $action, string $body): void
{
$this->getClient()->request(
'POST',
$this->config['endpoint'],
[],
[],
[
'HTTP_Content-Type' => 'text/xml; charset=UTF-8',
'HTTP_Content-Length' => strlen($body),
'HTTP_SOAPAction' => $this->config['SOAPAction'] ?? $action
],
$body
);
}
/**
* @return string|false
*/
protected function processInternalRequest(string $action, string $body)
{
ob_start();
try {
$this->getClient()->setServerParameter('HTTP_HOST', 'localhost');
$this->processRequest($action, $body);
} catch (ErrorException $exception) {
// Zend_Soap outputs warning as an exception
if (strpos($exception->getMessage(), 'Warning: Cannot modify header information') === false) {
ob_end_clean();
throw $exception;
}
}
$response = ob_get_contents();
ob_end_clean();
return $response;
}
protected function processExternalRequest(string $action, string $body): string
{
$this->processRequest($action, $body);
return $this->client->getInternalResponse()->getContent();
}
}
You can’t perform that action at this time.