1.0.24.0

* Fixed bug 301 by not setting BodyAsFile to null after first use

* Added extra unit test

* 1.0.24.0

CHANGELOG.md

@@ -1,3 +1,18 @@
+# 1.0.24.0 (22 July 2019)
+- [#302](https://github.com/WireMock-Net/WireMock.Net/pull/302) - Fixed bug 301 by not setting BodyAsFile to null after first use [bug] contributed by [rwwilden](https://github.com/rwwilden)
+- [#299](https://github.com/WireMock-Net/WireMock.Net/issues/299) - Get Mappings models instead of just IMapping interface [feature, question]
+- [#300](https://github.com/WireMock-Net/WireMock.Net/issues/300) - Integration with Azure Function [question]
+- [#301](https://github.com/WireMock-Net/WireMock.Net/issues/301) - Error thrown when calling mocked endpoint second time when using file-based response body [bug]
+
+# 1.0.23.0 (16 July 2019)
+- [#298](https://github.com/WireMock-Net/WireMock.Net/pull/298) - MappingModels [feature] contributed by [StefH](https://github.com/StefH)
+
+# 1.0.22.0 (15 July 2019)
+- [#297](https://github.com/WireMock-Net/WireMock.Net/pull/297) - FixNullRef (#295) contributed by [StefH](https://github.com/StefH)
+- [#178](https://github.com/WireMock-Net/WireMock.Net/issues/178) - Bug: Path matching fails when the URL contains encoded parts [bug, question]
+- [#295](https://github.com/WireMock-Net/WireMock.Net/issues/295) - NullRef in 1.0.21 [bug]
+- [#296](https://github.com/WireMock-Net/WireMock.Net/issues/296) - url param - how to accept either of multiple values [question]
+
 # 1.0.21.0 (03 July 2019)
 - [#286](https://github.com/WireMock-Net/WireMock.Net/pull/286) - Handlebars Extension [feature] contributed by [StefH](https://github.com/StefH)
 - [#293](https://github.com/WireMock-Net/WireMock.Net/pull/293) - workaround for AppContext.BaseDirectory being null on some platforms contributed by [eli-darkly](https://github.com/eli-darkly)

Directory.Build.props

@@ -4,7 +4,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>1.0.21</VersionPrefix>
+    <VersionPrefix>1.0.24</VersionPrefix>
   </PropertyGroup>
 
   <Choose>

GitHubReleaseNotes.txt

@@ -1,3 +1,3 @@
 https://github.com/StefH/GitHubReleaseNotes
 
-GitHubReleaseNotes.exe --output CHANGELOG.md --skip-empty-releases --version 1.0.21.0
+GitHubReleaseNotes.exe --output CHANGELOG.md --skip-empty-releases --version 1.0.24.0

azure-pipelines.yml

@@ -38,6 +38,9 @@ steps:
     %USERPROFILE%\.dotnet\tools\dotnet-sonarscanner end /d:sonar.login="$(SONAR_TOKEN)"
   displayName: End SonarScanner
 
+- task: whitesource.ws-bolt.bolt.wss.WhiteSource Bolt@19
+  displayName: 'WhiteSource Bolt'
+
 # Upload coverage to codecov.io
 - script: |
     %USERPROFILE%\.nuget\packages\codecov\1.1.0\tools\codecov.exe -f "./test/WireMock.Net.Tests/coverage.opencover.xml" -t $(CODECOV_TOKEN)

examples/WireMock.Net.Console.Net452.Classic/MainApp.cs

@@ -448,6 +448,8 @@ namespace WireMock.Net.ConsoleApplication
                     .WithHeader("Content-Type", "application/json")
                     .WithBodyAsJson(new { Id = "5bdf076c-5654-4b3e-842c-7caf1fabf8c9" }));
 
+            System.Console.WriteLine(JsonConvert.SerializeObject(server.MappingModels, Formatting.Indented));
+
             System.Console.WriteLine("Press any key to stop the server");
             System.Console.ReadKey();
             server.Stop();

src/WireMock.Net/ResponseBuilders/Response.cs

@@ -419,7 +419,6 @@ namespace WireMock.ResponseBuilders
             if (!UseTransformer && ResponseMessage.BodyData?.BodyAsFileIsCached == true)
             {
                 ResponseMessage.BodyData.BodyAsBytes = settings.FileSystemHandler.ReadResponseBodyAsFile(ResponseMessage.BodyData.BodyAsFile);
-                ResponseMessage.BodyData.BodyAsFile = null;
             }
 
             return ResponseMessage;

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

@@ -131,18 +131,18 @@ namespace WireMock.Server
         {
             if (folder == null)
             {
-                folder = _fileSystemHandler.GetMappingFolder();
+                folder = _settings.FileSystemHandler.GetMappingFolder();
             }
 
-            if (!_fileSystemHandler.FolderExists(folder))
+            if (!_settings.FileSystemHandler.FolderExists(folder))
             {
-                _logger.Info("The Static Mapping folder '{0}' does not exist, reading Static MappingFiles will be skipped.", folder);
+                _settings.Logger.Info("The Static Mapping folder '{0}' does not exist, reading Static MappingFiles will be skipped.", folder);
                 return;
             }
 
-            foreach (string filename in _fileSystemHandler.EnumerateFiles(folder).OrderBy(f => f))
+            foreach (string filename in _settings.FileSystemHandler.EnumerateFiles(folder).OrderBy(f => f))
             {
-                _logger.Info("Reading Static MappingFile : '{0}'", filename);
+                _settings.Logger.Info("Reading Static MappingFile : '{0}'", filename);
 
                 try
                 {
@@ -150,7 +150,7 @@ namespace WireMock.Server
                 }
                 catch
                 {
-                    _logger.Error("Static MappingFile : '{0}' could not be read. This file will be skipped.", filename);
+                    _settings.Logger.Error("Static MappingFile : '{0}' could not be read. This file will be skipped.", filename);
                 }
             }
         }
@@ -172,28 +172,28 @@ namespace WireMock.Server
                 return;
             }
 
-            _logger.Info("Watching folder '{0}' for new, updated and deleted MappingFiles.", folder);
+            _settings.Logger.Info("Watching folder '{0}' for new, updated and deleted MappingFiles.", folder);
 
             var watcher = new EnhancedFileSystemWatcher(folder, "*.json", EnhancedFileSystemWatcherTimeoutMs);
             watcher.Created += (sender, args) =>
             {
-                _logger.Info("MappingFile created : '{0}', reading file.", args.FullPath);
+                _settings.Logger.Info("MappingFile created : '{0}', reading file.", args.FullPath);
                 if (!ReadStaticMappingAndAddOrUpdate(args.FullPath))
                 {
-                    _logger.Error("Unable to read MappingFile '{0}'.", args.FullPath);
+                    _settings.Logger.Error("Unable to read MappingFile '{0}'.", args.FullPath);
                 }
             };
             watcher.Changed += (sender, args) =>
             {
-                _logger.Info("MappingFile updated : '{0}', reading file.", args.FullPath);
+                _settings.Logger.Info("MappingFile updated : '{0}', reading file.", args.FullPath);
                 if (!ReadStaticMappingAndAddOrUpdate(args.FullPath))
                 {
-                    _logger.Error("Unable to read MappingFile '{0}'.", args.FullPath);
+                    _settings.Logger.Error("Unable to read MappingFile '{0}'.", args.FullPath);
                 }
             };
             watcher.Deleted += (sender, args) =>
             {
-                _logger.Info("MappingFile deleted : '{0}'", args.FullPath);
+                _settings.Logger.Info("MappingFile deleted : '{0}'", args.FullPath);
                 string filenameWithoutExtension = Path.GetFileNameWithoutExtension(args.FullPath);
 
                 if (Guid.TryParse(filenameWithoutExtension, out Guid guidFromFilename))
@@ -220,7 +220,7 @@ namespace WireMock.Server
 
             string filenameWithoutExtension = Path.GetFileNameWithoutExtension(path);
 
-            if (FileHelper.TryReadMappingFileWithRetryAndDelay(_fileSystemHandler, path, out string value))
+            if (FileHelper.TryReadMappingFileWithRetryAndDelay(_settings.FileSystemHandler, path, out string value))
             {
                 var mappingModels = DeserializeObjectToArray<MappingModel>(JsonConvert.DeserializeObject(value));
                 foreach (var mappingModel in mappingModels)
@@ -361,7 +361,7 @@ namespace WireMock.Server
 
             if (mapping == null)
             {
-                _logger.Warn("HttpStatusCode set to 404 : Mapping not found");
+                _settings.Logger.Warn("HttpStatusCode set to 404 : Mapping not found");
                 return ResponseMessageBuilder.Create("Mapping not found", 404);
             }
 
@@ -405,12 +405,12 @@ namespace WireMock.Server
         {
             if (folder == null)
             {
-                folder = _fileSystemHandler.GetMappingFolder();
+                folder = _settings.FileSystemHandler.GetMappingFolder();
             }
 
-            if (!_fileSystemHandler.FolderExists(folder))
+            if (!_settings.FileSystemHandler.FolderExists(folder))
             {
-                _fileSystemHandler.CreateFolder(folder);
+                _settings.FileSystemHandler.CreateFolder(folder);
             }
 
             var model = MappingConverter.ToMappingModel(mapping);
@@ -418,26 +418,23 @@ namespace WireMock.Server
 
             string path = Path.Combine(folder, filename);
 
-            _logger.Info("Saving Mapping file {0}", filename);
+            _settings.Logger.Info("Saving Mapping file {0}", filename);
 
-            _fileSystemHandler.WriteMappingFile(path, JsonConvert.SerializeObject(model, _jsonSerializerSettings));
+            _settings.FileSystemHandler.WriteMappingFile(path, JsonConvert.SerializeObject(model, _jsonSerializerSettings));
         }
 
         private static string SanitizeFileName(string name, char replaceChar = '_')
         {
             return Path.GetInvalidFileNameChars().Aggregate(name, (current, c) => current.Replace(c, replaceChar));
         }
+        private IEnumerable<MappingModel> ToMappingModels()
+        {
+            return Mappings.Where(m => !m.IsAdminInterface).Select(MappingConverter.ToMappingModel);
+        }
 
         private ResponseMessage MappingsGet(RequestMessage requestMessage)
         {
-            var result = new List<MappingModel>();
-            foreach (var mapping in Mappings.Where(m => !m.IsAdminInterface))
-            {
-                var model = MappingConverter.ToMappingModel(mapping);
-                result.Add(model);
-            }
-
-            return ToJson(result);
+            return ToJson(ToMappingModels());
         }
 
         private ResponseMessage MappingsPost(RequestMessage requestMessage)
@@ -460,12 +457,12 @@ namespace WireMock.Server
             }
             catch (ArgumentException a)
             {
-                _logger.Error("HttpStatusCode set to 400 {0}", a);
+                _settings.Logger.Error("HttpStatusCode set to 400 {0}", a);
                 return ResponseMessageBuilder.Create(a.Message, 400);
             }
             catch (Exception e)
             {
-                _logger.Error("HttpStatusCode set to 500 {0}", e);
+                _settings.Logger.Error("HttpStatusCode set to 500 {0}", e);
                 return ResponseMessageBuilder.Create(e.ToString(), 500);
             }
         }
@@ -540,7 +537,7 @@ namespace WireMock.Server
 
             if (entry == null)
             {
-                _logger.Warn("HttpStatusCode set to 404 : Request not found");
+                _settings.Logger.Warn("HttpStatusCode set to 404 : Request not found");
                 return ResponseMessageBuilder.Create("Request not found", 404);
             }
 
@@ -683,7 +680,7 @@ namespace WireMock.Server
 
             if (pathOrUrlRequired && !pathOrUrlmatchersValid)
             {
-                _logger.Error("Path or Url matcher is missing for this mapping, this mapping will not be added.");
+                _settings.Logger.Error("Path or Url matcher is missing for this mapping, this mapping will not be added.");
                 return null;
             }
 

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

@@ -16,13 +16,13 @@ namespace WireMock.Server
         {
             string filename = GetFileNameFromRequestMessage(requestMessage);
 
-            string mappingFolder = _fileSystemHandler.GetMappingFolder();
-            if (!_fileSystemHandler.FolderExists(mappingFolder))
+            string mappingFolder = _settings.FileSystemHandler.GetMappingFolder();
+            if (!_settings.FileSystemHandler.FolderExists(mappingFolder))
             {
-                _fileSystemHandler.CreateFolder(mappingFolder);
+                _settings.FileSystemHandler.CreateFolder(mappingFolder);
             }
 
-            _fileSystemHandler.WriteFile(filename, requestMessage.BodyAsBytes);
+            _settings.FileSystemHandler.WriteFile(filename, requestMessage.BodyAsBytes);
 
             return ResponseMessageBuilder.Create("File created");
         }
@@ -31,13 +31,13 @@ namespace WireMock.Server
         {
             string filename = GetFileNameFromRequestMessage(requestMessage);
 
-            if (!_fileSystemHandler.FileExists(filename))
+            if (!_settings.FileSystemHandler.FileExists(filename))
             {
-                _logger.Info("The file '{0}' does not exist, updating file will be skipped.", filename);
+                _settings.Logger.Info("The file '{0}' does not exist, updating file will be skipped.", filename);
                 return ResponseMessageBuilder.Create("File is not found", 404);
             }
 
-            _fileSystemHandler.WriteFile(filename, requestMessage.BodyAsBytes);
+            _settings.FileSystemHandler.WriteFile(filename, requestMessage.BodyAsBytes);
 
             return ResponseMessageBuilder.Create("File updated");
         }
@@ -46,13 +46,13 @@ namespace WireMock.Server
         {
             string filename = GetFileNameFromRequestMessage(requestMessage);
 
-            if (!_fileSystemHandler.FileExists(filename))
+            if (!_settings.FileSystemHandler.FileExists(filename))
             {
-                _logger.Info("The file '{0}' does not exist.", filename);
+                _settings.Logger.Info("The file '{0}' does not exist.", filename);
                 return ResponseMessageBuilder.Create("File is not found", 404);
             }
 
-            byte[] bytes = _fileSystemHandler.ReadFile(filename);
+            byte[] bytes = _settings.FileSystemHandler.ReadFile(filename);
             var response = new ResponseMessage
             {
                 StatusCode = 200,
@@ -82,9 +82,9 @@ namespace WireMock.Server
         {
             string filename = GetFileNameFromRequestMessage(requestMessage);
 
-            if (!_fileSystemHandler.FileExists(filename))
+            if (!_settings.FileSystemHandler.FileExists(filename))
             {
-                _logger.Info("The file '{0}' does not exist.", filename);
+                _settings.Logger.Info("The file '{0}' does not exist.", filename);
                 return ResponseMessageBuilder.Create(404);
             }
 
@@ -95,13 +95,13 @@ namespace WireMock.Server
         {
             string filename = GetFileNameFromRequestMessage(requestMessage);
 
-            if (!_fileSystemHandler.FileExists(filename))
+            if (!_settings.FileSystemHandler.FileExists(filename))
             {
-                _logger.Info("The file '{0}' does not exist.", filename);
+                _settings.Logger.Info("The file '{0}' does not exist.", filename);
                 return ResponseMessageBuilder.Create("File is not deleted", 404);
             }
 
-            _fileSystemHandler.DeleteFile(filename);
+            _settings.FileSystemHandler.DeleteFile(filename);
             return ResponseMessageBuilder.Create("File deleted.");
         }
 

src/WireMock.Net/Server/FluentMockServer.cs

@@ -6,6 +6,7 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using System.Threading;
+using WireMock.Admin.Mappings;
 using WireMock.Exceptions;
 using WireMock.Handlers;
 using WireMock.Logging;
@@ -27,8 +28,6 @@ namespace WireMock.Server
     {
         private const int ServerStartDelayInMs = 100;
 
-        private readonly IWireMockLogger _logger;
-        private readonly IFileSystemHandler _fileSystemHandler;
         private readonly IFluentMockServerSettings _settings;
         private readonly IOwinSelfHost _httpServer;
         private readonly IWireMockMiddlewareOptions _options = new WireMockMiddlewareOptions();
@@ -57,6 +56,12 @@ namespace WireMock.Server
         [PublicAPI]
         public IEnumerable<IMapping> Mappings => _options.Mappings.Values.ToArray();
 
+        /// <summary>
+        /// Gets the mappings as MappingModels.
+        /// </summary>
+        [PublicAPI]
+        public IEnumerable<MappingModel> MappingModels => ToMappingModels();
+
         /// <summary>
         /// Gets the scenarios.
         /// </summary>
@@ -187,13 +192,13 @@ namespace WireMock.Server
         private FluentMockServer(IFluentMockServerSettings settings)
         {
             _settings = settings;
-            settings.Logger = settings.Logger ?? new WireMockNullLogger();
 
-            _logger = settings.Logger;
-            _fileSystemHandler = settings.FileSystemHandler ?? new LocalFileSystemHandler();
+            // Set default values if not provided
+            _settings.Logger = settings.Logger ?? new WireMockNullLogger();
+            _settings.FileSystemHandler = settings.FileSystemHandler ?? new LocalFileSystemHandler();
 
-            _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));
+            _settings.Logger.Info("WireMock.Net by Stef Heyenrath (https://github.com/WireMock-Net/WireMock.Net)");
+            _settings.Logger.Debug("WireMock.Net server settings {0}", JsonConvert.SerializeObject(settings, Formatting.Indented));
 
             if (settings.Urls != null)
             {
@@ -205,10 +210,10 @@ namespace WireMock.Server
                 Urls = new[] { $"{(settings.UseSSL == true ? "https" : "http")}://localhost:{port}" };
             }
 
-            _options.FileSystemHandler = _fileSystemHandler;
+            _options.FileSystemHandler = _settings.FileSystemHandler;
             _options.PreWireMockMiddlewareInit = settings.PreWireMockMiddlewareInit;
             _options.PostWireMockMiddlewareInit = settings.PostWireMockMiddlewareInit;
-            _options.Logger = _logger;
+            _options.Logger = _settings.Logger;
 
 #if USE_ASPNETCORE
             _httpServer = new AspNetCoreSelfHost(_options, Urls);
@@ -371,7 +376,7 @@ namespace WireMock.Server
         [PublicAPI]
         public void AllowPartialMapping(bool allow = true)
         {
-            _logger.Info("AllowPartialMapping is set to {0}", allow);
+            _settings.Logger.Info("AllowPartialMapping is set to {0}", allow);
             _options.AllowPartialMapping = allow;
         }
 

test/WireMock.Net.Tests/FluentMockServerTests.Admin.cs

@@ -47,12 +47,14 @@ namespace WireMock.Net.Tests
             server.ReadStaticMappings(folder);
 
             Check.That(server.Mappings).HasSize(5);
+            Check.That(server.MappingModels).HasSize(5);
 
             // Act
             server.ResetMappings();
 
             // Assert
             Check.That(server.Mappings).HasSize(0);
+            Check.That(server.MappingModels).HasSize(0);
         }
 
         [Fact]

test/WireMock.Net.Tests/FluentMockServerTests.cs

@@ -175,9 +175,11 @@ namespace WireMock.Net.Tests
         }
 
         [Theory]
-        [InlineData("GET")]
-        [InlineData("TRACE")]
         [InlineData("DELETE")]
+#if !NET452
+        [InlineData("TRACE")]
+        [InlineData("GET")]
+#endif
         public async Task FluentMockServer_Should_exclude_body_for_methods_where_body_is_definitely_disallowed(string method)
         {
             // Assign

test/WireMock.Net.Tests/ResponseBuilders/ResponseWithBodyFromFileTests.cs

@@ -0,0 +1,49 @@
+using FluentAssertions;
+using System.IO;
+using System.Net;
+using System.Net.Http;
+using System.Threading.Tasks;
+using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+using WireMock.Server;
+using Xunit;
+
+namespace WireMock.Net.Tests.ResponseBuilders
+{
+    public class ResponseWithBodyFromFileTests
+    {
+        [Fact]
+        public async Task Response_ProvideResponse_WithBodyFromFile()
+        {
+            // Arrange
+            var server = FluentMockServer.Start();
+
+            string path = Path.Combine(Directory.GetCurrentDirectory(), "__admin", "mappings", "MyXmlResponse.xml");
+
+            server
+                .Given(
+                    Request
+                        .Create()
+                        .UsingGet()
+                        .WithPath("/v1/content")
+                )
+                .RespondWith(
+                    Response
+                        .Create()
+                        .WithStatusCode(HttpStatusCode.OK)
+                        .WithHeader("Content-Type", "application/xml")
+                        .WithBodyFromFile(path)
+                );
+
+            // Act
+            var response1 = await new HttpClient().GetStringAsync("http://localhost:" + server.Ports[0] + "/v1/content");
+            var response2 = await new HttpClient().GetStringAsync("http://localhost:" + server.Ports[0] + "/v1/content");
+            var response3 = await new HttpClient().GetStringAsync("http://localhost:" + server.Ports[0] + "/v1/content");
+
+            // Assert
+            response1.Should().Contain("<hello>world</hello>");
+            response2.Should().Contain("<hello>world</hello>");
+            response3.Should().Contain("<hello>world</hello>");
+        }
+    }
+}