Added test to ensure that mkdocs.yml is up to date.

Author: asbjornu

src/GitVersionCore.Tests/DocumentationTests.cs

@@ -14,6 +14,14 @@
 [TestFixture]
 public class DocumentationTests
 {
+    private DirectoryInfo docsDirectory;
+
+    [OneTimeSetUp]
+    public void OneTimeSetUp()
+    {
+        docsDirectory = GetDocsDirectory();
+    }
+
     [Test]
     public void ConfigurationDocumentationIsUpToDate()
     {
@@ -54,8 +62,44 @@ public void VariableDocumentationIsUpToDate()
         }
     }
 
+    [Test]
+    public void DocumentationIndexIsUpToDate()
+    {
+        var documentationIndexFile = ReadDocumentationFile("../mkdocs.yml");
+        var docsDirectoryPath = new Uri(docsDirectory.FullName, UriKind.Absolute);
+
+        Console.WriteLine(docsDirectoryPath);
+
+        foreach (var markdownFile in docsDirectory.EnumerateFiles("*.md", SearchOption.AllDirectories))
+        {
+            var fullPath = new Uri(markdownFile.FullName, UriKind.Absolute);
+            var relativePath = docsDirectoryPath
+                .MakeRelativeUri(fullPath)
+                .ToString()
+                .Replace("docs/", string.Empty);
+
+            Console.WriteLine(fullPath);
+            Console.WriteLine(relativePath);
+
+            documentationIndexFile.ShouldContain(relativePath, () => string.Format("The file '{0}' is not listed in 'mkdocs.yml'.", relativePath));
+        }
+    }
+
+    private string ReadDocumentationFile(string relativeDocumentationFilePath)
+    {
+        var documentationFilePath = Path.Combine(docsDirectory.FullName, relativeDocumentationFilePath);
+        // Normalize path separators and such.
+        documentationFilePath = new FileInfo(documentationFilePath).FullName;
+
+        if (!File.Exists(documentationFilePath))
+        {
+            throw new FileNotFoundException(string.Format("The documentation file '{0}' couldn't be found.", documentationFilePath), documentationFilePath);
+        }
 
-    static string ReadDocumentationFile(string relativeDocumentationFilePath)
+        return File.ReadAllText(documentationFilePath);
+    }
+
+    private static DirectoryInfo GetDocsDirectory()
     {
         var currentDirectory = new FileInfo(typeof(DocumentationTests).Assembly.Location).Directory;
         while (currentDirectory != null)
@@ -78,15 +122,6 @@ static string ReadDocumentationFile(string relativeDocumentationFilePath)
             throw new DirectoryNotFoundException("Couldn't find the 'docs' directory.");
         }
 
-        var documentationFilePath = Path.Combine(currentDirectory.FullName, relativeDocumentationFilePath);
-        // Normalize path separators and such.
-        documentationFilePath = new FileInfo(documentationFilePath).FullName;
-
-        if (!File.Exists(documentationFilePath))
-        {
-            throw new FileNotFoundException(string.Format("The documentation file '{0}' couldn't be found.", documentationFilePath), documentationFilePath);
-        }
-
-        return File.ReadAllText(documentationFilePath);
+        return currentDirectory;
     }
 }