GitHub - coduo/php-matcher: The easiest way to match data structures like JSON/PlainText/XML against readable patterns. Sandbox: (original) (raw)

PHP Matcher

Library created for testing all kinds of JSON/XML/TXT/Scalar values against patterns.

API:

PHPMatcher::match($value = '{"foo": "bar"}', $pattern = '{"foo": "@string@"}') : bool; PHPMatcher::backtrace() : Backtrace; PHPMatcher::error() : ?string;

It was built to simplify API's functional testing.

• - 6.x README PHP >= 8.3 <= 8.5
• 5.x README PHP >= 7.2 < 8.0
• 5.0 README PHP >= 7.2 < 8.0
• 4.0.* README PHP >= 7.2 < 8.0
• 3.2.* README PHP >= 7.0 < 8.0
• 3.1.* README PHP >= 7.0 < 8.0

Sandbox

Feel free to play first with Sandbox

Installation

Require new dev dependency using composer:

composer require --dev "coduo/php-matcher"

Basic usage

Direct PHPMatcher usage

<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="" title="undefined" rel="noopener noreferrer">http://www.w3.org/2001/12/soap-encoding">

<soap:Body xmlns:m="" title="undefined" rel="noopener noreferrer">http://www.example.org/stock"> <m:GetStockPrice> <m:StockName>IBM <m:StockValue>Any Value

XML , <<<XML <soap:Envelope xmlns:soap="@string@" soap:encodingStyle="@string@">

<soap:Body xmlns:m="@string@"> <m:GetStockPrice> <m:StockName>@string@ <m:StockValue>@string@ <m:StockQty>@integer@.optional()

XML );

Example scenario for api in behat using mongo.

@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": "@*@"
    }
  ]
"""

PHPUnit integration

The assertMatchesPattern() is a handy assertion that matches values in PHPUnit tests. To use it either include the Coduo\PHPMatcher\PHPUnit\PHPMatcherAssertions trait, or extend the Coduo\PHPMatcher\PHPUnit\PHPMatcherTestCase:

namespace Coduo\PHPMatcher\Tests\PHPUnit;

use Coduo\PHPMatcher\PHPUnit\PHPMatcherAssertions; use PHPUnit\Framework\TestCase;

class PHPMatcherAssertionsTest extends TestCase { use PHPMatcherAssertions;

public function test_it_asserts_if_a_value_matches_the_pattern()
{
    $this->assertMatchesPattern('@string@', 'foo');
}

}

The matchesPattern() method can be used in PHPUnit stubs or mocks: mock=mock = mock=this->createMock(Foo::class); $mock->method('bar') ->with($this->matchesPattern('@string@')) ->willReturn('foo');

License

This library is distributed under the MIT license. Please see the LICENSE file.

Credits

This lib was inspired by JSON Expressions gem &&Behat RestExtension