Hello world
"); + public void IncludesInclusionHtml() => Html.Should().MatchInlineHtmlSnapshot("Hello world
", DocsHtml.Body()); } [InheritsTests] @@ -67,12 +70,12 @@ public class IncludeNotFoundTests() : DirectiveTest
+
+
+
+
+
+ First switch - Stack
+Some content between.
+
+
+
+
+ """,
+ DocsHtml.Body()
+ );
}
diff --git a/tests/Elastic.Markdown.Tests/FileInclusion/IncludedTabSetTests.cs b/tests/Elastic.Markdown.Tests/FileInclusion/IncludedTabSetTests.cs
index 853be6f911..38860fd128 100644
--- a/tests/Elastic.Markdown.Tests/FileInclusion/IncludedTabSetTests.cs
+++ b/tests/Elastic.Markdown.Tests/FileInclusion/IncludedTabSetTests.cs
@@ -4,8 +4,10 @@
using System.IO.Abstractions.TestingHelpers;
using AwesomeAssertions;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.Myst.Directives.Include;
using Elastic.Markdown.Tests.Directives;
+using Nullean.Snapshots.Html;
namespace Elastic.Markdown.Tests.FileInclusion;
@@ -47,18 +49,9 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
public void ParsesBlock() => Block.Should().NotBeNull();
[Test]
- public void EachIncludeHasUniqueIds()
- {
- // First include at line 2: (2 * 1000) + 0 = 2000
- // Second include at line 7: (7 * 1000) + 0 = 7000
- Html.Should().Contain("tabs-item-2000-0");
- Html.Should().Contain("tabs-item-2000-1");
- Html.Should().Contain("tabs-set-2000");
-
- Html.Should().Contain("tabs-item-7000-0");
- Html.Should().Contain("tabs-item-7000-1");
- Html.Should().Contain("tabs-set-7000");
- }
+ // First include at line 2: (2 * 1000) + 0 = 2000
+ // Second include at line 7: (7 * 1000) + 0 = 7000
+ public void EachIncludeHasUniqueIds() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body());
}
///
+
+ Second switch - Serverless
+
+
+
+
+
+
+ First tab set
+Some content between.
+
+
+
+
+ """,
+ DocsHtml.Body()
+ );
}
diff --git a/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs b/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs
index 1b26bd9e04..7a6158af59 100644
--- a/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs
+++ b/tests/Elastic.Markdown.Tests/FileInclusion/LiteralIncludeTests.cs
@@ -5,8 +5,10 @@
using System.IO.Abstractions.TestingHelpers;
using AwesomeAssertions;
using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.Myst.Directives.Include;
using Elastic.Markdown.Tests.Directives;
+using Nullean.Snapshots;
namespace Elastic.Markdown.Tests.FileInclusion;
@@ -60,14 +62,12 @@ public class LiteralIncludeRelativeTraversalBlocked() : DirectiveTest
+
+ Second tab set
+
+
+ + Hello world +
+A paragraph
++ Hello +
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -68,12 +85,23 @@ [Sub Requirements](testing/req.md#sub-requirements) [Test] public void GeneratesHtml() => // language=html - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Sub Requirements +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -84,12 +112,23 @@ [Sub Requirements](testing/req.md#new-reqs) [Test] public void GeneratesHtml() => // language=html - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Sub Requirements +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -99,12 +138,23 @@ public class ExternalPageAnchorAutoTitleTests() : AnchorLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """Special Requirements > Sub Requirements
""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Special Requirements > Sub Requirements +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -113,11 +163,29 @@ public class InPageBadAnchorTests() : AnchorLinkTestBase(""" """) { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml(""""""); + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Hello +
+ """, + DocsHtml.Body() + ); [Test] public void HasError() => - Collector.Diagnostics.Should().HaveCount(1).And.Contain(d => d.Message.Contains("`hello-world2` does not exist")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot("error {repo}/docs/index.md:7 `hello-world2` does not exist in index.md."); } [InheritsTests] @@ -127,13 +195,28 @@ [Sub Requirements](testing/req.md#sub-requirements2) { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Sub Requirements +
+ """, + DocsHtml.Body() ); [Test] public void HasError() => - Collector.Diagnostics.Should().HaveCount(1).And.Contain(d => d.Message.Contains("`sub-requirements2` does not exist")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot("error {repo}/docs/index.md:7 `sub-requirements2` does not exist in testing/req.md."); } [InheritsTests] @@ -143,11 +226,22 @@ [Heading inside dropdown](testing/req.md#heading-inside-dropdown) { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """Heading inside dropdown""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
+ + """, + DocsHtml.Body() ); [Test] - public void HasError() => Collector.Diagnostics.Should().HaveCount(0); + public void HasError() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -157,7 +251,13 @@ public class MissingMdExtensionTests() : AnchorLinkTestBase(""" { [Test] public void HasMdExtensionHintError() => - Collector.Diagnostics.Should().HaveCount(1).And.Contain(d => d.Message.Contains("Did you forget to add the .md extension?")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot( + "error {repo}/docs/index.md:7 `testing/req` is not a valid internal link. Did you forget to add the .md extension?" + ); } [InheritsTests] @@ -167,7 +267,13 @@ public class MissingMdExtensionWithAnchorTests() : AnchorLinkTestBase(""" { [Test] public void HasMdExtensionHintError() => - Collector.Diagnostics.Should().HaveCount(1).And.Contain(d => d.Message.Contains("Did you forget to add the .md extension?")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot( + "error {repo}/docs/index.md:7 `testing/req` is not a valid internal link. Did you forget to add the .md extension?" + ); } [InheritsTests] @@ -179,10 +285,9 @@ public class MissingFileNoMdHintTests() : AnchorLinkTestBase(""" public void HasGenericNotFoundError() => Collector .Diagnostics + .ToSnapshotText() .Should() - .HaveCount(1) - .And - .Contain(d => d.Message.Contains("does not exist")) - .And - .NotContain(d => d.Message.Contains("Did you forget to add the .md extension?")); + .MatchInlineSnapshot( + "error {repo}/docs/index.md:7 `testing/nonexistent` does not exist. If it was recently removed add a redirect. resolved to `{repo}/docs/testing/nonexistent`" + ); } diff --git a/tests/Elastic.Markdown.Tests/Inline/AutoLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/AutoLinkTests.cs index de40af1a39..251e3c087a 100644 --- a/tests/Elastic.Markdown.Tests/Inline/AutoLinkTests.cs +++ b/tests/Elastic.Markdown.Tests/Inline/AutoLinkTests.cs @@ -4,8 +4,11 @@ using AwesomeAssertions; using Elastic.Documentation.Diagnostics; +using Elastic.Documentation.Testing; using JetBrains.Annotations; using Markdig.Syntax.Inlines; +using Nullean.Snapshots; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -33,10 +36,17 @@ public class BasicAutoLinkTests() : AutoLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.Should().Contain("""https://docs.test.io"""); + Html.Should().MatchInlineHtmlSnapshot( + """ +Check out + https://docs.test.io + for more info.
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -46,12 +56,17 @@ public class AutoLinkWithPathTests() : AutoLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.Should().Contain( - """https://docs.test.io/path/to/page""" + Html.Should().MatchInlineHtmlSnapshot( + """ +Visit + https://docs.test.io/path/to/page + for details.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -61,12 +76,17 @@ public class AutoLinkWithQueryStringTests() : AutoLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.Should().Contain( - """https://docs.test.io/search?q=test&page=1""" + Html.Should().MatchInlineHtmlSnapshot( + """ +See + https://docs.test.io/search?q=test&page=1 + for results.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -76,12 +96,17 @@ public class AutoLinkWithAnchorTests() : AutoLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.Should().Contain( - """https://docs.test.io/page#section""" + Html.Should().MatchInlineHtmlSnapshot( + """ +Jump to + https://docs.test.io/page#section + for the section.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -91,10 +116,16 @@ public class AutoLinkTrailingPeriodTests() : AutoLinkTestBase(""" { [Test] public void ExcludesTrailingPeriod() => - Html.Should().Contain("""https://docs.test.io."""); + Html.Should().MatchInlineHtmlSnapshot( + """ +Check out + https://docs.test.io.
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -106,16 +137,19 @@ public class AutoLinkTrailingCommaTests() : AutoLinkTestBase( { [Test] public void ExcludesTrailingCommas() => - Html - .Should() - .Contain("""https://first.test.io,""") - .And - .Contain("""https://second.test.io,""") - .And - .Contain("""https://third.test.io"""); + Html.Should().MatchInlineHtmlSnapshot( + """ +Visit + https://first.test.io, + https://second.test.io, or + https://third.test.io + for info.
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -125,10 +159,13 @@ public class AutoLinkInParenthesesTests() : AutoLinkTestBase(""" { [Test] public void ExcludesClosingParen() => - Html.Should().Contain("""(https://docs.test.io)"""); + Html.Should().MatchInlineHtmlSnapshot( + "See the docs (https://docs.test.io) for details.
", + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -140,12 +177,17 @@ public class AutoLinkWithBalancedParensTests() : AutoLinkTestBase( { [Test] public void IncludesBalancedParens() => - Html.Should().Contain( - """https://en.wikipedia.org/wiki/Rust_(programming_language)""" + Html.Should().MatchInlineHtmlSnapshot( + """ +Check + https://en.wikipedia.org/wiki/Rust_(programming_language) + for more.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -155,19 +197,23 @@ public class AutoLinkElasticDocsHintTests() : AutoLinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.Should().Contain( - """https://www.elastic.co/docs/deploy-manage""" + Html.Should().MatchInlineHtmlSnapshot( + """ +See + https://www.elastic.co/docs/deploy-manage + for deployment info.
+ """, + DocsHtml.Body() ); [Test] public void EmitsHint() => Collector .Diagnostics + .ToSnapshotText() .Should() - .ContainSingle( - d => d.Severity == Severity.Hint && d.Message.Contains("elastic.co/docs") && d.Message.Contains( - "crosslink or relative link" - ) + .MatchInlineSnapshot( + "hint {repo}/docs/index.md:3 Autolink points to elastic.co/docs. Consider using a crosslink or relative link instead." ); } @@ -178,10 +224,23 @@ public class AutoLinkInCodeBlockTests() : AutoLinkNotFoundTestBase(""" """) { [Test] - public void DoesNotCreateLink() => Html.Should().NotContain(" +
+
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
public class AutoLinkInInlineCodeTests() : AutoLinkNotFoundTestBase("""
@@ -190,10 +249,17 @@ public class AutoLinkInInlineCodeTests() : AutoLinkNotFoundTestBase("""
{
[Test]
public void DoesNotCreateLinkInInlineCode() =>
- Html.Should().Contain("
+ https://docs.test.io/should/not/be/linked
+
+
+ https://docs.test.io/api").And.NotContain("""Use the URL
+ https://docs.test.io/api
+ in your config.
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
public class AutoLinkDoesNotMatchHttpTests() : AutoLinkNotFoundTestBase("""
@@ -201,10 +267,11 @@ public class AutoLinkDoesNotMatchHttpTests() : AutoLinkNotFoundTestBase("""
""")
{
[Test]
- public void DoesNotCreateLink() => Html.Should().NotContain("This http://docs.test.io should not be autolinked.", DocsHtml.Body());
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
[InheritsTests]
@@ -216,14 +283,19 @@ public class AutoLinkWithStandardLinkTests() : AutoLinkTestBase(
{
[Test]
public void BothLinksWork() =>
- Html
- .Should()
- .Contain("""Docs""")
- .And
- .Contain("""https://other.test.io""");
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+ Visit + Docs + or + https://other.test.io + for more.
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -235,15 +307,21 @@ public class AutoLinkInsideLinkTextTests() : AutoLinkTestBase( ) { [Test] - public void DoesNotCreateNestedAnchor() => - Html - .Should() - .Contain("""https://gist.github.com""") - .And - .NotMatchRegex(@"See + the page at https://example.test.io for details.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } // Verify that image-inside-link is unaffected by the IsNestedInsideLink guard (images bypass it via the IsImage branch). @@ -270,14 +352,20 @@ public class ImageInsideLinkTests() : InlineTest![](\"https://example.com/image.png\"");)
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+
+
+ 
+
+
Connect to https://www.elastic.co:443/guide for the guide.
", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class AutoLinkLocalhostExclusionTests() : AutoLinkNotFoundTestBase(""" @@ -319,10 +413,11 @@ public class AutoLinkLocalhostExclusionTests() : AutoLinkNotFoundTestBase(""" """) { [Test] - public void DoesNotCreateLinkForLocalhost() => Html.Should().NotContain(" + Html.Should().MatchInlineHtmlSnapshot("Check https://localhost/api for the local API.
", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class AutoLinkLoopbackExclusionTests() : AutoLinkNotFoundTestBase(""" @@ -330,10 +425,11 @@ public class AutoLinkLoopbackExclusionTests() : AutoLinkNotFoundTestBase(""" """) { [Test] - public void DoesNotCreateLinkForLoopback() => Html.Should().NotContain(" + Html.Should().MatchInlineHtmlSnapshot("Test at https://127.0.0.1/health for health check.
", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class AutoLinkExampleDomainExclusionTests() : AutoLinkNotFoundTestBase(""" @@ -341,10 +437,11 @@ public class AutoLinkExampleDomainExclusionTests() : AutoLinkNotFoundTestBase("" """) { [Test] - public void DoesNotCreateLinkForExampleDomain() => Html.Should().NotContain(" + Html.Should().MatchInlineHtmlSnapshot("See https://example.com/docs for examples.
", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class AutoLinkExampleSubdomainExclusionTests() : AutoLinkNotFoundTestBase(""" @@ -353,10 +450,10 @@ public class AutoLinkExampleSubdomainExclusionTests() : AutoLinkNotFoundTestBase { [Test] public void DoesNotCreateLinkForExampleSubdomain() => - Html.Should().NotContain("Visit https://system.example.com/setup for setup.", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class AutoLinkTemplatePlaceholderExclusionTests() : AutoLinkNotFoundTestBase( @@ -366,7 +463,8 @@ public class AutoLinkTemplatePlaceholderExclusionTests() : AutoLinkNotFoundTestB ) { [Test] - public void DoesNotCreateLinkForTemplatePlaceholder() => Html.Should().NotContain(" + Html.Should().MatchInlineHtmlSnapshot("Use https://{{cluster_id}}.es.test.co/api for your cluster.
", DocsHtml.Body()); // Note: We expect an error because {{cluster_id}} is an undefined substitution key, // but the important assertion is that the URL is not autolinked. @@ -379,10 +477,11 @@ public class AutoLinkAsciiDocStyleExclusionTests() : AutoLinkNotFoundTestBase( ) { [Test] - public void DoesNotCreateLinkForAsciiDocStyle() => Html.Should().NotContain(""" + Html.Should().MatchInlineHtmlSnapshot("See https://www.iana.org/assignments[IANA for assignments.
", DocsHtml.Body()); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -392,10 +491,15 @@ public class AutoLinkValidUrlStillWorksTests() : AutoLinkTestBase(""" { [Test] public void CreatesLinkForValidUrl() => - Html.Should().Contain( - """https://www.elastic.co/guide""" + Html.Should().MatchInlineHtmlSnapshot( + """ +Check + https://www.elastic.co/guide + for docs.
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } diff --git a/tests/Elastic.Markdown.Tests/Inline/CommentTest.cs b/tests/Elastic.Markdown.Tests/Inline/CommentTest.cs index f55dbed559..897a6be0a4 100644 --- a/tests/Elastic.Markdown.Tests/Inline/CommentTest.cs +++ b/tests/Elastic.Markdown.Tests/Inline/CommentTest.cs @@ -2,6 +2,9 @@ // Elasticsearch B.V licenses this file to you under the Apache 2.0 License. // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; +using Nullean.Snapshots; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -11,14 +14,10 @@ not a comment """) { [Test] - public void GeneratesAttributesInHtml() - { - // language=html - Html.Should().NotContain("""% comment""").And.Contain("""
not a comment
"""); - Html.ShouldBeHtml(""" + public void GeneratesAttributesInHtml() => + Html.Should().MatchInlineHtmlSnapshot("""not a comment
- """); - } + """, DocsHtml.Body()); } public class MultipleLineCommentTest() : InlineTest( @@ -35,27 +34,14 @@ also not a comment ) { [Test] - public void GeneratesAttributesInHtml() - { - // language=html - Html - .Should() - .NotContainAny( - "" - ) - .And - .ContainAll("
not a comment, and multi line comment below
", "also not a comment
"); - Html.ShouldBeHtml( + public void GeneratesAttributesInHtml() => + Html.Should().MatchInlineHtmlSnapshot( """not a comment, and multi line comment below
also not a comment
- """ + """, + DocsHtml.Body() ); - } } public class MultipleLineCommentWithLinkTest() : InlineTest( @@ -73,32 +59,17 @@ also not a comment ) { [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] - public void GeneratesAttributesInHtml() - { - // language=html - Html - .ReplaceLineEndings() - .Should() - .NotContainAny( - "" - ) - .And - .ContainAll("
not a comment, and multi line comment below
", "also not a comment
"); - Html.ShouldBeHtml( + public void GeneratesAttributesInHtml() => + Html.Should().MatchInlineHtmlSnapshot( """not a comment, and multi line comment below
also not a comment
- """ + """, + DocsHtml.Body() ); - } } ///content after comment
"); - } - - [Test] - public void ContentBeforeCommentShouldBeRendered() => Html.Should().Contain("content before comment
"); - - [Test] - public void CommentContentShouldNotBeRendered() => Html.Should().NotContain("TODO: Uncomment once page is live."); + // This test verifies GitHub issue #2456 is fixed. + // The "content after comment" should be rendered, not silently dropped. + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot( + """ +content before comment
+content after comment
+ """, + DocsHtml.Body() + ); } ///content before
").And.Contain("content after
"); - - [Test] - public void CommentContentShouldNotBeRendered() => Html.Should().NotContain("single line comment"); + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot(""" +content before
+content after
+ """, DocsHtml.Body()); } ///content before
").And.Contain("content after
"); - - [Test] - public void CommentContentShouldNotBeRendered() => - Html.Should().NotContain("start of comment").And.NotContain("middle of comment").And.NotContain("end of comment"); + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot(""" +content before
+content after
+ """, DocsHtml.Body()); } diff --git a/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs index 326c4f4a53..39bab26f60 100644 --- a/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs +++ b/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs @@ -4,8 +4,11 @@ using System.IO.Abstractions.TestingHelpers; using AwesomeAssertions; +using Elastic.Documentation.Testing; using JetBrains.Annotations; using Markdig.Syntax.Inlines; +using Nullean.Snapshots; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -46,10 +49,25 @@ public class InPageDirectiveLinkTests() : DirectiveBlockLinkTests(""" [Test] public void GeneratesHtml() => // language=html - Html.ShouldContainHtml(""""""); + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+
+ Warning
+
+
+
+ This is a 'warning' admonition
++ Hello +
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -58,8 +76,24 @@ [Sub Requirements](testing/req.md#hint_ref) """) { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml(""""""); + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+
+ Warning
+
+
+
+ This is a 'warning' admonition
++ Sub Requirements +
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } diff --git a/tests/Elastic.Markdown.Tests/Inline/FootnotesTests.cs b/tests/Elastic.Markdown.Tests/Inline/FootnotesTests.cs index d188d15864..8541dccf98 100644 --- a/tests/Elastic.Markdown.Tests/Inline/FootnotesTests.cs +++ b/tests/Elastic.Markdown.Tests/Inline/FootnotesTests.cs @@ -3,7 +3,9 @@ // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; using JetBrains.Annotations; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -18,35 +20,32 @@ public class FootnotesBasicTests() : InlineTest( ) { [Test] - public void ContainsFootnoteReferences() - { - Html.Should().Contain("footnote-ref"); - Html.Should().Contain("href=\"#fn:1\""); - Html.Should().Contain("href=\"#fn:2\""); - } - - [Test] - public void ContainsFootnoteContainer() => Html.Should().Contain("class=\"footnotes\""); - - [Test] - public void ContainsFootnoteDefinitions() - { - Html.Should().Contain("id=\"fn:1\""); - Html.Should().Contain("id=\"fn:2\""); - Html.Should().Contain("This is the first footnote."); - Html.Should().Contain("This is the second footnote."); - } - - [Test] - public void ContainsBackReferences() - { - Html.Should().Contain("footnote-back-ref"); - Html.Should().Contain("href=\"#fnref:1\""); - Html.Should().Contain("href=\"#fnref:2\""); - } - - [Test] - public void RendersFootnotesHeading() => Html.Should().Contain("Footnotes
"); + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot( + """ +Here's a simple footnote + 1 + + and another + 2 + .
+ + """, + DocsHtml.Body() + ); [Test] public void FootnotesHeadingPrecedesFootnoteContainer() @@ -83,12 +82,30 @@ public void ContainsMultipleReferencesToSameFootnote() } [Test] - public void ContainsMultipleBackReferences() - { - // Should have references back to both instances - Html.Should().Contain("href=\"#fnref:1\""); - Html.Should().Contain("href=\"#fnref:2\""); - } + // Should have references back to both instances + public void ContainsMultipleBackReferences() => + Html.Should().MatchInlineHtmlSnapshot( + """ +First reference + 1 + + and second reference + 1 + .
+ + """, + DocsHtml.Body() + ); [System.Text.RegularExpressions.GeneratedRegex("href=\"#fn:1\"")] private static partial System.Text.RegularExpressions.Regex MyRegex(); @@ -111,26 +128,35 @@ It has multiple paragraphs. ) { [Test] - public void ContainsComplexFootnoteStructure() - { - Html.Should().Contain("href=\"#fn:1\""); - Html.Should().Contain("This footnote has multiple elements."); - Html.Should().Contain("It has multiple paragraphs."); - } - - [Test] - public void ContainsBlockquoteInFootnote() - { - Html.Should().Contain("blockquote"); - Html.Should().Contain("And even a blockquote."); - } - - [Test] - public void ContainsListInFootnote() - { - Html.Should().Contain("List item 1"); - Html.Should().Contain("List item 2"); - } + public void GeneratesHtml() => + Html.Should().MatchInlineHtmlSnapshot( + """ +Here's a complex footnote + 1 + .
+
+
+
+ """,
+ DocsHtml.Body()
+ );
}
public class FootnotesWithCodeTests() : InlineTest(
@@ -148,11 +174,35 @@ def hello():
)
{
[Test]
- public void ContainsCodeBlockInFootnote()
- {
- Html.Should().Contain("Example code:");
- Html.Should().Contain("hello");
- }
+ public void ContainsCodeBlockInFootnote() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+ +
Footnotes
+-
+
-
+
This footnote has multiple elements.
+It has multiple paragraphs.
++
+And even a blockquote.
+-
+
- List item 1 +
- List item 2 +
+ ↩ +
+
+
See the code example + 1 + .
+ + """, + DocsHtml.Body() + ); } public class FootnotesConsecutiveDefinitionsTests() : InlineTest( @@ -167,20 +217,7 @@ public class FootnotesConsecutiveDefinitionsTests() : InlineTest( ) { [Test] - public void HandlesConsecutiveFootnoteDefinitions() - { - Html.Should().Contain("First footnote."); - Html.Should().Contain("Second footnote."); - Html.Should().Contain("Third footnote."); - } - - [Test] - public void AllFootnoteReferencesAreLinked() - { - Html.Should().Contain("href=\"#fn:1\""); - Html.Should().Contain("href=\"#fn:2\""); - Html.Should().Contain("href=\"#fn:3\""); - } + public void GeneratesHtml() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body()); } public class FootnotesInListTests() : InlineTest( @@ -194,11 +231,29 @@ public class FootnotesInListTests() : InlineTest( ) { [Test] - public void FootnoteWorksInListItem() - { - Html.Should().Contain("href=\"#fn:1\""); - Html.Should().Contain("Footnote from list item."); - } + public void FootnoteWorksInListItem() => + Html.Should().MatchInlineHtmlSnapshot( + """ +-
+
- Item one +
- Item two with footnote + 1 + + +
Named reference + 1 + .
+ + """, + DocsHtml.Body() + ); } public partial class FootnotesInlineCodeNotParsedTests() : InlineTest( @@ -228,11 +297,28 @@ public partial class FootnotesInlineCodeNotParsedTests() : InlineTest( ) { [Test] - public void InlineCodeFootnoteSyntaxNotParsed() - { - // The inline code `[^1]` should render as code, not as a footnote reference - Html.Should().Contain("[^1]");
- }
+ // The inline code `[^1]` should render as code, not as a footnote reference
+ public void InlineCodeFootnoteSyntaxNotParsed() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+ Real reference
+ 1
+ . Inline code example:
+ [^1]
+ should not be parsed.
Real reference + 1 + .
+
+
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
public void OnlyOneBackReference()
@@ -304,7 +416,7 @@ public partial class FootnotesCodeBlockInDirectiveTests() : InlineTest(
)
{
[Test]
- public void CodeBlockRendered() => Html.Should().Contain("language-markdown");
+ public void CodeBlockRendered() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body());
[Test]
public void CorrectBackReferenceCount()
@@ -347,26 +459,8 @@ public class FootnotesInsideDirectiveTests() : InlineTest(
)
{
[Test]
- public void OtherInlineElementsWorkInsideDirectives()
- {
- // Do other inline elements work?
- Html.Should().Contain("bold");
- Html.Should().Contain("href=\"https://example.com\"");
- }
-
- [Test]
- public void FootnoteReferencesWorkInsideDirectives()
- {
- // Footnote REFERENCES work inside directives
- Html.Should().Contain("footnote-ref");
- Html.Should().Contain("href=\"#fn:1\"");
- }
-
- [Test]
- public void FootnoteDefinitionsAreAtDocumentLevel()
- {
- // Footnote DEFINITIONS are rendered at the document level
- Html.Should().Contain("
+
+
+ Code block with [^1] reference.
+
+
+ ");
- Html.Should().Contain("Footnote definitions must be at the document level");
- }
+ // Do other inline elements work?
+ // Footnote REFERENCES work inside directives
+ // Footnote DEFINITIONS are rendered at the document level
+ public void GeneratesHtml() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body());
}
diff --git a/tests/Elastic.Markdown.Tests/Inline/HardBreakTests.cs b/tests/Elastic.Markdown.Tests/Inline/HardBreakTests.cs
index 506d6aea65..4b2882bb60 100644
--- a/tests/Elastic.Markdown.Tests/Inline/HardBreakTests.cs
+++ b/tests/Elastic.Markdown.Tests/Inline/HardBreakTests.cs
@@ -2,23 +2,27 @@
// Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
// See the LICENSE file in the project root for more information
+using AwesomeAssertions;
+using Elastic.Documentation.Testing;
+using Nullean.Snapshots.Html;
+
namespace Elastic.Markdown.Tests.Inline;
public class AllowBrTagTest() : InlineTest("Hello,
World!") { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml("
World
!") { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml("
+ """,
+ DocsHtml.Body()
+ );
}
diff --git a/tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs b/tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs
index daf95f63f6..d9863d7d55 100644
--- a/tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs
+++ b/tests/Elastic.Markdown.Tests/Inline/InlineAnchorTests.cs
@@ -4,10 +4,13 @@
using System.IO.Abstractions.TestingHelpers;
using AwesomeAssertions;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.Myst.InlineParsers;
using JetBrains.Annotations;
using Markdig.Syntax;
using Markdig.Syntax.Inlines;
+using Nullean.Snapshots;
+using Nullean.Snapshots.Html;
namespace Elastic.Markdown.Tests.Inline;
@@ -27,8 +30,9 @@ public void ParsesBlock()
[Test]
public void GeneratesAttributesInHtml() =>
- Html.ShouldContainHtml(
- """World!") { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml("
Hello,
World!
Hello,
World!
World
!") { [Test] - public void GeneratesHtml() => Html.ShouldContainHtml("
Hello,<br >World<br />!
"); + public void GeneratesHtml() => Html.Should().MatchInlineHtmlSnapshot("Hello,<br >World<br />!
", DocsHtml.Body()); } public class DisallowSpanTag() : InlineTest("Hello,World!") { [Test] // span tag is rendered as text - public void GeneratesHtml() => Html.ShouldContainHtml("Hello,<span>World!</span>
"); + public void GeneratesHtml() => Html.Should().MatchInlineHtmlSnapshot("Hello,<span>World!</span>
", DocsHtml.Body()); } diff --git a/tests/Elastic.Markdown.Tests/Inline/IconParserTests.cs b/tests/Elastic.Markdown.Tests/Inline/IconParserTests.cs index e729a80290..51ee2fd8d2 100644 --- a/tests/Elastic.Markdown.Tests/Inline/IconParserTests.cs +++ b/tests/Elastic.Markdown.Tests/Inline/IconParserTests.cs @@ -3,6 +3,8 @@ // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -19,25 +21,32 @@ An unknown icon {icon}`not_a_real_icon` should not be replaced. { [Test] public void Render() => - Html - .Should() - .Contain("") - .And - .Contain("") - .And - .Contain("") - .And - .NotContain("{icon}`check`") - .And - .NotContain("{icon}`cross`") - .And - .NotContain("{icon}`warning`") - .And - .Contain("/this:apm_trace:is:not:an:icon") - .And - .Contain(":invalid-icon:") - .And - .Contain("::"); + Html.Should().MatchInlineHtmlSnapshot( + """ +A check mark + + + . A cross + + + . A warning + + + .
+An unknown icon + + should not be replaced. This should not be an icon either/this:apm_trace:is:not:an:icon. Nor should this be an icon :invalid-icon:. An empty one is not an icon either ::.
+ """, + DocsHtml.Body() + ); } public class IconInListItemTest() : InlineTest(""" @@ -46,13 +55,20 @@ public class IconInListItemTest() : InlineTest(""" { [Test] public void Render() => - Html - .Should() - .Contain("") - .And - .NotContain("{icon}`check`") - .And - .NotContain(""); + Html.Should().MatchInlineHtmlSnapshot( + """ +-
+
- + + + + A check mark. +
+ Users + + + + +
+this is regular text and this and this continues to be regular text
""" + Html.Should().MatchInlineHtmlSnapshot( + """this is regular text and this and this continues to be regular text
""", + DocsHtml.Body() ); } @@ -49,7 +53,10 @@ public void ParsesBlock() [Test] public void GeneratesAttributesInHtml() => // language=html - Html.Should().Be("""and this continues to be regular text
"""); + Html.Should().MatchInlineHtmlSnapshot( + """and this continues to be regular text
""", + DocsHtml.Body() + ); } [InheritsTests] @@ -67,7 +74,7 @@ public void ParsesBlock() [Test] public void GeneratesAttributesInHtml() => // language=html - Html.ShouldContainHtml(""""""); + Html.Should().MatchInlineHtmlSnapshot("""""", DocsHtml.Body()); } [InheritsTests] @@ -77,8 +84,7 @@ this is regular text and this $$is-an-inline-anchor$$$ { [Test] public void GeneratesAttributesInHtml() => - // language=html - Html.Should().Contain("""this is regular text and this $$is-an-inline-anchor$$$
"""); + Html.Should().MatchInlineHtmlSnapshot("this is regular text and this $$is-an-inline-anchor$$$
", DocsHtml.Body()); } [InheritsTests] @@ -89,7 +95,7 @@ this is regular text and this $$$is-an-inline-anchor$$ [Test] public void GeneratesAttributesInHtml() => // language=html - Html.ShouldContainHtml("""this is regular text and this $$$is-an-inline-anchor$$
"""); + Html.Should().MatchInlineHtmlSnapshot("""this is regular text and this $$$is-an-inline-anchor$$
""", DocsHtml.Body()); } [InheritsTests] @@ -100,11 +106,12 @@ public class InlineAnchorInHeading() : BlockTest
+
+ + Hello world +
+A paragraph
++ Hello +
+ + """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -193,12 +217,26 @@ [Sub Requirements](testing/req.md#custom-anchor) { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ + Hello world +
+A paragraph
++ Sub Requirements +
+ + """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -209,7 +247,7 @@ [Install steps](testing/req.md#install-steps) ) { [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -222,7 +260,11 @@ [Install steps](testing/req.md#install-steps-install-anchor) // The heading renders as id="install-steps"; the inline anchor text is not part of its slug. [Test] public void HasAnError() => - Collector.Diagnostics.Should().ContainSingle().Which.Message.Should().Contain("install-steps-install-anchor"); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot("error {repo}/docs/index.md:7 `install-steps-install-anchor` does not exist in testing/req.md."); } [InheritsTests] @@ -233,5 +275,5 @@ [Install steps](testing/req.md#install-anchor) ) { [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } diff --git a/tests/Elastic.Markdown.Tests/Inline/InlineImageTest.cs b/tests/Elastic.Markdown.Tests/Inline/InlineImageTest.cs index 6bc36625e1..5d6b4f184e 100644 --- a/tests/Elastic.Markdown.Tests/Inline/InlineImageTest.cs +++ b/tests/Elastic.Markdown.Tests/Inline/InlineImageTest.cs @@ -2,7 +2,9 @@ // Elasticsearch B.V licenses this file to you under the Apache 2.0 License. // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; using Markdig.Syntax.Inlines; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -17,7 +19,10 @@ public class InlineImageTest() : InlineTest
+ Elasticsearch +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -58,12 +66,17 @@ public class LinkToPageTests() : LinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ ++ Requirements +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsCrossLink() => Collector.CrossLinks.Should().HaveCount(0); @@ -76,12 +89,17 @@ public class InsertPageTitleTests() : LinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ + + """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsCrossLink() => Collector.CrossLinks.Should().HaveCount(0); @@ -96,12 +114,17 @@ public class RepositoryLinksTest() : LinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ ++ test +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsCrossLink() => Collector.CrossLinks.Should().HaveCount(0); @@ -116,12 +139,13 @@ public class CrossLinkReferenceTest() : LinkTestBase(""" { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """""", + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsCrossLink() @@ -139,13 +163,17 @@ Go to [test](kibana://index.md) { [Test] public void GeneratesHtml() => - // language=html - Html.Should().Contain( - """Go to test
""" + Html.Should().MatchInlineHtmlSnapshot( + """ +Go to + test +
+ """, + DocsHtml.Body() ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsCrossLink() @@ -163,14 +191,24 @@ Go to [](kibana://index.md) { [Test] public void GeneratesHtml() => - // language=html - empty crosslinks now emit an error - Html.Should().Contain( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ + + """, + DocsHtml.Body() ); [Test] public void HasError() => - Collector.Diagnostics.Should().Contain(d => d.Severity == Severity.Error && d.Message.Contains("empty link text")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot( + "error {repo}/docs/index.md:4 Crosslink 'kibana://index.md' has empty link text. Please provide explicit link text." + ); [Test] public void EmitsCrossLink() @@ -188,14 +226,24 @@ Go to [](kibana://get-started/index.md) { [Test] public void GeneratesHtml() => - // language=html - empty crosslinks emit an error; isolated builds get target=_blank - Html.Should().Contain( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """ + + """, + DocsHtml.Body() ); [Test] public void HasError() => - Collector.Diagnostics.Should().Contain(d => d.Severity == Severity.Error && d.Message.Contains("empty link text")); + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot( + "error {repo}/docs/index.md:4 Crosslink 'kibana://get-started/index.md' has empty link text. Please provide explicit link text." + ); [Test] public void EmitsCrossLink() @@ -213,19 +261,14 @@ [global search field]({{this-variable-does-not-exist}}/introduction.html#kibana- ) { [Test] - public void HasErrors() - { - Collector.Diagnostics.Should().HaveCount(1); - Collector.Diagnostics.First().Severity.Should().Be(Severity.Error); + public void HasErrors() => Collector .Diagnostics - .First() - .Message + .ToSnapshotText() .Should() - .Contain( - "he url contains unresolved template expressions: '{{this-variable-does-not-exist}}/introduction.html#kibana-navigation-search'. Please check if there is an appropriate global or frontmatter subs variable." + .MatchInlineSnapshot( + "error {repo}/docs/index.md:3 The url contains unresolved template expressions: '{{this-variable-does-not-exist}}/introduction.html#kibana-navigation-search'. Please check if there is an appropriate global or frontmatter subs variable." ); - } } [InheritsTests] @@ -235,12 +278,13 @@ [link to app]({{some-url-with-a-version}}) { [Test] public void GeneratesHtml() => - Html.ShouldContainHtml( - """""" + Html.Should().MatchInlineHtmlSnapshot( + """""", + DocsHtml.Body() ); [Test] - public void HasNoWarningsOrErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoWarningsOrErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -249,19 +293,14 @@ [link to app]({{some-url-path-prefix}}/hello-world) """) { [Test] - public void HasWarnings() - { - Collector.Diagnostics.Should().HaveCount(1); - Collector.Diagnostics.First().Severity.Should().Be(Severity.Error); + public void HasWarnings() => Collector .Diagnostics - .First() - .Message + .ToSnapshotText() .Should() - .Contain( - "Link is resolved to '/something/hello-world'. Only external links are allowed to be resolved from template expressions." + .MatchInlineSnapshot( + "error {repo}/docs/index.md:3 Link is resolved to '/something/hello-world'. Only external links are allowed to be resolved from template expressions." ); - } } [InheritsTests] @@ -270,10 +309,14 @@ [Non Existing Link](/non-existing.md) """) { [Test] - public void HasErrors() => Collector.Diagnostics.Where(d => d.Severity == Severity.Error).Should().HaveCount(1); - - [Test] - public void HasNoWarning() => Collector.Diagnostics.Where(d => d.Severity == Severity.Warning).Should().HaveCount(0); + public void EmitsDiagnostics() => + Collector + .Diagnostics + .ToSnapshotText() + .Should() + .MatchInlineSnapshot( + "error {repo}/docs/index.md:3 `/non-existing.md` does not exist. If it was recently removed add a redirect. resolved to `{repo}/docs/non-existing.md`" + ); } [InheritsTests] @@ -287,7 +330,7 @@ public void GeneratesHtml() => Html.Should().BeNullOrWhiteSpace(); [Test] - public void HasErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -303,7 +346,7 @@ public class CommentedNonExistingLinks2() : LinkTestBase( { [Test] public void GeneratesHtml() => - Html.ShouldBeHtml( + Html.Should().MatchInlineHtmlSnapshot( """Links:
-
@@ -312,11 +355,12 @@ public void GeneratesHtml() =>
- """
+ """,
+ DocsHtml.Body()
);
[Test]
- public void HasErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
[InheritsTests]
@@ -330,7 +374,18 @@ This is another [Non Existing Link](/non-existing.md)
)
{
[Test]
- public void HasErrors() => Collector.Diagnostics.Should().HaveCount(3);
+ public void HasErrors() =>
+ Collector
+ .Diagnostics
+ .ToSnapshotText()
+ .Should()
+ .MatchInlineSnapshot(
+ """
+ error {repo}/docs/index.md:3 `/non-existing.md` does not exist. If it was recently removed add a redirect. resolved to `{repo}/docs/non-existing.md`
+ error {repo}/docs/index.md:4 `/non-existing.md` does not exist. If it was recently removed add a redirect. resolved to `{repo}/docs/non-existing.md`
+ error {repo}/docs/index.md:5 `/non-existing.md` does not exist. If it was recently removed add a redirect. resolved to `{repo}/docs/non-existing.md`
+ """
+ );
}
[InheritsTests]
@@ -341,10 +396,18 @@ [Install with Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=elasti
)
{
[Test]
- public void GeneratesHtml() => Html.Should().Contain("""href="cursor://""");
+ public void GeneratesHtml() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
[Test]
public void EmitsNoCrossLinks() => Collector.CrossLinks.Should().HaveCount(0);
@@ -356,10 +419,18 @@ [Install VS Code Extension](vscode:extension/elastic.elasticsearch)
""")
{
[Test]
- public void GeneratesHtml() => Html.Should().Contain("""href="vscode:""");
+ public void GeneratesHtml() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
[Test]
public void EmitsNoCrossLinks() => Collector.CrossLinks.Should().HaveCount(0);
@@ -373,10 +444,18 @@ [Install with VS Code Insiders](vscode-insiders:mcp/install?%7B%22name%22%3A%22o
)
{
[Test]
- public void GeneratesHtml() => Html.Should().Contain("""href="vscode-insiders:""");
+ public void GeneratesHtml() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+
- xpack.legacy.example + +
-
+
Example code:
++++++
+xpack.legacy.example: enabled: true ++
+ - ech.explicit.setting + + + +
-
+
+ Supported on: + +
++ + + ECH is explicitly listed as ga.
+
+ - no.applies.to.setting + +
-
+
No applies_to at all — universally available.
+
+ - xpack.sample.versioned + +
-
+
Behavior depends on version:
+-
+
-
+
+
+ + Defaults to + model-a.
+ -
+
+
+ + Defaults to + model-b.
+
+ -
+
+
- i18n.defaultLocale
+
+
+ +
+ -
+
Locale setting planned for a future stack version.
+
+ - xpack.sample.released
+
+
+ +
+ -
+
+ Supported on: + +
++ + + A setting that has been GA since 7.0.
+
+ - xpack.sample.mixed
+
+
+ +
+ -
+
+ Supported on: + +
++ + + GA since an existing version, scheduled for deprecation in a future version.
+
+ - + + A pending task +
- + + A completed task +
- + + A pending task +
- + + A completed task +
- + + A pending task +
- + + A completed task +
+ Install with VS Code Insiders +
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); [Test] public void EmitsNoCrossLinks() => Collector.CrossLinks.Should().HaveCount(0); @@ -413,7 +492,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem) } [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] diff --git a/tests/Elastic.Markdown.Tests/Inline/MathRoleTests.cs b/tests/Elastic.Markdown.Tests/Inline/MathRoleTests.cs index 960a18cb80..344c4f8f37 100644 --- a/tests/Elastic.Markdown.Tests/Inline/MathRoleTests.cs +++ b/tests/Elastic.Markdown.Tests/Inline/MathRoleTests.cs @@ -3,6 +3,8 @@ // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -11,7 +13,15 @@ public class MathRoleTests() : InlineTest(""" """) { [Test] - public void Render() => Html.Should().Contain("E = mc^2").And.NotContain("{math}`E = mc^2`"); + public void Render() => + Html.Should().MatchInlineHtmlSnapshot( + """ +Einstein's famous equation + E = mc^2 + relates energy and mass.
+ """, + DocsHtml.Body() + ); } public class MathRoleEscapesContentTests() : InlineTest(""" @@ -19,5 +29,13 @@ public class MathRoleEscapesContentTests() : InlineTest(""" """) { [Test] - public void Render() => Html.Should().Contain("a < b & b > c"); + public void Render() => + Html.Should().MatchInlineHtmlSnapshot( + """ +Compare + a < b & b > c + for ordering.
+ """, + DocsHtml.Body() + ); } diff --git a/tests/Elastic.Markdown.Tests/Inline/SubstitutionInlineCodeTest.cs b/tests/Elastic.Markdown.Tests/Inline/SubstitutionInlineCodeTest.cs index 4631aac3bc..3df00c0e60 100644 --- a/tests/Elastic.Markdown.Tests/Inline/SubstitutionInlineCodeTest.cs +++ b/tests/Elastic.Markdown.Tests/Inline/SubstitutionInlineCodeTest.cs @@ -3,6 +3,9 @@ // See the LICENSE file in the project root for more information using AwesomeAssertions; +using Elastic.Documentation.Testing; +using Nullean.Snapshots; +using Nullean.Snapshots.Html; namespace Elastic.Markdown.Tests.Inline; @@ -27,17 +30,27 @@ public class SubstitutionInlineCodeTest() : InlineTest( ) { [Test] - public void TestSubstitutionInlineCode() - { - // Check that regular code blocks are not processed - Html.Should().Contain("wget elasticsearch-{{version}}.tar.gz");
-
- // Check that {subs} inline code blocks have substitutions applied
- Html.Should().Contain("wget elasticsearch-8.15.0.tar.gz");
- Html.Should().Contain("export MY_VAR=8.15.0");
- Html.Should().Contain("version 8.15");
- }
+ // Check that regular code blocks are not processed
+ // Check that {subs} inline code blocks have substitutions applied
+ public void TestSubstitutionInlineCode() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+ Regular code:
+ wget elasticsearch-{{version}}.tar.gz
+
Code with substitutions:
+ wget elasticsearch-8.15.0.tar.gz
+
Multiple substitutions:
+ export MY_VAR=8.15.0
+
With mutations:
+ version 8.15
+
The following should be subbed: Hello World! not a comment
", DocsHtml.Body()); } public class NeedsDoubleBrackets() : InlineTest( @@ -42,19 +45,12 @@ not a {substitution} ) { [Test] + // treated as attributes to the block public void PreservesSingleBracket() => - Html - .Should() - .Contain("""Hello World!""") - .And - .Contain("""not a comment""") - .And - .NotContain("""{{hello-world}}""") - .And - .Contain( // treated as attributes to the block - """{substitution}""") - .And - .Contain("""{{valid-key}}"""); + Html.Should().MatchInlineHtmlSnapshot( + "The following should be subbed: Hello World! not a comment not a {{valid-key}} not a {substitution}
", + DocsHtml.Body() + ); } [InheritsTests] @@ -78,7 +74,23 @@ cd elasticsearch-{{version}}/ <2> ) { [Test] - public void ReplacesSubsInCode() => Html.Should().Contain("7.17.0"); + public void ReplacesSubsInCode() => + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ """,
+ DocsHtml.Body()
+ );
}
public class SupportsSubstitutionsFromDocSet() : InlineTest(
@@ -95,15 +107,10 @@ public class SupportsSubstitutionsFromDocSet() : InlineTest(
{
[Test]
public void EmitsGlobalVariable() =>
- Html
- .Should()
- .Contain("Hello World!")
- .And
- .NotContain("{{hello-world}}")
- .And
- .Contain("A variable from docset.yml")
- .And
- .NotContain("{{global-var}}");
+ Html.Should().MatchInlineHtmlSnapshot(
+ "
+
+
+ wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.17.0-linux-x86_64.tar.gz wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.17.0-linux-x86_64.tar.gz.sha512 shasum -a 512 -c elasticsearch-7.17.0-linux-x86_64.tar.gz.sha512
+
+ tar -xzf elasticsearch-7.17.0-linux-x86_64.tar.gz cd elasticsearch-7.17.0/
+
+
+
+ The following should be subbed: Hello World! The following should be subbed as well: A variable from docset.yml
", + DocsHtml.Body() + ); } public class CanNotShadeGlobalVariables() : InlineTest( @@ -123,16 +130,20 @@ public class CanNotShadeGlobalVariables() : InlineTest( { [Test] public void OnlySeesGlobalVariable() => - Html.Should().NotContain("Hello World!").And.NotContain("{{hello-world}}").And.Contain("A variable from docset.yml"); + Html.Should().MatchInlineHtmlSnapshot( + "
The following should be subbed: A variable from docset.yml The following should be subbed as well: A variable from docset.yml
", + DocsHtml.Body() + ); [Test] public void HasError() => Collector .Diagnostics + .ToSnapshotText() .Should() - .HaveCount(1) - .And - .Contain(d => d.Message.Contains("{hello-world} can not be redeclared in front matter as its a global substitution")); + .MatchInlineSnapshot( + "error {repo}/docs/index.md {hello-world} can not be redeclared in front matter as its a global substitution" + ); } public class ReplaceInHeader() : InlineTest( @@ -151,10 +162,19 @@ public class ReplaceInHeader() : InlineTest( { [Test] public void OnlySeesGlobalVariable() => - Html.ShouldContainHtml("""Hello World!
"""); + Html.Should().MatchInlineHtmlSnapshot( + """ +
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
public class ReplaceInImageAlt() : InlineTest(
@@ -171,7 +191,15 @@ public class ReplaceInImageAlt() : InlineTest(
)
{
[Test]
- public void OnlySeesGlobalVariable() => Html.Should().NotContain("alt=\"{{hello-world}}\"").And.Contain("alt=\"Hello World\"");
+ public void OnlySeesGlobalVariable() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+ + Hello World! +
+
+
+
+
+
Version: 9.0 Version with space: 9.0 Major only: 9 Major only with space: 9 Major.x: 9.x Major.x with space: 9.x Increase major: 10.0.0 Increase major with space: 10.0.0 Increase minor: 9.1.0 Increase minor with space: 9.1.0
", + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class MultipleMutationOperatorsTest() : InlineTest( @@ -262,22 +279,15 @@ public class MultipleMutationOperatorsTest() : InlineTest( ) { [Test] - public void MultipleMutationOperatorsWorkWithAndWithoutSpaces() - { - // Both versions with and without spaces should render the same way - Html - .Should() - .Contain("Version: 9.0") - .And - .Contain("Version with spaces: 9.0") - .And - .Contain("Product: ELASTICSEARCH") - .And - .Contain("Product with spaces: ELASTICSEARCH"); - } + // Both versions with and without spaces should render the same way + public void MultipleMutationOperatorsWorkWithAndWithoutSpaces() => + Html.Should().MatchInlineHtmlSnapshot( + "Version: 9.0 Version with spaces: 9.0 Product: ELASTICSEARCH Product with spaces: ELASTICSEARCH
", + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } public class MutationOperatorsInLinksTest() : InlineTest( @@ -299,26 +309,22 @@ [Link text with mutation and space]({{product | uc}} {{version | M.M}}) ) { [Test] - public void MutationOperatorsWorkInLinks() - { - // Check URL mutations - Html - .Should() - .Contain("href=\"https://www.elastic.co/guide/en/elasticsearch/reference/9.0/index.html\"") - .And - .NotContain("{{version|M.M}}") - .And - .NotContain("{{version | M.M}}"); - - // Check link text mutations - Html.Should().Contain("ELASTICSEARCH 9.0").And.NotContain("{{product|uc}}").And.NotContain("{{version|M.M}}"); - - // Check link text mutations with spaces - Html.Should().Contain("ELASTICSEARCH 9.0").And.NotContain("{{product | uc}}").And.NotContain("{{version | M.M}}"); - } + // Check URL mutations + // Check link text mutations + // Check link text mutations with spaces + public void MutationOperatorsWorkInLinks() => + Html.Should().MatchInlineHtmlSnapshot( + """ ++ Link with mutation operator + Link with mutation operator and space + [Link text with mutation](ELASTICSEARCH 9.0) [Link text with mutation and space](ELASTICSEARCH 9.0)
+ """, + DocsHtml.Body() + ); [Test] - public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0); + public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot(""); } [InheritsTests] @@ -344,16 +350,20 @@ public class MutationOperatorsInCodeBlocksTest() : BlockTest
+
+ """,
+ DocsHtml.Body()
+ );
[Test]
- public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+ public void HasNoErrors() => Collector.Diagnostics.ToSnapshotText().Should().MatchInlineSnapshot("");
}
diff --git a/tests/Elastic.Markdown.Tests/MissingTocFileTests.cs b/tests/Elastic.Markdown.Tests/MissingTocFileTests.cs
index d3393b0b2d..aadd5f114c 100644
--- a/tests/Elastic.Markdown.Tests/MissingTocFileTests.cs
+++ b/tests/Elastic.Markdown.Tests/MissingTocFileTests.cs
@@ -6,7 +6,9 @@
using AwesomeAssertions;
using Elastic.Documentation.Configuration;
using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.IO;
+using Nullean.Snapshots;
namespace Elastic.Markdown.Tests;
@@ -47,10 +49,15 @@ public void TocReferencesMissingFile_DoesNotThrow_AndEmitsClearError()
act.Should().NotThrow("a missing toc file must surface a validation error, not crash the build");
- collector.Errors.Should().BeGreaterThan(0);
collector
.Diagnostics
+ .ToSnapshotText()
.Should()
- .Contain(d => d.Severity == Severity.Error && d.Message.Contains("missing.md") && d.Message.Contains("does not exist"));
+ .MatchInlineSnapshot(
+ """
+ error {repo}/docs/docset.yml Table of contents references 'missing.md' but the file does not exist on disk.
+ error {repo}/docs/docset.yml Documentation set 'test' ({repo}/docs/docset.yml) table of contents has items defined but none could be created
+ """
+ );
}
}
diff --git a/tests/Elastic.Markdown.Tests/RootIndexValidationTests.cs b/tests/Elastic.Markdown.Tests/RootIndexValidationTests.cs
index 5470eac332..3e401cf490 100644
--- a/tests/Elastic.Markdown.Tests/RootIndexValidationTests.cs
+++ b/tests/Elastic.Markdown.Tests/RootIndexValidationTests.cs
@@ -7,7 +7,9 @@
using AwesomeAssertions;
using Elastic.Documentation.Configuration;
using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.IO;
+using Nullean.Snapshots;
namespace Elastic.Markdown.Tests;
@@ -41,8 +43,11 @@ public void InternalRegistry_MissingIndexMd_EmitsError()
var context = new BuildContext(collector, TestHelpers.CreateDocumentationFileSystem(fileSystem), configurationContext);
_ = new DocumentationSet(context, logger, new TestCrossLinkResolver());
- collector.Errors.Should().BeGreaterThan(0);
- collector.Diagnostics.Should().Contain(d => d.Severity == Severity.Error && d.Message.Contains("index.md"));
+ collector
+ .Diagnostics
+ .ToSnapshotText()
+ .Should()
+ .MatchInlineSnapshot("error {repo}/docs/docset.yml Non-public documentation sets require a root index.md file");
}
[Test]
diff --git a/tests/Elastic.Markdown.Tests/Search/DocumentationDocumentSerializationTests.cs b/tests/Elastic.Markdown.Tests/Search/DocumentationDocumentSerializationTests.cs
index d39a0e8e66..7d13103c2f 100644
--- a/tests/Elastic.Markdown.Tests/Search/DocumentationDocumentSerializationTests.cs
+++ b/tests/Elastic.Markdown.Tests/Search/DocumentationDocumentSerializationTests.cs
@@ -10,6 +10,7 @@
using Elastic.Documentation.Search;
using Elastic.Documentation.Search.Contract;
using Elastic.Documentation.Versions;
+using Nullean.Snapshots.Json;
namespace Elastic.Markdown.Tests.Search;
@@ -30,22 +31,37 @@ public void SerializeDocumentWithStackAppliesToProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- // Verify applies_to existing
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- appliesTo.ValueKind.Should().Be(JsonValueKind.Array);
-
- // Verify structure
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(1);
-
- var stackEntry = appliesArray[0];
- stackEntry.GetProperty("type").GetString().Should().Be("stack");
- stackEntry.GetProperty("sub_type").GetString().Should().Be("stack");
- stackEntry.GetProperty("lifecycle").GetString().Should().Be("ga");
- stackEntry.GetProperty("version").GetString().Should().Be("all");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "stack",
+ "sub_type": "stack",
+ "lifecycle": "ga",
+ "version": "all"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Test Page",
+ "search_title": "Test Page",
+ "content_type": "doc",
+ "path": "/test/page",
+ "url": "/test/page",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -68,26 +84,43 @@ public void SerializeDocumentWithDeploymentAppliesToProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(2);
-
- // Verify ESS entry
- var essEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "ess");
- essEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- essEntry.GetProperty("type").GetString().Should().Be("deployment");
- essEntry.GetProperty("lifecycle").GetString().Should().Be("ga");
- essEntry.GetProperty("version").GetString().Should().Be("all");
-
- // Verify ECE entry
- var eceEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "ece");
- eceEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- eceEntry.GetProperty("type").GetString().Should().Be("deployment");
- eceEntry.GetProperty("lifecycle").GetString().Should().Be("beta");
- eceEntry.GetProperty("version").GetString().Should().Be("3.5+");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "deployment",
+ "sub_type": "ece",
+ "lifecycle": "beta",
+ "version": "3.5+"
+ },
+ {
+ "type": "deployment",
+ "sub_type": "ess",
+ "lifecycle": "ga",
+ "version": "all"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Deployment Test",
+ "search_title": "Deployment Test",
+ "content_type": "doc",
+ "path": "/test/deployment",
+ "url": "/test/deployment",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -115,33 +148,49 @@ public void SerializeDocumentWithServerlessAppliesToProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(3);
-
- // Verify elasticsearch entry
- var esEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "elasticsearch");
- esEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- esEntry.GetProperty("type").GetString().Should().Be("serverless");
- esEntry.GetProperty("lifecycle").GetString().Should().Be("ga");
- esEntry.GetProperty("version").GetString().Should().Be("8.0+");
-
- // Verify security entry
- var secEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "security");
- secEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- secEntry.GetProperty("type").GetString().Should().Be("serverless");
- secEntry.GetProperty("lifecycle").GetString().Should().Be("preview");
- secEntry.GetProperty("version").GetString().Should().Be("1.0+");
-
- // Verify Vector Database entry
- var vectorDatabaseEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "vectordb");
- vectorDatabaseEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- vectorDatabaseEntry.GetProperty("type").GetString().Should().Be("serverless");
- vectorDatabaseEntry.GetProperty("lifecycle").GetString().Should().Be("ga");
- vectorDatabaseEntry.GetProperty("version").GetString().Should().Be("all");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "serverless",
+ "sub_type": "elasticsearch",
+ "lifecycle": "ga",
+ "version": "8.0+"
+ },
+ {
+ "type": "serverless",
+ "sub_type": "security",
+ "lifecycle": "preview",
+ "version": "1.0+"
+ },
+ {
+ "type": "serverless",
+ "sub_type": "vectordb",
+ "lifecycle": "ga",
+ "version": "all"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Serverless Test",
+ "search_title": "Serverless Test",
+ "content_type": "doc",
+ "path": "/test/serverless",
+ "url": "/test/serverless",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -160,18 +209,37 @@ public void SerializeDocumentWithProductAppliesToProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(1);
-
- var productEntry = appliesArray[0];
- productEntry.GetProperty("type").GetString().Should().Be("product");
- productEntry.GetProperty("sub_type").GetString().Should().Be("product");
- productEntry.GetProperty("lifecycle").GetString().Should().Be("beta");
- productEntry.GetProperty("version").GetString().Should().Be("2.0+");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "product",
+ "sub_type": "product",
+ "lifecycle": "beta",
+ "version": "2.0+"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Product Test",
+ "search_title": "Product Test",
+ "content_type": "doc",
+ "path": "/test/product",
+ "url": "/test/product",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -198,26 +266,43 @@ public void SerializeDocumentWithProductApplicabilityProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(2);
-
- // Verify apm-agent-dotnet entry
- var dotnetEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "apm-agent-dotnet");
- dotnetEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- dotnetEntry.GetProperty("type").GetString().Should().Be("product");
- dotnetEntry.GetProperty("lifecycle").GetString().Should().Be("ga");
- dotnetEntry.GetProperty("version").GetString().Should().Be("1.5+");
-
- // Verify apm-agent-node entry
- var nodeEntry = appliesArray.FirstOrDefault(e => e.GetProperty("sub_type").GetString() == "apm-agent-node");
- nodeEntry.ValueKind.Should().NotBe(JsonValueKind.Undefined);
- nodeEntry.GetProperty("type").GetString().Should().Be("product");
- nodeEntry.GetProperty("lifecycle").GetString().Should().Be("deprecated");
- nodeEntry.GetProperty("version").GetString().Should().Be("2.0+");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "product",
+ "sub_type": "apm-agent-dotnet",
+ "lifecycle": "ga",
+ "version": "1.5+"
+ },
+ {
+ "type": "product",
+ "sub_type": "apm-agent-node",
+ "lifecycle": "deprecated",
+ "version": "2.0+"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "APM Test",
+ "search_title": "APM Test",
+ "content_type": "doc",
+ "path": "/test/apm",
+ "url": "/test/apm",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -240,17 +325,49 @@ public void SerializeDocumentWithComplexAppliesToProducesCorrectJson()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(3);
-
- // Verify we have all three types
- appliesArray.Should().Contain(e => e.GetProperty("type").GetString() == "stack");
- appliesArray.Should().Contain(e => e.GetProperty("type").GetString() == "deployment");
- appliesArray.Should().Contain(e => e.GetProperty("type").GetString() == "serverless");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "stack",
+ "sub_type": "stack",
+ "lifecycle": "ga",
+ "version": "8.0+"
+ },
+ {
+ "type": "deployment",
+ "sub_type": "ess",
+ "lifecycle": "ga",
+ "version": "all"
+ },
+ {
+ "type": "serverless",
+ "sub_type": "elasticsearch",
+ "lifecycle": "ga",
+ "version": "all"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Complex Test",
+ "search_title": "Complex Test",
+ "content_type": "doc",
+ "path": "/test/complex",
+ "url": "/test/complex",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -266,18 +383,29 @@ public void SerializeDocumentWithNullAppliesToOmitsField()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- // With default JSON options, null values might be omitted or serialized as null
- // Let's check both possibilities
- if (root.TryGetProperty("applies_to", out var appliesTo))
- appliesTo.ValueKind.Should().Be(JsonValueKind.Null);
- else
- {
- // Field is omitted, which is also acceptable
- true.Should().BeTrue();
- }
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "No Applies Test",
+ "search_title": "No Applies Test",
+ "content_type": "doc",
+ "path": "/test/no-applies",
+ "url": "/test/no-applies",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -293,12 +421,30 @@ public void SerializeDocumentWithEmptyAppliesToProducesEmptyArray()
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- appliesTo.ValueKind.Should().Be(JsonValueKind.Array);
- appliesTo.GetArrayLength().Should().Be(0);
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Empty Applies Test",
+ "search_title": "Empty Applies Test",
+ "content_type": "doc",
+ "path": "/test/empty-applies",
+ "url": "/test/empty-applies",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -411,22 +557,49 @@ public void SerializeDocumentWithMultipleApplicabilitiesPerTypeProducesMultipleA
};
var json = JsonSerializer.Serialize(doc, _options);
- var jsonDoc = JsonDocument.Parse(json);
- var root = jsonDoc.RootElement;
-
- root.TryGetProperty("applies_to", out var appliesTo).Should().BeTrue();
- var appliesArray = appliesTo.EnumerateArray().ToList();
- appliesArray.Should().HaveCount(3);
-
- // All should be stack type
- appliesArray.Should().OnlyContain(e => e.GetProperty("type").GetString() == "stack");
- appliesArray.Should().OnlyContain(e => e.GetProperty("sub_type").GetString() == "stack");
-
- // Verify different lifecycle values
- var lifecycles = appliesArray.Select(e => e.GetProperty("lifecycle").GetString()).ToList();
- lifecycles.Should().Contain("ga");
- lifecycles.Should().Contain("beta");
- lifecycles.Should().Contain("deprecated");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "applies_to": [
+ {
+ "type": "stack",
+ "sub_type": "stack",
+ "lifecycle": "ga",
+ "version": "8.0+"
+ },
+ {
+ "type": "stack",
+ "sub_type": "stack",
+ "lifecycle": "beta",
+ "version": "7.17+"
+ },
+ {
+ "type": "stack",
+ "sub_type": "stack",
+ "lifecycle": "deprecated",
+ "version": "7.0+"
+ }
+ ],
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Multiple Test",
+ "search_title": "Multiple Test",
+ "content_type": "doc",
+ "path": "/test/multiple",
+ "url": "/test/multiple",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -441,13 +614,30 @@ public void SerializeDocument_IncludesSourceUrlAsSnakeCaseKeyword()
};
var json = JsonSerializer.Serialize(doc, _options);
- using var jsonDoc = JsonDocument.Parse(json);
- jsonDoc
- .RootElement
- .GetProperty("source_url")
- .GetString()
- .Should()
- .Be("https://github.com/elastic/docs-content/blob/main/docs/some-page.md");
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "source_url": "https://github.com/elastic/docs-content/blob/main/docs/some-page.md",
+ "title": "Some Page",
+ "search_title": "Some Page",
+ "content_type": "docs",
+ "path": "/docs/some-page",
+ "url": "/docs/some-page",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
[Test]
@@ -456,7 +646,28 @@ public void SerializeDocument_OmitsSourceUrlWhenNull()
var doc = new DocumentationDocument { Path = "/docs/some-page", Title = "Some Page", SearchTitle = "Some Page", SourceUrl = null };
var json = JsonSerializer.Serialize(doc, _options);
- using var jsonDoc = JsonDocument.Parse(json);
- jsonDoc.RootElement.TryGetProperty("source_url", out _).Should().BeFalse();
+ json.Should().MatchInlineJsonSnapshot(
+ """
+ {
+ "content_hash": "",
+ "content_last_updated": "0001-01-01T00:00:00+00:00",
+ "title": "Some Page",
+ "search_title": "Some Page",
+ "content_type": "docs",
+ "path": "/docs/some-page",
+ "url": "/docs/some-page",
+ "hash": "",
+ "batch_index_date": "0001-01-01T00:00:00+00:00",
+ "last_updated": "0001-01-01T00:00:00+00:00",
+ "headings": [],
+ "parents": [],
+ "content_tier": "reference",
+ "navigation": {
+ "depth": 50,
+ "table_of_contents": 50
+ }
+ }
+ """
+ );
}
}
diff --git a/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs b/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs
index f08701fe27..c89d4e4498 100644
--- a/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs
+++ b/tests/Elastic.Markdown.Tests/SettingsInclusion/IncludeTests.cs
@@ -6,8 +6,11 @@
using AwesomeAssertions;
using Elastic.Documentation.Configuration;
using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.Testing;
using Elastic.Markdown.Myst.Directives.Settings;
using Elastic.Markdown.Tests.Directives;
+using Nullean.Snapshots;
+using Nullean.Snapshots.Html;
namespace Elastic.Markdown.Tests.SettingsInclusion;
@@ -43,7 +46,7 @@ public void HasNoErrors()
}
[Test]
- public void IncludesInclusionHtml() => Html.Should().Contain("xpack.encryptedSavedObjects.encryptionKey");
+ public void IncludesInclusionHtml() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body());
}
[InheritsTests]
@@ -104,27 +107,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
}
[Test]
- public void RendersAppliesToAndMetadata()
- {
- Html.Should().Contain("applies-to-popover");
- Html.Should().Contain("settings-supported-on");
- Html.Should().Contain("Datatype:");
- Html.Should().Contain("Default:");
- Html.Should().Contain("Options:");
- }
-
- [Test]
- public void RendersNestedSettingName() => Html.Should().Contain("xpack.actions.customHostSettings[n].url");
-
- [Test]
- public void DotsInSettingNamesAreHyphensInAnchors()
- {
- Html.Should().Contain("id=\"xpack-actions-customhostsettings\"");
- Html.Should().NotContain("id=\"xpack.actions.customhostsettings\"");
- }
-
- [Test]
- public void NestedSettingAnchorIncludesParentPrefix() => Html.Should().Contain("id=\"xpack-actions-customhostsettingsn-url\"");
+ public void GeneratesHtml() => Html.Should().MatchHtmlSnapshot(DocsHtml.Body());
}
[InheritsTests]
@@ -156,11 +139,28 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
}
[Test]
- public void RendersAsFencedCodeBlock()
- {
- Html.Should().Contain("language-yaml");
- Html.Should().NotContain("[source,yaml]");
- }
+ public void RendersAsFencedCodeBlock() =>
+ Html.Should().MatchInlineHtmlSnapshot(
+ """
+
+
+
+ # Install Elasticsearch 9.0 wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-9.0-linux-x86_64.tar.gz # With space in mutation wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-9.0-linux-x86_64.tar.gz
+
+
+ Example
+-
+
Example
+-
+
Example
+-
+
Example
+-
+
Example
+-
+
Example
+-
+
-
+
-
+
-
+