Merge pull request #808 from okb/feature/config-should-invalidate-cache

Include the config hash in the cache key

Author: gep13

src/GitVersionCore.Tests/ExecuteCoreTests.cs

@@ -1,4 +1,5 @@
 using System;
+using System.IO;
 using System.Text;
 
 using GitVersion;
@@ -68,6 +69,53 @@ public void CacheFileIsMissing()
         info.ShouldContain("yml not found", () => info);
     }
 
+
+    [Test]
+    public void ConfigChangeInvalidatesCache()
+    {
+        const string versionCacheFileContent = @"
+Major: 4
+Minor: 10
+Patch: 3
+PreReleaseTag: test.19
+PreReleaseTagWithDash: -test.19
+PreReleaseLabel: test
+PreReleaseNumber: 19
+BuildMetaData: 
+BuildMetaDataPadded: 
+FullBuildMetaData: Branch.feature/test.Sha.dd2a29aff0c948e1bdf3dabbe13e1576e70d5f9f
+MajorMinorPatch: 4.10.3
+SemVer: 4.10.3-test.19
+LegacySemVer: 4.10.3-test19
+LegacySemVerPadded: 4.10.3-test0019
+AssemblySemVer: 4.10.3.0
+FullSemVer: 4.10.3-test.19
+InformationalVersion: 4.10.3-test.19+Branch.feature/test.Sha.dd2a29aff0c948e1bdf3dabbe13e1576e70d5f9f
+BranchName: feature/test
+Sha: dd2a29aff0c948e1bdf3dabbe13e1576e70d5f9f
+NuGetVersionV2: 4.10.3-test0019
+NuGetVersion: 4.10.3-test0019
+CommitsSinceVersionSource: 19
+CommitsSinceVersionSourcePadded: 0019
+CommitDate: 2015-11-10
+";
+
+        var versionAndBranchFinder = new ExecuteCore(fileSystem);
+
+        RepositoryScope(versionAndBranchFinder, (fixture, vv) =>
+        {
+            fileSystem.WriteAllText(vv.FileName, versionCacheFileContent);
+            vv = versionAndBranchFinder.ExecuteGitVersion(null, null, null, null, false, fixture.RepositoryPath, null);
+            vv.AssemblySemVer.ShouldBe("4.10.3.0");
+            
+            var configPath = Path.Combine(fixture.RepositoryPath, "GitVersionConfig.yaml");
+            fileSystem.WriteAllText(configPath, "next-version: 5.0");
+
+            vv = versionAndBranchFinder.ExecuteGitVersion(null, null, null, null, false, fixture.RepositoryPath, null);
+            vv.AssemblySemVer.ShouldBe("5.0.0.0");
+        });
+    }
+
     string RepositoryScope(ExecuteCore executeCore = null, Action<EmptyRepositoryFixture, VersionVariables> fixtureAction = null)
     {
         // Make sure GitVersion doesn't trigger build server mode when we are running the tests

src/GitVersionCore/GitVersionCache.cs

@@ -89,24 +89,32 @@ string GetKey(IRepository repo, string gitDir)
         {
             // Maybe using timestamp in .git/refs directory is enough?
             var ticks = fileSystem.GetLastDirectoryWrite(Path.Combine(gitDir, "refs"));
-            return string.Format("{0}:{1}:{2}:{3}", gitDir, repo.Head.CanonicalName, repo.Head.Tip.Sha, ticks);
+            var configPath = Path.Combine(repo.GetRepositoryDirectory(), "GitVersionConfig.yaml");
+            var configText = fileSystem.Exists(configPath) ? fileSystem.ReadAllText(configPath) : null;
+            var configHash = configText != null ? GetHash(configText) : null;
+            return string.Join(":", gitDir, repo.Head.CanonicalName, repo.Head.Tip.Sha, ticks, configHash);
         }
 
         static string GetCacheFileName(string key, string cacheDir)
         {
-            string cacheKey;
-            using (var sha1 = SHA1.Create())
-            {
-                // Make a shorter key by hashing, to avoid having to long cache filename.
-                cacheKey = BitConverter.ToString(sha1.ComputeHash(Encoding.UTF8.GetBytes(key))).Replace("-", "");
-            }
-            var cacheFileName = string.Concat(Path.Combine(cacheDir, cacheKey), ".yml");
-            return cacheFileName;
+            var cacheKey = GetHash(key);
+            return string.Concat(Path.Combine(cacheDir, cacheKey), ".yml");
         }
 
         static string GetCacheDir(string gitDir)
         {
             return Path.Combine(gitDir, "gitversion_cache");
         }
+
+        static string GetHash(string textToHash)
+        {
+            using (var sha1 = SHA1.Create())
+            {
+                var bytes = Encoding.UTF8.GetBytes(textToHash);
+                var hashedBytes = sha1.ComputeHash(bytes);
+                var hashedString = BitConverter.ToString(hashedBytes);
+                return hashedString.Replace("-", "");
+            }
+        }
     }
 }