/
JsonFileTest.php
395 lines (338 loc) · 12.7 KB
/
JsonFileTest.php
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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
<?php declare(strict_types=1);
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer\Test\Json;
use Seld\JsonLint\ParsingException;
use Composer\Json\JsonFile;
use Composer\Json\JsonValidationException;
use Composer\Test\TestCase;
class JsonFileTest extends TestCase
{
public function testParseErrorDetectExtraComma(): void
{
$json = '{
"foo": "bar",
}';
$this->expectParseException('Parse error on line 2', $json);
}
public function testParseErrorDetectExtraCommaInArray(): void
{
$json = '{
"foo": [
"bar",
]
}';
$this->expectParseException('Parse error on line 3', $json);
}
public function testParseErrorDetectUnescapedBackslash(): void
{
$json = '{
"fo\o": "bar"
}';
$this->expectParseException('Parse error on line 1', $json);
}
public function testParseErrorSkipsEscapedBackslash(): void
{
$json = '{
"fo\\\\o": "bar"
"a": "b"
}';
$this->expectParseException('Parse error on line 2', $json);
}
public function testParseErrorDetectSingleQuotes(): void
{
if (defined('JSON_PARSER_NOTSTRICT') && version_compare(phpversion('json'), '1.3.9', '<')) {
$this->markTestSkipped('jsonc issue, see https://github.com/remicollet/pecl-json-c/issues/23');
}
$json = '{
\'foo\': "bar"
}';
$this->expectParseException('Parse error on line 1', $json);
}
public function testParseErrorDetectMissingQuotes(): void
{
$json = '{
foo: "bar"
}';
$this->expectParseException('Parse error on line 1', $json);
}
public function testParseErrorDetectArrayAsHash(): void
{
$json = '{
"foo": ["bar": "baz"]
}';
$this->expectParseException('Parse error on line 2', $json);
}
public function testParseErrorDetectMissingComma(): void
{
$json = '{
"foo": "bar"
"bar": "foo"
}';
$this->expectParseException('Parse error on line 2', $json);
}
public function testSchemaValidation(): void
{
$json = new JsonFile(__DIR__.'/Fixtures/composer.json');
$this->assertTrue($json->validateSchema());
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
}
public function testSchemaValidationError(): void
{
$file = $this->createTempFile();
file_put_contents($file, '{ "name": null }');
$json = new JsonFile($file);
$expectedMessage = sprintf('"%s" does not match the expected JSON schema', $file);
$expectedError = 'name : NULL value found, but a string is required';
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$this->assertContains($expectedError, $e->getErrors());
}
try {
$json->validateSchema(JsonFile::LAX_SCHEMA);
$this->fail('Expected exception to be thrown (lax)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$this->assertContains($expectedError, $e->getErrors());
}
unlink($file);
}
public function testSchemaValidationLaxAdditionalProperties(): void
{
$file = $this->createTempFile();
file_put_contents($file, '{ "name": "vendor/package", "description": "generic description", "foo": "bar" }');
$json = new JsonFile($file);
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals(sprintf('"%s" does not match the expected JSON schema', $file), $e->getMessage());
$this->assertEquals(array('The property foo is not defined and the definition does not allow additional properties'), $e->getErrors());
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
unlink($file);
}
public function testSchemaValidationLaxRequired(): void
{
$file = $this->createTempFile();
$json = new JsonFile($file);
$expectedMessage = sprintf('"%s" does not match the expected JSON schema', $file);
file_put_contents($file, '{ }');
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$errors = $e->getErrors();
$this->assertContains('name : The property name is required', $errors);
$this->assertContains('description : The property description is required', $errors);
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
file_put_contents($file, '{ "name": "vendor/package" }');
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$this->assertEquals(array('description : The property description is required'), $e->getErrors());
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
file_put_contents($file, '{ "description": "generic description" }');
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$this->assertEquals(array('name : The property name is required'), $e->getErrors());
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
file_put_contents($file, '{ "type": "library" }');
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$errors = $e->getErrors();
$this->assertContains('name : The property name is required', $errors);
$this->assertContains('description : The property description is required', $errors);
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
file_put_contents($file, '{ "type": "project" }');
try {
$json->validateSchema();
$this->fail('Expected exception to be thrown (strict)');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$errors = $e->getErrors();
$this->assertContains('name : The property name is required', $errors);
$this->assertContains('description : The property description is required', $errors);
}
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
file_put_contents($file, '{ "name": "vendor/package", "description": "generic description" }');
$this->assertTrue($json->validateSchema());
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA));
unlink($file);
}
public function testCustomSchemaValidationLax(): void
{
$file = $this->createTempFile();
file_put_contents($file, '{ "custom": "property", "another custom": "property" }');
$schema = $this->createTempFile();
file_put_contents($schema, '{ "properties": { "custom": { "type": "string" }}}');
$json = new JsonFile($file);
$this->assertTrue($json->validateSchema(JsonFile::LAX_SCHEMA, $schema));
unlink($file);
unlink($schema);
}
public function testCustomSchemaValidationStrict(): void
{
$file = $this->createTempFile();
file_put_contents($file, '{ "custom": "property" }');
$schema = $this->createTempFile();
file_put_contents($schema, '{ "properties": { "custom": { "type": "string" }}}');
$json = new JsonFile($file);
$this->assertTrue($json->validateSchema(JsonFile::STRICT_SCHEMA, $schema));
unlink($file);
unlink($schema);
}
public function testAuthSchemaValidationWithCustomDataSource(): void
{
$json = json_decode('{"github-oauth": "foo"}');
$expectedMessage = sprintf('"COMPOSER_AUTH" does not match the expected JSON schema');
$expectedError = 'github-oauth : String value found, but an object is required';
try {
JsonFile::validateJsonSchema('COMPOSER_AUTH', $json, JsonFile::AUTH_SCHEMA);
$this->fail('Expected exception to be thrown');
} catch (JsonValidationException $e) {
$this->assertEquals($expectedMessage, $e->getMessage());
$this->assertSame([$expectedError], $e->getErrors());
}
}
public function testParseErrorDetectMissingCommaMultiline(): void
{
$json = '{
"foo": "barbar"
"bar": "foo"
}';
$this->expectParseException('Parse error on line 2', $json);
}
public function testParseErrorDetectMissingColon(): void
{
$json = '{
"foo": "bar",
"bar" "foo"
}';
$this->expectParseException('Parse error on line 3', $json);
}
public function testSimpleJsonString(): void
{
$data = array('name' => 'composer/composer');
$json = '{
"name": "composer/composer"
}';
$this->assertJsonFormat($json, $data);
}
public function testTrailingBackslash(): void
{
$data = array('Metadata\\' => 'src/');
$json = '{
"Metadata\\\\": "src/"
}';
$this->assertJsonFormat($json, $data);
}
public function testFormatEmptyArray(): void
{
$data = array('test' => array(), 'test2' => new \stdClass);
$json = '{
"test": [],
"test2": {}
}';
$this->assertJsonFormat($json, $data);
}
public function testEscape(): void
{
$data = array("Metadata\\\"" => 'src/');
$json = '{
"Metadata\\\\\\"": "src/"
}';
$this->assertJsonFormat($json, $data);
}
public function testUnicode(): void
{
$data = array("Žluťoučký \" kůň" => "úpěl ďábelské ódy za €");
$json = '{
"Žluťoučký \" kůň": "úpěl ďábelské ódy za €"
}';
$this->assertJsonFormat($json, $data);
}
public function testOnlyUnicode(): void
{
$data = "\\/ƌ";
$this->assertJsonFormat('"\\\\\\/ƌ"', $data, JSON_UNESCAPED_UNICODE);
}
public function testEscapedSlashes(): void
{
$data = "\\/foo";
$this->assertJsonFormat('"\\\\\\/foo"', $data, 0);
}
public function testEscapedBackslashes(): void
{
$data = "a\\b";
$this->assertJsonFormat('"a\\\\b"', $data, 0);
}
public function testEscapedUnicode(): void
{
$data = "ƌ";
$this->assertJsonFormat('"\\u018c"', $data, 0);
}
public function testDoubleEscapedUnicode(): void
{
$jsonFile = new JsonFile('composer.json');
$data = array("Zdjęcia","hjkjhl\\u0119kkjk");
$encodedData = $jsonFile->encode($data);
$doubleEncodedData = $jsonFile->encode(array('t' => $encodedData));
$decodedData = json_decode($doubleEncodedData, true);
$doubleData = json_decode($decodedData['t'], true);
$this->assertEquals($data, $doubleData);
}
/**
* @param string $text
* @param string $json
* @return void
*/
private function expectParseException(string $text, string $json): void
{
try {
$result = JsonFile::parseJson($json);
$this->fail(sprintf("Parsing should have failed but didn't.\nExpected:\n\"%s\"\nFor:\n\"%s\"\nGot:\n\"%s\"", $text, $json, var_export($result, true)));
} catch (ParsingException $e) {
$this->assertStringContainsString($text, $e->getMessage());
}
}
/**
* @param string $json
* @param mixed $data
* @param int|null $options
* @return void
*/
private function assertJsonFormat(string $json, $data, ?int $options = null): void
{
$file = new JsonFile('composer.json');
$json = str_replace("\r", '', $json);
if (null === $options) {
$this->assertEquals($json, $file->encode($data));
} else {
$this->assertEquals($json, $file->encode($data, $options));
}
}
}