JSON file deserialization throws errors if unknown properties are encountered.

Implements #15

Author: codeape2

UnitTests/TestJSONAdditionalData.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Xunit;
+using netmockery;
+using Newtonsoft.Json;
+using System.Linq;
+
+namespace UnitTests
+{
+    public class TestJSONAdditionalData
+    {
+        [Fact]
+        public void NoAdditionalDataGivesNullInJSONEndpoint()
+        {
+            var endpoint = JsonConvert.DeserializeObject<JSONEndpoint>("{\"name\": \"foobar\"}");
+            Assert.Equal("foobar", endpoint.name);
+            Assert.Null(endpoint.AdditionalData);
+
+            // check no exception
+            endpoint.ThrowExceptionIfAdditionalData();
+        }
+
+        [Fact]
+        public void AdditionalDataIsDeserializedJSONEndpoint()
+        {
+            var endpoint = JsonConvert.DeserializeObject<JSONEndpoint>("{\"name\": \"foobar\", \"nmae\": \"foobar\"}");
+            Assert.Equal("foobar", endpoint.name);
+            Assert.NotNull(endpoint.AdditionalData);
+            Assert.Equal("nmae", endpoint.AdditionalData.Keys.Single());
+        }
+
+        [Fact]
+        public void AdditionalDataIsNotValid()
+        {
+            var endpoint = JsonConvert.DeserializeObject<JSONEndpoint>("{\"name\": \"foobar\", \"nmae\": \"foobar\"}");
+            Assert.Equal("foobar", endpoint.name);
+            Assert.NotNull(endpoint.AdditionalData);
+            Assert.Equal("nmae", endpoint.AdditionalData.Keys.Single());
+
+            var exception = Assert.Throws<ArgumentException>(() => endpoint.ThrowExceptionIfAdditionalData());
+        }
+
+
+        [Fact]
+        public void NullAdditionalDataIsNotSerialized()
+        {
+            var endpoint = JsonConvert.DeserializeObject<JSONEndpoint>("{\"name\": \"foobar\"}");
+            Assert.Null(endpoint.AdditionalData);
+
+            var as_str = JsonConvert.SerializeObject(endpoint);
+            Assert.Equal("{\"name\":\"foobar\",\"pathregex\":null,\"responses\":null}", as_str);
+        }
+    }
+}

netmockery/EndpointCollectionReader.cs

@@ -20,6 +20,10 @@ static public EndpointCollection ReadFromDirectory(string directoryName)
                 JsonConvert.DeserializeObject<JSONDefaults>(File.ReadAllText(globalDefaultsFile)) 
                 : 
                 null;
+            if (globalDefaults != null)
+            {
+                globalDefaults.ThrowExceptionIfAdditionalData();
+            }
 
             foreach (var subdirectory in Directory.GetDirectories(directoryName))
             {

netmockery/JSONReader.cs

@@ -8,7 +8,7 @@
 using System.Text;
 using System.Text.RegularExpressions;
 using System.Net;
-
+using Newtonsoft.Json.Linq;
 
 namespace netmockery
 {
@@ -20,14 +20,16 @@ public static Endpoint ReadEndpoint(string jsonString, string rootDir, JSONDefau
         }
     }
 
-    public class JSONParam
+    public class JSONParam : JSONObjectWithAdditionalData
     {
         public string name;
         public string @default;
         public string description;
 
         public JSONParam Validated()
         {
+            ThrowExceptionIfAdditionalData();
+
             if (name == null)
             {
                 throw new ArgumentException($"Parameter missing name");
@@ -52,7 +54,7 @@ public JSONParam Validated()
         }
     }
 
-    public class JSONTest
+    public class JSONTest : JSONObjectWithAdditionalData
     {
         public string name;
         public string method;
@@ -69,6 +71,8 @@ public class JSONTest
 
         public JSONTest Validated()
         {
+            ThrowExceptionIfAdditionalData();
+
             if (requestpath == null)
             {
                 throw new ArgumentNullException(nameof(requestpath));
@@ -111,7 +115,7 @@ public NetmockeryTestCase CreateTestCase(string directory)
         }
     }
 
-    public class JSONResponse
+    public class JSONResponse : JSONObjectWithAdditionalData
     {
         public JSONRequestMatcher match;
 
@@ -133,10 +137,20 @@ public class JSONResponse
 
         public JSONResponse Validated()
         {
+            ThrowExceptionIfAdditionalData();
             if (match == null)
             {
                 throw new ArgumentException("match must be specified");
             }
+
+            if (replacements != null)
+            {
+                foreach (var replacement in replacements)
+                {
+                    replacement.ThrowExceptionIfAdditionalData();
+                }
+            }
+
             var mutuallyExclusive = new[] { literal, file, script, forward };
             var mutExWithValues = from value in mutuallyExclusive where value != null select value;
             if (mutExWithValues.Count() != 1)
@@ -207,7 +221,7 @@ from jsonreplacement in replacements
 
     }
 
-    public class JSONRequestMatcher
+    public class JSONRequestMatcher : JSONObjectWithAdditionalData
     {
         public string methods;
         public string xpath;
@@ -216,6 +230,8 @@ public class JSONRequestMatcher
 
         public RequestMatcher CreateRequestMatcher()
         {
+            ThrowExceptionIfAdditionalData();
+
             RequestMatcher retval;
             if (xpath != null)
             {
@@ -224,6 +240,7 @@ public RequestMatcher CreateRequestMatcher()
                 {
                     foreach (var jsonNs in namespaces)
                     {
+                        jsonNs.ThrowExceptionIfAdditionalData();
                         xpathMatcher.AddNamespace(jsonNs.prefix, jsonNs.ns);
                     }
                 }
@@ -245,19 +262,33 @@ public RequestMatcher CreateRequestMatcher()
         }
     }
 
-    public class JSONXPathNamespace
+    public class JSONXPathNamespace : JSONObjectWithAdditionalData
     {
         public string prefix;
         public string ns;
     }
 
-    public class JSONReplacement
+    public class JSONReplacement : JSONObjectWithAdditionalData
     {
         public string search;
         public string replace;
     }
 
-    public class JSONEndpoint
+    public class JSONObjectWithAdditionalData
+    {
+        [JsonExtensionData]
+        public IDictionary<string, JToken> AdditionalData;
+
+        public void ThrowExceptionIfAdditionalData()
+        {
+            if (AdditionalData != null)
+            {
+                throw new ArgumentException($"Unknown JSON attributes: " + string.Join(", ", from key in AdditionalData.Keys select $"'{key}'"));
+            }
+        }
+    }
+
+    public class JSONEndpoint : JSONObjectWithAdditionalData
     {
         public string name;
         public string pathregex;
@@ -266,6 +297,7 @@ public class JSONEndpoint
 
         public Endpoint CreateEndpoint(string rootDir, JSONDefaults globalDefaults)
         {
+            ThrowExceptionIfAdditionalData();
             var endpoint = new Endpoint(name, pathregex)
             {
                 Directory = rootDir
@@ -278,6 +310,10 @@ public Endpoint CreateEndpoint(string rootDir, JSONDefaults globalDefaults)
                 JsonConvert.DeserializeObject<JSONDefaults>(File.ReadAllText(endpointDefaultsFile))
                 :
                 null;
+            if (endpointDefaults != null)
+            {
+                endpointDefaults.ThrowExceptionIfAdditionalData();
+            }
 
             foreach (var jsonResponse in responses)
             {
@@ -330,7 +366,7 @@ private void applyDefaults(JSONDefaults defaults, JSONResponse jsonResponse)
         }
     }
 
-    public class JSONDefaults
+    public class JSONDefaults : JSONObjectWithAdditionalData
     {
         public string contenttype;
         public string charset;