1.0.4.0

Add request / response logging (#151)

CHANGELOG.md

@@ -1,3 +1,30 @@
+# 1.0.4.0 (23 June 2018)
+
+ - [#151](https://github.com/WireMock-Net/WireMock.Net/issues/151) - Feature: Add logging of incoming request and body for tracability
+ - [#149](https://github.com/WireMock-Net/WireMock.Net/issues/149) - Question: Transformer and Delay in Static Mappings?
+ - [#131](https://github.com/WireMock-Net/WireMock.Net/issues/131) - Bug: CurlException Couldn't connect to Server when running multiple tests
+
+Commits: 443fc76773...443fc76773
+
+
+# 1.0.3.20 (29 May 2018)
+
+ - [#147](https://github.com/WireMock-Net/WireMock.Net/pull/147) - Revert PortUtil.cs changes contributed by Stef Heyenrath ([StefH](https://github.com/StefH))
+ - [#146](https://github.com/WireMock-Net/WireMock.Net/issues/146) - Hang possibly due to Windows firewall prompt
+ - [#129](https://github.com/WireMock-Net/WireMock.Net/issues/129) - Random test failures between WireMock.Net 1.0.3.1 and 1.0.3.2
+
+Commits: 2fcfda49c7...2b498f45cb
+
+
+# 1.0.3.19 (28 May 2018)
+
+ - [#129](https://github.com/WireMock-Net/WireMock.Net/issues/129) - Random test failures between WireMock.Net 1.0.3.1 and 1.0.3.2
+ - [#145](https://github.com/WireMock-Net/WireMock.Net/pull/145) - Cancellation token not passed to server instance in .NET Core 2 contributed by Bob Paul ([Bob11327](https://github.com/Bob11327)) +fix
+ - [#144](https://github.com/WireMock-Net/WireMock.Net/pull/144) - Fix ConcurrentDictionary (#129) contributed by Stef Heyenrath ([StefH](https://github.com/StefH))
+
+Commits: ...
+
+
 # 1.0.3.18 (25 May 2018)
 
  - [#142](https://github.com/WireMock-Net/WireMock.Net/pull/142) - Allow all headers to be set as Response headers contributed by Stef Heyenrath ([StefH](https://github.com/StefH))

GitReleaseNotes.txt

@@ -1,5 +1,5 @@
 https://github.com/GitTools/GitReleaseNotes
 
-GitReleaseNotes.exe . /OutputFile CHANGELOG.md /Version 1.0.3.18
+GitReleaseNotes.exe . /OutputFile CHANGELOG.md /Version 1.0.4.0
 
 GitReleaseNotes.exe . /OutputFile CHANGELOG.md /allTags

examples/WireMock.Net.ConsoleApplication/MainApp.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Net;
 using Newtonsoft.Json;
+using WireMock.Logging;
 using WireMock.Matchers;
 using WireMock.RequestBuilders;
 using WireMock.ResponseBuilders;
@@ -28,7 +29,8 @@ namespace WireMock.Net.ConsoleApplication
                 //    SaveMapping = true
                 //},
                 PreWireMockMiddlewareInit = app => { System.Console.WriteLine($"PreWireMockMiddlewareInit : {app.GetType()}"); },
-                PostWireMockMiddlewareInit = app => { System.Console.WriteLine($"PostWireMockMiddlewareInit : {app.GetType()}"); }
+                PostWireMockMiddlewareInit = app => { System.Console.WriteLine($"PostWireMockMiddlewareInit : {app.GetType()}"); },
+                Logger = new WireMockConsoleLogger()
             });
             System.Console.WriteLine("FluentMockServer listening at {0}", string.Join(",", server.Urls));
 

examples/WireMock.Net.StandAlone.NETCoreApp/WireMockLog4NetLogger.cs

@@ -1,4 +1,6 @@
 using log4net;
+using Newtonsoft.Json;
+using WireMock.Admin.Requests;
 using WireMock.Logging;
 
 namespace WireMock.Net.StandAlone.NETCoreApp
@@ -26,5 +28,11 @@ namespace WireMock.Net.StandAlone.NETCoreApp
         {
             Log.ErrorFormat(formatString, args);
         }
+
+        public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
+        {
+            string message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented);
+            Log.DebugFormat("Admin[{0}] {1}", isAdminRequest, message);
+        }
     }
 }

examples/WireMock.Net.WebApplication/WireMockService.cs

@@ -1,6 +1,7 @@
 using System.Threading;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
+using WireMock.Admin.Requests;
 using WireMock.Logging;
 using WireMock.Net.StandAlone;
 using WireMock.Settings;
@@ -42,6 +43,12 @@ namespace WireMock.Net.WebApplication
             {
                 _logger.LogError(formatString, args);
             }
+
+            public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminrequest)
+            {
+                string message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented);
+                _logger.LogDebug("Admin[{0}] {1}", isAdminrequest, message);
+            }
         }
 
         public WireMockService(ILogger logger, IFluentMockServerSettings settings)

src/WireMock.Net.StandAlone/WireMock.Net.StandAlone.csproj

@@ -1,9 +1,9 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <Description>Lightweight StandAlone Http Mocking Server for .Net.</Description>
     <AssemblyTitle>WireMock.Net.StandAlone</AssemblyTitle>
-    <Version>1.0.3.18</Version>
+    <Version>1.0.4.0</Version>
     <Authors>Stef Heyenrath</Authors>
     <TargetFrameworks>net452;net46;netstandard1.3;netstandard2.0</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>

src/WireMock.Net/Logging/IWireMockLogger.cs

@@ -1,4 +1,5 @@
 using JetBrains.Annotations;
+using WireMock.Admin.Requests;
 
 namespace WireMock.Logging
 {
@@ -43,5 +44,13 @@ namespace WireMock.Logging
         [PublicAPI]
         [StringFormatMethod("formatString")]
         void Error([NotNull] string formatString, [NotNull] params object[] args);
+
+        /// <summary>
+        /// Writes the LogEntryModel (LogRequestModel, LogResponseModel and more).
+        /// </summary>
+        /// <param name="logEntryModel">The Request Log Model.</param>
+        /// <param name="isAdminrequest">Defines if this request is an admin request.</param>
+        [PublicAPI]
+        void DebugRequestResponse([NotNull] LogEntryModel logEntryModel, bool isAdminrequest);
     }
 }

src/WireMock.Net/Logging/WireMockConsoleLogger.cs

@@ -1,4 +1,6 @@
 using System;
+using Newtonsoft.Json;
+using WireMock.Admin.Requests;
 
 namespace WireMock.Logging
 {
@@ -8,6 +10,14 @@ namespace WireMock.Logging
     /// <seealso cref="IWireMockLogger" />
     public class WireMockConsoleLogger : IWireMockLogger
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="WireMockConsoleLogger"/> class.
+        /// </summary>
+        public WireMockConsoleLogger()
+        {
+            Console.OutputEncoding = System.Text.Encoding.UTF8;
+        }
+
         /// <see cref="IWireMockLogger.Debug"/>
         public void Debug(string formatString, params object[] args)
         {
@@ -32,9 +42,16 @@ namespace WireMock.Logging
             Console.WriteLine(Format("Error", formatString, args));
         }
 
+        /// <see cref="IWireMockLogger.DebugRequestResponse"/>
+        public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
+        {
+            string message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented);
+            Console.WriteLine(Format("DebugRequestResponse", "Admin[{0}] {1}", isAdminRequest, message));
+        }
+
         private static string Format(string level, string formatString, params object[] args)
         {
-            string message = string.Format(formatString, args);
+            var message = args.Length > 0 ? string.Format(formatString, args) : formatString;
 
             return $"{DateTime.UtcNow} [{level}] : {message}";
         }

src/WireMock.Net/Logging/WireMockNullLogger.cs

@@ -1,4 +1,6 @@
-namespace WireMock.Logging
+using WireMock.Admin.Requests;
+
+namespace WireMock.Logging
 {
     /// <summary>
     /// WireMockNullLogger which does not log.
@@ -25,5 +27,10 @@
         public void Error(string formatString, params object[] args)
         {
         }
+
+        /// <see cref="IWireMockLogger.DebugRequestResponse"/>
+        public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
+        {
+        }
     }
 }

src/WireMock.Net/Owin/AspNetCoreSelfHost.cs

@@ -110,7 +110,7 @@ namespace WireMock.Owin
                 _host.Run(_cts.Token);
 #else
                 _logger.Info("WireMock.Net server using netstandard2.0");
-                _host.Run();
+                _host.RunAsync(_cts.Token).Wait();
 #endif
             }
             catch (Exception e)

src/WireMock.Net/Owin/WireMockMiddleware.cs

@@ -7,6 +7,7 @@ using WireMock.Matchers;
 using WireMock.Util;
 using Newtonsoft.Json;
 using WireMock.Http;
+using WireMock.Serialization;
 #if !NETSTANDARD
 using Microsoft.Owin;
 #else
@@ -58,7 +59,7 @@ namespace WireMock.Owin
                     // Set start
                     if (!_options.Scenarios.ContainsKey(mapping.Scenario) && mapping.IsStartState)
                     {
-                        _options.Scenarios.Add(mapping.Scenario, null);
+                        _options.Scenarios.TryAdd(mapping.Scenario, null);
                     }
                 }
 
@@ -153,6 +154,8 @@ namespace WireMock.Owin
 
         private void LogRequest(LogEntry entry, bool addRequest)
         {
+            _options.Logger.DebugRequestResponse(LogEntryMapper.Map(entry), entry.RequestMessage.Path.StartsWith("/__admin/"));
+
             if (addRequest)
             {
                 _options.LogEntries.Add(entry);

src/WireMock.Net/Owin/WireMockMiddlewareOptions.cs

@@ -1,6 +1,5 @@
 using System;
 using System.Collections.Concurrent;
-using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using WireMock.Logging;
 using WireMock.Matchers;
@@ -23,7 +22,9 @@ namespace WireMock.Owin
 
         public bool AllowPartialMapping { get; set; }
 
-        public IDictionary<Guid, Mapping> Mappings { get; } = new ConcurrentDictionary<Guid, Mapping>();
+        public ConcurrentDictionary<Guid, Mapping> Mappings { get; } = new ConcurrentDictionary<Guid, Mapping>(); // Checked
+
+        public ConcurrentDictionary<string, object> Scenarios { get; } = new ConcurrentDictionary<string, object>(); // Checked
 
         public ObservableCollection<LogEntry> LogEntries { get; } = new ConcurentObservableCollection<LogEntry>();
 
@@ -31,8 +32,6 @@ namespace WireMock.Owin
 
         public int? MaxRequestLogCount { get; set; }
 
-        public IDictionary<string, object> Scenarios { get; } = new ConcurrentDictionary<string, object>();
-
 #if !NETSTANDARD
         public Action<IAppBuilder> PreWireMockMiddlewareInit { get; set; }
 

src/WireMock.Net/ResponseMessage.cs

@@ -1,5 +1,4 @@
-using System.Collections.Concurrent;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using WireMock.Util;
@@ -8,14 +7,14 @@ using WireMock.Validation;
 namespace WireMock
 {
     /// <summary>
-    /// The response.
+    /// The ResponseMessage.
     /// </summary>
     public class ResponseMessage
     {
         /// <summary>
         /// Gets the headers.
         /// </summary>
-        public IDictionary<string, WireMockList<string>> Headers { get; set; } = new ConcurrentDictionary<string, WireMockList<string>>();
+        public IDictionary<string, WireMockList<string>> Headers { get; set; } = new Dictionary<string, WireMockList<string>>();
 
         /// <summary>
         /// Gets or sets the status code.

src/WireMock.Net/Serialization/LogEntryMapper.cs

@@ -0,0 +1,70 @@
+using System.Linq;
+using WireMock.Admin.Mappings;
+using WireMock.Admin.Requests;
+using WireMock.Logging;
+
+namespace WireMock.Serialization
+{
+    internal static class LogEntryMapper
+    {
+        public static LogEntryModel Map(LogEntry logEntry)
+        {
+            return new LogEntryModel
+            {
+                Guid = logEntry.Guid,
+                Request = new LogRequestModel
+                {
+                    DateTime = logEntry.RequestMessage.DateTime,
+                    ClientIP = logEntry.RequestMessage.ClientIP,
+                    Path = logEntry.RequestMessage.Path,
+                    AbsoluteUrl = logEntry.RequestMessage.Url,
+                    Query = logEntry.RequestMessage.Query,
+                    Method = logEntry.RequestMessage.Method,
+                    Body = logEntry.RequestMessage.Body,
+                    BodyAsJson = logEntry.RequestMessage.BodyAsJson,
+                    BodyAsBytes = logEntry.RequestMessage.BodyAsBytes,
+                    Headers = logEntry.RequestMessage.Headers,
+                    Cookies = logEntry.RequestMessage.Cookies,
+                    BodyEncoding = logEntry.RequestMessage.BodyEncoding != null ? new EncodingModel
+                    {
+                        EncodingName = logEntry.RequestMessage.BodyEncoding.EncodingName,
+                        CodePage = logEntry.RequestMessage.BodyEncoding.CodePage,
+                        WebName = logEntry.RequestMessage.BodyEncoding.WebName
+                    } : null
+                },
+                Response = new LogResponseModel
+                {
+                    StatusCode = logEntry.ResponseMessage.StatusCode,
+                    BodyDestination = logEntry.ResponseMessage.BodyDestination,
+                    Body = logEntry.ResponseMessage.Body,
+                    BodyAsJson = logEntry.ResponseMessage.BodyAsJson,
+                    BodyAsBytes = logEntry.ResponseMessage.BodyAsBytes,
+                    BodyOriginal = logEntry.ResponseMessage.BodyOriginal,
+                    BodyAsFile = logEntry.ResponseMessage.BodyAsFile,
+                    BodyAsFileIsCached = logEntry.ResponseMessage.BodyAsFileIsCached,
+                    Headers = logEntry.ResponseMessage.Headers,
+                    BodyEncoding = logEntry.ResponseMessage.BodyEncoding != null ? new EncodingModel
+                    {
+                        EncodingName = logEntry.ResponseMessage.BodyEncoding.EncodingName,
+                        CodePage = logEntry.ResponseMessage.BodyEncoding.CodePage,
+                        WebName = logEntry.ResponseMessage.BodyEncoding.WebName
+                    } : null
+                },
+                MappingGuid = logEntry.MappingGuid,
+                MappingTitle = logEntry.MappingTitle,
+                RequestMatchResult = logEntry.RequestMatchResult != null ? new LogRequestMatchModel
+                {
+                    TotalScore = logEntry.RequestMatchResult.TotalScore,
+                    TotalNumber = logEntry.RequestMatchResult.TotalNumber,
+                    IsPerfectMatch = logEntry.RequestMatchResult.IsPerfectMatch,
+                    AverageTotalScore = logEntry.RequestMatchResult.AverageTotalScore,
+                    MatchDetails = logEntry.RequestMatchResult.MatchDetails.Select(x => new
+                    {
+                        Name = x.Key.Name.Replace("RequestMessage", string.Empty),
+                        Score = x.Value
+                    } as object).ToList()
+                } : null
+            };
+        }
+    }
+}

src/WireMock.Net/Server/FluentMockServer.Admin.cs

@@ -210,7 +210,7 @@ namespace WireMock.Server
             if (settings.SaveMapping)
             {
                 var mapping = ToMapping(requestMessage, responseMessage, settings.BlackListedHeaders ?? new string[] { });
-                _options.Mappings.Add(mapping.Guid, mapping);
+                _options.Mappings.TryAdd(mapping.Guid, mapping);
 
                 if (settings.SaveMappingToFile)
                 {
@@ -457,7 +457,7 @@ namespace WireMock.Server
                 return new ResponseMessage { StatusCode = 404, Body = "Request not found" };
             }
 
-            var model = ToLogEntryModel(entry);
+            var model = LogEntryMapper.Map(entry);
 
             return ToJson(model);
         }
@@ -478,71 +478,11 @@ namespace WireMock.Server
         {
             var result = LogEntries
                 .Where(r => !r.RequestMessage.Path.StartsWith("/__admin/"))
-                .Select(ToLogEntryModel);
+                .Select(LogEntryMapper.Map);
 
             return ToJson(result);
         }
 
-        private LogEntryModel ToLogEntryModel(LogEntry logEntry)
-        {
-            return new LogEntryModel
-            {
-                Guid = logEntry.Guid,
-                Request = new LogRequestModel
-                {
-                    DateTime = logEntry.RequestMessage.DateTime,
-                    ClientIP = logEntry.RequestMessage.ClientIP,
-                    Path = logEntry.RequestMessage.Path,
-                    AbsoluteUrl = logEntry.RequestMessage.Url,
-                    Query = logEntry.RequestMessage.Query,
-                    Method = logEntry.RequestMessage.Method,
-                    Body = logEntry.RequestMessage.Body,
-                    BodyAsJson = logEntry.RequestMessage.BodyAsJson,
-                    BodyAsBytes = logEntry.RequestMessage.BodyAsBytes,
-                    Headers = logEntry.RequestMessage.Headers,
-                    Cookies = logEntry.RequestMessage.Cookies,
-                    BodyEncoding = logEntry.RequestMessage.BodyEncoding != null ? new EncodingModel
-                    {
-                        EncodingName = logEntry.RequestMessage.BodyEncoding.EncodingName,
-                        CodePage = logEntry.RequestMessage.BodyEncoding.CodePage,
-                        WebName = logEntry.RequestMessage.BodyEncoding.WebName
-                    } : null
-                },
-                Response = new LogResponseModel
-                {
-                    StatusCode = logEntry.ResponseMessage.StatusCode,
-                    BodyDestination = logEntry.ResponseMessage.BodyDestination,
-                    Body = logEntry.ResponseMessage.Body,
-                    BodyAsJson = logEntry.ResponseMessage.BodyAsJson,
-                    BodyAsBytes = logEntry.ResponseMessage.BodyAsBytes,
-                    BodyOriginal = logEntry.ResponseMessage.BodyOriginal,
-                    BodyAsFile = logEntry.ResponseMessage.BodyAsFile,
-                    BodyAsFileIsCached = logEntry.ResponseMessage.BodyAsFileIsCached,
-                    Headers = logEntry.ResponseMessage.Headers,
-                    BodyEncoding = logEntry.ResponseMessage.BodyEncoding != null ? new EncodingModel
-                    {
-                        EncodingName = logEntry.ResponseMessage.BodyEncoding.EncodingName,
-                        CodePage = logEntry.ResponseMessage.BodyEncoding.CodePage,
-                        WebName = logEntry.ResponseMessage.BodyEncoding.WebName
-                    } : null
-                },
-                MappingGuid = logEntry.MappingGuid,
-                MappingTitle = logEntry.MappingTitle,
-                RequestMatchResult = logEntry.RequestMatchResult != null ? new LogRequestMatchModel
-                {
-                    TotalScore = logEntry.RequestMatchResult.TotalScore,
-                    TotalNumber = logEntry.RequestMatchResult.TotalNumber,
-                    IsPerfectMatch = logEntry.RequestMatchResult.IsPerfectMatch,
-                    AverageTotalScore = logEntry.RequestMatchResult.AverageTotalScore,
-                    MatchDetails = logEntry.RequestMatchResult.MatchDetails.Select(x => new
-                    {
-                        Name = x.Key.Name.Replace("RequestMessage", string.Empty),
-                        Score = x.Value
-                    } as object).ToList()
-                } : null
-            };
-        }
-
         private ResponseMessage RequestsDelete(RequestMessage requestMessage)
         {
             ResetLogEntries();
@@ -568,7 +508,7 @@ namespace WireMock.Server
                 }
             }
 
-            var result = dict.OrderBy(x => x.Value.AverageTotalScore).Select(x => x.Key).Select(ToLogEntryModel);
+            var result = dict.OrderBy(x => x.Value.AverageTotalScore).Select(x => x.Key).Select(LogEntryMapper.Map);
 
             return ToJson(result);
         }
@@ -577,7 +517,7 @@ namespace WireMock.Server
         #region Scenarios
         private ResponseMessage ScenariosGet(RequestMessage requestMessage)
         {
-            var scenarios = Scenarios.Select(s => new
+            var scenarios = Scenarios.ToArray().Select(s => new
             {
                 Name = s.Key,
                 Started = s.Value != null,

src/WireMock.Net/Server/FluentMockServer.cs

@@ -56,7 +56,7 @@ namespace WireMock.Server
         /// Gets the scenarios.
         /// </summary>
         [PublicAPI]
-        public IDictionary<string, object> Scenarios => new ConcurrentDictionary<string, object>(_options.Scenarios);
+        public ConcurrentDictionary<string, object> Scenarios => new ConcurrentDictionary<string, object>(_options.Scenarios); // Checked
 
         #region Start/Stop
         /// <summary>
@@ -161,6 +161,7 @@ namespace WireMock.Server
             settings.Logger = settings.Logger ?? new WireMockConsoleLogger();
             _logger = settings.Logger;
 
+            _logger.Info("WireMock.Net by Stef Heyenrath (https://github.com/WireMock-Net/WireMock.Net)");
             _logger.Debug("WireMock.Net server settings {0}", JsonConvert.SerializeObject(settings, Formatting.Indented));
 
             if (settings.Urls != null)
@@ -248,7 +249,9 @@ namespace WireMock.Server
         [PublicAPI]
         public void Stop()
         {
-            _httpServer?.StopAsync();
+            var result = _httpServer?.StopAsync();
+            if (result != null)
+                result.Wait();          //wait for stop to actually happen
         }
         #endregion
 
@@ -292,9 +295,9 @@ namespace WireMock.Server
         [PublicAPI]
         public void ResetMappings()
         {
-            foreach (var nonAdmin in _options.Mappings.Where(m => !m.Value.IsAdminInterface))
+            foreach (var nonAdmin in _options.Mappings.ToArray().Where(m => !m.Value.IsAdminInterface))
             {
-                _options.Mappings.Remove(nonAdmin);
+                _options.Mappings.TryRemove(nonAdmin.Key, out _);
             }
         }
 
@@ -308,7 +311,7 @@ namespace WireMock.Server
             // Check a mapping exists with the same GUID, if so, remove it.
             if (_options.Mappings.ContainsKey(guid))
             {
-                return _options.Mappings.Remove(guid);
+                return _options.Mappings.TryRemove(guid, out _);
             }
 
             return false;
@@ -317,7 +320,7 @@ namespace WireMock.Server
         private bool DeleteMapping(string path)
         {
             // Check a mapping exists with the same path, if so, remove it.
-            var mapping = _options.Mappings.FirstOrDefault(entry => string.Equals(entry.Value.Path, path, StringComparison.OrdinalIgnoreCase));
+            var mapping = _options.Mappings.ToArray().FirstOrDefault(entry => string.Equals(entry.Value.Path, path, StringComparison.OrdinalIgnoreCase));
             return DeleteMapping(mapping.Key);
         }
 
@@ -415,7 +418,7 @@ namespace WireMock.Server
             }
             else
             {
-                _options.Mappings.Add(mapping.Guid, mapping);
+                _options.Mappings.TryAdd(mapping.Guid, mapping);
             }
         }
     }

src/WireMock.Net/WireMock.Net.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <Description>Lightweight Http Mocking Server for .Net, inspired by WireMock from the Java landscape.</Description>
     <AssemblyTitle>WireMock.Net</AssemblyTitle>
-    <Version>1.0.3.18</Version>
+    <Version>1.0.4.0</Version>
     <Authors>Stef Heyenrath</Authors>
     <TargetFrameworks>net452;net46;netstandard1.3;netstandard2.0</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>