#region Copyright notice and license // Protocol Buffers - Google's data interchange format // Copyright 2008 Google Inc. All rights reserved. // https://developers.google.com/protocol-buffers/ // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #endregion using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Google.Protobuf.TestProtos; using NUnit.Framework; namespace Google.Protobuf { public class JsonFormatterTest { [Test] public void DefaultValues_WhenOmitted() { var formatter = new JsonFormatter(new JsonFormatter.Settings(formatDefaultValues: false)); Assert.AreEqual("{ }", formatter.Format(new ForeignMessage())); Assert.AreEqual("{ }", formatter.Format(new TestAllTypes())); Assert.AreEqual("{ }", formatter.Format(new TestMap())); } [Test] public void DefaultValues_WhenIncluded() { var formatter = new JsonFormatter(new JsonFormatter.Settings(formatDefaultValues: true)); Assert.AreEqual("{ \"c\": 0 }", formatter.Format(new ForeignMessage())); } [Test] public void AllSingleFields() { var message = new TestAllTypes { SingleBool = true, SingleBytes = ByteString.CopyFrom(1, 2, 3, 4), SingleDouble = 23.5, SingleFixed32 = 23, SingleFixed64 = 1234567890123, SingleFloat = 12.25f, SingleForeignEnum = ForeignEnum.FOREIGN_BAR, SingleForeignMessage = new ForeignMessage { C = 10 }, SingleImportEnum = ImportEnum.IMPORT_BAZ, SingleImportMessage = new ImportMessage { D = 20 }, SingleInt32 = 100, SingleInt64 = 3210987654321, SingleNestedEnum = TestAllTypes.Types.NestedEnum.FOO, SingleNestedMessage = new TestAllTypes.Types.NestedMessage { Bb = 35 }, SinglePublicImportMessage = new PublicImportMessage { E = 54 }, SingleSfixed32 = -123, SingleSfixed64 = -12345678901234, SingleSint32 = -456, SingleSint64 = -12345678901235, SingleString = "test\twith\ttabs", SingleUint32 = uint.MaxValue, SingleUint64 = ulong.MaxValue, }; var actualText = JsonFormatter.Default.Format(message); // Fields in declaration order, which matches numeric order. var expectedText = "{ " + "\"singleInt32\": 100, " + "\"singleInt64\": \"3210987654321\", " + "\"singleUint32\": 4294967295, " + "\"singleUint64\": \"18446744073709551615\", " + "\"singleSint32\": -456, " + "\"singleSint64\": \"-12345678901235\", " + "\"singleFixed32\": 23, " + "\"singleFixed64\": \"1234567890123\", " + "\"singleSfixed32\": -123, " + "\"singleSfixed64\": \"-12345678901234\", " + "\"singleFloat\": 12.25, " + "\"singleDouble\": 23.5, " + "\"singleBool\": true, " + "\"singleString\": \"test\\twith\\ttabs\", " + "\"singleBytes\": \"AQIDBA==\", " + "\"singleNestedMessage\": { \"bb\": 35 }, " + "\"singleForeignMessage\": { \"c\": 10 }, " + "\"singleImportMessage\": { \"d\": 20 }, " + "\"singleNestedEnum\": \"FOO\", " + "\"singleForeignEnum\": \"FOREIGN_BAR\", " + "\"singleImportEnum\": \"IMPORT_BAZ\", " + "\"singlePublicImportMessage\": { \"e\": 54 }" + " }"; Assert.AreEqual(expectedText, actualText); } [Test] public void RepeatedField() { Assert.AreEqual("{ \"repeatedInt32\": [ 1, 2, 3, 4, 5 ] }", JsonFormatter.Default.Format(new TestAllTypes { RepeatedInt32 = { 1, 2, 3, 4, 5 } })); } [Test] public void MapField_StringString() { Assert.AreEqual("{ \"mapStringString\": { \"with spaces\": \"bar\", \"a\": \"b\" } }", JsonFormatter.Default.Format(new TestMap { MapStringString = { { "with spaces", "bar" }, { "a", "b" } } })); } [Test] public void MapField_Int32Int32() { // The keys are quoted, but the values aren't. Assert.AreEqual("{ \"mapInt32Int32\": { \"0\": 1, \"2\": 3 } }", JsonFormatter.Default.Format(new TestMap { MapInt32Int32 = { { 0, 1 }, { 2, 3 } } })); } [Test] public void MapField_BoolBool() { // The keys are quoted, but the values aren't. Assert.AreEqual("{ \"mapBoolBool\": { \"false\": true, \"true\": false } }", JsonFormatter.Default.Format(new TestMap { MapBoolBool = { { false, true }, { true, false } } })); } [TestCase(1.0, "1")] [TestCase(double.NaN, "\"NaN\"")] [TestCase(double.PositiveInfinity, "\"Infinity\"")] [TestCase(double.NegativeInfinity, "\"-Infinity\"")] public void DoubleRepresentations(double value, string expectedValueText) { var message = new TestAllTypes { SingleDouble = value }; string actualText = JsonFormatter.Default.Format(message); string expectedText = "{ \"singleDouble\": " + expectedValueText + " }"; Assert.AreEqual(expectedText, actualText); } [Test] public void UnknownEnumValueOmitted_SingleField() { var message = new TestAllTypes { SingleForeignEnum = (ForeignEnum) 100 }; Assert.AreEqual("{ }", JsonFormatter.Default.Format(message)); } [Test] public void UnknownEnumValueOmitted_RepeatedField() { var message = new TestAllTypes { RepeatedForeignEnum = { ForeignEnum.FOREIGN_BAZ, (ForeignEnum) 100, ForeignEnum.FOREIGN_FOO } }; Assert.AreEqual("{ \"repeatedForeignEnum\": [ \"FOREIGN_BAZ\", \"FOREIGN_FOO\" ] }", JsonFormatter.Default.Format(message)); } [Test] public void UnknownEnumValueOmitted_MapField() { // This matches the C++ behaviour. var message = new TestMap { MapInt32Enum = { { 1, MapEnum.MAP_ENUM_FOO }, { 2, (MapEnum) 100 }, { 3, MapEnum.MAP_ENUM_BAR } } }; Assert.AreEqual("{ \"mapInt32Enum\": { \"1\": \"MAP_ENUM_FOO\", \"3\": \"MAP_ENUM_BAR\" } }", JsonFormatter.Default.Format(message)); } [Test] public void UnknownEnumValueOmitted_RepeatedField_AllEntriesUnknown() { // *Maybe* we should hold off on writing the "[" until we find that we've got at least one value to write... // but this is what happens at the moment, and it doesn't seem too awful. var message = new TestAllTypes { RepeatedForeignEnum = { (ForeignEnum) 200, (ForeignEnum) 100 } }; Assert.AreEqual("{ \"repeatedForeignEnum\": [ ] }", JsonFormatter.Default.Format(message)); } [Test] public void NullValueForMessage() { var message = new TestMap { MapInt32ForeignMessage = { { 10, null } } }; Assert.AreEqual("{ \"mapInt32ForeignMessage\": { \"10\": null } }", JsonFormatter.Default.Format(message)); } [Test] [TestCase("a\u17b4b", "a\\u17b4b")] // Explicit [TestCase("a\u0601b", "a\\u0601b")] // Ranged [TestCase("a\u0605b", "a\u0605b")] // Passthrough (note lack of double backslash...) public void SimpleNonAscii(string text, string encoded) { var message = new TestAllTypes { SingleString = text }; Assert.AreEqual("{ \"singleString\": \"" + encoded + "\" }", JsonFormatter.Default.Format(message)); } [Test] public void SurrogatePairEscaping() { var message = new TestAllTypes { SingleString = "a\uD801\uDC01b" }; Assert.AreEqual("{ \"singleString\": \"a\\ud801\\udc01b\" }", JsonFormatter.Default.Format(message)); } [Test] public void InvalidSurrogatePairsFail() { // Note: don't use TestCase for these, as the strings can't be reliably represented // See http://codeblog.jonskeet.uk/2014/11/07/when-is-a-string-not-a-string/ // Lone low surrogate var message = new TestAllTypes { SingleString = "a\uDC01b" }; Assert.Throws(() => JsonFormatter.Default.Format(message)); // Lone high surrogate message = new TestAllTypes { SingleString = "a\uD801b" }; Assert.Throws(() => JsonFormatter.Default.Format(message)); } [Test] [TestCase("foo_bar", "fooBar")] [TestCase("bananaBanana", "bananaBanana")] [TestCase("BANANABanana", "bananaBanana")] public void ToCamelCase(string original, string expected) { Assert.AreEqual(expected, JsonFormatter.ToCamelCase(original)); } [Test] [TestCase(null, "{ }")] [TestCase("x", "{ \"fooString\": \"x\" }")] [TestCase("", "{ \"fooString\": \"\" }")] [TestCase(null, "{ }")] public void Oneof(string fooStringValue, string expectedJson) { var message = new TestOneof(); if (fooStringValue != null) { message.FooString = fooStringValue; } // We should get the same result both with and without "format default values". var formatter = new JsonFormatter(new JsonFormatter.Settings(false)); Assert.AreEqual(expectedJson, formatter.Format(message)); formatter = new JsonFormatter(new JsonFormatter.Settings(true)); Assert.AreEqual(expectedJson, formatter.Format(message)); } [Test] public void WrapperFormatting_Single() { // Just a few examples, handling both classes and value types, and // default vs non-default values var message = new TestWellKnownTypes { Int64Field = 10, Int32Field = 0, BytesField = ByteString.FromBase64("ABCD"), StringField = "" }; var expectedJson = "{ \"int64Field\": \"10\", \"int32Field\": 0, \"stringField\": \"\", \"bytesField\": \"ABCD\" }"; Assert.AreEqual(expectedJson, JsonFormatter.Default.Format(message)); } [Test] public void WrapperFormatting_IncludeNull() { // The actual JSON here is very large because there are lots of fields. Just test a couple of them. var message = new TestWellKnownTypes { Int32Field = 10 }; var formatter = new JsonFormatter(new JsonFormatter.Settings(true)); var actualJson = formatter.Format(message); Assert.IsTrue(actualJson.Contains("\"int64Field\": null")); Assert.IsFalse(actualJson.Contains("\"int32Field\": null")); } } }