feat: add tests for ShellDocs service registration and slot splitting functionality, enhancing test coverage and reliability

Author: Shewart

shelldocs.slnx

@@ -1,4 +1,7 @@
 <Solution>
+  <Folder Name="/examples/">
+    <Project Path="examples/ShellDocs.Preview/ShellDocs.Preview.csproj" />
+  </Folder>
   <Folder Name="/src/">
     <Project Path="src/ShellDocs.CLI/ShellDocs.CLI.csproj" />
     <Project Path="src/ShellDocs.Components/ShellDocs.Components.csproj" />

tests/ShellDocs.Tests/AddShellDocsTests.cs

@@ -0,0 +1,59 @@
+using Microsoft.Extensions.DependencyInjection;
+using ShellDocs.Components;
+using ShellDocs.Core;
+using ShellDocs.Markdown;
+using Xunit;
+
+namespace ShellDocs.Tests;
+
+public class AddShellDocsTests
+{
+    [Fact]
+    public void AddShellDocs_RegistersCoreServices()
+    {
+        var services = new ServiceCollection();
+        services.AddShellDocs(o => o.SiteName = "Test");
+        var sp = services.BuildServiceProvider();
+
+        Assert.NotNull(sp.GetService<ShellDocsOptions>());
+        Assert.NotNull(sp.GetService<TypeRegistry>());
+        Assert.NotNull(sp.GetService<MarkdownRenderer>());
+        Assert.NotNull(sp.GetService<NavigationGraph>());
+    }
+
+    [Fact]
+    public void AddShellDocs_MissingContentRoot_ReturnsEmptyGraph()
+    {
+        var services = new ServiceCollection();
+        services.AddShellDocs(o => o.ContentRoot = "does-not-exist-" + Guid.NewGuid().ToString("N"));
+        var sp = services.BuildServiceProvider();
+
+        var graph = sp.GetRequiredService<NavigationGraph>();
+        Assert.Empty(graph.Root.Children);
+    }
+
+    [Fact]
+    public void AddShellDocs_RegisteredComponents_FlowIntoTypeRegistry()
+    {
+        var services = new ServiceCollection();
+        services.AddShellDocs(o => o.RegisterComponent<Callout>());
+        var sp = services.BuildServiceProvider();
+
+        var registry = sp.GetRequiredService<TypeRegistry>();
+        Assert.Equal(typeof(Callout), registry.Resolve("Callout"));
+    }
+
+    [Fact]
+    public void ShellDocsOptions_FluentAddNavLink_AppendsInOrder()
+    {
+        var options = new ShellDocsOptions()
+            .AddNavLink("Docs", "/docs")
+            .AddNavLink("Blog", "/blog");
+
+        Assert.Equal(2, options.PrimaryNav.Count);
+        Assert.Equal("Docs", options.PrimaryNav[0].Label);
+        Assert.Equal("/blog", options.PrimaryNav[1].Href);
+    }
+
+    public class Callout : Microsoft.AspNetCore.Components.ComponentBase { }
+}

tests/ShellDocs.Tests/ShellDocs.Tests.csproj

@@ -8,6 +8,7 @@
   <ItemGroup>
     <ProjectReference Include="..\..\src\ShellDocs.Core\ShellDocs.Core.csproj" />
     <ProjectReference Include="..\..\src\ShellDocs.Markdown\ShellDocs.Markdown.csproj" />
+    <ProjectReference Include="..\..\src\ShellDocs.Components\ShellDocs.Components.csproj" />
     <ProjectReference Include="..\..\src\ShellDocs.Templates\ShellDocs.Templates.csproj" />
   </ItemGroup>
 

tests/ShellDocs.Tests/SlotSplitterTests.cs

@@ -0,0 +1,86 @@
+using ShellDocs.Components.Content;
+using ShellDocs.Core;
+using ShellDocs.Markdown;
+using Xunit;
+
+namespace ShellDocs.Tests;
+
+public class SlotSplitterTests
+{
+    public class Fake : Microsoft.AspNetCore.Components.ComponentBase { }
+
+    private static RenderedDocument DocumentWith(string html, params Slot[] slots) =>
+        new(html, slots, new ParsedDocument(new Dictionary<string, object?>(), ""), Array.Empty<Heading>());
+
+    [Fact]
+    public void Split_HtmlOnly_ReturnsSingleHtmlPart()
+    {
+        var doc = DocumentWith("<p>Hello world</p>");
+        var parts = SlotSplitter.Split(doc);
+
+        var only = Assert.Single(parts);
+        var html = Assert.IsType<HtmlPart>(only);
+        Assert.Equal("<p>Hello world</p>", html.Html);
+    }
+
+    [Fact]
+    public void Split_SlotOnly_ReturnsSingleSlotPart()
+    {
+        var slot = new ComponentSlot("sabc", typeof(Fake), new Dictionary<string, string>(), null);
+        var doc = DocumentWith(
+            "<div data-shelldocs-slot=\"component\" data-shelldocs-id=\"sabc\"></div>",
+            slot);
+
+        var parts = SlotSplitter.Split(doc);
+
+        var only = Assert.Single(parts);
+        var sp = Assert.IsType<SlotPart>(only);
+        Assert.Same(slot, sp.Slot);
+    }
+
+    [Fact]
+    public void Split_MixedContent_InterleavesInOrder()
+    {
+        var slot1 = new ComponentSlot("s1", typeof(Fake), new Dictionary<string, string>(), null);
+        var slot2 = new PreviewSlot("s2", typeof(Fake), new Dictionary<string, string>(), "code", "razor");
+        var html =
+            "<p>Before</p>" +
+            "<div data-shelldocs-slot=\"component\" data-shelldocs-id=\"s1\"></div>" +
+            "<p>Middle</p>" +
+            "<div data-shelldocs-slot=\"preview\" data-shelldocs-id=\"s2\"></div>" +
+            "<p>After</p>";
+        var doc = DocumentWith(html, slot1, slot2);
+
+        var parts = SlotSplitter.Split(doc);
+
+        Assert.Equal(5, parts.Count);
+        Assert.Equal("<p>Before</p>", ((HtmlPart)parts[0]).Html);
+        Assert.Same(slot1, ((SlotPart)parts[1]).Slot);
+        Assert.Equal("<p>Middle</p>", ((HtmlPart)parts[2]).Html);
+        Assert.Same(slot2, ((SlotPart)parts[3]).Slot);
+        Assert.Equal("<p>After</p>", ((HtmlPart)parts[4]).Html);
+    }
+
+    [Fact]
+    public void Split_UnknownSlotId_DropsPlaceholder()
+    {
+        var html =
+            "<p>A</p>" +
+            "<div data-shelldocs-slot=\"component\" data-shelldocs-id=\"missing\"></div>" +
+            "<p>B</p>";
+        var doc = DocumentWith(html);
+
+        var parts = SlotSplitter.Split(doc);
+
+        Assert.Equal(2, parts.Count);
+        Assert.Equal("<p>A</p>", ((HtmlPart)parts[0]).Html);
+        Assert.Equal("<p>B</p>", ((HtmlPart)parts[1]).Html);
+    }
+
+    [Fact]
+    public void Split_EmptyHtml_ReturnsEmpty()
+    {
+        var doc = DocumentWith("");
+        Assert.Empty(SlotSplitter.Split(doc));
+    }
+}