#region License // Copyright (c) 2007 James Newton-King // // Permission is hereby granted, free of charge, to any person // obtaining a copy of this software and associated documentation // files (the "Software"), to deal in the Software without // restriction, including without limitation the rights to use, // copy, modify, merge, publish, distribute, sublicense, and/or sell // copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following // conditions: // // The above copyright notice and this permission notice shall be // included in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR // OTHER DEALINGS IN THE SOFTWARE. #endregion using System; using System.Collections.Generic; using Newtonsoft.Json.Converters; using Newtonsoft.Json.Tests.TestObjects; #if !NETFX_CORE using NUnit.Framework; #else using Microsoft.VisualStudio.TestTools.UnitTesting; using TestFixture = Microsoft.VisualStudio.TestTools.UnitTesting.TestClassAttribute; using Test = Microsoft.VisualStudio.TestTools.UnitTesting.TestMethodAttribute; #endif using System.IO; using ErrorEventArgs=Newtonsoft.Json.Serialization.ErrorEventArgs; namespace Newtonsoft.Json.Tests.Serialization { [TestFixture] public class SerializationErrorHandlingTests : TestFixtureBase { [Test] public void ErrorDeserializingListHandled() { string json = @"[ { ""Name"": ""Jim"", ""BirthDate"": ""\/Date(978048000000)\/"", ""LastModified"": ""\/Date(978048000000)\/"" }, { ""Name"": ""Jim"", ""BirthDate"": ""\/Date(978048000000)\/"", ""LastModified"": ""\/Date(978048000000)\/"" } ]"; VersionKeyedCollection c = JsonConvert.DeserializeObject(json); Assert.AreEqual(1, c.Count); Assert.AreEqual(1, c.Messages.Count); Assert.AreEqual("[1] - Error message for member 1 = An item with the same key has already been added.", c.Messages[0]); } [Test] public void DeserializingErrorInChildObject() { ListErrorObjectCollection c = JsonConvert.DeserializeObject(@"[ { ""Member"": ""Value1"", ""Member2"": null }, { ""Member"": ""Value2"" }, { ""ThrowError"": ""Value"", ""Object"": { ""Array"": [ 1, 2 ] } }, { ""ThrowError"": ""Handle this!"", ""Member"": ""Value3"" } ]"); Assert.AreEqual(3, c.Count); Assert.AreEqual("Value1", c[0].Member); Assert.AreEqual("Value2", c[1].Member); Assert.AreEqual("Value3", c[2].Member); Assert.AreEqual("Handle this!", c[2].ThrowError); } [Test] public void SerializingErrorInChildObject() { ListErrorObjectCollection c = new ListErrorObjectCollection { new ListErrorObject { Member = "Value1", ThrowError = "Handle this!", Member2 = "Member1" }, new ListErrorObject { Member = "Value2", Member2 = "Member2" }, new ListErrorObject { Member = "Value3", ThrowError = "Handle that!", Member2 = "Member3" } }; string json = JsonConvert.SerializeObject(c, Formatting.Indented); Assert.AreEqual(@"[ { ""Member"": ""Value1"", ""ThrowError"": ""Handle this!"", ""Member2"": ""Member1"" }, { ""Member"": ""Value2"" }, { ""Member"": ""Value3"", ""ThrowError"": ""Handle that!"", ""Member2"": ""Member3"" } ]", json); } [Test] public void DeserializingErrorInDateTimeCollection() { DateTimeErrorObjectCollection c = JsonConvert.DeserializeObject(@"[ ""2009-09-09T00:00:00Z"", ""kjhkjhkjhkjh"", [ 1 ], ""1977-02-20T00:00:00Z"", null, ""2000-12-01T00:00:00Z"" ]", new IsoDateTimeConverter()); Assert.AreEqual(3, c.Count); Assert.AreEqual(new DateTime(2009, 9, 9, 0, 0, 0, DateTimeKind.Utc), c[0]); Assert.AreEqual(new DateTime(1977, 2, 20, 0, 0, 0, DateTimeKind.Utc), c[1]); Assert.AreEqual(new DateTime(2000, 12, 1, 0, 0, 0, DateTimeKind.Utc), c[2]); } [Test] public void DeserializingErrorHandlingUsingEvent() { List errors = new List(); List c = JsonConvert.DeserializeObject>( @"[ ""2009-09-09T00:00:00Z"", ""I am not a date and will error!"", [ 1 ], ""1977-02-20T00:00:00Z"", null, ""2000-12-01T00:00:00Z"" ]", new JsonSerializerSettings { Error = delegate(object sender, ErrorEventArgs args) { errors.Add(args.ErrorContext.Path + " - " + args.ErrorContext.Member + " - " + args.ErrorContext.Error.Message); args.ErrorContext.Handled = true; }, Converters = {new IsoDateTimeConverter()} }); // 2009-09-09T00:00:00Z // 1977-02-20T00:00:00Z // 2000-12-01T00:00:00Z // The string was not recognized as a valid DateTime. There is a unknown word starting at index 0. // Unexpected token parsing date. Expected String, got StartArray. // Cannot convert null value to System.DateTime. Assert.AreEqual(3, c.Count); Assert.AreEqual(new DateTime(2009, 9, 9, 0, 0, 0, DateTimeKind.Utc), c[0]); Assert.AreEqual(new DateTime(1977, 2, 20, 0, 0, 0, DateTimeKind.Utc), c[1]); Assert.AreEqual(new DateTime(2000, 12, 1, 0, 0, 0, DateTimeKind.Utc), c[2]); Assert.AreEqual(3, errors.Count); #if !(NET20 || NET35 || WINDOWS_PHONE) Assert.AreEqual("[1] - 1 - The string was not recognized as a valid DateTime. There is an unknown word starting at index 0.", errors[0]); #else Assert.AreEqual("[1] - 1 - The string was not recognized as a valid DateTime. There is a unknown word starting at index 0.", errors[0]); #endif Assert.AreEqual("[2] - 2 - Unexpected token parsing date. Expected String, got StartArray.", errors[1]); Assert.AreEqual("[4] - 4 - Cannot convert null value to System.DateTime.", errors[2]); } [Test] public void DeserializingErrorInDateTimeCollectionWithAttributeWithEventNotCalled() { bool eventErrorHandlerCalled = false; DateTimeErrorObjectCollection c = JsonConvert.DeserializeObject( @"[ ""2009-09-09T00:00:00Z"", ""kjhkjhkjhkjh"", [ 1 ], ""1977-02-20T00:00:00Z"", null, ""2000-12-01T00:00:00Z"" ]", new JsonSerializerSettings { Error = (s, a) => eventErrorHandlerCalled = true, Converters = { new IsoDateTimeConverter() } }); Assert.AreEqual(3, c.Count); Assert.AreEqual(new DateTime(2009, 9, 9, 0, 0, 0, DateTimeKind.Utc), c[0]); Assert.AreEqual(new DateTime(1977, 2, 20, 0, 0, 0, DateTimeKind.Utc), c[1]); Assert.AreEqual(new DateTime(2000, 12, 1, 0, 0, 0, DateTimeKind.Utc), c[2]); Assert.AreEqual(false, eventErrorHandlerCalled); } [Test] public void SerializePerson() { PersonError person = new PersonError { Name = "George Michael Bluth", Age = 16, Roles = null, Title = "Mister Manager" }; string json = JsonConvert.SerializeObject(person, Formatting.Indented); Console.WriteLine(json); //{ // "Name": "George Michael Bluth", // "Age": 16, // "Title": "Mister Manager" //} Assert.AreEqual(@"{ ""Name"": ""George Michael Bluth"", ""Age"": 16, ""Title"": ""Mister Manager"" }", json); } [Test] public void DeserializeNestedUnhandled() { List errors = new List(); string json = @"[[""kjhkjhkjhkjh""]]"; Exception e = null; try { JsonSerializer serializer = new JsonSerializer(); serializer.Error += delegate(object sender, ErrorEventArgs args) { // only log an error once if (args.CurrentObject == args.ErrorContext.OriginalObject) errors.Add(args.ErrorContext.Path + " - " + args.ErrorContext.Member + " - " + args.ErrorContext.Error.Message); }; serializer.Deserialize(new StringReader(json), typeof(List>)); } catch (Exception ex) { e = ex; } Assert.AreEqual(@"Could not convert string to DateTime: kjhkjhkjhkjh. Line 1, position 16.", e.Message); Assert.AreEqual(1, errors.Count); Assert.AreEqual(@"[0][0] - 0 - Could not convert string to DateTime: kjhkjhkjhkjh. Line 1, position 16.", errors[0]); } [Test] public void MultipleRequiredPropertyErrors() { string json = "{}"; List errors = new List(); JsonSerializer serializer = new JsonSerializer(); serializer.Error += delegate(object sender, ErrorEventArgs args) { errors.Add(args.ErrorContext.Path + " - " + args.ErrorContext.Member + " - " + args.ErrorContext.Error.Message); args.ErrorContext.Handled = true; }; serializer.Deserialize(new JsonTextReader(new StringReader(json)), typeof (MyTypeWithRequiredMembers)); Assert.AreEqual(2, errors.Count); Assert.AreEqual(" - Required1 - Required property 'Required1' not found in JSON. Line 1, position 2.", errors[0]); Assert.AreEqual(" - Required2 - Required property 'Required2' not found in JSON. Line 1, position 2.", errors[1]); } [Test] public void HandlingArrayErrors() { string json = "[\"a\",\"b\",\"45\",34]"; List errors = new List(); JsonSerializer serializer = new JsonSerializer(); serializer.Error += delegate(object sender, ErrorEventArgs args) { errors.Add(args.ErrorContext.Path + " - " + args.ErrorContext.Member + " - " + args.ErrorContext.Error.Message); args.ErrorContext.Handled = true; }; serializer.Deserialize(new JsonTextReader(new StringReader(json)), typeof(int[])); Assert.AreEqual(2, errors.Count); Assert.AreEqual("[0] - 0 - Could not convert string to integer: a. Line 1, position 4.", errors[0]); Assert.AreEqual("[1] - 1 - Could not convert string to integer: b. Line 1, position 8.", errors[1]); } } [JsonObject] public class MyTypeWithRequiredMembers { [JsonProperty(Required = Required.AllowNull)] public string Required1; [JsonProperty(Required = Required.AllowNull)] public string Required2; } }