Add testing dir and update tests

elastic · Dec 19, 2024 · 4cd1158 · 4cd1158
1 parent a81f363
commit 4cd1158
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 13 deletions.
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");
 }