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.
This module requires PHPBrowser or any of Framework modules enabled.
modules:
enabled:
- REST:
depends: PhpBrowser
url: 'http://serviceapp/api/v1/'
Conflicts with SOAP module
Adds Bearer authentication via access token.
param
$accessToken[Part]
json[Part]
xmlAdds Digest authentication via username/password.
param
$usernameparam
$password[Part]
json[Part]
xmlAdds HTTP authentication via username/password.
param
$usernameparam
$password[Part]
json[Part]
xmlDeletes the header with the passed name. Subsequent requests will not have the deleted header in its request.
Example:
<?php $I->haveHttpHeader('X-Requested-With', 'Codeception'); $I->sendGET('test-headers.php'); // ... $I->deleteHeader('X-Requested-With'); $I->sendPOST('some-other-page.php'); ?>
param string
$name the name of the header to delete.[Part]
json[Part]
xmlChecks if the hash of a binary response is not the same as provided.
<?php $I->dontSeeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded"); ?>
Opposite to seeBinaryResponseEquals
param
$hash the hashed data response expectedparam
$algo the hash algorithm to use. Default md5.[Part]
json[Part]
xmlChecks over the given HTTP header and (optionally) its value, asserting that are not there
param
$nameparam
$value[Part]
json[Part]
xmlChecks that response code is not equal to provided value.
<?php $I->dontSeeResponseCodeIs(200); // preferred to use \Codeception\Util\HttpCode $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
[Part]
json[Part]
xmlparam
$codeChecks whether last response do not contain text.
param
$text[Part]
json[Part]
xmlOpposite to seeResponseContainsJson
[Part]
jsonparam array
$jsonOpposite to seeResponseJsonMatchesJsonPath
param string
$jsonPath[Part]
jsonOpposite to seeResponseJsonMatchesXpath
param string
$xpath[Part]
jsonOpposite to seeResponseMatchesJsonType
.
[Part]
json @see seeResponseMatchesJsonTypeparam
$jsonType jsonType structureparam null
$jsonPath optionally set specific path to structure with JsonPathAvailable since
2.1.3Checks 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]
xmlChecks 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]
xmlChecks whether XML response does not match XPath
<?php $I->dontSeeXmlResponseMatchesXpath('//root/user[@id=1]');
[Part]
xmlparam
$xpathFinds and returns attribute of element. Element is matched by either CSS or XPath
param
$cssOrXPathparam
$attributereturn
string[Part]
xmlDeprecated since 2.0.9 and removed since 2.1.0
param
$path @throws ModuleException @deprecatedReturns data from the current JSON response using JSONPath as selector. JsonPath is XPath equivalent for querying Json structures. Try your JsonPath expressions online. Even for a single value an array is returned.
This method require flow/jsonpath
> 0.2 library to be installed.
Example:
<?php // match the first `user.id` in json $firstUserId = $I->grabDataFromResponseByJsonPath('$..users[0].id'); $I->sendPUT('/user', array('id' => $firstUserId[0], 'name' => 'davert')); ?>
param string
$jsonPathreturn
array Array of matching itemsAvailable since
2.0.9 @throws \Exception[Part]
jsonReturns the value of the specified header name
param
$nameparam 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]
xmlReturns current response so that it can be used in next scenario steps.
Example:
<?php $user_id = $I->grabResponse(); $I->sendPUT('/user', array('id' => $user_id, 'name' => 'davert')); ?>
Available since
1.1return
string[Part]
json[Part]
xmlFinds and returns text contents of element. Element is matched by either CSS or XPath
param
$cssOrXPathreturn
string[Part]
xmlSets HTTP header valid for all next requests. Use deleteHeader
to unset it
<?php $I->haveHttpHeader('Content-Type', 'application/json'); // all next requests will contain this header ?>
param
$nameparam
$value[Part]
json[Part]
xmlChecks if the hash of a binary response is exactly the same as provided. Parameter can be passed as any hash string supported by hash(), with an optional second parameter to specify the hash type, which defaults to md5.
Example: Using md5 hash key
<?php $I->seeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded"); ?>
Example: Using md5 for a file contents
<?php $fileData = file_get_contents("test_file.jpg"); $I->seeBinaryResponseEquals(md5($fileData)); ?>
Example: Using sha256 hash
<?php $fileData = '/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k='; // very small jpeg $I->seeBinaryResponseEquals(hash("sha256", base64_decode($fileData)), 'sha256'); ?>
param
$hash the hashed data response expectedparam
$algo the hash algorithm to use. Default md5.[Part]
json[Part]
xmlChecks over the given HTTP header and (optionally) its value, asserting that are there
param
$nameparam
$value[Part]
json[Part]
xmlChecks 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.
<?php $I->seeHttpHeaderOnce('Cache-Control'); ?>>
param
$name[Part]
json[Part]
xmlChecks response code equals to provided value.
<?php $I->seeResponseCodeIs(200); // preferred to use \Codeception\Util\HttpCode $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
[Part]
json[Part]
xmlparam
$codeChecks whether the last response contains text.
param
$text[Part]
json[Part]
xmlChecks 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:
<?php // response: {name: john, email: [email protected]} $I->seeResponseContainsJson(array('name' => 'john')); // response {user: john, profile: { email: [email protected] }} $I->seeResponseContainsJson(array('email' => '[email protected]')); ?>
This method recursively checks if one array can be found inside of another.
param array
$json[Part]
jsonChecks if response is exactly the same as provided.
[Part]
json[Part]
xmlparam
$responseChecks whether last response was valid JSON. This is done with json_last_error function.
[Part]
jsonChecks whether last response was valid XML. This is done with libxml_get_last_error function.
[Part]
xmlChecks 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.
{ "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 } } }
<?php // at least one book in store has author $I->seeResponseJsonMatchesJsonPath('$.store.book[*].author'); // first book in store has author $I->seeResponseJsonMatchesJsonPath('$.store.book[0].author'); // at least one item in store has price $I->seeResponseJsonMatchesJsonPath('$.store..price'); ?>
param string
$jsonPath[Part]
jsonAvailable since
2.0.9Checks 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. *
{ "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 } } }
<?php // at least one book in store has author $I->seeResponseJsonMatchesXpath('//store/book/author'); // first book in store has author $I->seeResponseJsonMatchesXpath('//store/book[1]/author'); // at least one item in store has price $I->seeResponseJsonMatchesXpath('/store//price'); ?>
param string
$xpath[Part]
jsonAvailable since
2.0.9Checks 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:
<?php // {'user_id': 1, 'name': 'davert', 'is_active': false} $I->seeResponseMatchesJsonType([ 'user_id' => 'integer', 'name' => 'string|null', 'is_active' => 'boolean' ]); // narrow down matching with JsonPath: // {"users": [{ "name": "davert"}, {"id": 1}]} $I->seeResponseMatchesJsonType(['name' => 'string'], '$.users[0]'); ?>
In this case you can match that record contains fields with data types you expected. The list of possible data types:
You can also use nested data type structures:
<?php // {'user_id': 1, 'name': 'davert', 'company': {'name': 'Codegyre'}} $I->seeResponseMatchesJsonType([ 'user_id' => 'integer|string', // multiple types 'company' => ['name' => 'string'] ]); ?>
You can also apply filters to check values. Filter can be applied with :
char after the type declaration.
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-Datesstring: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:
<?php // {'user_id': 1, 'email' => '[email protected]'} $I->seeResponseMatchesJsonType([ 'user_id' => 'string:>0:<1000', // multiple filters can be used 'email' => 'string:regex(~\@~)' // we just check that @ char is included ]); // {'user_id': '1'} $I->seeResponseMatchesJsonType([ 'user_id' => 'string:>0', // works with strings as well } ?>
You can also add custom filters y accessing JsonType::addCustomFilter
method. See JsonType reference.
[Part]
jsonAvailable since
2.1.3param array
$jsonTypeparam string
$jsonPathChecks 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]
xmlChecks 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->seeXmlResponseIncludes("<result>1</result>"); ?>
param
$xml[Part]
xmlChecks whether XML response matches XPath
<?php $I->seeXmlResponseMatchesXpath('//root/user[@id=1]');
[Part]
xmlparam
$xpathSends DELETE request to given uri.
param
$urlparam array
$paramsparam array
$files[Part]
json[Part]
xmlSends a GET request to given uri.
param
$urlparam array
$params[Part]
json[Part]
xmlSends a HEAD request to given uri.
param
$urlparam array
$params[Part]
json[Part]
xmlSends LINK request to given uri.
param
$urlparam array
$linkEntries (entry is array with keys “uri” and “link-param”)@link http://tools.ietf.org/html/rfc2068#section-19.6.2.4
@author [email protected]
[Part]
json[Part]
xmlSends an OPTIONS request to given uri.
param
$urlparam array
$params[Part]
json[Part]
xmlSends PATCH request to given uri.
param
$urlparam array
$paramsparam array
$files[Part]
json[Part]
xmlSends a POST request to given uri. Parameters and files can be provided separately.
Example:
<?php //simple POST call $I->sendPOST('/message', ['subject' => 'Read this!', 'to' => '[email protected]']); //simple upload method $I->sendPOST('/message/24', ['inline' => 0], ['attachmentFile' => codecept_data_dir('sample_file.pdf')]); //uploading a file with a custom name and mime-type. This is also useful to simulate upload errors. $I->sendPOST('/message/24', ['inline' => 0], [ 'attachmentFile' => [ 'name' => 'document.pdf', 'type' => 'application/pdf', 'error' => UPLOAD_ERR_OK, 'size' => filesize(codecept_data_dir('sample_file.pdf')), 'tmp_name' => codecept_data_dir('sample_file.pdf') ] ]);
param
$urlparam array|\JsonSerializable
$paramsparam array
$files A list of filenames or “mocks” of $_FILES (each entry being an array with the following keys: name, type, error, size, tmp_name (pointing to the real file path). Each key works as the “name” attribute of a file input field.@see http://php.net/manual/en/features.file-upload.post-method.php @see codecept_data_dir()
[Part]
json[Part]
xmlSends PUT request to given uri.
param
$urlparam array
$paramsparam array
$files[Part]
json[Part]
xmlSends UNLINK request to given uri.
param
$urlparam array
$linkEntries (entry is array with keys “uri” and “link-param”) @link http://tools.ietf.org/html/rfc2068#section-19.6.2.4 @author [email protected][Part]
json[Part]
xmlEnables automatic redirects to be followed by the client
<?php $I->startFollowingRedirects();
[Part]
xml[Part]
jsonPrevents automatic redirects to be followed by the client
<?php $I->stopFollowingRedirects();
[Part]
xml[Part]
json
© 2011–2017 Michael Bodnarchuk and contributors
Licensed under the MIT License.
http://codeception.com/docs/modules/REST