Added VariableDocumentationIsUpToDate test

Author: asbjornu

src/GitVersionCore.Tests/DocumentationTests.cs

@@ -0,0 +1,64 @@
+using System;
+using System.IO;
+using System.Linq;
+
+using GitVersion;
+
+using NUnit.Framework;
+
+using Shouldly;
+
+[TestFixture]
+public class DocumentationTests
+{
+    [Test]
+    public void VariableDocumentationIsUpToDate()
+    {
+        var variableDocumentationFile = ReadDocumentationFile("more-info/variables.md");
+        var variables = VersionVariables.AvailableVariables.ToList();
+
+        variables.ShouldNotBeEmpty();
+
+        foreach (var variable in variables)
+        {
+            variableDocumentationFile.ShouldContain(variable,
+                                                    Environment.NewLine + variableDocumentationFile);
+        }
+    }
+
+
+    static string ReadDocumentationFile(string relativeDocumentationFilePath)
+    {
+        var currentDirectory = new DirectoryInfo(Environment.CurrentDirectory);
+        while (currentDirectory != null)
+        {
+            var docsDirectory = currentDirectory
+                .EnumerateDirectories("docs", SearchOption.TopDirectoryOnly)
+                .FirstOrDefault();
+
+            if (docsDirectory != null)
+            {
+                currentDirectory = docsDirectory;
+                break;
+            }
+
+            currentDirectory = currentDirectory.Parent;
+        }
+
+        if (currentDirectory == null || !currentDirectory.Name.Equals("docs", StringComparison.Ordinal))
+        {
+            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);
+    }
+}

src/GitVersionCore.Tests/GitVersionCore.Tests.csproj

@@ -120,6 +120,7 @@
     <Compile Include="BuildServers\MyGetTests.cs" />
     <Compile Include="BuildServers\VsoAgentTests.cs" />
     <Compile Include="BuildServers\TeamCityTests.cs" />
+    <Compile Include="DocumentationTests.cs" />
     <Compile Include="Fixtures\CommitCountingRepoFixture.cs" />
     <Compile Include="ConfigProviderTests.cs" />
     <Compile Include="Fixtures\LocalRepositoryFixture.cs" />

src/GitVersionCore/OutputVariables/VersionVariables.cs

@@ -3,6 +3,7 @@
     using System.Collections;
     using System.Collections.Generic;
     using System.Linq;
+    using System.Reflection;
 
     public class VersionVariables : IEnumerable<KeyValuePair<string, string>>
     {
@@ -81,8 +82,9 @@ public static IEnumerable<string> AvailableVariables
             get
             {
                 return typeof(VersionVariables)
-                    .GetProperties()
+                    .GetProperties(BindingFlags.Public | BindingFlags.DeclaredOnly | BindingFlags.Instance)
                     .Select(p => p.Name)
+                    .Where(p => p != "AvailableVariables" && p != "Item")
                     .OrderBy(a => a);
             }
         }