Add testing dir and update tests

bmorelli25 · bmorelli25 · commit 4cd11585fc33 · 2024-12-19T09:04:52.000-08:00
diff --git a/docs/source/docset.yml b/docs/source/docset.yml
@@ -41,3 +41,4 @@ toc:
       - file: tabs.md
       - file: tagged_regions.md
       - file: titles.md
+  - folder: testing
diff --git a/docs/source/testing/index.md b/docs/source/testing/index.md
@@ -0,0 +1,5 @@
+---
+title: Testing
+---
+
+The files in this directory are used for testing purposes. Do not edit these files unless you are working on tests.
diff --git a/docs/source/testing/req.md b/docs/source/testing/req.md
@@ -0,0 +1,14 @@
+---
+title: "Requirements"
+---
+
+To follow this tutorial you will need to install the following components:
+
+- An installation of Elasticsearch, based on our hosted [Elastic Cloud](https://www.elastic.co/cloud) service (which includes a free trial period), or a self-hosted service that you run on your own computer. See the Install Elasticsearch section above for installation instructions.
+- A [Python](https://python.org) interpreter. Make sure it is a recent version, such as Python 3.8 or newer.
+
+The tutorial assumes that you have no previous knowledge of Elasticsearch or general search topics, but it expects you to have a basic familiarity with the following technologies, at least at a beginner level:
+
+- Python development
+- The [Flask](https://flask.palletsprojects.com/) web framework for Python.
+- The command prompt or terminal application in your operating system.
diff --git a/tests/Elastic.Markdown.Tests/Inline/AnchorLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/AnchorLinkTests.cs
@@ -34,7 +34,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 
 To follow this tutorial you will need to install the following components:
 """;
-		fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);
+		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
 		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
 	}
 
@@ -59,7 +59,7 @@ public void GeneratesHtml() =>
 
 public class ExternalPageAnchorTests(ITestOutputHelper output) : AnchorLinkTestBase(output,
 """
-[Sub Requirements](elastic/search-labs/search/req.md#sub-requirements)
+[Sub Requirements](testing/req.md#sub-requirements)
 """
 )
 {
@@ -76,7 +76,7 @@ public void GeneratesHtml() =>
 
 public class ExternalPageAnchorAutoTitleTests(ITestOutputHelper output) : AnchorLinkTestBase(output,
 """
-[](elastic/search-labs/search/req.md#sub-requirements)
+[](testing/req.md#sub-requirements)
 """
 )
 {
@@ -112,7 +112,7 @@ public void HasError() => Collector.Diagnostics.Should().HaveCount(1)
 
 public class ExternalPageBadAnchorTests(ITestOutputHelper output) : AnchorLinkTestBase(output,
 """
-[Sub Requirements](elastic/search-labs/search/req.md#sub-requirements2)
+[Sub Requirements](testing/req.md#sub-requirements2)
 """
 )
 {
@@ -127,4 +127,3 @@ public void GeneratesHtml() =>
 	public void HasError() => Collector.Diagnostics.Should().HaveCount(1)
 		.And.Contain(d => d.Message.Contains("`sub-requirements2` does not exist"));
 }
-
diff --git a/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/DirectiveBlockLinkTests.cs
@@ -36,7 +36,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 This is a 'caution' admonition
 ```
 """;
-		fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);
+		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
 		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
 	}
 
@@ -61,7 +61,7 @@ public void GeneratesHtml() =>
 
 public class ExternalDirectiveLinkTests(ITestOutputHelper output) : DirectiveBlockLinkTests(output,
 """
-[Sub Requirements](elastic/search-labs/search/req.md#hint_ref)
+[Sub Requirements](testing/req.md#hint_ref)
 """
 )
 {
@@ -75,4 +75,3 @@ public void GeneratesHtml() =>
 	[Fact]
 	public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
 }
-
diff --git a/tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs b/tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs
@@ -27,7 +27,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)
 
 To follow this tutorial you will need to install the following components:
 """;
-		fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);
+		fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);
 		fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));
 	}
 
@@ -52,7 +52,7 @@ public void GeneratesHtml() =>
 
 public class LinkToPageTests(ITestOutputHelper output) : LinkTestBase(output,
 """
-[Requirements](elastic/search-labs/search/req.md)
+[Requirements](testing/req.md)
 """
 )
 {
@@ -69,7 +69,7 @@ public void GeneratesHtml() =>
 
 public class InsertPageTitleTests(ITestOutputHelper output) : LinkTestBase(output,
 """
-[](elastic/search-labs/search/req.md)
+[](testing/req.md)
 """
 )
 {
diff --git a/tests/Elastic.Markdown.Tests/SiteMap/NavigationTests.cs b/tests/Elastic.Markdown.Tests/SiteMap/NavigationTests.cs
@@ -18,12 +18,12 @@ public void ParsesNestedFoldersAndPrefixesPaths()
 	{
 		Configuration.ImplicitFolders.Should().NotBeNullOrEmpty();
 		Configuration.ImplicitFolders.Should()
-			.Contain("markup")
+			.Conta("markup")
 			.And.Contain("elastic/observability");
 	}
 	[Fact]
 	public void ParsesFilesAndPrefixesPaths() =>
 		Configuration.Files.Should()
 			.Contain("index.md")
-			.And.Contain("elastic/search-labs/search/req.md");
+			.And.Contain("testing/req.md");
 }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +title: Testing
 +---
++
 +The files in this directory are used for testing purposes. Do not edit these files unless you are working on tests.
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)`
`34`	`34`
`35`	`35`	`To follow this tutorial you will need to install the following components:`
`36`	`36`	`""";`
`37`		`- fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);`
	`37`	`+ fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);`
`38`	`38`	`fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));`
`39`	`39`	`}`
`40`	`40`
`@@ -59,7 +59,7 @@ public void GeneratesHtml() =>`
`59`	`59`
`60`	`60`	`public class ExternalPageAnchorTests(ITestOutputHelper output) : AnchorLinkTestBase(output,`
`61`	`61`	`"""`
`62`		`-[Sub Requirements](elastic/search-labs/search/req.md#sub-requirements)`
	`62`	`+[Sub Requirements](testing/req.md#sub-requirements)`
`63`	`63`	`"""`
`64`	`64`	`)`
`65`	`65`	`{`
`@@ -76,7 +76,7 @@ public void GeneratesHtml() =>`
`76`	`76`
`77`	`77`	`public class ExternalPageAnchorAutoTitleTests(ITestOutputHelper output) : AnchorLinkTestBase(output,`
`78`	`78`	`"""`
`79`		`-[](elastic/search-labs/search/req.md#sub-requirements)`
	`79`	`+[](testing/req.md#sub-requirements)`
`80`	`80`	`"""`
`81`	`81`	`)`
`82`	`82`	`{`
`@@ -112,7 +112,7 @@ public void HasError() => Collector.Diagnostics.Should().HaveCount(1)`
`112`	`112`
`113`	`113`	`public class ExternalPageBadAnchorTests(ITestOutputHelper output) : AnchorLinkTestBase(output,`
`114`	`114`	`"""`
`115`		`-[Sub Requirements](elastic/search-labs/search/req.md#sub-requirements2)`
	`115`	`+[Sub Requirements](testing/req.md#sub-requirements2)`
`116`	`116`	`"""`
`117`	`117`	`)`
`118`	`118`	`{`
`@@ -127,4 +127,3 @@ public void GeneratesHtml() =>`
`127`	`127`	`public void HasError() => Collector.Diagnostics.Should().HaveCount(1)`
`128`	`128`	.And.Contain(d => d.Message.Contains("`sub-requirements2` does not exist"));
`129`	`129`	`}`
`130`		`-`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)`
`36`	`36`	`This is a 'caution' admonition`
`37`	`37`	```
`38`	`38`	`""";`
`39`		`- fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);`
	`39`	`+ fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);`
`40`	`40`	`fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));`
`41`	`41`	`}`
`42`	`42`
`@@ -61,7 +61,7 @@ public void GeneratesHtml() =>`
`61`	`61`
`62`	`62`	`public class ExternalDirectiveLinkTests(ITestOutputHelper output) : DirectiveBlockLinkTests(output,`
`63`	`63`	`"""`
`64`		`-[Sub Requirements](elastic/search-labs/search/req.md#hint_ref)`
	`64`	`+[Sub Requirements](testing/req.md#hint_ref)`
`65`	`65`	`"""`
`66`	`66`	`)`
`67`	`67`	`{`
`@@ -75,4 +75,3 @@ public void GeneratesHtml() =>`
`75`	`75`	`[Fact]`
`76`	`76`	`public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);`
`77`	`77`	`}`
`78`		`-`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ protected override void AddToFileSystem(MockFileSystem fileSystem)`
`27`	`27`
`28`	`28`	`To follow this tutorial you will need to install the following components:`
`29`	`29`	`""";`
`30`		`- fileSystem.AddFile(@"docs/source/elastic/search-labs/search/req.md", inclusion);`
	`30`	`+ fileSystem.AddFile(@"docs/source/testing/req.md", inclusion);`
`31`	`31`	`fileSystem.AddFile(@"docs/source/_static/img/observability.png", new MockFileData(""));`
`32`	`32`	`}`
`33`	`33`
`@@ -52,7 +52,7 @@ public void GeneratesHtml() =>`
`52`	`52`
`53`	`53`	`public class LinkToPageTests(ITestOutputHelper output) : LinkTestBase(output,`
`54`	`54`	`"""`
`55`		`-[Requirements](elastic/search-labs/search/req.md)`
	`55`	`+[Requirements](testing/req.md)`
`56`	`56`	`"""`
`57`	`57`	`)`
`58`	`58`	`{`
`@@ -69,7 +69,7 @@ public void GeneratesHtml() =>`
`69`	`69`
`70`	`70`	`public class InsertPageTitleTests(ITestOutputHelper output) : LinkTestBase(output,`
`71`	`71`	`"""`
`72`		`-[](elastic/search-labs/search/req.md)`
	`72`	`+[](testing/req.md)`
`73`	`73`	`"""`
`74`	`74`	`)`
`75`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,12 +18,12 @@ public void ParsesNestedFoldersAndPrefixesPaths()`
`18`	`18`	`{`
`19`	`19`	`Configuration.ImplicitFolders.Should().NotBeNullOrEmpty();`
`20`	`20`	`Configuration.ImplicitFolders.Should()`
`21`		`- .Contain("markup")`
	`21`	`+ .Conta("markup")`
`22`	`22`	`.And.Contain("elastic/observability");`
`23`	`23`	`}`
`24`	`24`	`[Fact]`
`25`	`25`	`public void ParsesFilesAndPrefixesPaths() =>`
`26`	`26`	`Configuration.Files.Should()`
`27`	`27`	`.Contain("index.md")`
`28`		`- .And.Contain("elastic/search-labs/search/req.md");`
	`28`	`+ .And.Contain("testing/req.md");`
`29`	`29`	`}`