[Azure.Core] Update Tests for ModelSerializer (Azure#38169)

nisha-bhatia · web-flow · commit c498f5312fb5 · 2023-08-29T15:10:39.000-07:00
diff --git a/sdk/core/Azure.Core/tests/ModelSerialization/ModelWriterTests.cs b/sdk/core/Azure.Core/tests/ModelSerialization/ModelWriterTests.cs
@@ -22,7 +22,7 @@ namespace Azure.Core.Tests.ModelSerialization
     public class ModelWriterTests
     {
         private const int _modelSize = 156000;
-        private static readonly string _json = File.ReadAllText(TestData.GetLocation("ResourceProviderData.json"));
+        private static readonly string _json = File.ReadAllText(TestData.GetLocation("ResourceProviderData/ResourceProviderData.json"));
         private static readonly ResourceProviderData _resourceProviderData = ModelSerializer.Deserialize<ResourceProviderData>(BinaryData.FromString(_json));
 
         [Test]
diff --git a/sdk/core/Azure.Core/tests/common/Azure.Core.Tests.Common.csproj b/sdk/core/Azure.Core/tests/common/Azure.Core.Tests.Common.csproj
@@ -18,7 +18,16 @@
   </ItemGroup>
   
   <ItemGroup>
-    <None Update="TestData\AvailabilitySetData.json">
+    <None Update="TestData\AvailabilitySetData\AvailabilitySetDataWithVMs.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\AvailabilitySetData\AvailabilitySetData.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\AvailabilitySetData\AvailabilitySetDataWithVMsWireFormat.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\AvailabilitySetData\AvailabilitySetDataWireFormat.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
     <None Update="TestData\ModelXml.xml">
@@ -27,10 +36,16 @@
     <None Update="TestData\ModelXmlX.xml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="TestData\ResourceProviderData-Collapsed.json">
+    <None Update="TestData\ResourceProviderData\ResourceProviderData-Collapsed.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\ResourceProviderData\ResourceProviderData.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="TestData\ModelX\ModelX.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
-    <None Update="TestData\ResourceProviderData.json">
+    <None Update="TestData\ModelX\ModelXWireFormat.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
   </ItemGroup>
diff --git a/sdk/core/Azure.Core/tests/common/ModelSerializationTests/Models/DiscriminatorSet/ModelX.cs b/sdk/core/Azure.Core/tests/common/ModelSerializationTests/Models/DiscriminatorSet/ModelX.cs
@@ -3,6 +3,7 @@
 
 using System;
 using System.Collections.Generic;
+using System.Linq;
 using System.Text.Json;
 using Azure.Core.Serialization;
 
@@ -16,15 +17,21 @@ public ModelX()
             Kind = "X";
         }
 
-        internal ModelX(string kind, string name, int xProperty, Dictionary<string, BinaryData> rawData)
+        internal ModelX(string kind, string name, int xProperty, int? nullProperty, IList<string> fields, IDictionary<string, string> keyValuePairs, Dictionary<string, BinaryData> rawData)
             : base(rawData)
         {
             Kind = kind;
             Name = name;
             XProperty = xProperty;
+            NullProperty = nullProperty;
+            Fields = fields;
+            KeyValuePairs = keyValuePairs;
         }
 
-        public int XProperty { get; private set; }
+        public int XProperty { get; }
+        public IList<string> Fields { get; }
+        public int? NullProperty = null;
+        public IDictionary<string, string> KeyValuePairs { get; }
 
         void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IModelJsonSerializable<ModelX>)this).Serialize(writer, ModelSerializerOptions.DefaultWireOptions);
 
@@ -63,6 +70,38 @@ private void Serialize(Utf8JsonWriter writer, ModelSerializerOptions options)
                 writer.WritePropertyName("name"u8);
                 writer.WriteStringValue(Name);
             }
+            if (Optional.IsCollectionDefined(Fields))
+            {
+                writer.WritePropertyName("fields"u8);
+                writer.WriteStartArray();
+                foreach (string field in Fields)
+                {
+                    writer.WriteStringValue(field);
+                }
+                writer.WriteEndArray();
+            }
+            if (Optional.IsDefined(NullProperty))
+            {
+                writer.WritePropertyName("nullProperty"u8);
+                writer.WriteNumberValue(NullProperty.Value);
+            }
+            if (Optional.IsCollectionDefined(KeyValuePairs))
+            {
+                writer.WritePropertyName("keyValuePairs"u8);
+                writer.WriteStartObject();
+                foreach (var item in KeyValuePairs)
+                {
+                    writer.WritePropertyName(item.Key);
+                    if (item.Value == null)
+                    {
+                        writer.WriteNullValue();
+                        continue;
+                    }
+                    writer.WriteObjectValue(item.Value);
+                }
+                writer.WriteEndObject();
+            }
+
             if (options.Format == ModelSerializerFormat.Json)
             {
                 writer.WritePropertyName("xProperty"u8);
@@ -86,7 +125,11 @@ internal static ModelX DeserializeModelX(JsonElement element, ModelSerializerOpt
             string kind = default;
             Optional<string> name = default;
             int xProperty = default;
+            Optional<int> nullProperty = default;
+            Optional<IList<string>> fields = default;
+            Optional<IDictionary<string, string>> keyValuePairs = default;
             Dictionary<string, BinaryData> rawData = new Dictionary<string, BinaryData>();
+
             foreach (var property in element.EnumerateObject())
             {
                 if (property.NameEquals("kind"u8))
@@ -99,6 +142,30 @@ internal static ModelX DeserializeModelX(JsonElement element, ModelSerializerOpt
                     name = property.Value.GetString();
                     continue;
                 }
+                if (property.NameEquals("fields"u8))
+                {
+                    fields = property.Value.EnumerateArray().Select(element => element.GetString()).ToList();
+                    continue;
+                }
+                if (property.NameEquals("nullProperty"u8))
+                {
+                    if (property.Value.ValueKind == JsonValueKind.Null)
+                    {
+                        continue;
+                    }
+                    nullProperty = property.Value.GetInt32();
+                    continue;
+                }
+                if (property.NameEquals("keyValuePairs"u8))
+                {
+                    Dictionary<string, string> dictionary = new Dictionary<string, string>();
+                    foreach (var property0 in property.Value.EnumerateObject())
+                    {
+                        dictionary.Add(property0.Name, property0.Value.GetString());
+                    }
+                    keyValuePairs = dictionary;
+                    continue;
+                }
                 if (property.NameEquals("xProperty"u8))
                 {
                     xProperty = property.Value.GetInt32();
@@ -110,7 +177,7 @@ internal static ModelX DeserializeModelX(JsonElement element, ModelSerializerOpt
                     rawData.Add(property.Name, BinaryData.FromString(property.Value.GetRawText()));
                 }
             }
-            return new ModelX(kind, name, xProperty, rawData);
+            return new ModelX(kind, name, xProperty, Optional.ToNullable(nullProperty), Optional.ToList(fields), Optional.ToDictionary(keyValuePairs), rawData);
         }
 
         ModelX IModelSerializable<ModelX>.Deserialize(BinaryData data, ModelSerializerOptions options)
diff --git a/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetData.json b/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetData.json
diff --git a/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWireFormat.json b/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWireFormat.json
@@ -0,0 +1,18 @@
+{
+    "name": "testAS-3375",
+    "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375",
+    "type": "Microsoft.Compute/availabilitySets",
+    "location": "eastus",
+    "tags": {
+        "key": "value"
+    },
+    "properties": {
+        "platformUpdateDomainCount": 5,
+        "platformFaultDomainCount": 3
+    },
+    "sku": {
+        "name": "Classic"
+    },
+    "extraSku": "extraSku",
+    "extraRoot": "extraRoot"
+}
diff --git a/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWithVMs.json b/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWithVMs.json
@@ -0,0 +1,24 @@
+{
+    "name": "testAS-3375",
+    "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375",
+    "type": "Microsoft.Compute/availabilitySets",
+    "location": "eastus",
+    "tags": {
+        "key": "value"
+    },
+    "properties": {
+        "platformUpdateDomainCount": 5,
+        "platformFaultDomainCount": 3,
+        "virtualMachines": [
+            {
+                "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS1"
+            },
+            {
+                "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS2"
+            }
+        ]
+    },
+    "sku": {
+        "name": "Classic"
+    }
+}
diff --git a/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWithVMsWireFormat.json b/sdk/core/Azure.Core/tests/common/TestData/AvailabilitySetData/AvailabilitySetDataWithVMsWireFormat.json
@@ -0,0 +1,24 @@
+{
+    "name": "testAS-3375",
+    "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375",
+    "type": "Microsoft.Compute/availabilitySets",
+    "location": "eastus",
+    "tags": {
+        "key": "value"
+    },
+    "properties": {
+        "platformUpdateDomainCount": 5,
+        "platformFaultDomainCount": 3,
+        "virtualMachines": [
+            {
+                "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS1"
+            },
+            {
+                "id": "/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS2"
+            }
+        ]
+    },
+    "sku": {
+        "name": "Classic"
+    }
+}
diff --git a/sdk/core/Azure.Core/tests/common/TestData/ModelX/ModelX.json b/sdk/core/Azure.Core/tests/common/TestData/ModelX/ModelX.json
@@ -0,0 +1,13 @@
+{
+    "kind": "X",
+    "name": "xmodel",
+    "xProperty": 100,
+    "fields": [
+        "testField"
+    ],
+    "nullProperty": null,
+    "keyValuePairs": {
+        "color": "red"
+    },
+    "extra": "stuff" 
+}
diff --git a/sdk/core/Azure.Core/tests/common/TestData/ModelX/ModelXWireFormat.json b/sdk/core/Azure.Core/tests/common/TestData/ModelX/ModelXWireFormat.json
@@ -0,0 +1,13 @@
+{
+    "kind": "X",
+    "name": "xmodel",
+    "xProperty": 100,
+    "fields": [
+        "testField"
+    ],
+    "nullProperty": null,
+    "keyValuePairs": {
+        "color": "red"
+    },
+    "extra": "stuff"
+}
diff --git a/sdk/core/Azure.Core/tests/common/TestData/ResourceProviderData/ResourceProviderData-Collapsed.json b/sdk/core/Azure.Core/tests/common/TestData/ResourceProviderData/ResourceProviderData-Collapsed.json
diff --git a/sdk/core/Azure.Core/tests/common/TestData/ResourceProviderData/ResourceProviderData.json b/sdk/core/Azure.Core/tests/common/TestData/ResourceProviderData/ResourceProviderData.json
diff --git a/sdk/core/Azure.Core/tests/public/ModelSerializationTests/AvailabilitySetDataTests.cs b/sdk/core/Azure.Core/tests/public/ModelSerializationTests/AvailabilitySetDataTests.cs
@@ -3,15 +3,17 @@
 
 using System;
 using System.Collections.Generic;
+using System.IO;
 using Azure.Core.Serialization;
+using Azure.Core.Tests.Common;
 using Azure.Core.Tests.ResourceManager.Compute;
 using NUnit.Framework;
 
 namespace Azure.Core.Tests.Public.ModelSerializationTests
 {
     internal class AvailabilitySetDataTests : ModelJsonTests<AvailabilitySetData>
     {
-        protected override string WirePayload => "{\"name\":\"testAS-3375\",\"id\":\"/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375\",\"type\":\"Microsoft.Compute/availabilitySets\",\"location\":\"eastus\",\"tags\":{\"key\":\"value\"},\"properties\":{\"platformUpdateDomainCount\":5,\"platformFaultDomainCount\":3},\"sku\":{\"name\":\"Classic\",\"extraSku\":\"extraSku\"},\"extraRoot\":\"extraRoot\"}";
+        protected override string WirePayload => File.ReadAllText(TestData.GetLocation("AvailabilitySetData/AvailabilitySetDataWireFormat.json")).TrimEnd();
 
         protected override string JsonPayload => WirePayload;
 
diff --git a/sdk/core/Azure.Core/tests/public/ModelSerializationTests/AvailabilitySetDataTestsWithVMs.cs b/sdk/core/Azure.Core/tests/public/ModelSerializationTests/AvailabilitySetDataTestsWithVMs.cs
@@ -0,0 +1,73 @@
+﻿// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Azure.Core.Serialization;
+using Azure.Core.Tests.Common;
+using Azure.Core.Tests.ResourceManager.Compute;
+using NUnit.Framework;
+
+namespace Azure.Core.Tests.Public.ModelSerializationTests
+{
+    internal class AvailabilitySetDataTestsWithVMs : ModelJsonTests<AvailabilitySetData>
+    {
+        protected override string WirePayload => File.ReadAllText(TestData.GetLocation("AvailabilitySetData/AvailabilitySetDataWithVMsWireFormat.json")).TrimEnd();
+
+        protected override string JsonPayload => WirePayload;
+
+        protected override Func<AvailabilitySetData, RequestContent> ToRequestContent => model => model;
+
+        protected override Func<Response, AvailabilitySetData> FromResponse => response => (AvailabilitySetData)response;
+
+        protected override string GetExpectedResult(ModelSerializerFormat format)
+        {
+            var expectedSerializedString = "{";
+            if (format == ModelSerializerFormat.Json)
+                expectedSerializedString += "\"name\":\"testAS-3375\",\"id\":\"/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375\",\"type\":\"Microsoft.Compute/availabilitySets\",";
+            expectedSerializedString += "\"sku\":{\"name\":\"Classic\"";
+            //if (!ignoreAdditionalProperties)
+            //    expectedSerializedString += ",\"extraSku\":\"extraSku\"";
+            expectedSerializedString += "},\"tags\":{\"key\":\"value\"},\"location\":\"eastus\",\"properties\":{\"platformUpdateDomainCount\":5,\"platformFaultDomainCount\":3";
+            //if (!ignoreAdditionalProperties)
+            //    expectedSerializedString += ",\"extraRoot\":\"extraRoot\"";
+            expectedSerializedString += ",\"virtualMachines\":[{\"id\":\"/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS1\"},{\"id\":\"/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS2\"}]";
+            expectedSerializedString += "}}";
+            return expectedSerializedString; ;
+        }
+
+        protected override void VerifyModel(AvailabilitySetData model, ModelSerializerFormat format)
+        {
+            Dictionary<string, string> expectedTags = new Dictionary<string, string>() { { "key", "value" } };
+
+            Assert.AreEqual("/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS-3375", model.Id.ToString());
+            CollectionAssert.AreEquivalent(expectedTags, model.Tags);
+            Assert.AreEqual(AzureLocation.EastUS, model.Location);
+            Assert.AreEqual("testAS-3375", model.Name);
+            Assert.AreEqual("Microsoft.Compute/availabilitySets", model.ResourceType.ToString());
+            Assert.AreEqual(5, model.PlatformUpdateDomainCount);
+            Assert.AreEqual(3, model.PlatformFaultDomainCount);
+            Assert.AreEqual("Classic", model.Sku.Name);
+            Assert.AreEqual(2, model.VirtualMachines.Count);
+            Assert.AreEqual("/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS1", model.VirtualMachines[0].Id.ToString());
+            Assert.AreEqual("/subscriptions/e37510d7-33b6-4676-886f-ee75bcc01871/resourceGroups/testRG-6497/providers/Microsoft.Compute/availabilitySets/testAS2", model.VirtualMachines[1].Id.ToString());
+        }
+
+        protected override void CompareModels(AvailabilitySetData model, AvailabilitySetData model2, ModelSerializerFormat format)
+        {
+            Assert.AreEqual(format == ModelSerializerFormat.Wire ? null : model.Id, model2.Id);
+            Assert.AreEqual(model.Location, model2.Location);
+            Assert.AreEqual(format == ModelSerializerFormat.Wire ? null : model.Name, model2.Name);
+            Assert.AreEqual(model.PlatformFaultDomainCount, model2.PlatformFaultDomainCount);
+            Assert.AreEqual(model.PlatformUpdateDomainCount, model2.PlatformUpdateDomainCount);
+            if (format == ModelSerializerFormat.Json)
+                Assert.AreEqual(model.ResourceType, model2.ResourceType);
+            CollectionAssert.AreEquivalent(model.Tags, model2.Tags);
+            Assert.AreEqual(model.Sku.Name, model2.Sku.Name);
+            Assert.AreEqual(model.VirtualMachines.Count, model2.VirtualMachines.Count);
+            Assert.AreEqual(model.VirtualMachines[0].Id, model2.VirtualMachines[0].Id);
+            Assert.AreEqual(model.VirtualMachines[1].Id, model2.VirtualMachines[1].Id);
+        }
+    }
+}
diff --git a/sdk/core/Azure.Core/tests/public/ModelSerializationTests/ModelXTests.cs b/sdk/core/Azure.Core/tests/public/ModelSerializationTests/ModelXTests.cs
diff --git a/sdk/core/Azure.Core/tests/public/ModelSerializationTests/ResourceProviderDataTests.cs b/sdk/core/Azure.Core/tests/public/ModelSerializationTests/ResourceProviderDataTests.cs

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ namespace Azure.Core.Tests.ModelSerialization`
`22`	`22`	`public class ModelWriterTests`
`23`	`23`	`{`
`24`	`24`	`private const int _modelSize = 156000;`
`25`		`- private static readonly string _json = File.ReadAllText(TestData.GetLocation("ResourceProviderData.json"));`
	`25`	`+ private static readonly string _json = File.ReadAllText(TestData.GetLocation("ResourceProviderData/ResourceProviderData.json"));`
`26`	`26`	`private static readonly ResourceProviderData _resourceProviderData = ModelSerializer.Deserialize<ResourceProviderData>(BinaryData.FromString(_json));`
`27`	`27`
`28`	`28`	`[Test]`