Test_API_Serializers.cs

Go to the documentation of this file.

using System;
using System.Collections.Generic;
using AnalyzeRe;
using AnalyzeRe.JsonConverters;
using AnalyzeRe.Layers;
using AnalyzeReTesting.Base;
using AnalyzeReTesting.Utilities;
 
#if MSTEST
using Microsoft.VisualStudio.TestTools.UnitTesting;
#elif NUNIT
using NUnit.Framework;
using TestClass = NUnit.Framework.TestFixtureAttribute;
using TestMethod = NUnit.Framework.TestAttribute;
using TestCategory = NUnit.Framework.CategoryAttribute;
#endif
 
namespace AnalyzeReTesting.Tests.AnalyzeReAPI
{
    [TestClass]
    public class TestSuite_Serializers : BaseServerTestSuite
    {
        private const string TestCategory = "Serializers";
 
        [TestMethod, TestCategory(TestCategory)]
        public void Test_API_POST_NestedLayer_Nested()
        {
            IInjectableResource<CatXL> catXL = Samples.Layer_CatXL;
            IInjectableResource<ILayerView<Nested>> layerView =
                Samples.GetInjectableLayerView(new Nested
                {
                    description = "Sample Cascaded Layer",
                    sink = Samples.Layer_Generic.AsInlinedReference,
                    sources = new Nested.Sources(catXL.AsInlinedReference)
                });
 
            GenericTest.POST_ValidResource(layerView.Unposted);
        }
 
        [TestMethod, TestCategory(TestCategory)]
        public void Test_API_POST_NestedLayer_Referenced()
        {
            IInjectableResource<CatXL> catXL = Samples.Layer_CatXL;
            IInjectableResource<ILayerView<Nested>> layerView =
                Samples.GetInjectableLayerView(new Nested
                {
                    description = "Sample Cascaded Layer",
                    sink = Samples.Layer_Generic.AsReference,
                    sources = new Nested.Sources(catXL.AsReference)
                });
            GenericTest.POST_ValidResource(layerView.Unposted);
        }
 
        [TestMethod, TestCategory(TestCategory)]
        public void Test_API_POST_Metadata_Nested_Dictionary_and_List()
        {
            IInjectableResource<CatXL> testLayer = Samples.Layer_CatXL;
            CatXL modified = testLayer.Unposted;
            modified.meta_data = new Dictionary<string, object>
            {
                { "One", 1 },
                { "Two", 2.22 },
                { "Three", "Three" },
                //Skip.Indefinitely("APIV1 currently only supports flat metadata.");
                //{ "Four",
                //    new Dictionary<string, object>
                //    {
                //        { "A", "a" },
                //        { "B", 2 },
                //        { "C", 3.33 }
                //    }
                //},
                //{ "Five", new List<object> { 1, 2, 3, 4, 5 } },
                //{ "Six", new List<object> { "1", "2", "3", "4", "5" } },
                //{ "Seven", new List<object> { 1, "2", 3.33, "4" } }
            };
            CatXL result = InjectableResource.Create(modified, EnvironmentSettings.RUN_OFFLINE).Posted;
            //Skip.Indefinitely("APIV1 currently only supports flat metadata.");
            //Assert.AreEqual(typeof(Dictionary<string, object>), result.meta_data["Four"].GetType());
            //Assert.AreEqual(typeof(List<object>), result.meta_data["Seven"].GetType());
            //Assert.AreEqual(typeof(List<object>), result.meta_data["Five"].GetType());
            //Assert.AreEqual(typeof(List<object>), result.meta_data["Six"].GetType());
            AssertApi.PostResponseMatches(modified, result);
        }
 
        [TestMethod, TestCategory(TestCategory)]
        public void Test_API_Serialize_WeaklyTypedReference()
        {
            AnalyzeReJsonConverter deserializer = AnalyzeReJsonConverter.Default;
 
            ILayerView<ILayer> weakReference = Samples.LayerView_CatXL.Unposted;
            string json = weakReference.Serialize();
            ILayerView<ILayer> restored = deserializer.Deserialize<ILayerView<ILayer>>(json);
            AssertApi.AllPropertiesEqual(weakReference, restored);
 
            // Wrap that weak reference in a Nested sources list.
            Nested nested = new Nested();
            nested.sources.Add(weakReference.layer.ToReference());
            json = nested.Serialize();
            Nested restored2 = deserializer.Deserialize<Nested>(json);
            AssertApi.AllPropertiesEqual(nested, restored2);
 
            // Wrap that in a nested layer
            weakReference = new LayerView<Nested>(nested, null, null);
            json = weakReference.Serialize();
            restored = deserializer.Deserialize<ILayerView<ILayer>>(json);
            AssertApi.AllPropertiesEqual(weakReference, restored);
        }
 
        [TestMethod, TestCategory(TestCategory)]
        public void Test_Serialize_Extension()
        {
            ILayerView<CatXL> catXLView = Samples.LayerView_CatXL.Posted;
            // Give the sub-layer property an id (to ensure nested server-generated attributes are maintained)
            catXLView.layer.id = Samples.Valid_NonExistant_UUID;
            // Invoke the serialize helper method
            string serializedResult = catXLView.Serialize(pretty: true);
            Console.WriteLine("Serialized (default):\n" + serializedResult);
 
            // Test that all properties were returned by deserializing the result and comparing all attributes.
            AnalyzeReJsonConverter deserializer = AnalyzeReJsonConverter.Default;
            ILayerView<CatXL> deserialized = deserializer.Deserialize<ILayerView<CatXL>>(serializedResult);
            AssertApi.AllPropertiesEqual(catXLView, deserialized);
            // The above only tests user-editable properties.
            // Also assert that server-generated properties were maintained.
            Assert.AreEqual(catXLView.id, deserialized.id);
            Assert.AreEqual(catXLView.ylt_id, deserialized.ylt_id);
            Assert.AreEqual(catXLView.layer.id, deserialized.layer.id);
 
            // Now assert that if we explicitly exclude server-generated properties, they are lost.
            serializedResult = catXLView.Serialize(true, false);
            Console.WriteLine("\nSerialized (exclude server-generated):\n" + serializedResult);
            deserialized = deserializer.Deserialize<ILayerView<CatXL>>(serializedResult);
            Assert.IsNull(deserialized.id);
            Assert.IsNull(deserialized.ylt_id);
            Assert.IsNull(deserialized.layer.id);
        }
    }
}