[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/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);
+        }
     }
 }