Implemented optional request/response log disable

codeape2 · Aug 9, 2017 · d217036 · d217036
1 parent 5d91ff2
commit d217036
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 7 deletions.
diff --git a/UnitTests/TestInitFromJSON.cs b/UnitTests/TestInitFromJSON.cs
@@ -44,6 +44,14 @@ public void SimpleEndpointAttributes()
             var endpoint = JSONReader.ReadEndpoint(ENDPOINTJSON, "p:\\ath\\to\\endpoint\\directory", globalDefaults: null);
             Assert.Equal("foo", endpoint.Name);
             Assert.Equal("^/foo/$", endpoint.PathRegex);
+            Assert.True(endpoint.RecordRequests);
+        }
+
+        [Fact]
+        public void DoNotRecordRequestsAttribute()
+        {
+            var endpoint = JSONReader.ReadEndpoint("{'name': 'foo', 'pathregex': 'bar', 'responses': [], 'record': false}", "p:\\ath\\to\\endpoint\\directory", globalDefaults: null);
+            Assert.False(endpoint.RecordRequests);
         }
 
         private Endpoint endpoint;

diff --git a/UnitTests/TestJSONAdditionalData.cs b/UnitTests/TestJSONAdditionalData.cs
@@ -39,6 +39,7 @@ public void AdditionalDataIsNotValid()
             Assert.Equal("nmae", endpoint.AdditionalData.Keys.Single());
 
             var exception = Assert.Throws<ArgumentException>(() => endpoint.ThrowExceptionIfAdditionalData());
+            Assert.Equal("Unknown JSON attributes: 'nmae'", exception.Message);
         }
 
 
@@ -49,7 +50,7 @@ public void NullAdditionalDataIsNotSerialized()
             Assert.Null(endpoint.AdditionalData);
 
             var as_str = JsonConvert.SerializeObject(endpoint);
-            Assert.Equal("{\"name\":\"foobar\",\"pathregex\":null,\"responses\":null}", as_str);
+            Assert.Equal("{\"name\":\"foobar\",\"pathregex\":null,\"record\":true,\"responses\":null}", as_str);
         }
     }
 }
diff --git a/netmockery/Endpoint.cs b/netmockery/Endpoint.cs
@@ -43,6 +43,7 @@ public Endpoint(string name, string pathregex)
         //public IEnumerable<EndpointParameter> Parameters => _parameters;
 
         public string Directory { get; set; }
+        public bool RecordRequests { get; set; }
 
         public string Name => _name;
         public string PathRegex => _pathregex;

diff --git a/netmockery/JSONReader.cs b/netmockery/JSONReader.cs
@@ -292,6 +292,7 @@ public class JSONEndpoint : JSONObjectWithAdditionalData
     {
         public string name;
         public string pathregex;
+        public bool record = true;
         public JSONResponse[] responses;
 
 
@@ -300,7 +301,8 @@ public Endpoint CreateEndpoint(string rootDir, JSONDefaults globalDefaults)
             ThrowExceptionIfAdditionalData();
             var endpoint = new Endpoint(name, pathregex)
             {
-                Directory = rootDir
+                Directory = rootDir,
+                RecordRequests = record
             };
 
             var endpointDefaultsFile = Path.Combine(rootDir, "defaults.json");

diff --git a/netmockery/ResponseRegistry.cs b/netmockery/ResponseRegistry.cs
@@ -22,13 +22,17 @@ public class ResponseRegistryItem
         public string Error;
         public bool SingleMatch;
 
+        public bool HasBeenAddedToRegistry => Id != 0;
+
         public void WriteIncomingInfoToConsole()
         {
+            Debug.Assert(HasBeenAddedToRegistry);
             Console.WriteLine($"[{Id}] {Timestamp.ToString("HH:mm:ss.fff")} {Method} {RequestPath}");
         }
 
         public void WriteResolvedInfoToConsole()
         {
+            Debug.Assert(HasBeenAddedToRegistry);
             if (Endpoint != null)
             {
                 Console.WriteLine($"[{Id}] Endpoint: {Endpoint.Name}");
@@ -88,5 +92,11 @@ public ResponseRegistryItem Add(ResponseRegistryItem responseRegistryItem)
             }
             return responseRegistryItem;
         }
+
+        public void AddAndWriteIncomingInfoToConsole(ResponseRegistryItem responseRegistryItem)
+        {
+            Add(responseRegistryItem);
+            responseRegistryItem.WriteIncomingInfoToConsole();
+        }
     }
 }
diff --git a/netmockery/Startup.cs b/netmockery/Startup.cs
@@ -46,15 +46,15 @@ public void ConfigureServices(IServiceCollection services)
         public async Task HandleRequest(HttpContext context, string requestBody, byte[] requestBodyBytes)
         {
             Debug.Assert(context != null);
-            var responseRegistryItem = _responseRegistry.Add(new ResponseRegistryItem
+            var responseRegistryItem = new ResponseRegistryItem
             {
                 Timestamp = DateTime.Now,
                 RequestBody = requestBody,
                 Method = context.Request.Method,
                 RequestPath = context.Request.Path.ToString(),
                 QueryString = context.Request.QueryString.ToString()
-            });
-            responseRegistryItem.WriteIncomingInfoToConsole();
+            };
+            Debug.Assert(responseRegistryItem.Id == 0);
 
             try
             {
@@ -64,25 +64,35 @@ public async Task HandleRequest(HttpContext context, string requestBody, byte[]
             {
                 Debug.WriteLine(e);
                 responseRegistryItem.Error = e.ToString();
+                if (! responseRegistryItem.HasBeenAddedToRegistry)
+                {
+                    _responseRegistry.AddAndWriteIncomingInfoToConsole(responseRegistryItem);
+                }
             }
             finally
             {
-                responseRegistryItem.WriteResolvedInfoToConsole();                
+                if (responseRegistryItem.HasBeenAddedToRegistry)
+                {
+                    responseRegistryItem.WriteResolvedInfoToConsole();
+                }
             }
 
         }
 
         public async Task HandleRequestInner(ResponseRegistryItem responseRegistryItem, HttpContext context, string requestBody, byte[] requestBodyBytes)
         {
             Debug.Assert(_endpointCollectionProvider != null);
+            Debug.Assert(responseRegistryItem != null);
             var endpointCollection = _endpointCollectionProvider.EndpointCollection;
             var endpoint = endpointCollection.Resolve(context.Request.Path.ToString());
             responseRegistryItem.Endpoint = endpoint;
             if (endpoint != null)
-            {
+            {                
                 var matcher_and_creator = endpoint.Resolve(context.Request.Method, context.Request.Path, context.Request.QueryString, requestBody, context.Request.Headers);
                 if (matcher_and_creator != null)
                 {
+                    //TODO: Only if configured
+                    _responseRegistry.AddAndWriteIncomingInfoToConsole(responseRegistryItem);
                     var responseCreator = matcher_and_creator.ResponseCreator;
 
                     responseRegistryItem.RequestMatcher = matcher_and_creator.RequestMatcher;
@@ -106,11 +116,13 @@ public async Task HandleRequestInner(ResponseRegistryItem responseRegistryItem,
                 }
                 else
                 {
+                    _responseRegistry.AddAndWriteIncomingInfoToConsole(responseRegistryItem);
                     responseRegistryItem.Error = "Endpoint has no match for request";
                 }
             }
             else
             {
+                _responseRegistry.AddAndWriteIncomingInfoToConsole(responseRegistryItem);
                 responseRegistryItem.Error = "No endpoint matches request path";
             }
         }

diff --git a/netmockery/documentation.md b/netmockery/documentation.md
@@ -59,6 +59,7 @@ Example directory structure:
 * ``name``: The endpoint's name. The name is for display in the web UI only.
 * ``pathregex``: A request path reqular expression, used in the first step of the incoming request handling.
 * ``responses``: A list of request matching rules and response creation steps for the endpoint.
+* TODO: Document ``record`` property
 
 Example ``endpoint.json``: