Add support for HandleBars File (to read a file) (#278)

* HandleBarsFileFragment

* 1.0.17

* {{File}}

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

@@ -0,0 +1,102 @@
+using Moq;
+using Newtonsoft.Json.Linq;
+using NFluent;
+using System;
+using System.Threading.Tasks;
+using WireMock.Handlers;
+using WireMock.Models;
+using WireMock.ResponseBuilders;
+using WireMock.Transformers;
+using Xunit;
+
+namespace WireMock.Net.Tests.ResponseBuilders
+{
+    public class ResponseWithHandlebarsFileTests
+    {
+        private readonly Mock<IFileSystemHandler> _filesystemHandlerMock;
+        private const string ClientIp = "::1";
+
+        public ResponseWithHandlebarsFileTests()
+        {
+            _filesystemHandlerMock = new Mock<IFileSystemHandler>(MockBehavior.Strict);
+            _filesystemHandlerMock.Setup(fs => fs.ReadResponseBodyAsString(It.IsAny<string>())).Returns("abc");
+        }
+
+        [Fact]
+        public async Task Response_ProvideResponseAsync_Handlebars_File()
+        {
+            // Assign
+            var request = new RequestMessage(new UrlDetails("http://localhost:1234"), "GET", ClientIp);
+
+            var response = Response.Create()
+                .WithBodyAsJson(new
+                {
+                    Data = "{{File \"x.json\"}}"
+                })
+                .WithTransformer();
+
+            response.SetPrivateFieldValue("_fileSystemHandler", _filesystemHandlerMock.Object);
+            response.SetPrivateFieldValue("_responseMessageTransformer", new ResponseMessageTransformer(_filesystemHandlerMock.Object));
+
+            // Act
+            var responseMessage = await response.ProvideResponseAsync(request);
+
+            // Assert
+            JObject j = JObject.FromObject(responseMessage.BodyData.BodyAsJson);
+            Check.That(j["Data"].Value<string>()).Equals("abc");
+
+            // Verify
+            _filesystemHandlerMock.Verify(fs => fs.ReadResponseBodyAsString("x.json"), Times.Once);
+            _filesystemHandlerMock.VerifyNoOtherCalls();
+        }
+
+        [Fact]
+        public async Task Response_ProvideResponseAsync_Handlebars_File_Replace()
+        {
+            // Assign
+            var request = new RequestMessage(new UrlDetails("http://localhost:1234?id=x"), "GET", ClientIp);
+
+            var response = Response.Create()
+                .WithBodyAsJson(new
+                {
+                    Data = "{{File \"{{request.query.id}}.json\"}}"
+                })
+                .WithTransformer();
+
+            response.SetPrivateFieldValue("_fileSystemHandler", _filesystemHandlerMock.Object);
+            response.SetPrivateFieldValue("_responseMessageTransformer", new ResponseMessageTransformer(_filesystemHandlerMock.Object));
+
+            // Act
+            var responseMessage = await response.ProvideResponseAsync(request);
+
+            // Assert
+            JObject j = JObject.FromObject(responseMessage.BodyData.BodyAsJson);
+            Check.That(j["Data"].Value<string>()).Equals("abc");
+
+            // Verify
+            _filesystemHandlerMock.Verify(fs => fs.ReadResponseBodyAsString("x.json"), Times.Once);
+            _filesystemHandlerMock.VerifyNoOtherCalls();
+        }
+
+        [Fact]
+        public void Response_ProvideResponseAsync_Handlebars_File_WithMissingArgument_ThrowsArgumentOutOfRangeException()
+        {
+            // Assign
+            var request = new RequestMessage(new UrlDetails("http://localhost:1234"), "GET", ClientIp);
+
+            var response = Response.Create()
+                .WithBodyAsJson(new
+                {
+                    Data = "{{File}}"
+                })
+                .WithTransformer();
+
+            // Act
+            Check.ThatAsyncCode(() => response.ProvideResponseAsync(request)).Throws<ArgumentOutOfRangeException>();
+
+            // Verify
+            _filesystemHandlerMock.Verify(fs => fs.ReadResponseBodyAsString(It.IsAny<string>()), Times.Never);
+            _filesystemHandlerMock.VerifyNoOtherCalls();
+        }
+    }
+}

test/WireMock.Net.Tests/TestUtils.cs

@@ -1,4 +1,5 @@
-using System.Reflection;
+using System;
+using System.Reflection;
 
 namespace WireMock.Net.Tests
 {
@@ -10,5 +11,53 @@ namespace WireMock.Net.Tests
 
             return (T)field.GetValue(obj);
         }
+
+        /// <summary>
+        /// Set a _private_ Field Value on a given Object
+        /// </summary>
+        /// <typeparam name="T">Type of the Property</typeparam>
+        /// <param name="obj">Object from where the Property Value is returned</param>
+        /// <param name="propertyName">Property name as string.</param>
+        /// <param name="value">the value to set</param>
+        public static void SetPrivateFieldValue<T>(this object obj, string propertyName, T value)
+        {
+            if (obj == null)
+            {
+                throw new ArgumentNullException(nameof(obj));
+            }
+
+            Type t = obj.GetType();
+            FieldInfo fi = null;
+            while (fi == null && t != null)
+            {
+                fi = t.GetField(propertyName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
+                t = t.BaseType;
+            }
+
+            if (fi == null)
+            {
+                throw new ArgumentOutOfRangeException(nameof(propertyName), $"Field {propertyName} was not found in Type {obj.GetType().FullName}");
+            }
+
+            fi.SetValue(obj, value);
+        }
+
+        /// <summary>
+        /// Sets a _private_ Property Value from a given Object.
+        /// </summary>
+        /// <typeparam name="T">Type of the Property</typeparam>
+        /// <param name="obj">Object from where the Property Value is set</param>
+        /// <param name="propertyName">Property name as string.</param>
+        /// <param name="value">Value to set.</param>
+        public static void SetPrivatePropertyValue<T>(this object obj, string propertyName, T value)
+        {
+            Type t = obj.GetType();
+            if (t.GetProperty(propertyName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) == null)
+            {
+                throw new ArgumentOutOfRangeException(nameof(propertyName), $"Property {propertyName} was not found in Type {obj.GetType().FullName}");
+            }
+
+            t.InvokeMember(propertyName, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.SetProperty | BindingFlags.Instance, null, obj, new object[] { value });
+        }
     }
 }

test/WireMock.Net.Tests/WireMock.Net.Tests.csproj

@@ -36,6 +36,8 @@
     </PackageReference>
     <PackageReference Include="System.Threading" Version="4.3.0" />
 
+    <PackageReference Include="RestEase" Version="1.4.7" />
+    <PackageReference Include="RandomDataGenerator.Net" Version="1.0.8" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
     <PackageReference Include="MimeKitLite" Version="2.0.7" />
     <PackageReference Include="Moq" Version="4.10.1" />
@@ -50,6 +52,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
+    <!--<PackageReference Include="StrongNamer" Version="0.0.8" />-->
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net452'">