ListOfStringsToEnumConverterTestClass_ReadJson_TestFlagWithoutZeroEnum_EvaluatesToZero Test

Adds a test that ensures Flags can have their value set to 0, even if the Enum does not contain 0 as an explicit value.

Author: WispyMouse

Assets/Tests/PlayMode/Config/JsonConverters/ListOfStringsToEnumConverterTests.cs

@@ -30,7 +30,7 @@ namespace PlayEveryWare.EpicOnlineServices.Tests.Config
     using Newtonsoft.Json.Linq;
     public static partial class ListOfStringsToEnumConverterTests
     {
-        private static readonly Dictionary<string, TestOrderEnum> CUSTOM_MAPPING = new()
+        private static readonly Dictionary<string, TestOrderEnum> TESTORDERENUM_CUSTOM_MAPPING = new()
         {
             { "FirstLetter", TestOrderEnum.A },
             { "SecondLetter", TestOrderEnum.B },
@@ -47,18 +47,38 @@ private enum TestOrderEnum : int
             C = 0x00008
         }
 
-        private class ListOfStringsToEnumConverterTestClass : ListOfStringsToEnumConverter<TestOrderEnum>
+        /// <summary>
+        /// This Enum is explicitly marked as a flag, and lacks a "0" value.
+        /// There are Flags inside the EOS SDK C# that do not set a "0".
+        /// <seealso cref="Epic.OnlineServices.IntegratedPlatform.IntegratedPlatformManagementFlags"/>
+        /// </summary>
+        [Flags]
+        private enum TestFlagWithoutZeroEnum : int
         {
-            protected override TestOrderEnum FromStringArray(JArray array)
+            A = 0x00001,
+            B = 0x00002,
+            C = 0x00004
+        }
+
+        private class ListOfStringsToEnumConverterTestClass<TEnum> : ListOfStringsToEnumConverter<TEnum> where TEnum : struct, Enum
+        {
+            private readonly Dictionary<string, TEnum> mappings;
+
+            public ListOfStringsToEnumConverterTestClass(Dictionary<string, TEnum> inMappings)
             {
-                return FromStringArrayWithCustomMapping(array, CUSTOM_MAPPING);
+                mappings = inMappings;
+            }
+
+            protected override TEnum FromStringArray(JArray array)
+            {
+                return FromStringArrayWithCustomMapping(array, mappings);
             }
         }
 
         [Test]
         public static void ListOfStringsToEnumConverterTestClass_ReadJson_ArrayOfStrings_ReturnsCorrectEnum()
         {
-            var converter = new ListOfStringsToEnumConverterTestClass();
+            var converter = new ListOfStringsToEnumConverterTestClass<TestOrderEnum>(TESTORDERENUM_CUSTOM_MAPPING);
             var json = JArray.FromObject(new[] { "FirstLetter", "ThirdLetter", "B" });
             var result = (TestOrderEnum)converter.ReadJson(json.CreateReader(), typeof(InputStateButtonFlags), null, null);
 
@@ -68,7 +88,7 @@ public static void ListOfStringsToEnumConverterTestClass_ReadJson_ArrayOfStrings
         [Test]
         public static void ListOfStringsToEnumConverterTestClass_ReadJson_SingleString_ReturnsCorrectEnum()
         {
-            var converter = new ListOfStringsToEnumConverterTestClass();
+            var converter = new ListOfStringsToEnumConverterTestClass<TestOrderEnum>(TESTORDERENUM_CUSTOM_MAPPING);
             var json = JToken.FromObject("A");
             var result = (TestOrderEnum)converter.ReadJson(json.CreateReader(), typeof(InputStateButtonFlags), null, null);
 
@@ -78,7 +98,7 @@ public static void ListOfStringsToEnumConverterTestClass_ReadJson_SingleString_R
         [Test]
         public static void ListOfStringsToEnumConverterTestClass_ReadJson_Null_ReturnsDefaultEnum()
         {
-            var converter = new ListOfStringsToEnumConverterTestClass();
+            var converter = new ListOfStringsToEnumConverterTestClass<TestOrderEnum>(TESTORDERENUM_CUSTOM_MAPPING);
             var result = (TestOrderEnum)converter.ReadJson(new JValue((string)null).CreateReader(), typeof(InputStateButtonFlags), null, null);
 
             Assert.AreEqual(TestOrderEnum.None, result);
@@ -87,11 +107,25 @@ public static void ListOfStringsToEnumConverterTestClass_ReadJson_Null_ReturnsDe
         [Test]
         public static void ListOfStringsToEnumConverterTestClass_ReadJson_InvalidTokenType_ThrowsException()
         {
-            var converter = new ListOfStringsToEnumConverterTestClass();
+            var converter = new ListOfStringsToEnumConverterTestClass<TestOrderEnum>(TESTORDERENUM_CUSTOM_MAPPING);
             var invalidJson = JToken.FromObject(123); // Invalid type for enum parsing
 
             Assert.Throws<JsonSerializationException>(() => converter.ReadJson(invalidJson.CreateReader(), typeof(TestOrderEnum), null, null));
         }
 
+        /// <summary>
+        /// Converts a '0' into <see cref="TestFlagWithoutZeroEnum"/> using the <see cref="ListOfStringsToEnumConverterTestClass"/>.
+        /// Even though <see cref="TestFlagWithoutZeroEnum"/> lacks a 0, it is a Flag enum.
+        /// The resulting value should be equivalent to a '0' integer, as opposed to using the lowest value.
+        /// </summary>
+        [Test]
+        public static void ListOfStringsToEnumConverterTestClass_ReadJson_TestFlagWithoutZeroEnum_EvaluatesToZero()
+        {
+            var converter = new ListOfStringsToEnumConverterTestClass<TestFlagWithoutZeroEnum>(null);
+            var json = JToken.FromObject(0);
+            var result = (TestFlagWithoutZeroEnum)converter.ReadJson(json.CreateReader(), typeof(TestFlagWithoutZeroEnum), null, null);
+
+            Assert.AreEqual((TestFlagWithoutZeroEnum)0, result);
+        }
     }
 }