Upload files with multipart content type

Author: mihaj

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>0.2.5</Version>
+    <Version>0.2.6</Version>
   </PropertyGroup>
 </Project>

README.md

@@ -69,6 +69,31 @@ using (var client = new HttpTesterClient())
 }
 ```
 
+**POST File Upload request**
+You can upload files with `multipart/form-data` content type like shown below. 
+There are 2 overloads of `WithMultipart`, one for uploading binary data and the other for string data.
+
+```csharp
+using (var client = new HttpTesterClient())
+{
+    var response = await client
+        .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+        .WithQueryParams(new Dictionary<string, string>() { { "api-version", "1" } })
+        .WithMethod(HttpMethod.Post)
+        .WithMultipart(image, "FileContent", "logo.png")
+        .WithMultipart("MetaData", "My metadata.")
+        .WithPath("/api/bicycles/1/images")
+        .Start();
+
+    var msg = await response.GetResponseBodyString();
+
+    Assert.Equal("File name: miha.txt, length: 119305", msg);
+    Assert.True(response.IsSuccessStatusCode);
+}
+```
+
+There is double content-type safety built-in and you can not do `WithMultipart` and `WithJsonBody` in the same request.
+
 #### HttpTesterClient Authentication
 
 Currently `HttpTesterClient` supports:

src/QAToolKit.Engine.HttpTester.Test/HttpTesterClientTests.cs

@@ -431,7 +431,7 @@ public async Task HttpTesterClientPostObjectBodyWithFulUrlWithNTLMAuthorization_
                    .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net/api/bicycles?api-version=1"))
                    .WithJsonBody(BicycleFixture.GetCfr())
                    .WithMethod(HttpMethod.Post)
-                   .WithNTLMAuthentication("user","pass")
+                   .WithNTLMAuthentication("user", "pass")
                    .Start();
 
                 var msg = await response.GetResponseBody<dynamic>();
@@ -441,5 +441,117 @@ public async Task HttpTesterClientPostObjectBodyWithFulUrlWithNTLMAuthorization_
                 Assert.Equal("Giant", msg.brand.ToString());
             }
         }
+
+        [Fact]
+        public async Task HttpTesterClientFileUpload_Success()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                byte[] image = new WebClient().DownloadData("https://qatoolkit.io/assets/logo.png");
+
+                var response = await client
+                 .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+                 .WithQueryParams(new Dictionary<string, string>() { { "api-version", "2" } })
+                 .WithMethod(HttpMethod.Post)
+                 .WithPath("/api/bicycles/1/images")
+                 .WithMultipart(image, "FileContent", "logo.png")
+                 .WithMultipart("FileName", "miha.txt")
+                 .Start();
+
+                var msg = await response.GetResponseBodyString();
+
+                Assert.Equal("File name: miha.txt, length: 119305", msg);
+                Assert.True(response.IsSuccessStatusCode);
+            }
+        }
+
+        [Fact]
+        public async Task HttpTesterClientFileUpload2_Success()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                byte[] image = new WebClient().DownloadData("https://qatoolkit.io/assets/logo.png");
+
+                var response = await client
+                 .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+                 .WithQueryParams(new Dictionary<string, string>() { { "api-version", "2" } })
+                 .WithMethod(HttpMethod.Post)
+                 .WithPath("/api/bicycles/1/images")
+                 .WithMultipart(image, "FileContent", "logo.png")
+                 .WithMultipart("FileName", "miha.txt")
+                 .Start();
+
+                var msg = await response.GetResponseBodyString();
+
+                Assert.Equal("File name: miha.txt, length: 119305", msg);
+                Assert.True(response.IsSuccessStatusCode);
+            }
+        }
+
+        [Fact]
+        public async Task HttpTesterClientBrochureUpload_Success()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                byte[] image = new WebClient().DownloadData("https://qatoolkit.io/assets/logo.png");
+
+                var response = await client
+                 .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+                 .WithQueryParams(new Dictionary<string, string>() { { "api-version", "2" } })
+                 .WithMethod(HttpMethod.Post)
+                 .WithPath("/api/bicycles/1/brochures")
+                 .WithMultipart(image, "Image.FileContent", "logo.png")
+                 .WithMultipart("Image.FileName", "miha.txt")
+                 .WithMultipart("Metadata.Year", "2000")
+                 .WithMultipart("Metadata.Name", "Brochure 2000")
+                 .Start();
+
+                var msg = await response.GetResponseBodyString();
+
+                Assert.Equal("File name: Brochure 2000, image name: miha.txt, length: 119305", msg);
+                Assert.True(response.IsSuccessStatusCode);
+            }
+        }
+
+        [Fact]
+        public void HttpTesterClientBrochureUploadBodyPresent_Fails()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                byte[] image = new WebClient().DownloadData("https://qatoolkit.io/assets/logo.png");
+
+                var response = client
+                 .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+                 .WithQueryParams(new Dictionary<string, string>() { { "api-version", "2" } })
+                 .WithMethod(HttpMethod.Post)
+                 .WithPath("/api/bicycles/1/brochures")
+                 .WithJsonBody<string>("1234");
+
+                var exception = Assert.Throws<QAToolKitEngineHttpTesterException>(() => client.WithMultipart(image, "Image.FileContent", "logo.png"));
+                Assert.StartsWith("Body application/json already defined on", exception.Message);
+            }
+        }
+
+        [Fact]
+        public void HttpTesterClientBrochureUploadMultipartPresent_Fails()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                byte[] image = new WebClient().DownloadData("https://qatoolkit.io/assets/logo.png");
+
+                var response = client
+                 .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+                 .WithQueryParams(new Dictionary<string, string>() { { "api-version", "2" } })
+                 .WithMethod(HttpMethod.Post)
+                 .WithPath("/api/bicycles/1/brochures")
+                 .WithMultipart(image, "Image.FileContent", "logo.png")
+                 .WithMultipart("Image.FileName", "miha.txt")
+                 .WithMultipart("Metadata.Year", "2000")
+                 .WithMultipart("Metadata.Name", "Brochure 2000");
+
+               var exception = Assert.Throws<QAToolKitEngineHttpTesterException>(() => client.WithJsonBody<string>("1234"));
+                Assert.StartsWith("Body multipart/form-data already defined", exception.Message);
+            }
+        }
     }
 }

src/QAToolKit.Engine.HttpTester/Extensions/HttpResponseMessageExtensions.cs

@@ -20,5 +20,25 @@ public static async Task<T> GetResponseBody<T>(this HttpResponseMessage httpResp
             var bodyResponse = await httpResponseMessage.Content.ReadAsStringAsync();
             return JsonConvert.DeserializeObject<T>(bodyResponse);
         }
+
+        /// <summary>
+        /// Get response as string
+        /// </summary>
+        /// <param name="httpResponseMessage"></param>
+        /// <returns></returns>
+        public static async Task<string> GetResponseBodyString(this HttpResponseMessage httpResponseMessage)
+        {
+            return await httpResponseMessage.Content.ReadAsStringAsync();
+        }
+
+        /// <summary>
+        /// Get response as byte array
+        /// </summary>
+        /// <param name="httpResponseMessage"></param>
+        /// <returns></returns>
+        public static async Task<byte[]> GetResponseBodyBytes(this HttpResponseMessage httpResponseMessage)
+        {
+            return await httpResponseMessage.Content.ReadAsByteArrayAsync();
+        }
     }
 }

src/QAToolKit.Engine.HttpTester/HttpTesterClient.cs

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -28,6 +29,7 @@ public class HttpTesterClient : IHttpTesterClient, IDisposable
         private HttpMethod _httpMethod;
         private Dictionary<string, string> _queryParameters = null;
         private HttpResponseMessage _responseMessage = null;
+        private MultipartFormDataContent _multipartFormDataContent = null;
 
         /// <summary>
         /// Measured HTTP request duration
@@ -95,6 +97,9 @@ public IHttpTesterClient WithHeaders(Dictionary<string, string> headers)
         /// <returns></returns>
         public IHttpTesterClient WithJsonBody<T>(T bodyObject)
         {
+            if (_multipartFormDataContent != null)
+                throw new QAToolKitEngineHttpTesterException("Body multipart/form-data already defined on the HTTP client. Can not add application/json content type.");
+
             if (bodyObject == null)
             {
                 return this;
@@ -197,6 +202,57 @@ public IHttpTesterClient WithNTLMAuthentication()
             return this;
         }
 
+        /// <summary>
+        /// Create a multipart form data content and add a file content
+        /// </summary>
+        /// <param name="fileByteArray"></param>
+        /// <param name="httpContentName"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        public IHttpTesterClient WithMultipart(byte[] fileByteArray, string httpContentName, string fileName)
+        {
+            if (!string.IsNullOrEmpty(_body))
+                throw new QAToolKitEngineHttpTesterException("Body application/json already defined on the HTTP client. Can not add multipart/form-data content type.");
+            if (fileByteArray == null)
+                throw new ArgumentNullException($"{nameof(fileByteArray)} is null.");
+            if (string.IsNullOrEmpty(httpContentName))
+                throw new ArgumentNullException($"{nameof(httpContentName)} is null.");
+
+            if (_multipartFormDataContent == null)
+            {
+                _multipartFormDataContent = new MultipartFormDataContent();
+            }
+
+            _multipartFormDataContent.Add(new ByteArrayContent(fileByteArray), httpContentName, fileName);
+
+            return this;
+        }
+
+        /// <summary>
+        /// Add a string to a multipart form data
+        /// </summary>
+        /// <param name="httpContentName"></param>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        public IHttpTesterClient WithMultipart(string httpContentName, string value)
+        {
+            if (!string.IsNullOrEmpty(_body))
+                throw new QAToolKitEngineHttpTesterException("Body application/json already defined on the HTTP client. Can not add multipart/form-data content type.");
+            if (string.IsNullOrEmpty(httpContentName))
+                throw new ArgumentNullException($"{nameof(httpContentName)} is null.");
+            if (value == null)
+                throw new ArgumentNullException($"{nameof(value)} is null.");
+
+            if (_multipartFormDataContent == null)
+            {
+                _multipartFormDataContent = new MultipartFormDataContent();
+            }
+
+            _multipartFormDataContent.Add(new StringContent(value), httpContentName);
+
+            return this;
+        }
+
         /// <summary>
         /// Start the HTTP request
         /// </summary>
@@ -246,6 +302,11 @@ public async Task<HttpResponseMessage> Start()
                     requestMessage.Content = new StringContent(_body, Encoding.UTF8, "application/json");
                 }
 
+                if (_multipartFormDataContent != null)
+                {
+                    requestMessage.Content = _multipartFormDataContent;
+                }
+
                 _responseMessage = await HttpClient.SendAsync(requestMessage);
             }
             sw.Stop();

src/QAToolKit.Engine.HttpTester/Interfaces/IHttpTesterClient.cs

@@ -74,6 +74,21 @@ public interface IHttpTesterClient
         /// <returns></returns>
         IHttpTesterClient WithNTLMAuthentication();
         /// <summary>
+        /// Upload a file
+        /// </summary>
+        /// <param name="fileByteArray"></param>
+        /// <param name="httpContentName"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        IHttpTesterClient WithMultipart(byte[] fileByteArray, string httpContentName, string fileName);
+        /// <summary>
+        /// Upload a file
+        /// </summary>
+        /// <param name="httpContentName"></param>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        IHttpTesterClient WithMultipart(string httpContentName, string value);
+        /// <summary>
         /// Start the HTTP request
         /// </summary>
         /// <returns></returns>