Add some basic tests for formatting httprequestmessages

Author: dnperfors

.editorconfig

@@ -9,6 +9,9 @@ trim_trailing_whitespace = true
 [*.md]
 trim_trailing_whitespace = false
 
+[*.verified.http]
+insert_final_newline = false
+
 [*.cs]
 indent_size = 4
 dotnet_style_qualification_for_field = false:warning

.gitattributes

@@ -0,0 +1 @@
+*.verified.http   text eol=crlf

src/TestableHttpClient/Utils/HttpRequestMessageFormatter.cs

@@ -0,0 +1,42 @@
+using System.Globalization;
+
+namespace TestableHttpClient.Utils;
+
+internal static class HttpRequestMessageFormatter
+{
+    internal static string Format(HttpRequestMessage? request, HttpRequestMessageFormatOptions options)
+    {
+        if (request is null)
+        {
+            return "null";
+        }
+
+        IFormatProvider formatProvider = CultureInfo.InvariantCulture;
+        StringBuilder builder = new();
+        builder.Append(formatProvider, $"{request.Method} {request.RequestUri} HTTP/{request.Version}\r\n");
+        foreach(var header in request.Headers)
+        {
+            builder.Append(formatProvider, $"{header.Key}: {string.Join(", ", header.Value)}\r\n");
+        }
+        foreach(var header in request.Content?.Headers ?? Enumerable.Empty<KeyValuePair<string, IEnumerable<string>>>())
+        {
+            builder.Append(formatProvider, $"{header.Key}: {string.Join(", ", header.Value)}\r\n");
+        }
+        builder.Append("\r\n");
+        builder.Append(request.Content?.ReadAsStringAsync().GetAwaiter().GetResult());
+
+        return builder.ToString();
+    }
+}
+
+[Flags]
+internal enum HttpRequestMessageFormatOptions
+{
+    HttpMethod = 1,
+    RequestUri = 2,
+    HttpVersion = 4,
+    RequestLine = HttpMethod | RequestUri | HttpVersion,
+    Headers = 8,
+    Content = 16,
+    All = RequestLine | Headers | Content
+}

src/TestableHttpClient/Utils/NetStandardPollyFill.cs

@@ -1,5 +1,7 @@
 #if NETSTANDARD
 
+using System.Runtime.CompilerServices;
+
 namespace TestableHttpClient.Utils;
 
 internal static class NetStandardPollyFill
@@ -13,6 +15,11 @@ public static string Replace(this string input, string oldValue, string newValue
     {
         return input.Replace(oldValue, newValue);
     }
+
+    public static StringBuilder Append(this StringBuilder builder, IFormatProvider? provider, string handler)
+    {
+        return builder.Append(handler);
+    }
 }
 
 #endif

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTestData/simple_get_request_version_1.0.verified.http

@@ -0,0 +1,2 @@
+GET https://example.com/ HTTP/1.0
+

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTestData/simple_get_request_version_1.1.verified.http

@@ -0,0 +1,2 @@
+GET https://example.com/ HTTP/1.1
+

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTestData/simple_get_request_version_2.0.verified.http

@@ -0,0 +1,2 @@
+GET https://example.com/ HTTP/2.0
+

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTestData/simple_get_request_version_3.0.verified.http

@@ -0,0 +1,2 @@
+GET https://example.com/ HTTP/3.0
+

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTestData/simple_post_request.verified.http

@@ -0,0 +1,5 @@
+POST https://example.com/ HTTP/1.1
+Content-Type: text/plain; charset=utf-8
+Content-Length: 13
+
+Hello, World!

test/TestableHttpClient.Tests/Utils/HttpRequestMessageFormatterTests.cs

@@ -0,0 +1,57 @@
+using System.IO;
+using System.Runtime.CompilerServices;
+
+using TestableHttpClient.Utils;
+
+namespace TestableHttpClient.Tests.Utils;
+
+public sealed class HttpRequestMessageFormatterTests
+{
+    private static string FetchTestData(string filename, [CallerFilePath] string callerFilePath = "")
+    {
+        string directory = Path.GetDirectoryName(callerFilePath)!;
+        string filePath = Path.Combine(directory, "HttpRequestMessageFormatterTestData", filename);
+        filePath += ".verified.http";
+        return File.ReadAllText(filePath);
+    }
+    [Fact]
+    public void Format_NullRequest_CreatesExpectedString()
+    {
+        HttpRequestMessage? request = null;
+
+        var result = HttpRequestMessageFormatter.Format(request, HttpRequestMessageFormatOptions.All);
+
+        Assert.Equal("null", result);
+    }
+
+    [Theory]
+    [InlineData("1.0")]
+    [InlineData("1.1")]
+    [InlineData("2.0")]
+    [InlineData("3.0")]
+    public void Format_SimpleGetRequest_CreatesExpectedString(string version)
+    {
+        using HttpRequestMessage request = new(HttpMethod.Get, "https://example.com")
+        {
+            Version = Version.Parse(version)
+        };
+        string result = HttpRequestMessageFormatter.Format(request, HttpRequestMessageFormatOptions.All);
+
+        string expected = FetchTestData($"simple_get_request_version_{version}");
+
+        Assert.Equal(expected, result);
+    }
+
+    [Fact]
+    public void Format_SimplePostRequestWithHttpVersion2_CreatesExpectedString()
+    {
+        using HttpRequestMessage request = new(HttpMethod.Post, "https://example.com");
+        request.Content = new StringContent("Hello, World!");
+        request.Content.Headers.ContentLength = 13;
+        string result = HttpRequestMessageFormatter.Format(request, HttpRequestMessageFormatOptions.All);
+
+        string expected = FetchTestData("simple_post_request");
+
+        Assert.Equal(expected, result);
+    }
+}