1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?php declare(strict_types=1);
/*
* This file is part of PHPUnit.
*
* (c) Sebastian Bergmann <sebastian@phpunit.de>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace PHPUnit\Framework\Constraint;
use function json_encode;
use function sprintf;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\TestFailure;
use PHPUnit\Util\Json;
/**
* @small
*/
final class JsonMatchesTest extends ConstraintTestCase
{
public static function evaluateDataprovider(): array
{
return [
'valid JSON' => [true, json_encode(['Mascott' => 'Tux']), json_encode(['Mascott' => 'Tux'])],
'error syntax' => [false, '{"Mascott"::}', json_encode(['Mascott' => 'Tux'])],
'error UTF-8' => [false, json_encode('\xB1\x31'), json_encode(['Mascott' => 'Tux'])],
'invalid JSON in class instantiation' => [false, json_encode(['Mascott' => 'Tux']), '{"Mascott"::}'],
'string type not equals number' => [false, '{"age": "5"}', '{"age": 5}'],
'string type not equals boolean' => [false, '{"age": "true"}', '{"age": true}'],
'string type not equals null' => [false, '{"age": "null"}', '{"age": null}'],
'object fields are unordered' => [true, '{"first":1, "second":"2"}', '{"second":"2", "first":1}'],
'child object fields are unordered' => [true, '{"Mascott": {"name":"Tux", "age":5}}', '{"Mascott": {"age":5, "name":"Tux"}}'],
'null field different from missing field' => [false, '{"present": true, "missing": null}', '{"present": true}'],
'array elements are ordered' => [false, '["first", "second"]', '["second", "first"]'],
'single boolean valid json' => [true, 'true', 'true'],
'single number valid json' => [true, '5.3', '5.3'],
'single null valid json' => [true, 'null', 'null'],
'objects are not arrays' => [false, '{}', '[]'],
];
}
public static function evaluateThrowsExpectationFailedExceptionWhenJsonIsValidButDoesNotMatchDataprovider(): array
{
return [
'error UTF-8' => [json_encode('\xB1\x31'), json_encode(['Mascott' => 'Tux'])],
'string type not equals number' => ['{"age": "5"}', '{"age": 5}'],
'string type not equals boolean' => ['{"age": "true"}', '{"age": true}'],
'string type not equals null' => ['{"age": "null"}', '{"age": null}'],
'null field different from missing field' => ['{"missing": null, "present": true}', '{"present": true}'],
'array elements are ordered' => ['["first", "second"]', '["second", "first"]'],
];
}
/**
* @dataProvider evaluateDataprovider
*
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function testEvaluate($expected, $jsonOther, $jsonValue): void
{
$constraint = new JsonMatches($jsonValue);
$this->assertEquals($expected, $constraint->evaluate($jsonOther, '', true));
}
/**
* @dataProvider evaluateThrowsExpectationFailedExceptionWhenJsonIsValidButDoesNotMatchDataprovider
*
* @throws \PHPUnit\Framework\AssertionFailedError
* @throws \PHPUnit\Framework\Exception
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
* @throws ExpectationFailedException
*/
public function testEvaluateThrowsExpectationFailedExceptionWhenJsonIsValidButDoesNotMatch($jsonOther, $jsonValue): void
{
$constraint = new JsonMatches($jsonValue);
try {
$constraint->evaluate($jsonOther, '', false);
$this->fail(sprintf('Expected %s to be thrown.', ExpectationFailedException::class));
} catch (ExpectationFailedException $expectedException) {
$comparisonFailure = $expectedException->getComparisonFailure();
$this->assertNotNull($comparisonFailure);
[$error, $jsonOtherCanonicalized] = Json::canonicalize($jsonOther);
[$error, $jsonValueCanonicalized] = Json::canonicalize($jsonValue);
$this->assertSame(Json::prettify($jsonOtherCanonicalized), $comparisonFailure->getActualAsString());
$this->assertSame(Json::prettify($jsonValueCanonicalized), $comparisonFailure->getExpectedAsString());
$this->assertSame('Failed asserting that two json values are equal.', $comparisonFailure->getMessage());
}
}
public function testToString(): void
{
$jsonValue = json_encode(['Mascott' => 'Tux']);
$constraint = new JsonMatches($jsonValue);
$this->assertEquals('matches JSON string "' . $jsonValue . '"', $constraint->toString());
}
public function testFailErrorWithInvalidValueAndOther(): void
{
$constraint = new JsonMatches('{"Mascott"::}');
try {
$constraint->evaluate('{"Mascott"::}', '', false);
$this->fail(sprintf('Expected %s to be thrown.', ExpectationFailedException::class));
} catch (ExpectationFailedException $e) {
$this->assertEquals(
<<<'EOF'
Failed asserting that '{"Mascott"::}' matches JSON string "{"Mascott"::}".
EOF
,
TestFailure::exceptionToString($e)
);
}
}
public function testFailErrorWithValidValueAndInvalidOther(): void
{
$constraint = new JsonMatches('{"Mascott"::}');
try {
$constraint->evaluate('{"Mascott":"Tux"}', '', false);
$this->fail(sprintf('Expected %s to be thrown.', ExpectationFailedException::class));
} catch (ExpectationFailedException $e) {
$this->assertEquals(
<<<'EOF'
Failed asserting that '{"Mascott":"Tux"}' matches JSON string "{"Mascott"::}".
EOF
,
TestFailure::exceptionToString($e)
);
}
}
public function testEmptyObjectNotConvertedToArrayInDiff(): void
{
$constraint = new JsonMatches('{"obj": {}, "val": 1}');
try {
$constraint->evaluate('{"obj": {}, "val": 2}', '', false);
} catch (ExpectationFailedException $e) {
$this->assertEquals(
<<<'EOF'
Failed asserting that '{"obj": {}, "val": 2}' matches JSON string "{"obj": {}, "val": 1}".
--- Expected
+++ Actual
@@ @@
{
"obj": {},
- "val": 1
+ "val": 2
}
EOF
,
TestFailure::exceptionToString($e)
);
}
}
public function testObjectAreCanonicalizedInDiff(): void
{
$constraint = new JsonMatches('{"obj": {"x": 1, "y": 2}, "val": 1}');
try {
$constraint->evaluate('{"obj": {"y": 2, "x": 1}, "val": 2}', '', false);
} catch (ExpectationFailedException $e) {
$this->assertEquals(
<<<'EOF'
Failed asserting that '{"obj": {"y": 2, "x": 1}, "val": 2}' matches JSON string "{"obj": {"x": 1, "y": 2}, "val": 1}".
--- Expected
+++ Actual
@@ @@
"x": 1,
"y": 2
},
- "val": 1
+ "val": 2
}
EOF
,
TestFailure::exceptionToString($e)
);
}
}
}
|
