Http duration added, XML deserializer for HTTP response content

Author: mihaj

.gitignore

@@ -361,3 +361,4 @@ MigrationBackup/
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
 /src/QAToolKit.Engine.HttpTester.Test/global.json
+/.idea/

Directory.Build.props

@@ -1,5 +1,5 @@
 <Project>
   <PropertyGroup>
-    <Version>0.2.11</Version>
+    <Version>0.3.0</Version>
   </PropertyGroup>
 </Project>

README.md

@@ -18,7 +18,7 @@ Get in touch with me on:
 
 A sample on how to easily call the HTTP request with .NET `HttpClient`:
 
-**GET request**
+##### GET request
 ```csharp
 using (var client = new HttpTesterClient())
 {
@@ -35,12 +35,13 @@ using (var client = new HttpTesterClient())
     var expecterResponse = BicycleFixture.GetBicycles().ToExpectedObject();
     expecterResponse.ShouldEqual(msg);
 
-    Assert.True(client.Duration < 2000);
+    Assert.True(client.Duration < 2000); //Start() method execution duration
+    Assert.True(client.HttpDuration < 2000); //HTTP request duration
     Assert.True(response.IsSuccessStatusCode);
 }
 ```
 
-**POST request**
+##### POST request
 ```csharp
 
 //Payload object
@@ -74,7 +75,7 @@ using (var client = new HttpTesterClient())
 }
 ```
 
-**POST File Upload request**
+##### 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.
@@ -100,7 +101,31 @@ using (var client = new HttpTesterClient())
 
 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**
+##### Deserialize HttpResponse message body
+
+`QAToolKit.Engine.HttpTester` supports 4 `HttpResponse` helper methods to give you maximum flexibility when reading reponse body.
+
+- `GetResponseBodyString`: return response content as a string.
+- `GetResponseJsonBody`: deserialize response content from JSON to object
+- `GetResponseXmlBody`: deserialize response content from XML to object.
+- `GetResponseBodyBytes`: return response content as byte array.
+- [Obsolete] `GetResponseBody`: this is obsolete, it deserializes response content from JSON to object. It's replaced by `GetResponseJsonBody`.
+
+##### HttpClient execution time is measured
+
+The library extends `HttpClient` object with `Duration` and `HttpDuration` properties. The first returns the measured duration of `Start();` method and the latter return the duration of HTTP request execution.
+
+```csharp
+    var response = await client
+        .CreateHttpRequest(new Uri("https://qatoolkitapi.azurewebsites.net"))
+        .WithQueryParams(new Dictionary<string, string>() { { "api-version", "1" } })
+        .Start();
+        
+    client.Duration; //Start() method execution duration
+    client.HttpDuration; //HTTP request duration
+```
+
+##### Create Tester client from QAToolKit Swagger request
 
 If you are using QAToolKit Swagger library to generate `HttpRequest` object you can use a `CreateHttpRequest` override.
 
@@ -141,7 +166,7 @@ using (var client = new HttpTesterClient())
 
 Currently `HttpTesterClient` supports:
 
-**Basic authentication**
+##### Basic authentication
 
 ```csharp
     var response = await client
@@ -151,7 +176,7 @@ Currently `HttpTesterClient` supports:
         .Start();
 ```
 
-**Bearer token authentication**
+##### Bearer token authentication
 
 ```csharp
     var response = await client
@@ -161,7 +186,7 @@ Currently `HttpTesterClient` supports:
         .Start();
 ```
 
-**NTLM authentication**
+##### NTLM authentication
 
 ```csharp
     var response = await client

src/QAToolKit.Engine.HttpTester.Test/Fixtures/XMLFixture.cs

@@ -0,0 +1,47 @@
+namespace QAToolKit.Engine.HttpTester.Test.Fixtures
+{
+// NOTE: Generated code may require at least .NET Framework 4.5 or .NET Core/Standard 2.0.
+    /// <remarks/>
+    [System.SerializableAttribute()]
+    [System.ComponentModel.DesignerCategoryAttribute("code")]
+    [System.Xml.Serialization.XmlTypeAttribute(AnonymousType = true)]
+    [System.Xml.Serialization.XmlRootAttribute(Namespace = "", IsNullable = false)]
+    public partial class note
+    {
+        private string toField;
+
+        private string fromField;
+
+        private string headingField;
+
+        private string bodyField;
+
+        /// <remarks/>
+        public string to
+        {
+            get { return this.toField; }
+            set { this.toField = value; }
+        }
+
+        /// <remarks/>
+        public string from
+        {
+            get { return this.fromField; }
+            set { this.fromField = value; }
+        }
+
+        /// <remarks/>
+        public string heading
+        {
+            get { return this.headingField; }
+            set { this.headingField = value; }
+        }
+
+        /// <remarks/>
+        public string body
+        {
+            get { return this.bodyField; }
+            set { this.bodyField = value; }
+        }
+    }
+}

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

@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Net;
 using System.Net.Http;
+using System.Runtime.InteropServices;
 using System.Threading.Tasks;
 using Xunit;
 
@@ -114,9 +115,11 @@ public async Task HttpTestAsserterHeaderMissing_Fails()
                 var asserter = new HttpTestAsserter(response);
 
                 var duration = client.Duration;
+                var httpDuration = client.HttpDuration;
                 Assert.Throws<ArgumentNullException>(() => asserter
                     .ResponseContentContains("scott")
                     .RequestDurationEquals(duration, (x) => x < 2000)
+                    .RequestDurationEquals(httpDuration, (x) => x < 1800)
                     .ResponseStatusCodeEquals(HttpStatusCode.OK)
                     .ResponseHasHttpHeader(null)
                     .AssertAll());
@@ -196,7 +199,7 @@ public async Task HttpTestAsserterDeleteIsBodyEmpty_Success()
                 var duration = client.Duration;
                 var assertResults = asserter
                     .ResponseBodyIsEmpty()
-                    .RequestDurationEquals(duration, (x) => (x > 100 && x < 1000))
+                    .RequestDurationEquals(duration, (x) => (x > 100 && x < 2000))
                     .ResponseStatusCodeIsSuccess()
                     .AssertAll();
 

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

@@ -413,7 +413,7 @@ public async Task HttpTesterClientPostObjectBodyWithFulUrlWithNTLMDefaultAuthori
                    .WithNTLMAuthentication()
                    .Start();
 
-                var msg = await response.GetResponseBody<dynamic>();
+                var msg = await response.GetResponseJsonBody<dynamic>();
 
                 Assert.True(client.Duration < 2000);
                 Assert.True(response.IsSuccessStatusCode);

src/QAToolKit.Engine.HttpTester.Test/QAToolKit.Engine.HttpTester.Test.csproj

@@ -7,21 +7,21 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="coverlet.msbuild" Version="2.9.0">
+    <PackageReference Include="coverlet.msbuild" Version="3.0.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.Extensions.Logging" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.8.3" />
     <PackageReference Include="QAToolKit.Source.Swagger" Version="0.3.9" />
-	<PackageReference Include="ExpectedObjects" Version="2.3.6" />
+	<PackageReference Include="ExpectedObjects" Version="3.5.2" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="coverlet.collector" Version="1.3.0">
+    <PackageReference Include="coverlet.collector" Version="3.0.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

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

@@ -0,0 +1,31 @@
+using System;
+using System.Net.Http;
+using System.Threading.Tasks;
+using QAToolKit.Engine.HttpTester.Extensions;
+using QAToolKit.Engine.HttpTester.Test.Fixtures;
+using Xunit;
+
+namespace QAToolKit.Engine.HttpTester.Test
+{
+    public class XmlDeserializerTests
+    {
+        [Fact]
+        public async Task HttpTesterClientSimple_Success()
+        {
+            using (var client = new HttpTesterClient())
+            {
+                var response = await client
+                    .CreateHttpRequest(new Uri("https://www.w3schools.com/xml/note.xml"))
+                    .WithMethod(HttpMethod.Get)
+                    .Start();
+
+                var msg = await response.GetResponseXmlBody<note>();
+
+                Assert.True(client.Duration < 2000);
+                Assert.True(response.IsSuccessStatusCode);
+                Assert.Equal("Reminder", msg.heading);
+                Assert.Equal("Jani", msg.from);
+            }
+        }
+    }
+}

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

@@ -1,6 +1,9 @@
-using Newtonsoft.Json;
+using System;
+using System.IO;
+using Newtonsoft.Json;
 using System.Net.Http;
 using System.Threading.Tasks;
+using System.Xml.Serialization;
 
 namespace QAToolKit.Engine.HttpTester.Extensions
 {
@@ -15,11 +18,40 @@ public static class HttpResponseMessageExtensions
         /// <typeparam name="T"></typeparam>
         /// <param name="httpResponseMessage"></param>
         /// <returns></returns>
+        [Obsolete("This method is obsolete and will be deprecated. Use 'GetResponseJsonBody<T>' instead.")]
         public static async Task<T> GetResponseBody<T>(this HttpResponseMessage httpResponseMessage)
         {
             var bodyResponse = await httpResponseMessage.Content.ReadAsStringAsync();
             return JsonConvert.DeserializeObject<T>(bodyResponse);
         }
+        
+        /// <summary>
+        /// Deserialize JSON response body to object
+        /// </summary>
+        /// <param name="httpResponseMessage"></param>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        public static async Task<T> GetResponseJsonBody<T>(this HttpResponseMessage httpResponseMessage)
+        {
+            var bodyResponse = await httpResponseMessage.Content.ReadAsStringAsync();
+            return JsonConvert.DeserializeObject<T>(bodyResponse);
+        }
+        
+        /// <summary>
+        /// Deserialize XML response body to object
+        /// </summary>
+        /// <param name="httpResponseMessage"></param>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        public static async Task<T> GetResponseXmlBody<T>(this HttpResponseMessage httpResponseMessage)
+        {
+            var bodyResponse = await httpResponseMessage.Content.ReadAsStringAsync();
+            var xmlSerialize = new XmlSerializer(typeof(T));  
+  
+            var xmlResult = (T)xmlSerialize.Deserialize(new StringReader(bodyResponse));  
+  
+            return xmlResult ?? default(T);
+        }
 
         /// <summary>
         /// Get response as string