[265] Add file upload to allow mocking of file operations (#266)

* [265] Add file upload to allow mocking of file operations

* [265] Fix failing test

* Update code + add tests

* LocalFileSystemHandlerTests

* 1.0.13

* Fixed the file post to create the mapping folder if none exists to begin with, otherwise the file upload fails with 404 (can't find the folder to upload to).

* fix tests

* add more tests for LocalFileSystemHandler

* Added the head method for files to check if a file exists without returning it as a body.

* Add a test and fix the response message (head requires no body).

* Fix newline

* Fix newline.

* Fix the number of mapping tests

* Update tests and update client-interface-api

* Cleanup "MappingConverter.cs"

src/WireMock.Net/Client/IFluentMockServerAdmin.cs

@@ -167,5 +167,42 @@ namespace WireMock.Client
         /// </summary>
         [Post("__admin/scenarios")]
         Task<StatusModel> ResetScenariosAsync();
+
+        /// <summary>
+        /// Create a new File
+        /// </summary>
+        /// <param name="filename">The filename</param>
+        /// <param name="body">The body</param>
+        [Post("__admin/files/{filename}")]
+        Task<StatusModel> PostFileAsync([Path] string filename, [Body] string body);
+
+        /// <summary>
+        /// Update an existing File
+        /// </summary>
+        /// <param name="filename">The filename</param>
+        /// <param name="body">The body</param>
+        [Put("__admin/files/{filename}")]
+        Task<StatusModel> PutFileAsync([Path] string filename, [Body] string body);
+
+        /// <summary>
+        /// Get the content of an existing File
+        /// </summary>
+        /// <param name="filename">The filename</param>
+        [Get("__admin/files/{filename}")]
+        Task<string> GetFileAsync([Path] string filename);
+
+        /// <summary>
+        /// Delete an existing File
+        /// </summary>
+        /// <param name="filename">The filename</param>
+        [Delete("__admin/files/{filename}")]
+        Task<StatusModel> DeleteFileAsync([Path] string filename);
+
+        /// <summary>
+        /// Check if a file exists
+        /// </summary>
+        /// <param name="filename">The filename</param>
+        [Head("__admin/files/{filename}")]
+        Task FileExistsAsync([Path] string filename);
     }
 }

src/WireMock.Net/Handlers/IFileSystemHandler.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using JetBrains.Annotations;
+using System.Collections.Generic;
 
 namespace WireMock.Handlers
 {
@@ -18,40 +19,67 @@ namespace WireMock.Handlers
         /// </summary>
         /// <param name="path">The path.</param>
         /// <returns>true if path refers to an existing directory; false if the directory does not exist or an error occurs when trying to determine if the specified directory exists.</returns>
-        bool FolderExists(string path);
+        bool FolderExists([NotNull] string path);
 
         /// <summary>
         ///  Creates all directories and subdirectories in the specified path unless they already exist.
         /// </summary>
         /// <param name="path">The path.</param>
-        void CreateFolder(string path);
+        void CreateFolder([NotNull] string path);
 
         /// <summary>
         ///  Returns an enumerable collection of file names in a specified path.
         /// </summary>
         /// <param name="path">The path.</param>
         /// <returns>An enumerable collection of the full names (including paths) for the files in the directory specified by path.</returns>
-        IEnumerable<string> EnumerateFiles(string path);
+        IEnumerable<string> EnumerateFiles([NotNull] string path);
 
         /// <summary>
         /// Read a static mapping file as text.
         /// </summary>
         /// <param name="path">The path (folder + filename with .json extension).</param>
         /// <returns>The file content as text.</returns>
-        string ReadMappingFile(string path);
+        string ReadMappingFile([NotNull] string path);
 
         /// <summary>
-        /// Write the static mapping.
+        /// Write the static mapping file.
         /// </summary>
         /// <param name="path">The path (folder + filename with .json extension).</param>
         /// <param name="text">The text.</param>
-        void WriteMappingFile(string path, string text);
+        void WriteMappingFile([NotNull] string path, [NotNull] string text);
 
         /// <summary>
         /// Read a response body file as text.
         /// </summary>
         /// <param name="path">The path or filename from the file to read.</param>
         /// <returns>The file content as bytes.</returns>
-        byte[] ReadResponseBodyAsFile(string path);
+        byte[] ReadResponseBodyAsFile([NotNull] string path);
+
+        /// <summary>
+        /// Delete a file.
+        /// </summary>
+        /// <param name="filename">The filename.</param>
+        void DeleteFile([NotNull] string filename);
+
+        /// <summary>
+        /// Determines whether the given path refers to an existing file on disk.
+        /// </summary>
+        /// <param name="filename">The filename.</param>
+        /// <returns>true if path refers to an existing file; false if the file does not exist.</returns>
+        bool FileExists([NotNull] string filename);
+
+        /// <summary>
+        /// Write a file.
+        /// </summary>
+        /// <param name="filename">The filename.</param>
+        /// <param name="bytes">The bytes.</param>
+        void WriteFile([NotNull] string filename, [NotNull] byte[] bytes);
+
+        /// <summary>
+        /// Read a file as bytes.
+        /// </summary>
+        /// <param name="filename">The filename.</param>
+        /// <returns>The file content as bytes.</returns>
+        byte[] ReadFile([NotNull] string filename);
     }
 }

src/WireMock.Net/Handlers/LocalFileSystemHandler.cs

@@ -1,5 +1,4 @@
-using JetBrains.Annotations;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.IO;
 using WireMock.Validation;
 
@@ -13,7 +12,7 @@ namespace WireMock.Handlers
         private static readonly string AdminMappingsFolder = Path.Combine("__admin", "mappings");
 
         /// <inheritdoc cref="IFileSystemHandler.FolderExists"/>
-        public bool FolderExists([NotNull] string path)
+        public bool FolderExists(string path)
         {
             Check.NotNullOrEmpty(path, nameof(path));
 
@@ -21,7 +20,7 @@ namespace WireMock.Handlers
         }
 
         /// <inheritdoc cref="IFileSystemHandler.CreateFolder"/>
-        public void CreateFolder([NotNull] string path)
+        public void CreateFolder(string path)
         {
             Check.NotNullOrEmpty(path, nameof(path));
 
@@ -29,7 +28,7 @@ namespace WireMock.Handlers
         }
 
         /// <inheritdoc cref="IFileSystemHandler.EnumerateFiles"/>
-        public IEnumerable<string> EnumerateFiles([NotNull] string path)
+        public IEnumerable<string> EnumerateFiles(string path)
         {
             Check.NotNullOrEmpty(path, nameof(path));
 
@@ -43,15 +42,15 @@ namespace WireMock.Handlers
         }
 
         /// <inheritdoc cref="IFileSystemHandler.ReadMappingFile"/>
-        public string ReadMappingFile([NotNull] string path)
+        public string ReadMappingFile(string path)
         {
             Check.NotNullOrEmpty(path, nameof(path));
 
             return File.ReadAllText(path);
         }
 
-        /// <inheritdoc cref="IFileSystemHandler.WriteMappingFile"/>
-        public void WriteMappingFile([NotNull] string path, [NotNull] string text)
+        /// <inheritdoc cref="IFileSystemHandler.WriteMappingFile(string, string)"/>
+        public void WriteMappingFile(string path, string text)
         {
             Check.NotNullOrEmpty(path, nameof(path));
             Check.NotNull(text, nameof(text));
@@ -68,5 +67,48 @@ namespace WireMock.Handlers
             // Else the path will just be as-is.
             return File.ReadAllBytes(Path.GetFileName(path) == path ? Path.Combine(GetMappingFolder(), path) : path);
         }
+
+        /// <inheritdoc cref="IFileSystemHandler.FileExists"/>
+        public bool FileExists(string filename)
+        {
+            Check.NotNullOrEmpty(filename, nameof(filename));
+
+            return File.Exists(AdjustPath(filename));
+        }
+
+        /// <inheritdoc cref="IFileSystemHandler.WriteFile(string, byte[])"/>
+        public void WriteFile(string filename, byte[] bytes)
+        {
+            Check.NotNullOrEmpty(filename, nameof(filename));
+            Check.NotNull(bytes, nameof(bytes));
+
+            File.WriteAllBytes(AdjustPath(filename), bytes);
+        }
+
+        /// <inheritdoc cref="IFileSystemHandler.DeleteFile"/>
+        public void DeleteFile(string filename)
+        {
+            Check.NotNullOrEmpty(filename, nameof(filename));
+
+            File.Delete(AdjustPath(filename));
+        }
+
+        /// <inheritdoc cref="IFileSystemHandler.ReadFile"/>
+        public byte[] ReadFile(string filename)
+        {
+            Check.NotNullOrEmpty(filename, nameof(filename));
+
+            return File.ReadAllBytes(AdjustPath(filename));
+        }
+
+        /// <summary>
+        /// Adjusts the path to the MappingFolder.
+        /// </summary>
+        /// <param name="filename">The path.</param>
+        /// <returns>Adjusted path</returns>
+        private string AdjustPath(string filename)
+        {
+            return Path.Combine(GetMappingFolder(), filename);
+        }
     }
 }

src/WireMock.Net/ResponseMessageBuilder.cs

@@ -33,5 +33,13 @@ namespace WireMock
 
             return response;
         }
+
+        internal static ResponseMessage Create(int statusCode)
+        {
+            return new ResponseMessage
+            {
+                StatusCode = statusCode
+            };
+        }
     }
 }

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -77,7 +77,7 @@ namespace WireMock.Serialization
                 },
                 Response = new ResponseModel
                 {
-                    Delay = (int?) response.Delay?.TotalMilliseconds
+                    Delay = (int?)response.Delay?.TotalMilliseconds
                 }
             };
 

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

@@ -34,13 +34,14 @@ namespace WireMock.Server
         private const int AdminPriority = int.MinValue;
         private const int ProxyPriority = 1000;
         private const string ContentTypeJson = "application/json";
+        private const string AdminFiles = "/__admin/files";
         private const string AdminMappings = "/__admin/mappings";
         private const string AdminRequests = "/__admin/requests";
         private const string AdminSettings = "/__admin/settings";
         private const string AdminScenarios = "/__admin/scenarios";
 
-        private readonly RegexMatcher _adminMappingsGuidPathMatcher = new RegexMatcher(MatchBehaviour.AcceptOnMatch, @"^\/__admin\/mappings\/(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$");
-        private readonly RegexMatcher _adminRequestsGuidPathMatcher = new RegexMatcher(MatchBehaviour.AcceptOnMatch, @"^\/__admin\/requests\/(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$");
+        private readonly RegexMatcher _adminMappingsGuidPathMatcher = new RegexMatcher(MatchBehaviour.AcceptOnMatch, @"^\/__admin\/mappings\/([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$");
+        private readonly RegexMatcher _adminRequestsGuidPathMatcher = new RegexMatcher(MatchBehaviour.AcceptOnMatch, @"^\/__admin\/requests\/([0-9A-Fa-f]{8}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{4}[-][0-9A-Fa-f]{12})$");
 
         private readonly JsonSerializerSettings _settings = new JsonSerializerSettings
         {
@@ -97,10 +98,17 @@ namespace WireMock.Server
 
             // __admin/scenarios/reset
             Given(Request.Create().WithPath(AdminScenarios + "/reset").UsingPost()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(ScenariosReset));
+
+            // __admin/files/{filename}
+            Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingPost()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(FilePost));
+            Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingPut()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(FilePut));
+            Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingGet()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(FileGet));
+            Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingHead()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(FileHead));
+            Given(Request.Create().WithPath(_adminFilesFilenamePathMatcher).UsingDelete()).AtPriority(AdminPriority).RespondWith(new DynamicResponseProvider(FileDelete));
         }
         #endregion
 
-        #region StaticMappings        
+        #region StaticMappings
         /// <summary>
         /// Saves the static mappings.
         /// </summary>

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

@@ -0,0 +1,114 @@
+using System.IO;
+using System.Linq;
+using System.Text;
+using WireMock.Matchers;
+using WireMock.Util;
+
+namespace WireMock.Server
+{
+    public partial class FluentMockServer
+    {
+        private readonly RegexMatcher _adminFilesFilenamePathMatcher = new RegexMatcher(MatchBehaviour.AcceptOnMatch, @"^\/__admin\/files\/.*$");
+        private static readonly Encoding[] FileBodyIsString = { Encoding.UTF8, Encoding.ASCII };
+
+        #region Files/{filename}
+        private ResponseMessage FilePost(RequestMessage requestMessage)
+        {
+            string filename = GetFileNameFromRequestMessage(requestMessage);
+
+            string mappingFolder = _fileSystemHandler.GetMappingFolder();
+            if (!_fileSystemHandler.FolderExists(mappingFolder))
+            {
+                _fileSystemHandler.CreateFolder(mappingFolder);
+            }
+
+            _fileSystemHandler.WriteFile(filename, requestMessage.BodyAsBytes);
+
+            return ResponseMessageBuilder.Create("File created");
+        }
+
+        private ResponseMessage FilePut(RequestMessage requestMessage)
+        {
+            string filename = GetFileNameFromRequestMessage(requestMessage);
+
+            if (!_fileSystemHandler.FileExists(filename))
+            {
+                _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);
+
+            return ResponseMessageBuilder.Create("File updated");
+        }
+
+        private ResponseMessage FileGet(RequestMessage requestMessage)
+        {
+            string filename = GetFileNameFromRequestMessage(requestMessage);
+
+            if (!_fileSystemHandler.FileExists(filename))
+            {
+                _logger.Info("The file '{0}' does not exist.", filename);
+                return ResponseMessageBuilder.Create("File is not found", 404);
+            }
+
+            byte[] bytes = _fileSystemHandler.ReadFile(filename);
+            var response = new ResponseMessage
+            {
+                StatusCode = 200,
+                BodyData = new BodyData
+                {
+                    BodyAsBytes = bytes,
+                    DetectedBodyType = BodyType.Bytes,
+                    DetectedBodyTypeFromContentType = BodyType.None
+                }
+            };
+
+            if (BytesEncodingUtils.TryGetEncoding(bytes, out Encoding encoding) && FileBodyIsString.Select(x => x.Equals(encoding)).Any())
+            {
+                response.BodyData.DetectedBodyType = BodyType.String;
+                response.BodyData.BodyAsString = encoding.GetString(bytes);
+            }
+
+            return response;
+        }
+
+        /// <summary>
+        /// Checks if file exists.
+        /// Note: Response is returned with no body as a head request doesn't accept a body, only the status code.
+        /// </summary>
+        /// <param name="requestMessage">The request message.</param>
+        private ResponseMessage FileHead(RequestMessage requestMessage)
+        {
+            string filename = GetFileNameFromRequestMessage(requestMessage);
+
+            if (!_fileSystemHandler.FileExists(filename))
+            {
+                _logger.Info("The file '{0}' does not exist.", filename);
+                return ResponseMessageBuilder.Create(404);
+            }
+
+            return ResponseMessageBuilder.Create(204);
+        }
+
+        private ResponseMessage FileDelete(RequestMessage requestMessage)
+        {
+            string filename = GetFileNameFromRequestMessage(requestMessage);
+
+            if (!_fileSystemHandler.FileExists(filename))
+            {
+                _logger.Info("The file '{0}' does not exist.", filename);
+                return ResponseMessageBuilder.Create("File is not deleted", 404);
+            }
+
+            _fileSystemHandler.DeleteFile(filename);
+            return ResponseMessageBuilder.Create("File deleted.");
+        }
+
+        private string GetFileNameFromRequestMessage(RequestMessage requestMessage)
+        {
+            return Path.GetFileName(requestMessage.Path.Substring(AdminFiles.Length + 1));
+        }
+        #endregion
+    }
+}