SOAP

Installation

composer require --dev codeception/module-soap

Description

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: [email protected]

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)

Actions

dontSeeSoapResponseContainsStructure

• param string $xml
• return void

Opposite to seeSoapResponseContainsStructure

dontSeeSoapResponseContainsXPath

• param string $xPath
• return void

Checks XML response doesn’t contain XPath locator

<?php
$I->dontSeeSoapResponseContainsXPath('//root/user[@id=1]');

dontSeeSoapResponseEquals

• param string $xml
• return void

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).

dontSeeSoapResponseIncludes

• param XmlBuilder|DOMDocument|string $xml
• return void

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).

grabAttributeFrom

• version 1.1
• param string $cssOrXPath
• param string $attribute
• return string

Finds and returns attribute of element.

Element is matched by either CSS or XPath

grabTextContentFrom

• version 1.1
• param string $cssOrXPath
• return string

Finds and returns text contents of element.

Element is matched by either CSS or XPath

haveSoapHeader

• param string $header
• param array $params
• return void

Prepare SOAP header.

Receives header name and parameters as array.

Example:

<?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>

seeSoapResponseCodeIs

• param string $code
• return void

Checks response code from server.

seeSoapResponseContainsStructure

• param string $xml
• return void

Checks XML response contains provided structure.

Response elements will be compared with XML provided. Only nodeNames are checked to see elements match.

Example:

<?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.

seeSoapResponseContainsXPath

• param string $xPath
• return void

Checks XML response with XPath locator

<?php
$I->seeSoapResponseContainsXPath('//root/user[@id=1]');

seeSoapResponseEquals

• param string $xml
• return void

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
$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);

seeSoapResponseIncludes

• param XmlBuilder|DOMDocument|string $xml
• return void

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
$I->seeSoapResponseIncludes("<result>1</result>");
$I->seeSoapRequestIncludes(\Codeception\Utils\Soap::response()->result->val(1));

$dom = new \DOMDocument();
$dom->load('template.xml');
$I->seeSoapRequestIncludes($dom);

sendSoapRequest

• param string $action
• param object|string $body
• return void

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:

$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');