-
-
Notifications
You must be signed in to change notification settings - Fork 76
/
Copy pathSerializerTest.php
1869 lines (1568 loc) · 70.6 KB
/
SerializerTest.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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <[email protected]>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Serializer\Tests;
use PHPUnit\Framework\TestCase;
use Symfony\Component\PropertyAccess\Exception\InvalidTypeException;
use Symfony\Component\PropertyAccess\PropertyAccessor;
use Symfony\Component\PropertyInfo\Extractor\PhpDocExtractor;
use Symfony\Component\PropertyInfo\Extractor\ReflectionExtractor;
use Symfony\Component\PropertyInfo\PropertyInfoExtractor;
use Symfony\Component\Serializer\Encoder\CsvEncoder;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Exception\ExtraAttributesException;
use Symfony\Component\Serializer\Exception\InvalidArgumentException;
use Symfony\Component\Serializer\Exception\LogicException;
use Symfony\Component\Serializer\Exception\NotNormalizableValueException;
use Symfony\Component\Serializer\Exception\PartialDenormalizationException;
use Symfony\Component\Serializer\Exception\UnexpectedValueException;
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorFromClassMetadata;
use Symfony\Component\Serializer\Mapping\ClassDiscriminatorMapping;
use Symfony\Component\Serializer\Mapping\ClassMetadata;
use Symfony\Component\Serializer\Mapping\ClassMetadataInterface;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
use Symfony\Component\Serializer\Mapping\Loader\AttributeLoader;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\ArrayDenormalizer;
use Symfony\Component\Serializer\Normalizer\BackedEnumNormalizer;
use Symfony\Component\Serializer\Normalizer\CustomNormalizer;
use Symfony\Component\Serializer\Normalizer\DataUriNormalizer;
use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
use Symfony\Component\Serializer\Normalizer\DateTimeZoneNormalizer;
use Symfony\Component\Serializer\Normalizer\DenormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
use Symfony\Component\Serializer\Normalizer\GetSetMethodNormalizer;
use Symfony\Component\Serializer\Normalizer\NormalizerAwareInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
use Symfony\Component\Serializer\Normalizer\UidNormalizer;
use Symfony\Component\Serializer\Normalizer\UnwrappingDenormalizer;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Serializer\Tests\Fixtures\Attributes\AbstractDummy;
use Symfony\Component\Serializer\Tests\Fixtures\Attributes\AbstractDummyFirstChild;
use Symfony\Component\Serializer\Tests\Fixtures\Attributes\AbstractDummySecondChild;
use Symfony\Component\Serializer\Tests\Fixtures\DenormalizableDummy;
use Symfony\Component\Serializer\Tests\Fixtures\DummyFirstChildQuux;
use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface;
use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberOne;
use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberThree;
use Symfony\Component\Serializer\Tests\Fixtures\DummyMessageNumberTwo;
use Symfony\Component\Serializer\Tests\Fixtures\DummyNullableInt;
use Symfony\Component\Serializer\Tests\Fixtures\DummyObjectWithEnumConstructor;
use Symfony\Component\Serializer\Tests\Fixtures\DummyObjectWithEnumProperty;
use Symfony\Component\Serializer\Tests\Fixtures\DummyWithObjectOrNull;
use Symfony\Component\Serializer\Tests\Fixtures\DummyWithVariadicParameter;
use Symfony\Component\Serializer\Tests\Fixtures\DummyWithVariadicProperty;
use Symfony\Component\Serializer\Tests\Fixtures\FalseBuiltInDummy;
use Symfony\Component\Serializer\Tests\Fixtures\FooImplementationDummy;
use Symfony\Component\Serializer\Tests\Fixtures\FooInterfaceDummyDenormalizer;
use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
use Symfony\Component\Serializer\Tests\Fixtures\ObjectCollectionPropertyDummy;
use Symfony\Component\Serializer\Tests\Fixtures\Php74Full;
use Symfony\Component\Serializer\Tests\Fixtures\Php80WithOptionalConstructorParameter;
use Symfony\Component\Serializer\Tests\Fixtures\Php80WithPromotedTypedConstructor;
use Symfony\Component\Serializer\Tests\Fixtures\TraversableDummy;
use Symfony\Component\Serializer\Tests\Fixtures\TrueBuiltInDummy;
use Symfony\Component\Serializer\Tests\Fixtures\WithTypedConstructor;
use Symfony\Component\Serializer\Tests\Normalizer\TestDenormalizer;
use Symfony\Component\Serializer\Tests\Normalizer\TestNormalizer;
class SerializerTest extends TestCase
{
public function testItThrowsExceptionOnInvalidNormalizer()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('The class "stdClass" neither implements "Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface" nor "Symfony\\Component\\Serializer\\Normalizer\\DenormalizerInterface".');
new Serializer([new \stdClass()]);
}
public function testItThrowsExceptionOnInvalidEncoder()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('The class "stdClass" neither implements "Symfony\\Component\\Serializer\\Encoder\\EncoderInterface" nor "Symfony\\Component\\Serializer\\Encoder\\DecoderInterface"');
new Serializer([], [new \stdClass()]);
}
public function testNormalizeNoMatch()
{
$serializer = new Serializer([$this->createMock(NormalizerInterface::class)]);
$this->expectException(UnexpectedValueException::class);
$serializer->normalize(new \stdClass(), 'xml');
}
public function testNormalizeTraversable()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$result = $serializer->serialize(new TraversableDummy(), 'json');
$this->assertEquals('{"foo":"foo","bar":"bar"}', $result);
}
public function testNormalizeGivesPriorityToInterfaceOverTraversable()
{
$serializer = new Serializer([new CustomNormalizer()], ['json' => new JsonEncoder()]);
$result = $serializer->serialize(new NormalizableTraversableDummy(), 'json');
$this->assertEquals('{"foo":"normalizedFoo","bar":"normalizedBar"}', $result);
}
public function testNormalizeOnDenormalizer()
{
$serializer = new Serializer([new TestDenormalizer()], []);
$this->expectException(UnexpectedValueException::class);
$this->assertTrue($serializer->normalize(new \stdClass(), 'json'));
}
public function testDenormalizeNoMatch()
{
$serializer = new Serializer([$this->createMock(NormalizerInterface::class)]);
$this->expectException(UnexpectedValueException::class);
$serializer->denormalize('foo', 'stdClass');
}
public function testDenormalizeOnObjectThatOnlySupportsDenormalization()
{
$serializer = new Serializer([new CustomNormalizer()]);
$obj = $serializer->denormalize('foo', (new DenormalizableDummy())::class, 'xml');
$this->assertInstanceOf(DenormalizableDummy::class, $obj);
}
public function testDenormalizeOnNormalizer()
{
$serializer = new Serializer([new TestNormalizer()], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(UnexpectedValueException::class);
$this->assertTrue($serializer->denormalize(json_encode($data), 'stdClass', 'json'));
}
public function testCustomNormalizerCanNormalizeCollectionsAndScalar()
{
$serializer = new Serializer([new TestNormalizer()], []);
$this->assertNull($serializer->normalize(['a', 'b']));
$this->assertNull($serializer->normalize(new \ArrayObject(['c', 'd'])));
$this->assertNull($serializer->normalize([]));
$this->assertNull($serializer->normalize('test'));
}
public function testNormalizeWithSupportOnData()
{
$normalizer1 = $this->createMock(NormalizerInterface::class);
$normalizer1->method('getSupportedTypes')->willReturn(['*' => false]);
$normalizer1->method('supportsNormalization')
->willReturnCallback(fn ($data, $format) => isset($data->test));
$normalizer1->method('normalize')->willReturn('test1');
$normalizer2 = $this->createMock(NormalizerInterface::class);
$normalizer2->method('getSupportedTypes')->willReturn(['*' => false]);
$normalizer2->method('supportsNormalization')
->willReturn(true);
$normalizer2->method('normalize')->willReturn('test2');
$serializer = new Serializer([$normalizer1, $normalizer2]);
$data = new \stdClass();
$data->test = true;
$this->assertEquals('test1', $serializer->normalize($data));
$this->assertEquals('test2', $serializer->normalize(new \stdClass()));
}
public function testDenormalizeWithSupportOnData()
{
$denormalizer1 = $this->createMock(DenormalizerInterface::class);
$denormalizer1->method('getSupportedTypes')->willReturn(['*' => false]);
$denormalizer1->method('supportsDenormalization')
->willReturnCallback(fn ($data, $type, $format) => isset($data['test1']));
$denormalizer1->method('denormalize')->willReturn('test1');
$denormalizer2 = $this->createMock(DenormalizerInterface::class);
$denormalizer2->method('getSupportedTypes')->willReturn(['*' => false]);
$denormalizer2->method('supportsDenormalization')
->willReturn(true);
$denormalizer2->method('denormalize')->willReturn('test2');
$serializer = new Serializer([$denormalizer1, $denormalizer2]);
$this->assertEquals('test1', $serializer->denormalize(['test1' => true], 'test'));
$this->assertEquals('test2', $serializer->denormalize([], 'test'));
}
public function testSerialize()
{
$serializer = new Serializer([new GetSetMethodNormalizer()], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$result = $serializer->serialize(Model::fromArray($data), 'json');
$this->assertEquals(json_encode($data), $result);
}
public function testSerializeScalar()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$result = $serializer->serialize('foo', 'json');
$this->assertEquals('"foo"', $result);
}
public function testSerializeArrayOfScalars()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$data = ['foo', [5, 3]];
$result = $serializer->serialize($data, 'json');
$this->assertEquals(json_encode($data), $result);
}
public function testSerializeEmpty()
{
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$data = ['foo' => new \stdClass()];
// Old buggy behaviour
$result = $serializer->serialize($data, 'json');
$this->assertEquals('{"foo":[]}', $result);
$result = $serializer->serialize($data, 'json', ['preserve_empty_objects' => true]);
$this->assertEquals('{"foo":{}}', $result);
}
public function testSerializeNoEncoder()
{
$serializer = new Serializer([], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(UnexpectedValueException::class);
$serializer->serialize($data, 'json');
}
public function testSerializeNoNormalizer()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(LogicException::class);
$serializer->serialize(Model::fromArray($data), 'json');
}
public function testDeserialize()
{
$serializer = new Serializer([new GetSetMethodNormalizer()], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$result = $serializer->deserialize(json_encode($data), Model::class, 'json');
$this->assertEquals($data, $result->toArray());
}
public function testDeserializeUseCache()
{
$serializer = new Serializer([new GetSetMethodNormalizer()], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$serializer->deserialize(json_encode($data), Model::class, 'json');
$data = ['title' => 'bar', 'numbers' => [2, 8]];
$result = $serializer->deserialize(json_encode($data), Model::class, 'json');
$this->assertEquals($data, $result->toArray());
}
public function testDeserializeNoNormalizer()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(LogicException::class);
$serializer->deserialize(json_encode($data), Model::class, 'json');
}
public function testDeserializeWrongNormalizer()
{
$serializer = new Serializer([new CustomNormalizer()], ['json' => new JsonEncoder()]);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(UnexpectedValueException::class);
$serializer->deserialize(json_encode($data), Model::class, 'json');
}
public function testDeserializeNoEncoder()
{
$serializer = new Serializer([], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->expectException(UnexpectedValueException::class);
$serializer->deserialize(json_encode($data), Model::class, 'json');
}
public function testDeserializeSupported()
{
$serializer = new Serializer([new GetSetMethodNormalizer()], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->assertTrue($serializer->supportsDenormalization(json_encode($data), Model::class, 'json'));
}
public function testDeserializeNotSupported()
{
$serializer = new Serializer([new GetSetMethodNormalizer()], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->assertFalse($serializer->supportsDenormalization(json_encode($data), 'stdClass', 'json'));
}
public function testDeserializeNotSupportedMissing()
{
$serializer = new Serializer([], []);
$data = ['title' => 'foo', 'numbers' => [5, 3]];
$this->assertFalse($serializer->supportsDenormalization(json_encode($data), Model::class, 'json'));
}
public function testEncode()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$data = ['foo', [5, 3]];
$result = $serializer->encode($data, 'json');
$this->assertEquals(json_encode($data), $result);
}
public function testDecode()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$data = ['foo', [5, 3]];
$result = $serializer->decode(json_encode($data), 'json');
$this->assertEquals($data, $result);
}
public function testSupportsArrayDeserialization()
{
$serializer = new Serializer(
[
new GetSetMethodNormalizer(),
new PropertyNormalizer(),
new ObjectNormalizer(),
new CustomNormalizer(),
new ArrayDenormalizer(),
],
[
'json' => new JsonEncoder(),
]
);
$this->assertTrue(
$serializer->supportsDenormalization([], __NAMESPACE__.'\Model[]', 'json')
);
}
public function testDeserializeArray()
{
$jsonData = '[{"title":"foo","numbers":[5,3]},{"title":"bar","numbers":[2,8]}]';
$expectedData = [
Model::fromArray(['title' => 'foo', 'numbers' => [5, 3]]),
Model::fromArray(['title' => 'bar', 'numbers' => [2, 8]]),
];
$serializer = new Serializer(
[
new GetSetMethodNormalizer(),
new ArrayDenormalizer(),
],
[
'json' => new JsonEncoder(),
]
);
$this->assertEquals(
$expectedData,
$serializer->deserialize($jsonData, __NAMESPACE__.'\Model[]', 'json')
);
}
public function testNormalizerAware()
{
$normalizerAware = $this->createMock(NormalizerAwareNormalizer::class);
$normalizerAware->expects($this->once())
->method('setNormalizer');
new Serializer([$normalizerAware]);
}
public function testDenormalizerAware()
{
$denormalizerAware = $this->createMock(DenormalizerAwareDenormalizer::class);
$denormalizerAware->expects($this->once())
->method('setDenormalizer');
new Serializer([$denormalizerAware]);
}
public function testDeserializeObjectConstructorWithObjectTypeHint()
{
$jsonData = '{"bar":{"value":"baz"}}';
$serializer = new Serializer([new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$this->assertEquals(new Foo(new Bar('baz')), $serializer->deserialize($jsonData, Foo::class, 'json'));
}
public function testDeserializeAndSerializeAbstractObjectsWithTheClassMetadataDiscriminatorResolver()
{
$example = new AbstractDummyFirstChild('foo-value', 'bar-value');
$example->setQuux(new DummyFirstChildQuux('quux'));
$loaderMock = new class implements ClassMetadataFactoryInterface {
public function getMetadataFor($value): ClassMetadataInterface
{
if (AbstractDummy::class === $value) {
return new ClassMetadata(
AbstractDummy::class,
new ClassDiscriminatorMapping('type', [
'first' => AbstractDummyFirstChild::class,
'second' => AbstractDummySecondChild::class,
])
);
}
throw new InvalidArgumentException();
}
public function hasMetadataFor($value): bool
{
return AbstractDummy::class === $value;
}
};
$discriminatorResolver = new ClassDiscriminatorFromClassMetadata($loaderMock);
$serializer = new Serializer([new ObjectNormalizer(null, null, null, new PhpDocExtractor(), $discriminatorResolver)], ['json' => new JsonEncoder()]);
$jsonData = '{"type":"first","quux":{"value":"quux"},"bar":"bar-value","foo":"foo-value"}';
$deserialized = $serializer->deserialize($jsonData, AbstractDummy::class, 'json');
$this->assertEquals($example, $deserialized);
$serialized = $serializer->serialize($deserialized, 'json');
$this->assertEquals($jsonData, $serialized);
}
public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadataDiscriminatorResolver()
{
$example = new DummyMessageNumberOne();
$example->one = 1;
$jsonData = '{"type":"one","one":1,"two":null}';
$serializer = $this->serializerWithClassDiscriminator();
$deserialized = $serializer->deserialize($jsonData, DummyMessageInterface::class, 'json');
$this->assertEquals($example, $deserialized);
$serialized = $serializer->serialize($deserialized, 'json');
$this->assertEquals($jsonData, $serialized);
}
public function testDeserializeAndSerializeInterfacedObjectsWithTheClassMetadataDiscriminatorResolverAndGroups()
{
$example = new DummyMessageNumberOne();
$example->two = 2;
$serializer = $this->serializerWithClassDiscriminator();
$deserialized = $serializer->deserialize('{"type":"one","one":1,"two":2}', DummyMessageInterface::class, 'json', [
'groups' => ['two'],
]);
$this->assertEquals($example, $deserialized);
$serialized = $serializer->serialize($deserialized, 'json', [
'groups' => ['two'],
]);
$this->assertEquals('{"two":2,"type":"one"}', $serialized);
}
public function testDeserializeAndSerializeNestedInterfacedObjectsWithTheClassMetadataDiscriminator()
{
$nested = new DummyMessageNumberOne();
$nested->one = 'foo';
$example = new DummyMessageNumberTwo();
$example->setNested($nested);
$serializer = $this->serializerWithClassDiscriminator();
$serialized = $serializer->serialize($example, 'json');
$deserialized = $serializer->deserialize($serialized, DummyMessageInterface::class, 'json');
$this->assertEquals($example, $deserialized);
}
public function testDeserializeAndSerializeNestedAbstractAndInterfacedObjectsWithTheClassMetadataDiscriminator()
{
$example = new DummyMessageNumberThree();
$serializer = $this->serializerWithClassDiscriminator();
$serialized = $serializer->serialize($example, 'json');
$deserialized = $serializer->deserialize($serialized, DummyMessageInterface::class, 'json');
$this->assertEquals($example, $deserialized);
}
public function testExceptionWhenTypeIsNotKnownInDiscriminator()
{
try {
$this->serializerWithClassDiscriminator()->deserialize('{"type":"second","one":1}', DummyMessageInterface::class, 'json');
$this->fail();
} catch (\Throwable $e) {
$this->assertInstanceOf(NotNormalizableValueException::class, $e);
$this->assertSame('The type "second" is not a valid value.', $e->getMessage());
$this->assertSame('string', $e->getCurrentType());
$this->assertSame(['string'], $e->getExpectedTypes());
$this->assertSame('type', $e->getPath());
$this->assertTrue($e->canUseMessageForUser());
}
}
public function testExceptionWhenTypeIsNotInTheBodyToDeserialiaze()
{
try {
$this->serializerWithClassDiscriminator()->deserialize('{"one":1}', DummyMessageInterface::class, 'json');
$this->fail();
} catch (\Throwable $e) {
$this->assertInstanceOf(NotNormalizableValueException::class, $e);
$this->assertSame('Type property "type" not found for the abstract object "Symfony\Component\Serializer\Tests\Fixtures\DummyMessageInterface".', $e->getMessage());
$this->assertSame('null', $e->getCurrentType());
$this->assertSame(['string'], $e->getExpectedTypes());
$this->assertSame('type', $e->getPath());
$this->assertFalse($e->canUseMessageForUser());
}
}
public function testNotNormalizableValueExceptionMessageForAResource()
{
$this->expectException(NotNormalizableValueException::class);
$this->expectExceptionMessage('An unexpected value could not be normalized: "stream" resource');
(new Serializer())->normalize(tmpfile());
}
public function testNormalizeTransformEmptyArrayObjectToArray()
{
$serializer = new Serializer(
[
new PropertyNormalizer(),
new ObjectNormalizer(),
new ArrayDenormalizer(),
],
[
'json' => new JsonEncoder(),
]
);
$object = [];
$object['foo'] = new \ArrayObject();
$object['bar'] = new \ArrayObject(['notempty']);
$object['baz'] = new \ArrayObject(['nested' => new \ArrayObject()]);
$object['a'] = new \ArrayObject(['nested' => []]);
$object['b'] = [];
$this->assertSame('{"foo":[],"bar":["notempty"],"baz":{"nested":[]},"a":{"nested":[]},"b":[]}', $serializer->serialize($object, 'json'));
}
public static function provideObjectOrCollectionTests()
{
$serializer = new Serializer(
[
new PropertyNormalizer(),
new ObjectNormalizer(),
new ArrayDenormalizer(),
],
[
'json' => new JsonEncoder(),
]
);
$data = [];
$data['a1'] = new \ArrayObject();
$data['a2'] = new \ArrayObject(['k' => 'v']);
$data['b1'] = [];
$data['b2'] = ['k' => 'v'];
$data['c1'] = new \ArrayObject(['nested' => new \ArrayObject()]);
$data['c2'] = new \ArrayObject(['nested' => new \ArrayObject(['k' => 'v'])]);
$data['d1'] = new \ArrayObject(['nested' => []]);
$data['d2'] = new \ArrayObject(['nested' => ['k' => 'v']]);
$data['e1'] = new class {
public $map = [];
};
$data['e2'] = new class {
public $map = ['k' => 'v'];
};
$data['f1'] = new class(new \ArrayObject()) {
public $map;
public function __construct(\ArrayObject $map)
{
$this->map = $map;
}
};
$data['f2'] = new class(new \ArrayObject(['k' => 'v'])) {
public $map;
public function __construct(\ArrayObject $map)
{
$this->map = $map;
}
};
$data['g1'] = new Baz([]);
$data['g2'] = new Baz(['greg']);
yield [$serializer, $data];
}
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizeWithCollection(Serializer $serializer, array $data)
{
$expected = '{"a1":[],"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json'));
}
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizePreserveEmptyArrayObject(Serializer $serializer, array $data)
{
$expected = '{"a1":{},"a2":{"k":"v"},"b1":[],"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":[]},"d2":{"nested":{"k":"v"}},"e1":{"map":[]},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{},"settings":[]},"g2":{"list":["greg"],"settings":[]}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizeEmptyArrayAsObject(Serializer $serializer, array $data)
{
$expected = '{"a1":[],"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":[]},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":[]},"f2":{"map":{"k":"v"}},"g1":{"list":[],"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
]));
}
/** @dataProvider provideObjectOrCollectionTests */
public function testNormalizeEmptyArrayAsObjectAndPreserveEmptyArrayObject(Serializer $serializer, array $data)
{
$expected = '{"a1":{},"a2":{"k":"v"},"b1":{},"b2":{"k":"v"},"c1":{"nested":{}},"c2":{"nested":{"k":"v"}},"d1":{"nested":{}},"d2":{"nested":{"k":"v"}},"e1":{"map":{}},"e2":{"map":{"k":"v"}},"f1":{"map":{}},"f2":{"map":{"k":"v"}},"g1":{"list":{},"settings":{}},"g2":{"list":["greg"],"settings":{}}}';
$this->assertSame($expected, $serializer->serialize($data, 'json', [
Serializer::EMPTY_ARRAY_AS_OBJECT => true,
AbstractObjectNormalizer::PRESERVE_EMPTY_OBJECTS => true,
]));
}
public function testNormalizeScalar()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->assertSame('42', $serializer->serialize(42, 'json'));
$this->assertSame('true', $serializer->serialize(true, 'json'));
$this->assertSame('false', $serializer->serialize(false, 'json'));
$this->assertSame('3.14', $serializer->serialize(3.14, 'json'));
$this->assertSame('3.14', $serializer->serialize(31.4e-1, 'json'));
$this->assertSame('" spaces "', $serializer->serialize(' spaces ', 'json'));
$this->assertSame('"@Ca$e%"', $serializer->serialize('@Ca$e%', 'json'));
}
public function testNormalizeScalarArray()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->assertSame('[42]', $serializer->serialize([42], 'json'));
$this->assertSame('[true,false]', $serializer->serialize([true, false], 'json'));
$this->assertSame('[3.14,3.24]', $serializer->serialize([3.14, 32.4e-1], 'json'));
$this->assertSame('[" spaces ","@Ca$e%"]', $serializer->serialize([' spaces ', '@Ca$e%'], 'json'));
}
public function testDeserializeScalar()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->assertSame(42, $serializer->deserialize('42', 'int', 'json'));
$this->assertTrue($serializer->deserialize('true', 'bool', 'json'));
$this->assertSame(3.14, $serializer->deserialize('3.14', 'float', 'json'));
$this->assertSame(3.14, $serializer->deserialize('31.4e-1', 'float', 'json'));
$this->assertSame(' spaces ', $serializer->deserialize('" spaces "', 'string', 'json'));
$this->assertSame('@Ca$e%', $serializer->deserialize('"@Ca$e%"', 'string', 'json'));
}
public function testDeserializeLegacyScalarType()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->expectException(LogicException::class);
$serializer->deserialize('42', 'integer', 'json');
}
public function testDeserializeScalarTypeToCustomType()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->expectException(LogicException::class);
$serializer->deserialize('"something"', Foo::class, 'json');
}
public function testDeserializeNonscalarTypeToScalar()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->expectException(NotNormalizableValueException::class);
$serializer->deserialize('{"foo":true}', 'string', 'json');
}
public function testDeserializeInconsistentScalarType()
{
$serializer = new Serializer([], ['json' => new JsonEncoder()]);
$this->expectException(NotNormalizableValueException::class);
$serializer->deserialize('"42"', 'int', 'json');
}
public function testDeserializeScalarArray()
{
$serializer = new Serializer([new ArrayDenormalizer()], ['json' => new JsonEncoder()]);
$this->assertSame([42], $serializer->deserialize('[42]', 'int[]', 'json'));
$this->assertSame([true, false], $serializer->deserialize('[true,false]', 'bool[]', 'json'));
$this->assertSame([3.14, 3.24], $serializer->deserialize('[3.14,32.4e-1]', 'float[]', 'json'));
$this->assertSame([' spaces ', '@Ca$e%'], $serializer->deserialize('[" spaces ","@Ca$e%"]', 'string[]', 'json'));
}
public function testDeserializeInconsistentScalarArray()
{
$serializer = new Serializer([new ArrayDenormalizer()], ['json' => new JsonEncoder()]);
$this->expectException(NotNormalizableValueException::class);
$serializer->deserialize('["42"]', 'int[]', 'json');
}
public function testDeserializeOnObjectWithObjectCollectionProperty()
{
$serializer = new Serializer([new FooInterfaceDummyDenormalizer(), new ObjectNormalizer(null, null, null, new PhpDocExtractor())], [new JsonEncoder()]);
$obj = $serializer->deserialize('{"foo":[{"name":"bar"}]}', ObjectCollectionPropertyDummy::class, 'json');
$this->assertInstanceOf(ObjectCollectionPropertyDummy::class, $obj);
$fooDummyObjects = $obj->getFoo();
$this->assertCount(1, $fooDummyObjects);
$fooDummyObject = $fooDummyObjects[0];
$this->assertInstanceOf(FooImplementationDummy::class, $fooDummyObject);
$this->assertSame('bar', $fooDummyObject->name);
}
public function testDeserializeWrappedScalar()
{
$serializer = new Serializer([new UnwrappingDenormalizer()], ['json' => new JsonEncoder()]);
$this->assertSame(42, $serializer->deserialize('{"wrapper": 42}', 'int', 'json', [UnwrappingDenormalizer::UNWRAP_PATH => '[wrapper]']));
}
public function testDeserializeNullableIntInXml()
{
$extractor = new PropertyInfoExtractor([], [new ReflectionExtractor()]);
$serializer = new Serializer([new ObjectNormalizer(null, null, null, $extractor)], ['xml' => new XmlEncoder()]);
$obj = $serializer->deserialize('<?xml version="1.0" encoding="UTF-8"?><DummyNullableInt><value/></DummyNullableInt>', DummyNullableInt::class, 'xml');
$this->assertInstanceOf(DummyNullableInt::class, $obj);
$this->assertNull($obj->value);
}
public function testUnionTypeDeserializable()
{
$classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
$extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
$serializer = new Serializer(
[
new DateTimeNormalizer(),
new ObjectNormalizer($classMetadataFactory, null, null, $extractor, new ClassDiscriminatorFromClassMetadata($classMetadataFactory)),
],
['json' => new JsonEncoder()]
);
$actual = $serializer->deserialize('{ "changed": null }', DummyUnionType::class, 'json', [
DateTimeNormalizer::FORMAT_KEY => \DateTimeinterface::ATOM,
]);
$this->assertEquals((new DummyUnionType())->setChanged(null), $actual, 'Union type denormalization first case failed.');
$actual = $serializer->deserialize('{ "changed": "2022-03-22T16:15:05+0000" }', DummyUnionType::class, 'json', [
DateTimeNormalizer::FORMAT_KEY => \DateTimeinterface::ATOM,
]);
$expectedDateTime = \DateTimeImmutable::createFromFormat(\DateTimeinterface::ATOM, '2022-03-22T16:15:05+0000');
$this->assertEquals((new DummyUnionType())->setChanged($expectedDateTime), $actual, 'Union type denormalization second case failed.');
$actual = $serializer->deserialize('{ "changed": false }', DummyUnionType::class, 'json', [
DateTimeNormalizer::FORMAT_KEY => \DateTimeinterface::ATOM,
]);
$this->assertEquals(new DummyUnionType(), $actual, 'Union type denormalization third case failed.');
}
public function testUnionTypeDeserializableWithoutAllowedExtraAttributes()
{
$classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
$extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
$serializer = new Serializer(
[
new ObjectNormalizer($classMetadataFactory, null, null, $extractor, new ClassDiscriminatorFromClassMetadata($classMetadataFactory)),
],
['json' => new JsonEncoder()]
);
$actual = $serializer->deserialize('{ "v": { "a": 0 }}', DummyUnionWithAAndCAndB::class, 'json', [
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
]);
$this->assertEquals(new DummyUnionWithAAndCAndB(new DummyATypeForUnion()), $actual);
$actual = $serializer->deserialize('{ "v": { "b": 1 }}', DummyUnionWithAAndCAndB::class, 'json', [
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
]);
$this->assertEquals(new DummyUnionWithAAndCAndB(new DummyBTypeForUnion()), $actual);
$actual = $serializer->deserialize('{ "v": { "c": 3 }}', DummyUnionWithAAndCAndB::class, 'json', [
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
]);
$this->assertEquals(new DummyUnionWithAAndCAndB(new DummyCTypeForUnion(3)), $actual);
$this->expectException(ExtraAttributesException::class);
$serializer->deserialize('{ "v": { "b": 1, "d": "i am not allowed" }}', DummyUnionWithAAndCAndB::class, 'json', [
AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
]);
}
public function testFalseBuiltInTypes()
{
$extractor = new PropertyInfoExtractor([], [new ReflectionExtractor()]);
$serializer = new Serializer([new ObjectNormalizer(null, null, null, $extractor)], ['json' => new JsonEncoder()]);
$actual = $serializer->deserialize('{"false":false}', FalseBuiltInDummy::class, 'json');
$this->assertEquals(new FalseBuiltInDummy(), $actual);
}
public function testTrueBuiltInTypes()
{
$extractor = new PropertyInfoExtractor([], [new ReflectionExtractor()]);
$serializer = new Serializer([new ObjectNormalizer(null, null, null, $extractor)], ['json' => new JsonEncoder()]);
$actual = $serializer->deserialize('{"true":true}', TrueBuiltInDummy::class, 'json');
$this->assertEquals(new TrueBuiltInDummy(), $actual);
}
public function testDeserializeUntypedFormat()
{
$serializer = new Serializer([new ObjectNormalizer(null, null, null, new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]))], ['csv' => new CsvEncoder()]);
$actual = $serializer->deserialize('value'.\PHP_EOL.',', DummyWithObjectOrNull::class, 'csv', [CsvEncoder::AS_COLLECTION_KEY => false]);
$this->assertEquals(new DummyWithObjectOrNull(null), $actual);
}
private function serializerWithClassDiscriminator()
{
$classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
return new Serializer([new ObjectNormalizer($classMetadataFactory, null, null, new ReflectionExtractor(), new ClassDiscriminatorFromClassMetadata($classMetadataFactory))], ['json' => new JsonEncoder()]);
}
public function testDeserializeAndUnwrap()
{
$jsonData = '{"baz": {"foo": "bar", "inner": {"title": "value", "numbers": [5,3]}}}';
$expectedData = Model::fromArray(['title' => 'value', 'numbers' => [5, 3]]);
$serializer = new Serializer([new UnwrappingDenormalizer(new PropertyAccessor()), new ObjectNormalizer()], ['json' => new JsonEncoder()]);
$this->assertEquals(
$expectedData,
$serializer->deserialize($jsonData, __NAMESPACE__.'\Model', 'json', [UnwrappingDenormalizer::UNWRAP_PATH => '[baz][inner]'])
);
}
/**
* @dataProvider provideCollectDenormalizationErrors
*/
public function testCollectDenormalizationErrors(?ClassMetadataFactory $classMetadataFactory)
{
$json = '
{
"string": null,
"int": null,
"float": null,
"bool": null,
"dateTime": null,
"dateTimeImmutable": null,
"dateTimeZone": null,
"splFileInfo": null,
"uuid": null,
"array": null,
"collection": [
{
"string": "string"
},
{
"string": null
}
],
"php74FullWithConstructor": {},
"php74FullWithTypedConstructor": {
"something": "not a float",
"somethingElse": "not a bool"
},
"dummyMessage": {
},
"nestedObject": {
"int": "string"
},
"anotherCollection": null
}';
$extractor = new PropertyInfoExtractor([], [new PhpDocExtractor(), new ReflectionExtractor()]);
$serializer = new Serializer(
[
new ArrayDenormalizer(),
new DateTimeNormalizer(),
new DateTimeZoneNormalizer(),
new DataUriNormalizer(),
new UidNormalizer(),
new ObjectNormalizer($classMetadataFactory, null, null, $extractor, $classMetadataFactory ? new ClassDiscriminatorFromClassMetadata($classMetadataFactory) : null),
],
['json' => new JsonEncoder()]
);
try {
$serializer->deserialize($json, Php74Full::class, 'json', [
DenormalizerInterface::COLLECT_DENORMALIZATION_ERRORS => true,
]);
$this->fail();
} catch (\Throwable $th) {
$this->assertInstanceOf(PartialDenormalizationException::class, $th);
}
$this->assertInstanceOf(Php74Full::class, $th->getData());
$exceptionsAsArray = array_map(fn (NotNormalizableValueException $e): array => [
'currentType' => $e->getCurrentType(),
'expectedTypes' => $e->getExpectedTypes(),
'path' => $e->getPath(),
'useMessageForUser' => $e->canUseMessageForUser(),
'message' => $e->getMessage(),
], $th->getErrors());
$expected = [
[
'currentType' => 'null',
'expectedTypes' => [
'string',
],
'path' => 'string',
'useMessageForUser' => false,
'message' => 'The type of the "string" attribute for class "Symfony\\Component\\Serializer\\Tests\\Fixtures\\Php74Full" must be one of "string" ("null" given).',
],
[
'currentType' => 'null',
'expectedTypes' => [
'int',
],