Feat multipart file upload support

src/PactNet.Abstractions/IRequestBuilder.cs

@@ -204,7 +204,14 @@ public interface IRequestBuilderV3
         /// <param name="body">Request body</param>
         /// <param name="contentType">Content type</param>
         /// <returns>Fluent builder</returns>
-        IRequestBuilderV3 WithBody(string body, string contentType);
+        IRequestBuilderV3 WithBody(string body, string contentType);
+
+        /// <summary>
+        /// A Multipart body containing a single part, which is an uploaded file
+        /// </summary>
+        /// <param name="filePath">The absolute path of the file being uploaded</param>
+        /// <returns>Fluent builder</returns>
+        IRequestBuilderV3 WithMultipartSingleFileUpload(string filePath);
 
         // TODO: Support binary and multi-part body
 

src/PactNet/Drivers/HttpInteractionDriver.cs

@@ -96,6 +96,15 @@ public void WithRequestBody(string contentType, string body)
         /// <param name="contentType">Context type</param>
         /// <param name="body">Serialised body</param>
         public void WithResponseBody(string contentType, string body)
-            => NativeInterop.WithBody(this.interaction, InteractionPart.Response, contentType, body).CheckInteropSuccess();
+            => NativeInterop.WithBody(this.interaction, InteractionPart.Response, contentType, body).CheckInteropSuccess();
+
+        /// <summary>
+        /// Set the request body to multipart/form-data for file upload
+        /// </summary>
+        /// <param name="contentType">Content type override</param>
+        /// <param name="filePath">path to file being uploaded</param>
+        /// <param name="mimePartName">the name of the mime part being uploaded</param>
+        public void WithMultipartSingleFileUpload(string contentType, string filePath, string mimePartName)
+            => NativeInterop.WithMultipartSingleFileUpload(this.interaction, InteractionPart.Request, contentType, filePath, mimePartName).CheckInteropSuccess();
     }
 }

src/PactNet/Drivers/IHttpInteractionDriver.cs

@@ -54,6 +54,14 @@ internal interface IHttpInteractionDriver : IProviderStateDriver
         /// </summary>
         /// <param name="contentType">Context type</param>
         /// <param name="body">Serialised body</param>
-        void WithResponseBody(string contentType, string body);
+        void WithResponseBody(string contentType, string body);
+
+        /// <summary>
+        /// Set the response body for a single file to be uploaded as a multipart/form-data content type
+        /// </summary>
+        /// <param name="filePath">path to file being uploaded</param>
+        /// <param name="contentType">Content type override</param>
+        /// <param name="mimePartName">the name of the mime part being uploaded</param>
+        void WithMultipartSingleFileUpload(string filePath, string contentType, string mimePartName);
     }
 }

src/PactNet/Drivers/InteropActionExtensions.cs

@@ -1,5 +1,7 @@
-using PactNet.Exceptions;
-
+using System.Runtime.InteropServices;
+using PactNet.Exceptions;
+using PactNet.Interop;
+
 namespace PactNet.Drivers
 {
     /// <summary>
@@ -19,5 +21,14 @@ public static void CheckInteropSuccess(this bool success)
                 throw new PactFailureException("Unable to perform the given action. The interop call indicated failure");
             }
         }
+
+        public static void CheckInteropSuccess(this StringResult success)
+        {
+            if (success.tag != StringResult.Tag.StringResult_Ok)
+            {
+                string errorMsg = Marshal.PtrToStringAnsi(success.failed._0);
+                throw new PactFailureException($"Unable to perform the given action. The interop call returned failure: {errorMsg}");
+            }
+        }
     }
 }

src/PactNet/Interop/NativeInterop.cs

@@ -61,7 +61,10 @@ internal static class NativeInterop
         public static extern bool ResponseStatus(InteractionHandle interaction, ushort status);
 
         [DllImport(DllName, EntryPoint = "pactffi_with_body")]
-        public static extern bool WithBody(InteractionHandle interaction, InteractionPart part, string contentType, string body);
+        public static extern bool WithBody(InteractionHandle interaction, InteractionPart part, string contentType, string body);
+
+        [DllImport(DllName, EntryPoint = "pactffi_with_multipart_file")]
+        public static extern StringResult WithMultipartSingleFileUpload(InteractionHandle interaction, InteractionPart part, string contentType, string filePath,  string mimePartName );
 
         [DllImport(DllName, EntryPoint = "pactffi_free_string")]
         public static extern void FreeString(IntPtr s);

src/PactNet/Interop/StringResult.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Runtime.InteropServices;
+namespace PactNet.Interop
+{
+
+    [StructLayout(LayoutKind.Explicit)]
+    internal struct StringResult
+    {
+        public enum Tag
+        {
+            StringResult_Ok,
+            StringResult_Failed,
+        };
+
+        [FieldOffset(0)]
+        public Tag tag;
+
+        [FieldOffset(8)]
+        public StringResult_Ok_Body ok;
+
+        [FieldOffset(8)]
+        public StringResult_Failed_Body failed;
+    }
+
+    [StructLayout(LayoutKind.Sequential)]
+    internal struct StringResult_Ok_Body
+    {
+        public IntPtr _0;
+    }
+
+    [StructLayout(LayoutKind.Sequential)]
+    internal struct StringResult_Failed_Body
+    {
+        public IntPtr _0;
+    }
+}

src/PactNet/RequestBuilder.cs

@@ -241,8 +241,16 @@ IRequestBuilderV3 IRequestBuilderV3.WithJsonBody(dynamic body, JsonSerializerSet
         /// <param name="contentType">Content type override</param>
         /// <returns>Fluent builder</returns>
         IRequestBuilderV3 IRequestBuilderV3.WithJsonBody(dynamic body, JsonSerializerSettings settings, string contentType)
-            => this.WithJsonBody(body, settings, contentType);
-
+            => this.WithJsonBody(body, settings, contentType);
+
+        /// <summary>
+        /// Set a body which is multipart/form-data but contains only one part, which is a file upload
+        /// </summary>
+        /// <param name="filePath">Path to the file being uploaded</param>
+        /// <returns>Fluent builder</returns>
+        IRequestBuilderV3 IRequestBuilderV3.WithMultipartSingleFileUpload(string filePath)
+            => this.WithMultipartSingleFileUpload(filePath, "multipart/form-data", "file");
+
         /// <summary>
         /// A pre-formatted body which should be used as-is for the request 
         /// </summary>
@@ -390,8 +398,20 @@ internal RequestBuilder WithJsonBody(dynamic body, JsonSerializerSettings settin
         {
             string serialised = JsonConvert.SerializeObject(body, settings);
             return this.WithBody(serialised, contentType);
+        }
+
+        /// <summary>
+        /// Set a body which is multipart/form-data but contains only one part, which is a file upload
+        /// </summary>
+        /// <param name="filePath">path to file being uploaded</param>
+        /// <param name="contentType">Content type override</param>
+        /// <param name="mimePartName">The name of the mime part being uploaded</param>
+        /// <returns>Fluent builder</returns>
+        internal RequestBuilder WithMultipartSingleFileUpload(string filePath, string contentType, string mimePartName)
+        {
+            this.driver.WithMultipartSingleFileUpload(filePath, contentType, mimePartName);
+            return this;
         }
-
         /// <summary>
         /// A pre-formatted body which should be used as-is for the request 
         /// </summary>

tests/PactNet.Tests/Drivers/FfiIntegrationTests.cs

@@ -2,9 +2,12 @@
 using System.IO;
 using System.Net;
 using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Runtime.InteropServices;
 using System.Text;
 using System.Threading.Tasks;
 using FluentAssertions;
+using Newtonsoft.Json.Linq;
 using PactNet.Drivers;
 using PactNet.Interop;
 using Xunit;
@@ -24,28 +27,29 @@ public FfiIntegrationTests(ITestOutputHelper output)
             this.output = output;
 
             NativeInterop.LogToBuffer(LevelFilter.Trace);
-        }
-
+        }
+
         [Fact]
-        public async Task HttpInteraction_v3_CreatesPactFile()
+        public async Task HttpInteraction_v3_CreatesPactFile_WithMultiPartRequest()
         {
             var driver = new PactDriver();
 
             try
             {
                 IHttpPactDriver pact = driver.NewHttpPact("NativeDriverTests-Consumer-V3",
-                                                          "NativeDriverTests-Provider",
-                                                          PactSpecification.V3);
-
-                IHttpInteractionDriver interaction = pact.NewHttpInteraction("a sample interaction");
+                                                          "NativeDriverTests-Provider-Multipart",
+                                                          PactSpecification.V3);
+
+                IHttpInteractionDriver interaction = pact.NewHttpInteraction("a sample interaction");
+
+                string contentType = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "application/octet-stream" : "image/jpeg";
 
                 interaction.Given("provider state");
-                interaction.GivenWithParam("state with param", "foo", "bar");
-                interaction.WithRequest("POST", "/path");
-                interaction.WithRequestHeader("X-Request-Header", "request1", 0);
-                interaction.WithRequestHeader("X-Request-Header", "request2", 1);
-                interaction.WithQueryParameter("param", "value", 0);
-                interaction.WithRequestBody("application/json", @"{""foo"":42}");
+                interaction.WithRequest("POST", "/path");
+                var path = Path.GetFullPath("data/test_file.jpeg");
+                Assert.True(File.Exists(path));
+
+                interaction.WithMultipartSingleFileUpload(contentType, path, "file");
 
                 interaction.WithResponseStatus((ushort)HttpStatusCode.Created);
                 interaction.WithResponseHeader("X-Response-Header", "value1", 0);
@@ -54,19 +58,114 @@ public async Task HttpInteraction_v3_CreatesPactFile()
 
                 using IMockServerDriver mockServer = pact.CreateMockServer("127.0.0.1", null, false);
 
-                var client = new HttpClient { BaseAddress = mockServer.Uri };
-                client.DefaultRequestHeaders.Add("X-Request-Header", new[] { "request1", "request2" });
-
-                HttpResponseMessage result = await client.PostAsync("/path?param=value", new StringContent(@"{""foo"":42}", Encoding.UTF8, "application/json"));
-                result.StatusCode.Should().Be(HttpStatusCode.Created);
-                result.Headers.GetValues("X-Response-Header").Should().BeEquivalentTo("value1", "value2");
+                var client = new HttpClient { BaseAddress = mockServer.Uri };
+
+                using var fileStream = new FileStream("data/test_file.jpeg", FileMode.Open, FileAccess.Read);
+
+                var upload = new MultipartFormDataContent();
+                upload.Headers.ContentType.MediaType = "multipart/form-data";
+
+                var fileContent = new StreamContent(fileStream);
+                fileContent.Headers.ContentType = MediaTypeHeaderValue.Parse("image/jpeg");
+
+                var fileName = Path.GetFileName(path);
+                var fileNameBytes = Encoding.UTF8.GetBytes(fileName);
+                var encodedFileName = Convert.ToBase64String(fileNameBytes);
+                upload.Add(fileContent, "file", fileName);
+                upload.Headers.ContentDisposition = new ContentDispositionHeaderValue("form-data")
+                {
+                    Name = "file",
+                    FileName = fileName,
+                    FileNameStar = $"utf-8''{encodedFileName}"
+                };
+
+                HttpResponseMessage result = await client.PostAsync("/path", upload);
+                result.StatusCode.Should().Be(HttpStatusCode.Created);
+
+                string logs = mockServer.MockServerLogs();
 
                 string content = await result.Content.ReadAsStringAsync();
                 content.Should().Be(@"{""foo"":42}");
 
                 mockServer.MockServerMismatches().Should().Be("[]");
 
-                string logs = mockServer.MockServerLogs();
+                logs.Should().NotBeEmpty();
+
+                this.output.WriteLine("Mock Server Logs");
+                this.output.WriteLine("----------------");
+                this.output.WriteLine(logs);
+
+                pact.WritePactFile(Environment.CurrentDirectory);
+            }
+            finally
+            {
+                this.WriteDriverLogs(driver);
+            }
+            // The body and boundry will be different, so test the header and matching rules are multipart/form-data
+            var file = new FileInfo("NativeDriverTests-Consumer-V3-NativeDriverTests-Provider-Multipart.json");
+            file.Exists.Should().BeTrue();
+
+            string pactContents = File.ReadAllText(file.FullName).TrimEnd();
+            JObject pactObject = JObject.Parse(pactContents);
+
+            string expectedPactContent = File.ReadAllText("data/v3-server-integration-MultipartFormDataBody.json").TrimEnd();
+            JObject expectedPactObject = JObject.Parse(pactContents);
+
+
+            string contentTypeHeader = (string)pactObject["interactions"][0]["request"]["headers"]["Content-Type"];
+            Assert.Contains("multipart/form-data;", contentTypeHeader);
+
+
+            JArray integrationsArray = (JArray)pactObject["interactions"];
+            JToken matchingRules = integrationsArray.First["request"]["matchingRules"];
+
+            JArray expecteIntegrationsArray = (JArray)expectedPactObject["interactions"];
+            JToken expectedMatchingRules = expecteIntegrationsArray.First["request"]["matchingRules"];
+
+            Assert.True(JToken.DeepEquals(matchingRules, expectedMatchingRules));              
+        }
+
+        [Fact]
+        public async Task HttpInteraction_v3_CreatesPactFile()
+        {
+            var driver = new PactDriver();
+
+            try
+            {
+                IHttpPactDriver pact = driver.NewHttpPact("NativeDriverTests-Consumer-V3",
+                                                          "NativeDriverTests-Provider",
+                                                          PactSpecification.V3);
+
+                IHttpInteractionDriver interaction = pact.NewHttpInteraction("a sample interaction");
+
+                interaction.Given("provider state");
+                interaction.GivenWithParam("state with param", "foo", "bar");
+                interaction.WithRequest("POST", "/path");
+                interaction.WithRequestHeader("X-Request-Header", "request1", 0);
+                interaction.WithRequestHeader("X-Request-Header", "request2", 1);
+                interaction.WithQueryParameter("param", "value", 0);
+                interaction.WithRequestBody("application/json", @"{""foo"":42}");
+
+                interaction.WithResponseStatus((ushort)HttpStatusCode.Created);
+                interaction.WithResponseHeader("X-Response-Header", "value1", 0);
+                interaction.WithResponseHeader("X-Response-Header", "value2", 1);
+                interaction.WithResponseBody("application/json", @"{""foo"":42}");
+
+                using IMockServerDriver mockServer = pact.CreateMockServer("127.0.0.1", null, false);
+
+                var client = new HttpClient { BaseAddress = mockServer.Uri };
+                client.DefaultRequestHeaders.Add("X-Request-Header", new[] { "request1", "request2" });
+
+                HttpResponseMessage result = await client.PostAsync("/path?param=value", new StringContent(@"{""foo"":42}", Encoding.UTF8, "application/json"));
+                result.StatusCode.Should().Be(HttpStatusCode.Created);
+                result.Headers.GetValues("X-Response-Header").Should().BeEquivalentTo("value1", "value2");
+
+                string content = await result.Content.ReadAsStringAsync();
+                content.Should().Be(@"{""foo"":42}");
+
+                mockServer.MockServerMismatches().Should().Be("[]");
+
+                string logs = mockServer.MockServerLogs();
                 logs.Should().NotBeEmpty();
 
                 this.output.WriteLine("Mock Server Logs");

tests/PactNet.Tests/PactNet.Tests.csproj

@@ -42,4 +42,13 @@
     <ProjectReference Include="..\..\src\PactNet\PactNet.csproj" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Update="data\test_file.jpeg">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+    <None Update="data\v3-server-integration-MultipartFormDataBody.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
 </Project>

tests/PactNet.Tests/RequestBuilderTests.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Net.Http;
 using FluentAssertions;
 using Moq;
@@ -194,6 +195,16 @@ public void WillRespond_RequestNotConfigured_ThrowsInvalidOperationException()
             Action action = () => this.builder.WillRespond();
 
             action.Should().Throw<InvalidOperationException>("because the request has not been configured");
+        }
+
+        [Fact]
+        public void WithMultipartSingleFileUpload_AddsRequestBody()
+        {
+            var path = Path.GetFullPath("data/test_file.jpeg");
+
+            this.builder.WithMultipartSingleFileUpload(path,"multipart/form-data", "file");
+
+            this.mockDriver.Verify(s => s.WithMultipartSingleFileUpload(path, "multipart/form-data", "file"));
         }
     }
 }

tests/PactNet.Tests/data/v3-server-integration-MultipartFormDataBody.json

@@ -0,0 +1,69 @@
+{
+  "consumer": {
+    "name": "NativeDriverTests-Consumer-V3"
+  },
+  "interactions": [
+    {
+      "description": "a sample interaction",
+      "providerStates": [
+        {
+          "name": "provider state"
+        }
+      ],
+      "request": {
+        "body": "LS1MQ1NqcTNxdWtmYmc2WjJTDQpDb250ZW50LURpc3Bvc2l0aW9uOiBmb3JtLWRhdGE7IG5hbWU9ImZpbGUiOyBmaWxlbmFtZT0idGVzdF9maWxlLmpwZWciDQpDb250ZW50LVR5cGU6IGltYWdlL2pwZWcNCg0K/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAAAAAAAAAAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/2wBDAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQH/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAABv/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAVAQEBAAAAAAAAAAAAAAAAAAAJCv/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AC6lAjD/2Q0KLS1MQ1NqcTNxdWtmYmc2WjJTLS0NCg==",
+        "headers": {
+          "Content-Type": "multipart/form-data; boundary=LCSjq3qukfbg6Z2S"
+        },
+        "matchingRules": {
+          "body": {
+            "$.file": {
+              "combine": "AND",
+              "matchers": [
+                {
+                  "match": "contentType",
+                  "value": "application/octet-stream"
+                }
+              ]
+            }
+          },
+          "header": {
+            "Content-Type": {
+              "combine": "AND",
+              "matchers": [
+                {
+                  "match": "regex",
+                  "regex": "multipart/form-data;(\\s*charset=[^;]*;)?\\s*boundary=.*"
+                }
+              ]
+            }
+          }
+        },
+        "method": "POST",
+        "path": "/path"
+      },
+      "response": {
+        "body": {
+          "foo": 42
+        },
+        "headers": {
+          "Content-Type": "application/json",
+          "X-Response-Header": "value1, value2"
+        },
+        "status": 201
+      }
+    }
+  ],
+  "metadata": {
+    "pactRust": {
+      "ffi": "0.4.0",
+      "models": "1.0.4"
+    },
+    "pactSpecification": {
+      "version": "3.0.0"
+    }
+  },
+  "provider": {
+    "name": "NativeDriverTests-Provider-Multipart"
+  }
+}