Module for testing REST WebService.

This module can be used either with frameworks or PHPBrowser. If a framework module is connected, the testing will occur in the application directly. Otherwise, a PHPBrowser should be specified as a dependency to send requests and receive responses from a server.

• Maintainer: tiger-seo, davert
• Stability: stable
• Contact: codecept@davert.mail.ua
• Contact: tiger.seo@gmail.com

• url optional - the url of api

This module requires PHPBrowser or any of Framework modules enabled.

modules:
   enabled:
       - REST:
           depends: PhpBrowser
           url: 'http://serviceapp/api/v1/'

• headers - array of headers going to be sent.
• params - array of sent data
• response - last response (string)

• Json - actions for validating Json responses (no Xml responses)
• Xml - actions for validating XML responses (no Json responses)

Adds Bearer authentication via access token.

• param $accessToken
• [Part] json
• [Part] xml

Adds Digest authentication via username/password.

• param $username
• param $password
• [Part] json
• [Part] xml

Adds HTTP authentication via username/password.

• param $username
• param $password
• [Part] json
• [Part] xml

Checks over the given HTTP header and (optionally) its value, asserting that are not there

• param $name
• param $value
• [Part] json
• [Part] xml

Checks that response code is not equal to provided value.

• [Part] json
• [Part] xml
• param $code

Checks whether last response do not contain text.

• param $text
• [Part] json
• [Part] xml

Opposite to seeResponseContainsJson

• [Part] json
• param array $json

Opposite to seeResponseJsonMatchesJsonPath

• param array $jsonPath
• [Part] json

Opposite to seeResponseMatchesJsonType.

• [Part] json
• see seeResponseMatchesJsonType
• param $jsonType jsonType structure
• param null $jsonPath optionally set specific path to structure with JsonPath
• Available since 2.1.3

Checks XML response does not equal to 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 $xml
• [Part] xml

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 $xml
• [Part] xml

Checks wheather XML response does not match XPath

{% highlight php %}

{% endhighlight %}

• param string $jsonPath
• return array Array of matching items
• Available since 2.0.9
• throws \Exception
• [Part] json

Returns the value of the specified header name

• param $name

• param Boolean $first Whether to return the first value or all header values

• return string|array The first header value if $first is true, an array of values otherwise

• [Part] json

• [Part] xml

Returns current response so that it can be used in next scenario steps.

Example:

{% highlight php %}

{% endhighlight %}

• Available since 1.1
• return string
• [Part] json
• [Part] xml

Finds and returns text contents of element. Element is matched by either CSS or XPath

• param $cssOrXPath
• return string
• [Part] xml

Sets HTTP header

• param $name
• param $value
• [Part] json
• [Part] xml

Checks over the given HTTP header and (optionally) its value, asserting that are there

• param $name
• param $value
• [Part] json
• [Part] xml

Checks that http response header is received only once. HTTP RFC2616 allows multiple response headers with the same name. You can check that you didn't accidentally sent the same header twice.

{% highlight php %}

{% endhighlight %}

• param $name
• [Part] json
• [Part] xml

Checks response code equals to provided value.

• [Part] json
• [Part] xml
• param $code

Checks whether the last response contains text.

• param $text
• [Part] json
• [Part] xml

Checks whether the last JSON response contains provided array. The response is converted to array with json_decode($response, true) Thus, JSON is represented by associative array. This method matches that response array contains provided array.

Examples:

{% highlight php %}

{% endhighlight %}

This method recursively checks if one array can be found inside of another.

• param array $json
• [Part] json

Checks if response is exactly the same as provided.

• [Part] json
• [Part] xml
• param $response

Checks whether last response was valid JSON. This is done with json_last_error function.

• [Part] json

Checks whether last response was valid XML. This is done with libxml_get_last_error function.

• [Part] xml

Checks if json structure in response matches JsonPath. JsonPath is XPath equivalent for querying Json structures. Try your JsonPath expressions online. This assertion allows you to check the structure of response json.

This method require flow/jsonpath > 0.2 library to be installed.

{% highlight json %}

{ "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }

{% endhighlight %}

{% highlight php %}

{% endhighlight %}

• [Part] json
• Available since 2.0.9

Checks if json structure in response matches the xpath provided. JSON is not supposed to be checked against XPath, yet it can be converted to xml and used with XPath. This assertion allows you to check the structure of response json. * {% highlight json %}

{ "store": { "book": [ { "category": "reference", "author": "Nigel Rees", "title": "Sayings of the Century", "price": 8.95 }, { "category": "fiction", "author": "Evelyn Waugh", "title": "Sword of Honour", "price": 12.99 } ], "bicycle": { "color": "red", "price": 19.95 } } }

{% endhighlight %}

{% highlight php %}

{% endhighlight %}

• [Part] json
• Available since 2.0.9

Checks that Json matches provided types. In case you don't know the actual values of JSON data returned you can match them by type. Starts check with a root element. If JSON data is array it will check the first element of an array. You can specify the path in the json which should be checked with JsonPath

Basic example:

{% highlight php %}

{% endhighlight %}

In this case you can match that record contains fields with data types you expected. The list of possible data types:

• string
• integer
• float
• array (json object is array as well)
• boolean

You can also use nested data type structures:

{% highlight php %}

{% endhighlight %}

You can also apply filters to check values. Filter can be applied with : char after the type declatation.

Here is the list of possible filters:

• integer:>{val} - checks that integer is greater than {val} (works with float and string types too).
• integer:<{val} - checks that integer is lower than {val} (works with float and string types too).
• string:url - checks that value is valid url.
• string:date - checks that value is date in JavaScript format: https://weblog.west-wind.com/posts/2014/Jan/06/JavaScript-JSON-Date-Parsing-and-real-Dates
• string:email - checks that value is a valid email according to http://emailregex.com/
• string:regex({val}) - checks that string matches a regex provided with {val}

This is how filters can be used:

{% highlight php %}

{% endhighlight %}

You can also add custom filters y accessing JsonType::addCustomFilter method. See JsonType reference.

• [Part] json
• Available since 2.1.3
• param array $jsonType
• param string $jsonPath

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

• param $xml
• [Part] xml

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:

{% highlight php %}

{% endhighlight %}

• param $xml
• [Part] xml

Checks wheather XML response matches XPath

{% highlight php %}