Enforce _snippets folder rules for includes (#190)

Author: Mpdreamz

docs/source/syntax/_snippets/my_snippet.md renamed to docs/source/syntax/_snippets/reusable-snippet.md

@@ -0,0 +1,5 @@
+This snippet is not included anywhere
+
+```{warning}
+This snippet is not included anywhere
+```

docs/source/syntax/_snippets/unused-snippet.md

@@ -12,11 +12,11 @@ If there are portions of content that are relevant to multiple pages, you can in
 ### Syntax
 
 ```markdown
-:::{include} _snippets/my_snippet.md
+:::{include} _snippets/reusable-snippet.md
 :::
 ```
 
-:::{include} _snippets/my_snippet.md
+:::{include} _snippets/reusable-snippet.md
 :::
 
 ### Asciidoc syntax

docs/source/syntax/file_inclusion.md

@@ -19,3 +19,6 @@ public record StaticFile(IFileInfo SourceFile, IDirectoryInfo RootPath)
 
 public record ExcludedFile(IFileInfo SourceFile, IDirectoryInfo RootPath)
 	: DocumentationFile(SourceFile, RootPath);
+
+public record SnippetFile(IFileInfo SourceFile, IDirectoryInfo RootPath)
+	: DocumentationFile(SourceFile, RootPath);

src/Elastic.Markdown/IO/DocumentationFile.cs

@@ -90,6 +90,11 @@ private DocumentationFile CreateMarkDownFile(IFileInfo file, BuildContext contex
 		if (Configuration.Globs.Any(g => g.IsMatch(relativePath)))
 			return new MarkdownFile(file, SourcePath, MarkdownParser, context);
 
+		// we ignore files in folders that start with an underscore
+		if (relativePath.IndexOf("_snippets", StringComparison.Ordinal) >= 0)
+			return new SnippetFile(file, SourcePath);
+
+		// we ignore files in folders that start with an underscore
 		if (relativePath.IndexOf("/_", StringComparison.Ordinal) > 0 || relativePath.StartsWith("_"))
 			return new ExcludedFile(file, SourcePath);
 

src/Elastic.Markdown/IO/DocumentationSet.cs

@@ -71,5 +71,24 @@ private void ExtractInclusionPath(ParserContext context)
 			Found = true;
 		else
 			this.EmitError($"`{IncludePath}` does not exist.");
+
+		// literal includes may point to locations other than `_snippets` since they do not
+		// participate in emitting links
+		if (Literal)
+			return;
+
+		var file = FileSystem.FileInfo.New(IncludePath);
+
+		if (file.Directory != null && file.Directory.FullName.IndexOf("_snippets", StringComparison.Ordinal) < 0)
+		{
+			this.EmitError($"{{include}} only supports including snippets from `_snippet` folders. `{IncludePath}` is not a snippet");
+			Found = false;
+		}
+
+		if (file.FullName == context.Path.FullName)
+		{
+			this.EmitError($"{{include}} cyclical include detected `{IncludePath}` points to itself");
+			Found = false;
+		}
 	}
 }

src/Elastic.Markdown/Myst/Directives/IncludeBlock.cs

@@ -10,15 +10,23 @@
 
 namespace Elastic.Markdown.Tests.DocSet;
 
-public class LinkReferenceTests(ITestOutputHelper output) : NavigationTestsBase(output)
+public class LinkReferenceTests : NavigationTestsBase
 {
+	public LinkReferenceTests(ITestOutputHelper output) : base(output) => Reference = LinkReference.Create(Set);
+
+	private LinkReference Reference { get; }
+
 	[Fact]
-	public void Create()
-	{
-		var reference = LinkReference.Create(Set);
+	public void ShouldNotBeNull() =>
+		Reference.Should().NotBeNull();
 
-		reference.Should().NotBeNull();
-	}
+	[Fact]
+	public void EmitsLinks() =>
+		Reference.Links.Should().NotBeNullOrEmpty();
+
+	[Fact]
+	public void ShouldNotIncludeSnippets() =>
+		Reference.Links.Should().NotContain(l => l.Contains("_snippets/"));
 }
 
 public class GitCheckoutInformationTests(ITestOutputHelper output) : NavigationTestsBase(output)

tests/Elastic.Markdown.Tests/DocSet/LinkReferenceTests.cs

@@ -114,3 +114,70 @@ public void EmitsError()
 			.OnlyContain(d => d.Message.Contains("include requires an argument."));
 	}
 }
+
+public class IncludeNeedsToLiveInSpecialFolder(ITestOutputHelper output) : DirectiveTest<IncludeBlock>(output,
+"""
+```{include} test.md
+```
+"""
+)
+{
+
+	protected override void AddToFileSystem(MockFileSystem fileSystem)
+	{
+		// language=markdown
+		var inclusion = "*Hello world*";
+		fileSystem.AddFile(@"docs/source/test.md", inclusion);
+	}
+
+	[Fact]
+	public void ParsesBlock() => Block.Should().NotBeNull();
+
+	[Fact]
+	public void IncludesNothing() => Html.Should().Be("");
+
+	[Fact]
+	public void EmitsError()
+	{
+		Collector.Diagnostics.Should().NotBeNullOrEmpty().And.HaveCount(1);
+		Collector.Diagnostics.Should().OnlyContain(d => d.Severity == Severity.Error);
+		Collector.Diagnostics.Should()
+			.OnlyContain(d => d.Message.Contains("only supports including snippets from `_snippet` folders."));
+	}
+}
+
+
+public class CanNotIncludeItself(ITestOutputHelper output) : DirectiveTest<IncludeBlock>(output,
+"""
+```{include} _snippets/test.md
+```
+"""
+)
+{
+
+	protected override void AddToFileSystem(MockFileSystem fileSystem)
+	{
+		// language=markdown
+		var inclusion =
+"""
+:::{include} test.md
+:::
+""";
+		fileSystem.AddFile(@"docs/source/_snippets/test.md", inclusion);
+	}
+
+	[Fact]
+	public void ParsesBlock() => Block.Should().NotBeNull();
+
+	[Fact]
+	public void IncludesNothing() => Html.Should().Be("");
+
+	[Fact]
+	public void EmitsError()
+	{
+		Collector.Diagnostics.Should().NotBeNullOrEmpty().And.HaveCount(1);
+		Collector.Diagnostics.Should().OnlyContain(d => d.Severity == Severity.Error);
+		Collector.Diagnostics.Should()
+			.OnlyContain(d => d.Message.Contains("cyclical include detected"));
+	}
+}