CreateHttpRequest override that accepts HttpRequest object

Author: mihaj

Directory.Build.props

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

README.md

@@ -3,12 +3,17 @@
 [![CodeQL](https://github.com/qatoolkit/qatoolkit-engine-httptester-net/workflows/CodeQL%20Analyze/badge.svg)](https://github.com/qatoolkit/qatoolkit-engine-httptester-net/security/code-scanning)
 [![Sonarcloud Quality gate](https://github.com/qatoolkit/qatoolkit-engine-httptester-net/workflows/Sonarqube%20Analyze/badge.svg)](https://sonarcloud.io/dashboard?id=qatoolkit_qatoolkit-engine-httptester-net)
 [![NuGet package](https://img.shields.io/nuget/v/QAToolKit.Engine.HttpTester?label=QAToolKit.Engine.HttpTester)](https://www.nuget.org/packages/QAToolKit.Engine.HttpTester/)
+[![Discord](https://img.shields.io/discord/787220825127780354?color=%23267CB9&label=Discord%20chat)](https://discord.com/invite/tu3WDV5Z?utm_source=Discord%20Widget&utm_medium=Connect)
 
 ## Description
 `QAToolKit.Engine.HttpTester` is a .NET Standard 2.1 library, that that contains an implementation of `IHttpTesterClient` that is a thin wrapper around .NET `HttpClient` to allow to write easy Http Request calls.
 
 Supported .NET frameworks and standards: `netstandard2.0`, `netstandard2.1`, `netcoreapp3.1`, `net5.0`
 
+Get in touch with me on:
+
+[![Discord](https://img.shields.io/discord/787220825127780354?color=%23267CB9&label=Discord%20chat)](https://discord.com/invite/tu3WDV5Z?utm_source=Discord%20Widget&utm_medium=Connect)
+
 ### HttpTesterClient
 
 A sample on how to easily call the HTTP request with .NET `HttpClient`:
@@ -70,6 +75,7 @@ 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.
 
@@ -92,7 +98,44 @@ using (var client = new HttpTesterClient())
 }
 ```
 
-There is double content-type safety built-in and you can not do `WithMultipart` and `WithJsonBody` in the same request.
+There is content-type safety built-in and you can not do `WithMultipart` and `WithJsonBody` in the same request.
+
+**Create Tester client from QAToolKit Swagger request**
+
+If you are using QAToolKit Swagger library to generate `HttpRequest` object you can use a `CreateHttpRequest` override.
+
+In this sample below, `CreateHttpRequest` accepts a first request from the list of requests generated by Swagger library.
+
+```csharp
+//GET Requests from Swagger file
+var urlSource = new SwaggerUrlSource();
+
+var requests = await urlSource.Load(new Uri[] {
+    new Uri("https://qatoolkitapi.azurewebsites.net/swagger/v1/swagger.json")
+});
+
+using (var client = new HttpTesterClient())
+{
+    var response = await client
+        .CreateHttpRequest(requests.FirstOrDefault())
+        .Start();
+    ....
+}
+```
+
+The `CreateHttpRequest` override will assign only `BaseUrl`, `Path`, `HttpMethod`, `Query parameters` and `Header parameters`. You need to assign `HttpBody` manually with `WithJsonBody`.
+For example:
+
+```csharp
+using (var client = new HttpTesterClient())
+{
+    var response = await client
+        .CreateHttpRequest(requests.FirstOrDefault())
+        .WithJsonBody(object)
+        .Start();
+    ....
+}
+```
 
 #### HttpTesterClient Authentication
 
@@ -124,7 +167,7 @@ Currently `HttpTesterClient` supports:
     var response = await client
         .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
         ....
-        .WithNTKMAuthentication("user", "pass") // or default security context .WithNTKMAuthentication()
+        .WithNTLMAuthentication("user", "pass") // or default security context .WithNTLMAuthentication()
         .Start();
 ```
 

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

@@ -333,11 +333,10 @@ public async Task HttpTesterClientPostStringBodyWithFulUrl_Success()
                    .WithMethod(HttpMethod.Post)
                    .Start();
 
-                var msg = await response.Content.ReadAsStringAsync();
+                var msg = await response.GetResponseBodyString();
 
                 Assert.True(client.Duration < 2000);
                 Assert.True(response.IsSuccessStatusCode);
-                //Assert.Equal("Giant", msg.brand.ToString());
             }
         }
 
@@ -460,7 +459,7 @@ public async Task HttpTesterClientFileUpload_Success()
 
                 var msg = await response.GetResponseBodyString();
 
-                Assert.Equal("File name: miha.txt, length: 119305", msg);
+                Assert.Equal("\"File name: miha.txt, length: 119305\"", msg);
                 Assert.True(response.IsSuccessStatusCode);
             }
         }
@@ -483,7 +482,7 @@ public async Task HttpTesterClientFileUpload2_Success()
 
                 var msg = await response.GetResponseBodyString();
 
-                Assert.Equal("File name: miha.txt, length: 119305", msg);
+                Assert.Equal("\"File name: miha.txt, length: 119305\"", msg);
                 Assert.True(response.IsSuccessStatusCode);
             }
         }
@@ -508,7 +507,7 @@ public async Task HttpTesterClientBrochureUpload_Success()
 
                 var msg = await response.GetResponseBodyString();
 
-                Assert.Equal("File name: Brochure 2000, image name: miha.txt, length: 119305", msg);
+                Assert.Equal("\"File name: Brochure 2000, image name: miha.txt, length: 119305\"", msg);
                 Assert.True(response.IsSuccessStatusCode);
             }
         }
@@ -553,5 +552,70 @@ public void HttpTesterClientBrochureUploadMultipartPresent_Fails()
                 Assert.StartsWith("Body multipart/form-data already defined", exception.Message);
             }
         }
+
+        [Fact]
+        public async Task HttpTesterClientAddPostHttpRequest_Success()
+        {
+            var urlSource = new SwaggerUrlSource(options =>
+            {
+                options.AddBaseUrl(new Uri("https://qatoolkitapi.azurewebsites.net/"));
+                options.AddRequestFilters(new RequestFilter()
+                {
+                    EndpointNameWhitelist = new string[] { "NewBike" }
+                });
+                options.UseSwaggerExampleValues = true;
+            });
+
+            var requests = await urlSource.Load(new Uri[] {
+                new Uri("https://qatoolkitapi.azurewebsites.net/swagger/v1/swagger.json")
+            });
+
+            using (var client = new HttpTesterClient())
+            {
+                var response = await client
+                     .CreateHttpRequest(requests.FirstOrDefault())
+                     .WithJsonBody(BicycleFixture.Get())
+                     .Start();
+
+                var msg = await response.GetResponseBody<Bicycle>();
+
+                Assert.True(client.Duration < 2000);
+                Assert.True(response.IsSuccessStatusCode);
+                Assert.Equal("Giant", msg.Brand);
+            }
+        }
+
+        [Fact]
+        public async Task HttpTesterClientAddGetHttpRequest_Success()
+        {
+            var urlSource = new SwaggerUrlSource(options =>
+            {
+                options.AddBaseUrl(new Uri("https://qatoolkitapi.azurewebsites.net/"));
+                options.AddRequestFilters(new RequestFilter()
+                {
+                    EndpointNameWhitelist = new string[] { "GetAllBikes" }
+                });
+                options.UseSwaggerExampleValues = true;
+            });
+
+            var requests = await urlSource.Load(new Uri[] {
+                new Uri("https://qatoolkitapi.azurewebsites.net/swagger/v1/swagger.json")
+            });
+
+            using (var client = new HttpTesterClient())
+            {
+                var response = await client
+                 .CreateHttpRequest(requests.FirstOrDefault())
+                 .Start();
+
+                var msg = await response.GetResponseBody<List<Bicycle>>();
+
+                var expecterResponse = BicycleFixture.GetBicycles().ToExpectedObject();
+                expecterResponse.ShouldEqual(msg);
+
+                Assert.True(client.Duration < 2000);
+                Assert.True(response.IsSuccessStatusCode);
+            }
+        }
     }
 }

src/QAToolKit.Engine.HttpTester/HttpTesterClient.cs

@@ -1,10 +1,12 @@
 using Newtonsoft.Json;
+using QAToolKit.Core.Models;
 using QAToolKit.Engine.HttpTester.Exceptions;
 using QAToolKit.Engine.HttpTester.Interfaces;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Net.Http.Headers;
@@ -253,6 +255,75 @@ public IHttpTesterClient WithMultipart(string httpContentName, string value)
             return this;
         }
 
+        /// <summary>
+        /// Create a HTTP tester client from QAToolKit HttpRequest object
+        /// </summary>
+        /// <param name="httpRequest">Create tester client with BaseUrl, Path, HttpMethod, Headers and URL Query paramteres read from HttpRequest object. Specify other values and parameters manually.</param>
+        /// <param name="validateCertificate"></param>
+        /// <returns></returns>
+        public IHttpTesterClient CreateHttpRequest(HttpRequest httpRequest, bool validateCertificate = true)
+        {
+            if (httpRequest == null)
+            {
+                throw new QAToolKitEngineHttpTesterException("'HttpRequest' is null. Pass in the valid object.");
+            }
+
+            if (HttpClient != null)
+            {
+                throw new QAToolKitEngineHttpTesterException("HttpClient is already instantiated. Create new 'HttpTesterClient'.");
+            }
+
+            var baseAddress = new Uri(httpRequest.BasePath);
+
+            HttpHandler = new HttpClientHandler();
+
+            if (!validateCertificate &&
+                (baseAddress.Scheme == Uri.UriSchemeHttp || baseAddress.Scheme == Uri.UriSchemeHttps))
+            {
+                HttpHandler.ClientCertificateOptions = ClientCertificateOption.Manual;
+                HttpHandler.ServerCertificateCustomValidationCallback =
+                (httpRequestMessage, cert, cetChain, policyErrors) =>
+                {
+                    return true;
+                };
+            }
+
+            HttpClient = new HttpClient(HttpHandler)
+            {
+                BaseAddress = baseAddress
+            };
+
+
+            if (string.IsNullOrEmpty(httpRequest.Path))
+            {
+                throw new QAToolKitEngineHttpTesterException("HttpRequest Path is required.");
+            }
+
+            _path = httpRequest.Path;
+
+            _httpMethod = httpRequest.Method;
+
+            //Query parameters
+            if (_queryParameters == null)
+                _queryParameters = new Dictionary<string, string>();
+
+            foreach (var parameter in httpRequest.Parameters.Where(t => t.Location == Location.Query && t.Value != null))
+            {
+                _queryParameters.Add(parameter.Name, parameter.Value);
+            }
+
+            //Headers
+            if (_headers == null)
+                _headers = new Dictionary<string, string>();
+
+            foreach (var header in httpRequest.Parameters.Where(t => t.Location == Location.Header && t.Value != null))
+            {
+                _headers.Add(header.Name, header.Value);
+            }
+
+            return this;
+        }
+
         /// <summary>
         /// Start the HTTP request
         /// </summary>

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

@@ -1,4 +1,5 @@
-using System;
+using QAToolKit.Core.Models;
+using System;
 using System.Collections.Generic;
 using System.Net.Http;
 using System.Threading.Tasks;
@@ -18,6 +19,13 @@ public interface IHttpTesterClient
         /// <returns></returns>
         IHttpTesterClient CreateHttpRequest(Uri baseAddress, bool validateCertificate = true);
         /// <summary>
+        /// Create a HTTP request client from QAToolKit HttpRequest object
+        /// </summary>
+        /// <param name="httpRequest"></param>
+        /// <param name="validateCertificate"></param>
+        /// <returns></returns>
+        IHttpTesterClient CreateHttpRequest(HttpRequest httpRequest, bool validateCertificate = true);
+        /// <summary>
         /// Add URL path to the HTTP client
         /// </summary>
         /// <param name="urlPath"></param>