Add test for http formatter.

dotnet · Apr 28, 2023 · 29c11d3 · 29c11d3
1 parent 21c8b92
commit 29c11d3
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 12 deletions.
diff --git a/....ApiCompatibility.Tests/ApiCompatibilityTests.httpRequest_api_is_not_changed.approved.txt b/....ApiCompatibility.Tests/ApiCompatibilityTests.httpRequest_api_is_not_changed.approved.txt
@@ -17,7 +17,7 @@ Microsoft.DotNet.Interactive.HttpRequest
     public System.Uri BaseAddress { get; set;}
     public System.Void SetValue(System.String valueName, System.String value)
   public class HttpRequestKernelExtension
-    public static System.Void Load(Microsoft.DotNet.Interactive.Kernel kernel)
+    public static System.Void Load(Microsoft.DotNet.Interactive.Kernel kernel, System.Net.Http.HttpClient httpClient = null)
     .ctor()
   public class HttpResponse
     .ctor(System.Int32 statusCode, System.String reasonPhrase, System.String version, System.Collections.Generic.Dictionary<System.String,System.String[]> headers, HttpRequest request = null, HttpContent content = null, System.Nullable<System.Double> elapsedMilliseconds = null)

diff --git a/src/Microsoft.DotNet.Interactive.HttpRequest.Tests/HttpRequestKernelTests.cs b/src/Microsoft.DotNet.Interactive.HttpRequest.Tests/HttpRequestKernelTests.cs
@@ -10,13 +10,19 @@
 using FluentAssertions;
 using Microsoft.DotNet.Interactive.Commands;
 using Microsoft.DotNet.Interactive.Events;
+using Microsoft.DotNet.Interactive.Formatting;
 using Microsoft.DotNet.Interactive.Tests.Utility;
 using Xunit;
 
 namespace Microsoft.DotNet.Interactive.HttpRequest.Tests;
 
 public class HttpRequestKernelTests
 {
+    public HttpRequestKernelTests()
+    {
+        Formatter.ResetToDefault();
+    }
+
     [Theory]
     [InlineData("GET")]
     [InlineData("PUT")]
@@ -41,7 +47,6 @@ public async Task supports_verbs(string verb)
         result.Events.Should().NotContainErrors();
 
         request.Method.Method.Should().Be(verb);
-
     }
 
     [Fact]
@@ -51,7 +56,7 @@ public async Task requires_base_address_when_using_relative_uris()
 
         var result = await kernel.SendAsync(new SubmitCode("get  /relativePath"));
 
-        var error =  result.Events.Should().ContainSingle<CommandFailed>().Which;
+        var error = result.Events.Should().ContainSingle<CommandFailed>().Which;
 
         error.Message.Should().Contain("Cannot use relative path /relativePath without a base address.");
     }
@@ -69,7 +74,7 @@ public async Task ignores_base_address_when_using_absolute_paths()
         var client = new HttpClient(handler);
         using var kernel = new HttpRequestKernel(client: client);
         kernel.BaseAddress = new Uri("http://example.com");
-        
+
         var result = await kernel.SendAsync(new SubmitCode("get  https://anotherlocation.com/endpoint"));
 
         result.Events.Should().NotContainErrors();
@@ -89,7 +94,7 @@ public async Task can_replace_symbols()
         });
         var client = new HttpClient(handler);
         using var kernel = new HttpRequestKernel(client: client);
-     
+
         kernel.SetValue("my_host", "my.host.com");
 
         var result = await kernel.SendAsync(new SubmitCode("get  https://{{my_host}}:1200/endpoint"));
@@ -123,7 +128,7 @@ public async Task can_use_base_address_to_resolve_host_symbol()
     [Fact]
     public async Task can_handle_multiple_request_in_a_single_submission()
     {
-        List<HttpRequestMessage> requests = new ();
+        List<HttpRequestMessage> requests = new();
         var handler = new InterceptingHttpMessageHandler((message, _) =>
         {
             requests.Add(message);
@@ -140,7 +145,7 @@ public async Task can_handle_multiple_request_in_a_single_submission()
 
         result.Events.Should().NotContainErrors();
 
-        requests.Select(r => r.RequestUri.AbsoluteUri).ToArray().Should().BeEquivalentTo(new []{ "https://location1.com:1200/endpoint", "https://location2.com:1200/endpoint" });
+        requests.Select(r => r.RequestUri.AbsoluteUri).ToArray().Should().BeEquivalentTo(new[] { "https://location1.com:1200/endpoint", "https://location2.com:1200/endpoint" });
     }
 
     [Fact]
@@ -227,7 +232,7 @@ public async Task can_use_symbols_in_body()
         });
         var client = new HttpClient(handler);
         using var kernel = new HttpRequestKernel(client: client);
-        kernel.SetValue("one","1");
+        kernel.SetValue("one", "1");
         var result = await kernel.SendAsync(new SubmitCode(@"
 post  https://location1.com:1200/endpoint
 Authorization: Basic username password
@@ -352,4 +357,32 @@ public async Task multiple_diagnostics_are_returned_from_the_same_submission()
 
         diagnostics.Diagnostics.Should().HaveCount(2);
     }
+
+    [Fact]
+    public async Task produces_json_html_and_plain_text_formatted_values()
+    {
+        HttpRequestMessage request = null;
+        var handler = new InterceptingHttpMessageHandler((message, _) =>
+        {
+            request = message;
+            var response = new HttpResponseMessage(HttpStatusCode.OK);
+            response.RequestMessage = message;
+            return Task.FromResult(response);
+        });
+        var client = new HttpClient(handler);
+
+        using var root = new CompositeKernel();
+        HttpRequestKernelExtension.Load(root, client);
+        var kernel = root.FindKernels(k => k is HttpRequestKernel).Single();
+
+        var result = await kernel.SendAsync(new SubmitCode($"GET http://testuri.ninja"));
+
+        result.Events.Should().NotContainErrors();
+
+        var displayEvent =
+            result.Events.Should().ContainSingle<DisplayEvent>().Which.FormattedValues.Should()
+                .Contain(f => f.MimeType == HtmlFormatter.MimeType).And
+                .Contain(f => f.MimeType == PlainTextFormatter.MimeType).And
+                .Contain(f => f.MimeType == JsonFormatter.MimeType);
+    }
 }
diff --git a/src/Microsoft.DotNet.Interactive.HttpRequest/HttpRequestKernelExtension.cs b/src/Microsoft.DotNet.Interactive.HttpRequest/HttpRequestKernelExtension.cs
@@ -1,17 +1,18 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using System.Net.Http;
 using Microsoft.DotNet.Interactive.Formatting;
 
 namespace Microsoft.DotNet.Interactive.HttpRequest;
 
 public class HttpRequestKernelExtension
 {
-    public static void Load(Kernel kernel)
+    public static void Load(Kernel kernel, HttpClient? httpClient = null)
     {
         if (kernel.RootKernel is CompositeKernel compositeKernel)
         {
-            var httpRequestKernel = new HttpRequestKernel();
+            var httpRequestKernel = new HttpRequestKernel(client: httpClient);
             compositeKernel.Add(httpRequestKernel);
             httpRequestKernel.UseValueSharing();
 
@@ -29,8 +30,7 @@ public static void Load(Kernel kernel)
 
     private static void RegisterFormatters()
     {
-        // TODO: Add Json.
-        Formatter.SetPreferredMimeTypesFor(typeof(HttpResponse), HtmlFormatter.MimeType, PlainTextFormatter.MimeType);
+        Formatter.SetPreferredMimeTypesFor(typeof(HttpResponse), HtmlFormatter.MimeType, PlainTextFormatter.MimeType, JsonFormatter.MimeType);
 
         Formatter.Register<HttpResponse>(
             (value, context) =>