Simplify failure description returned by PHPMatcherConstraint

[niklasnatter]

Change Log

Added

Fixed

Changed

• Omit pattern and empty backtrace in failure description returned by PHPMatcherConstraint

Removed

Deprecated

Security

---

Description

This PR simplifies the failure description returned by the PHPMatcherConstraint class. The intention of the change is to make the actual error easier to find. We are happily using the library for testing an API with big responses. Prepending the error with the given value and the pattern makes it hard to sport the actual error in such a usecase.

The PR changes the output when running the following example test cases like this:

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

class PatternTest extends TestCase
{
    public function testPattern(): void
    {
        $pattern = <<<EOF
            {
                "name": "@string@",
                "description": "test-1"
            }
EOF;

        $value = <<<EOF
            {
                "name": "test-2",
                "description": "test-2"
            }
EOF;

        TestCase::assertThat(
            $value,
            new PHPMatcherConstraint($pattern)
        );
    }
}

Old output:

1) Namespace\PatternTest::testPattern
Failed asserting that '            {\n
                "name": "test-2",\n
                "description": "test-2"\n
            }' matches given pattern.
Pattern: '            {\n
                "name": "@string@",\n
                "description": "test-1"\n
            }'
Error: Value "test-2" does not match pattern "test-1" at path: "[description]"
Backtrace: 
Empty.
--- Expected
+++ Actual
@@ @@
 {
-    "description": "test-1",
-    "name": "@string@"
+    "description": "test-2",
+    "name": "test-2"
 }

New output:

1) Namespace\PatternTest::testPattern
Failed asserting that Value "test-2" does not match pattern "test-1" at path: "[description]".
--- Expected
+++ Actual
@@ @@
 {
-    "description": "test-1",
-    "name": "@string@"
+    "description": "test-2",
+    "name": "test-2"
 }

[norberttech]

awesome, thanks @nnatter 🙌