Transform body as file

examples/WireMock.Net.Console.NETCoreApp2/__admin/mappings/1.cs

@@ -1 +1 @@
-C# Hello
+// C# Hello

src/WireMock.Net/Admin/Mappings/ResponseModel.cs

@@ -62,6 +62,11 @@ public class ResponseModel
         /// </summary>
         public bool? UseTransformer { get; set; }
 
+        /// <summary>
+        /// Use the Handlerbars transformer for the content from the referenced BodyAsFile.
+        /// </summary>
+        public bool? UseTransformerForBodyAsFile { get; set; }
+
         /// <summary>
         /// Gets or sets the headers.
         /// </summary>

src/WireMock.Net/ResponseBuilders/ITransformResponseBuilder.cs

@@ -11,6 +11,6 @@ public interface ITransformResponseBuilder : IDelayResponseBuilder
         /// <returns>
         /// The <see cref="IResponseBuilder"/>.
         /// </returns>
-        IResponseBuilder WithTransformer();
+        IResponseBuilder WithTransformer(bool transformContentFromBodyAsFile = false);
     }
 }

src/WireMock.Net/ResponseBuilders/Response.cs

@@ -33,6 +33,11 @@ public partial class Response : IResponseBuilder
         /// </summary>
         public bool UseTransformer { get; private set; }
 
+        /// <summary>
+        /// Gets a value indicating whether to use the Handlerbars transformer for the content from the referenced BodyAsFile.
+        /// </summary>
+        public bool UseTransformerForBodyAsFile { get; private set; }
+
         /// <summary>
         /// The Proxy URL to use.
         /// </summary>
@@ -311,10 +316,11 @@ public IResponseBuilder WithBodyFromBase64(string bodyAsBase64, Encoding encodin
             return this;
         }
 
-        /// <inheritdoc cref="ITransformResponseBuilder.WithTransformer"/>
-        public IResponseBuilder WithTransformer()
+        /// <inheritdoc cref="ITransformResponseBuilder.WithTransformer(bool)"/>
+        public IResponseBuilder WithTransformer(bool transformContentFromBodyAsFile = false)
         {
             UseTransformer = true;
+            UseTransformerForBodyAsFile = transformContentFromBodyAsFile;
             return this;
         }
 
@@ -414,7 +420,7 @@ public async Task<ResponseMessage> ProvideResponseAsync(RequestMessage requestMe
             {
                 var factory = new HandlebarsContextFactory(settings.FileSystemHandler, settings.HandlebarsRegistrationCallback);
                 var responseMessageTransformer = new ResponseMessageTransformer(factory);
-                return responseMessageTransformer.Transform(requestMessage, ResponseMessage);
+                return responseMessageTransformer.Transform(requestMessage, ResponseMessage, UseTransformerForBodyAsFile);
             }
 
             if (!UseTransformer && ResponseMessage.BodyData?.BodyAsFileIsCached == true)

src/WireMock.Net/Serialization/MappingConverter.cs

@@ -112,6 +112,7 @@ public MappingModel ToMappingModel(IMapping mapping)
                 mappingModel.Response.BodyAsFile = null;
                 mappingModel.Response.BodyAsFileIsCached = null;
                 mappingModel.Response.UseTransformer = null;
+                mappingModel.Response.UseTransformerForBodyAsFile = null;
                 mappingModel.Response.BodyEncoding = null;
                 mappingModel.Response.ProxyUrl = response.ProxyUrl;
                 mappingModel.Response.Fault = null;
@@ -125,6 +126,10 @@ public MappingModel ToMappingModel(IMapping mapping)
                 {
                     mappingModel.Response.UseTransformer = response.UseTransformer;
                 }
+                if (response.UseTransformerForBodyAsFile)
+                {
+                    mappingModel.Response.UseTransformerForBodyAsFile = response.UseTransformerForBodyAsFile;
+                }
 
                 if (response.ResponseMessage.BodyData != null)
                 {

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

@@ -785,7 +785,7 @@ private IResponseBuilder InitResponseBuilder(ResponseModel responseModel)
 
             if (responseModel.UseTransformer == true)
             {
-                responseBuilder = responseBuilder.WithTransformer();
+                responseBuilder = responseBuilder.WithTransformer(responseModel.UseTransformerForBodyAsFile == true);
             }
 
             if (!string.IsNullOrEmpty(responseModel.ProxyUrl))

src/WireMock.Net/Transformers/HandlebarsContext.cs

@@ -0,0 +1,11 @@
+using HandlebarsDotNet;
+using WireMock.Handlers;
+
+namespace WireMock.Transformers
+{
+    internal class HandlebarsContext : IHandlebarsContext
+    {
+        public IHandlebars Handlebars { get; set; }
+        public IFileSystemHandler FileSystemHandler { get; set; }
+    }
+}

src/WireMock.Net/Transformers/HandlebarsContextFactory.cs

@@ -20,15 +20,19 @@ public HandlebarsContextFactory(IFileSystemHandler fileSystemHandler, Action<IHa
             _action = action;
         }
 
-        public IHandlebars Create()
+        public IHandlebarsContext Create()
         {
-            var handlebarsContext = Handlebars.Create(HandlebarsConfiguration);
+            var handlebars = Handlebars.Create(HandlebarsConfiguration);
 
-            HandlebarsHelpers.Register(handlebarsContext, _fileSystemHandler);
+            HandlebarsHelpers.Register(handlebars, _fileSystemHandler);
 
-            _action?.Invoke(handlebarsContext, _fileSystemHandler);
+            _action?.Invoke(handlebars, _fileSystemHandler);
 
-            return handlebarsContext;
+            return new HandlebarsContext
+            {
+                Handlebars = handlebars,
+                FileSystemHandler = _fileSystemHandler
+            };
         }
     }
-}
+}

src/WireMock.Net/Transformers/IHandlebarsContext.cs

@@ -0,0 +1,12 @@
+using HandlebarsDotNet;
+using WireMock.Handlers;
+
+namespace WireMock.Transformers
+{
+    interface IHandlebarsContext
+    {
+        IHandlebars Handlebars { get; set; }
+
+        IFileSystemHandler FileSystemHandler { get; set; }
+    }
+}

src/WireMock.Net/Transformers/IHandlebarsContextFactory.cs

@@ -4,6 +4,6 @@ namespace WireMock.Transformers
 {
     interface IHandlebarsContextFactory
     {
-        IHandlebars Create();
+        IHandlebarsContext Create();
     }
 }

src/WireMock.Net/Transformers/ResponseMessageTransformer.cs

@@ -1,5 +1,4 @@
-using HandlebarsDotNet;
-using JetBrains.Annotations;
+using JetBrains.Annotations;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using System;
@@ -21,7 +20,7 @@ public ResponseMessageTransformer([NotNull] IHandlebarsContextFactory factory)
             _factory = factory;
         }
 
-        public ResponseMessage Transform(RequestMessage requestMessage, ResponseMessage original)
+        public ResponseMessage Transform(RequestMessage requestMessage, ResponseMessage original, bool useTransformerForBodyAsFile)
         {
             var handlebarsContext = _factory.Create();
 
@@ -36,7 +35,7 @@ public ResponseMessage Transform(RequestMessage requestMessage, ResponseMessage
                     break;
 
                 case BodyType.File:
-                    TransformBodyAsFile(handlebarsContext, template, original, responseMessage);
+                    TransformBodyAsFile(handlebarsContext, template, original, responseMessage, useTransformerForBodyAsFile);
                     break;
 
                 case BodyType.String:
@@ -52,9 +51,9 @@ public ResponseMessage Transform(RequestMessage requestMessage, ResponseMessage
             var newHeaders = new Dictionary<string, WireMockList<string>>();
             foreach (var header in original.Headers)
             {
-                var templateHeaderKey = handlebarsContext.Compile(header.Key);
+                var templateHeaderKey = handlebarsContext.Handlebars.Compile(header.Key);
                 var templateHeaderValues = header.Value
-                    .Select(handlebarsContext.Compile)
+                    .Select(handlebarsContext.Handlebars.Compile)
                     .Select(func => func(template))
                     .ToArray();
 
@@ -66,7 +65,7 @@ public ResponseMessage Transform(RequestMessage requestMessage, ResponseMessage
             return responseMessage;
         }
 
-        private static void TransformBodyAsJson(IHandlebars handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage)
+        private static void TransformBodyAsJson(IHandlebarsContext handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage)
         {
             JToken jToken;
             switch (original.BodyData.BodyAsJson)
@@ -94,7 +93,7 @@ private static void TransformBodyAsJson(IHandlebars handlebarsContext, object te
             };
         }
 
-        private static void WalkNode(IHandlebars handlebarsContext, JToken node, object context)
+        private static void WalkNode(IHandlebarsContext handlebarsContext, JToken node, object context)
         {
             if (node.Type == JTokenType.Object)
             {
@@ -121,7 +120,7 @@ private static void WalkNode(IHandlebars handlebarsContext, JToken node, object
                     return;
                 }
 
-                var templateForStringValue = handlebarsContext.Compile(stringValue);
+                var templateForStringValue = handlebarsContext.Handlebars.Compile(stringValue);
                 string transformedString = templateForStringValue(context);
                 if (!string.Equals(stringValue, transformedString))
                 {
@@ -153,9 +152,9 @@ private static void ReplaceNodeValue(JToken node, string stringValue)
             node.Replace(value);
         }
 
-        private static void TransformBodyAsString(IHandlebars handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage)
+        private static void TransformBodyAsString(IHandlebarsContext handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage)
         {
-            var templateBodyAsString = handlebarsContext.Compile(original.BodyData.BodyAsString);
+            var templateBodyAsString = handlebarsContext.Handlebars.Compile(original.BodyData.BodyAsString);
 
             responseMessage.BodyData = new BodyData
             {
@@ -165,16 +164,33 @@ private static void TransformBodyAsString(IHandlebars handlebarsContext, object
             };
         }
 
-        private static void TransformBodyAsFile(IHandlebars handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage)
+        private void TransformBodyAsFile(IHandlebarsContext handlebarsContext, object template, ResponseMessage original, ResponseMessage responseMessage, bool useTransformerForBodyAsFile)
         {
-            var templateBodyAsFile = handlebarsContext.Compile(original.BodyData.BodyAsFile);
+            var templateBodyAsFile = handlebarsContext.Handlebars.Compile(original.BodyData.BodyAsFile);
+            string transformedBodyAsFilename = templateBodyAsFile(template);
 
-            responseMessage.BodyData = new BodyData
+            if (!useTransformerForBodyAsFile)
             {
-                DetectedBodyType = original.BodyData.DetectedBodyType,
-                DetectedBodyTypeFromContentType = original.BodyData.DetectedBodyTypeFromContentType,
-                BodyAsFile = templateBodyAsFile(template)
-            };
+                responseMessage.BodyData = new BodyData
+                {
+                    DetectedBodyType = original.BodyData.DetectedBodyType,
+                    DetectedBodyTypeFromContentType = original.BodyData.DetectedBodyTypeFromContentType,
+                    BodyAsFile = transformedBodyAsFilename
+                };
+            }
+            else
+            {
+                string text = handlebarsContext.FileSystemHandler.ReadResponseBodyAsString(transformedBodyAsFilename);
+                var templateBodyAsString = handlebarsContext.Handlebars.Compile(text);
+
+                responseMessage.BodyData = new BodyData
+                {
+                    DetectedBodyType = BodyType.String,
+                    DetectedBodyTypeFromContentType = original.BodyData.DetectedBodyTypeFromContentType,
+                    BodyAsString = templateBodyAsString(template),
+                    BodyAsFile = transformedBodyAsFilename
+                };
+            }
         }
     }
-}
+}

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

@@ -5,6 +5,7 @@
 using Moq;
 using Newtonsoft.Json;
 using NFluent;
+using WireMock.Handlers;
 using WireMock.Models;
 using WireMock.ResponseBuilders;
 using WireMock.Settings;
@@ -226,7 +227,7 @@ public async Task Response_ProvideResponse_Handlebars_WithBodyAsFile()
 
             var response = Response.Create()
                 .WithTransformer()
-                .WithBodyFromFile(@"c:\\{{request.query.MyUniqueNumber}}\test.xml"); // why use a \\ here ?
+                .WithBodyFromFile(@"c:\\{{request.query.MyUniqueNumber}}\\test.xml");
 
             // Act
             var responseMessage = await response.ProvideResponseAsync(request, _settingsMock.Object);
@@ -235,6 +236,30 @@ public async Task Response_ProvideResponse_Handlebars_WithBodyAsFile()
             Check.That(responseMessage.BodyData.BodyAsFile).Equals(@"c:\1\test.xml");
         }
 
+        [Fact]
+        public async Task Response_ProvideResponse_Handlebars_WithBodyAsFile_And_TransformContentFromBodyAsFile()
+        {
+            // Assign
+            var filesystemHandlerMock = new Mock<IFileSystemHandler>(MockBehavior.Strict);
+            filesystemHandlerMock.Setup(fs => fs.ReadResponseBodyAsString(It.IsAny<string>())).Returns("<xml MyUniqueNumber=\"{{request.query.MyUniqueNumber}}\"></xml>");
+
+            _settingsMock.SetupGet(s => s.FileSystemHandler).Returns(filesystemHandlerMock.Object);
+
+            var request = new RequestMessage(new UrlDetails("http://localhost/foo?MyUniqueNumber=1"), "GET", ClientIp);
+
+            var response = Response.Create()
+                .WithTransformer(true)
+                .WithBodyFromFile(@"c:\\{{request.query.MyUniqueNumber}}\\test.xml");
+
+            // Act
+            var responseMessage = await response.ProvideResponseAsync(request, _settingsMock.Object);
+
+            // Assert
+            Check.That(responseMessage.BodyData.BodyAsFile).Equals(@"c:\1\test.xml");
+            Check.That(responseMessage.BodyData.DetectedBodyType).Equals(BodyType.String);
+            Check.That(responseMessage.BodyData.BodyAsString).Equals("<xml MyUniqueNumber=\"1\"></xml>");
+        }
+
         [Fact]
         public async Task Response_ProvideResponse_Handlebars_WithBodyAsFile_JsonPath()
         {