Added tests for mermaid diagrams

Author: darrelmiller

src/Microsoft.OpenApi.Hidi/OpenApiService.cs

@@ -549,13 +549,13 @@ private static void LogErrors(ILogger<OpenApiService> logger, ReadResult result)
             }
         }
 
-        private static void WriteTreeDocument(string openapi, OpenApiDocument document, StreamWriter writer)
+        internal static void WriteTreeDocument(string openapiUrl, OpenApiDocument document, StreamWriter writer)
         {
             var rootNode = OpenApiUrlTreeNode.Create(document, "main");
 
             writer.WriteLine("# " + document.Info.Title);
             writer.WriteLine();
-            writer.WriteLine("OpenAPI: " + openapi);
+            writer.WriteLine("OpenAPI: " + openapiUrl);
 
             writer.WriteLine(@"<div>");
             // write a span for each mermaidcolorscheme

src/Microsoft.OpenApi/Services/OpenApiUrlTreeNode.cs

@@ -242,7 +242,7 @@ public void AddAdditionalData(Dictionary<string, List<string>> additionalData)
         /// Write tree as Mermaid syntax
         /// </summary>
         /// <param name="writer">StreamWriter to write the Mermaid content to</param>
-        public void WriteMermaid(StreamWriter writer)
+        public void WriteMermaid(TextWriter writer)
         {
             writer.WriteLine("graph LR");
             foreach (var style in MermaidNodeStyles)
@@ -269,7 +269,7 @@ public void WriteMermaid(StreamWriter writer)
             { "OTHER", new MermaidNodeStyle("White", MermaidNodeShape.SquareCornerRectangle) },
         };
 
-        private static void ProcessNode(OpenApiUrlTreeNode node, StreamWriter writer)
+        private static void ProcessNode(OpenApiUrlTreeNode node, TextWriter writer)
         {
             var path = string.IsNullOrEmpty(node.Path) ? "/" : SanitizeMermaidNode(node.Path);
             var methods = GetMethods(node);

test/Microsoft.OpenApi.Hidi.Tests/Services/OpenApiServiceTests.cs

@@ -1,10 +1,14 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+using System.Text;
 using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
 using Microsoft.OpenApi.Hidi;
+using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.OData;
 using Microsoft.OpenApi.Services;
+using Microsoft.VisualStudio.TestPlatform.Utilities;
 using Xunit;
 
 namespace Microsoft.OpenApi.Tests.Services
@@ -71,5 +75,24 @@ public void ReturnOpenApiConvertSettingsWhenSettingsFileIsProvided(string filePa
                 Assert.NotNull(settings);
             }
         }
+
+        [Fact]
+        public void ShowCommandGeneratesMermaidDiagram()
+        {
+            var openApiDoc = new OpenApiDocument();
+            openApiDoc.Info = new OpenApiInfo
+            {
+                Title = "Test",
+                Version = "1.0.0"
+            };
+            var stream = new MemoryStream();
+            using var writer = new StreamWriter(stream);
+            OpenApiService.WriteTreeDocument("https://example.org/openapi.json", openApiDoc, writer);
+            writer.Flush();
+            stream.Position = 0;
+            using var reader = new StreamReader(stream);
+            var output = reader.ReadToEnd();
+            Assert.Contains("graph LR", output);
+        }
     }
 }

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

@@ -1118,7 +1118,7 @@ namespace Microsoft.OpenApi.Services
         public void Attach(Microsoft.OpenApi.Models.OpenApiDocument doc, string label) { }
         public Microsoft.OpenApi.Services.OpenApiUrlTreeNode Attach(string path, Microsoft.OpenApi.Models.OpenApiPathItem pathItem, string label) { }
         public bool HasOperations(string label) { }
-        public void WriteMermaid(System.IO.StreamWriter writer) { }
+        public void WriteMermaid(System.IO.TextWriter writer) { }
         public static Microsoft.OpenApi.Services.OpenApiUrlTreeNode Create() { }
         public static Microsoft.OpenApi.Services.OpenApiUrlTreeNode Create(Microsoft.OpenApi.Models.OpenApiDocument doc, string label) { }
     }

test/Microsoft.OpenApi.Tests/Services/OpenApiUrlTreeNodeTests.VerifyDiagramFromSampleOpenAPI.verified.txt

@@ -0,0 +1,15 @@
+graph LR
+classDef GET fill:lightSteelBlue,stroke:#333,stroke-width:2px
+classDef POST fill:Lightcoral,stroke:#333,stroke-width:2px
+classDef GET_POST fill:forestGreen,stroke:#333,stroke-width:2px
+classDef DELETE_GET_PATCH fill:yellowGreen,stroke:#333,stroke-width:2px
+classDef DELETE_GET_PATCH_PUT fill:oliveDrab,stroke:#333,stroke-width:2px
+classDef DELETE_GET_PUT fill:olive,stroke:#333,stroke-width:2px
+classDef DELETE_GET fill:DarkSeaGreen,stroke:#333,stroke-width:2px
+classDef DELETE fill:Tomato,stroke:#333,stroke-width:2px
+classDef OTHER fill:White,stroke:#333,stroke-width:2px
+/["/"] --> /houses["houses"]
+class /houses OTHER
+/["/"] --> /cars["cars"]
+class /cars OTHER
+class / OTHER

test/Microsoft.OpenApi.Tests/Services/OpenApiUrlTreeNodeTests.cs

@@ -3,12 +3,16 @@
 
 using System;
 using System.Collections.Generic;
+using System.IO;
+using System.Threading.Tasks;
 using Microsoft.OpenApi.Models;
 using Microsoft.OpenApi.Services;
+using VerifyXunit;
 using Xunit;
 
 namespace Microsoft.OpenApi.Tests.Services
 {
+    [UsesVerify]
     public class OpenApiUrlTreeNodeTests
     {
         private OpenApiDocument OpenApiDocumentSample_1 => new OpenApiDocument()
@@ -443,5 +447,21 @@ public void ThrowsArgumentNullExceptionForNullArgumentInAddAdditionalDataMethod(
 
             Assert.Throws<ArgumentNullException>(() => rootNode.AddAdditionalData(null));
         }
+
+        [Fact]
+        public async Task VerifyDiagramFromSampleOpenAPI()
+        {
+            var doc1 = OpenApiDocumentSample_1;
+
+            var label1 = "personal";
+            var rootNode = OpenApiUrlTreeNode.Create(doc1, label1);
+
+            var writer = new StringWriter();
+            rootNode.WriteMermaid(writer);
+            writer.Flush();
+            var diagram = writer.GetStringBuilder().ToString();
+
+            await Verifier.Verify(diagram);
+        }
     }
 }