#PHP Matcher
PHP Matcher lets You assert like a gangster in Your test cases, where response can be something you cannot predict
##Installation
Add to your composer.json
require: {
"coduo/php-matcher": "1.0.*"
}
Common way of testing api responses with Symfony2 WebTestCase
public function testGetToys()
{
$this->setUpFixtures();
$this->setUpOath();
$this->client->request('GET', '/api/toys');
$response = $this->client->getResponse();
$this->assertJsonResponse($response, 200);
$content = $response->getContent();
$decoded = json_decode($content, true);
$this->assertTrue(isset($decoded[0]['id']));
$this->assertTrue(isset($decoded[1]['id']));
$this->assertTrue(isset($decoded[2]['id']));
$this->assertEquals($decoded[0]['name'], 'Barbie'));
$this->assertEquals($decoded[1]['name'], 'GI Joe'));
$this->assertEquals($decoded[2]['name'], 'Optimus Prime'));
}With php-matcher, you can make it more readable:
public function testGetToys()
{
$this->setUpFixtures();
$this->setUpOath();
$this->client->request('GET', '/api/toys');
$response = $this->client->getResponse();
$this->assertJsonResponse($response, 200);
$content = $response->getContent();
$pattern = '[
{
"id": @string@,
"name": "Barbie",
"_links: @*@
},
{
"id": @string@,
"name": "GI Joe",
"_links": @*@
},
{
"id": @string@,
"name": "Optimus Prime",
"_links": @*@
}
]
';
$this->assertTrue(match($content, $pattern));
}From now you should be able to use global function match($value, $pattern)
@string@@integer@@boolean@@array@@...@- unbounded array@double@@null@@*@||@wildcard@expr(expression)
##Example usage
<?php
match(1, 1);
match('string', 'string')<?php
match(1, '@integer@');
match('Norbert', '@string@');
match(array('foo', 'bar'), '@array@');
match(12.4, '@double@');
match(true, '@boolean@');<?php
match(1, '@*@');
match(new \stdClass(), '@wildcard@');<?php
match(new \DateTime('2014-04-01'), "expr(value.format('Y-m-d') == '2014-04-01'");
match("Norbert", "expr(value === 'Norbert')");<?php
match(
array(
'users' => array(
array(
'id' => 1,
'firstName' => 'Norbert',
'lastName' => 'Orzechowicz',
'roles' => array('ROLE_USER')
),
array(
'id' => 2,
'firstName' => 'Michał',
'lastName' => 'Dąbrowski',
'roles' => array('ROLE_USER')
),
array(
'id' => 3,
'firstName' => 'Johnny',
'lastName' => 'DąbrowsBravoki',
'roles' => array('ROLE_HANDSOME_GUY')
)
),
true,
6.66
),
array(
'users' => array(
array(
'id' => '@integer@',
'firstName' => '@string@',
'lastName' => 'Orzechowicz',
'roles' => '@array@'
),
array(
'id' => '@integer@'
'firstName' => '@string@',
'lastName' => 'Dąbrowski',
'roles' => '@array@'
),
'@...@'
),
'@boolean@',
'@double@'
)
)<?php
match(
'{
"users":[
{
"firstName": "Norbert",
"lastName": "Orzechowicz",
"roles":["ROLE_USER", "ROLE_DEVELOPER"]}
]
}',
'{
"users":[
{
"firstName": @string@,
"lastName": @string@,
"roles": @array@
}
]
}'
)@profile, @user
Feature: Listing user toys
As a user
I want to list my toys
Background:
Given I send and accept JSON
Scenario: Listing toys
Given the following users exist:
| firstName | lastName |
| Chuck | Norris |
And the following toys user "Chuck Norris" exist:
| name |
| Barbie |
| GI Joe |
| Optimus Prime |
When I set valid authorization code oauth header for user "Chuck Norris"
And I send a GET request on "/api/toys"
Then the response status code should be 200
And the JSON response should match:
"""
[
{
"id": @string@,
"name": "Barbie",
"_links: "@*@"
},
{
"id": @string@,
"name": "GI Joe",
"_links": "@*@"
},
{
"id": @string@,
"name": "Optimus Prime",
"_links": "@*@"
}
]
"""This library is distributed under the MIT license. Please see the LICENSE file.
This lib was inspired by JSON Expressions gem && Behat RestExtension