Feature/task disk cache

src/GitVersionCore.Tests/ExecuteCoreTests.cs

@@ -0,0 +1,95 @@
+using System;
+using System.Text;
+
+using GitVersion;
+using GitVersion.Helpers;
+
+using NUnit.Framework;
+
+using Shouldly;
+
+[TestFixture]
+public class ExecuteCoreTests
+{
+    IFileSystem fileSystem;
+
+    [SetUp]
+    public void SetUp()
+    {
+        fileSystem = new FileSystem();
+    }
+
+    [Test]
+    public void CacheFileExistsOnDisk()
+    {
+        const string versionCacheFileContent = @"
+Major: 4
+Minor: 10
+Patch: 3
+PreReleaseTag: test.19
+PreReleaseTagWithDash: -test.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);
+
+        var info = 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");
+        });
+
+        info.ShouldContain("Deserializing version variables from cache file", () => info);
+    }
+
+    [Test]
+    public void CacheFileIsMissing()
+    {
+        var info = RepositoryScope();
+        info.ShouldContain("yml not found", () => info);
+    }
+
+    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
+        Environment.SetEnvironmentVariable("APPVEYOR", null);
+        var infoBuilder = new StringBuilder();
+        Action<string> infoLogger = s => { infoBuilder.AppendLine(s); };
+        executeCore = executeCore ?? new ExecuteCore(fileSystem);
+
+        Logger.SetLoggers(infoLogger, s => { }, s => { });
+
+        using (var fixture = new EmptyRepositoryFixture(new Config()))
+        {
+            fixture.Repository.MakeACommit();
+            var vv = executeCore.ExecuteGitVersion(null, null, null, null, false, fixture.RepositoryPath, null);
+
+            vv.AssemblySemVer.ShouldBe("0.1.0.0");
+            vv.FileName.ShouldNotBeNullOrEmpty();
+
+            if (fixtureAction != null)
+            {
+                fixtureAction(fixture, vv);
+            }
+        }
+
+        return infoBuilder.ToString();
+    }
+}

src/GitVersionCore.Tests/GitVersionCore.Tests.csproj

@@ -72,6 +72,10 @@
       <HintPath>..\packages\Mono.Cecil.0.9.6.1\lib\net45\Mono.Cecil.Rocks.dll</HintPath>
       <Private>True</Private>
     </Reference>
+    <Reference Include="NSubstitute, Version=1.9.2.0, Culture=neutral, PublicKeyToken=92dd2e9066daa5ca, processorArchitecture=MSIL">
+      <HintPath>..\packages\NSubstitute.1.9.2.0\lib\net45\NSubstitute.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="nunit.core, Version=2.6.4.14350, Culture=neutral, PublicKeyToken=96d09a1eb7f44a77, processorArchitecture=MSIL">
       <HintPath>..\packages\NUnitTestAdapter.2.0.0\lib\nunit.core.dll</HintPath>
       <Private>True</Private>
@@ -125,7 +129,6 @@
     <Compile Include="ConfigProviderTests.cs" />
     <Compile Include="Fixtures\LocalRepositoryFixture.cs" />
     <Compile Include="Fixtures\RemoteRepositoryFixture.cs" />
-    <Compile Include="GitDirFinderTests.cs" />
     <Compile Include="Fixtures\BaseGitFlowRepositoryFixture.cs" />
     <Compile Include="GitHelperTests.cs" />
     <Compile Include="GitPreparerTests.cs" />
@@ -175,6 +178,7 @@
     <Compile Include="TestFileSystem.cs" />
     <Compile Include="TestStream.cs" />
     <Compile Include="VariableProviderTests.cs" />
+    <Compile Include="ExecuteCoreTests.cs" />
     <Compile Include="VersionCalculation\BaseVersionCalculatorTests.cs" />
     <Compile Include="VersionCalculation\NextVersionCalculatorTests.cs" />
     <Compile Include="VersionCalculation\Strategies\ConfigNextVersionBaseVersionStrategyTests.cs" />

src/GitVersionCore.Tests/TestFileSystem.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Text;
+
 using GitVersion.Helpers;
 
 public class TestFileSystem : IFileSystem
@@ -35,9 +37,13 @@ public string ReadAllText(string path)
     public void WriteAllText(string file, string fileContents)
     {
         if (fileSystem.ContainsKey(file))
+        {
             fileSystem[file] = fileContents;
+        }
         else
+        {
             fileSystem.Add(file, fileContents);
+        }
     }
 
     public IEnumerable<string> DirectoryGetFiles(string directory, string searchPattern, SearchOption searchOption)
@@ -49,4 +55,24 @@ public Stream OpenWrite(string path)
     {
         return new TestStream(path, this);
     }
+
+    public Stream OpenRead(string path)
+    {
+        if (fileSystem.ContainsKey(path))
+        {
+            var content = fileSystem[path];
+            return new MemoryStream(Encoding.UTF8.GetBytes(content));
+        }
+
+        throw new FileNotFoundException("File not found.", path);
+    }
+
+    public void CreateDirectory(string path)
+    {
+    }
+
+    public long GetLastDirectoryWrite(string path)
+    {
+        return 1;
+    }
 }

src/GitVersionCore.Tests/packages.config

@@ -7,6 +7,7 @@
   <package id="LibGit2Sharp" version="0.21.0.176" targetFramework="net45" />
   <package id="ModuleInit.Fody" version="1.5.8.0" targetFramework="net45" developmentDependency="true" />
   <package id="Mono.Cecil" version="0.9.6.1" targetFramework="net45" />
+  <package id="NSubstitute" version="1.9.2.0" targetFramework="net45" />
   <package id="NUnit" version="2.6.4" targetFramework="net45" />
   <package id="NUnitTestAdapter" version="2.0.0" targetFramework="net45" />
   <package id="Shouldly" version="2.5.0" targetFramework="net45" />

src/GitVersionCore/ExecuteCore.cs

@@ -4,17 +4,25 @@ namespace GitVersion
     using System.Linq;
     using GitVersion.Helpers;
 
-    public static class ExecuteCore
+    using LibGit2Sharp;
+
+    public class ExecuteCore
     {
-        public static VersionVariables ExecuteGitVersion(IFileSystem fileSystem, string targetUrl, string dynamicRepositoryLocation, Authentication authentication, string targetBranch, bool noFetch, string workingDirectory, string commitId)
+        readonly IFileSystem fileSystem;
+        readonly GitVersionCache gitVersionCache;
+
+        public ExecuteCore(IFileSystem fileSystem)
+        {
+            if (fileSystem == null) throw new ArgumentNullException("fileSystem");
+
+            this.fileSystem = fileSystem;
+            gitVersionCache = new GitVersionCache(fileSystem);
+        }
+
+        public VersionVariables ExecuteGitVersion(string targetUrl, string dynamicRepositoryLocation, Authentication authentication, string targetBranch, bool noFetch, string workingDirectory, string commitId)
         {
             // Normalise if we are running on build server
             var gitPreparer = new GitPreparer(targetUrl, dynamicRepositoryLocation, authentication, noFetch, workingDirectory);
-            var applicableBuildServers = BuildServerList.GetApplicableBuildServers();
-            var buildServer = applicableBuildServers.FirstOrDefault();
-
-            gitPreparer.Initialise(buildServer != null, ResolveCurrentBranch(buildServer, targetBranch));
-
             var dotGitDirectory = gitPreparer.GetDotGitDirectory();
             var projectRoot = gitPreparer.GetProjectRootDirectory();
             Logger.WriteInfo(string.Format("Project root is: " + projectRoot));
@@ -23,28 +31,85 @@ public static VersionVariables ExecuteGitVersion(IFileSystem fileSystem, string
                 // TODO Link to wiki article
                 throw new Exception(string.Format("Failed to prepare or find the .git directory in path '{0}'.", workingDirectory));
             }
-            VersionVariables variables;
-            var versionFinder = new GitVersionFinder();
-            var configuration = ConfigurationProvider.Provide(projectRoot, fileSystem);
-
-            using (var repo = RepositoryLoader.GetRepo(dotGitDirectory))
+
+            using (var repo = GetRepository(dotGitDirectory))
             {
-                var gitVersionContext = new GitVersionContext(repo, configuration, commitId: commitId);
-                var semanticVersion = versionFinder.FindVersion(gitVersionContext);
-                variables = VariableProvider.GetVariablesFor(semanticVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);
+                var versionVariables = gitVersionCache.LoadVersionVariablesFromDiskCache(repo, dotGitDirectory);
+                if (versionVariables == null)
+                {
+                    versionVariables = ExecuteInternal(targetBranch, commitId, repo, gitPreparer, projectRoot);
+                    gitVersionCache.WriteVariablesToDiskCache(repo, dotGitDirectory, versionVariables);
+                }
+
+                return versionVariables;
             }
+        }
 
-            return variables;
+        public bool TryGetVersion(string directory, out VersionVariables versionVariables, bool noFetch, Authentication authentication)
+        {
+            try
+            {
+                versionVariables = ExecuteGitVersion(null, null, authentication, null, noFetch, directory, null);
+                return true;
+            }
+            catch (Exception ex)
+            {
+                Logger.WriteWarning("Could not determine assembly version: " + ex);
+                versionVariables = null;
+                return false;
+            }
         }
 
-        private static string ResolveCurrentBranch(IBuildServer buildServer, string targetBranch)
+        static string ResolveCurrentBranch(IBuildServer buildServer, string targetBranch)
         {
-            if (buildServer == null) return targetBranch;
+            if (buildServer == null)
+            {
+                return targetBranch;
+            }
 
             var currentBranch = buildServer.GetCurrentBranch() ?? targetBranch;
             Logger.WriteInfo("Branch from build environment: " + currentBranch);
 
             return currentBranch;
         }
+
+        VersionVariables ExecuteInternal(string targetBranch, string commitId, IRepository repo, GitPreparer gitPreparer, string projectRoot)
+        {
+            var applicableBuildServers = BuildServerList.GetApplicableBuildServers();
+            var buildServer = applicableBuildServers.FirstOrDefault();
+
+            gitPreparer.Initialise(buildServer != null, ResolveCurrentBranch(buildServer, targetBranch));
+
+            var versionFinder = new GitVersionFinder();
+            var configuration = ConfigurationProvider.Provide(projectRoot, fileSystem);
+
+            var gitVersionContext = new GitVersionContext(repo, configuration, commitId : commitId);
+            var semanticVersion = versionFinder.FindVersion(gitVersionContext);
+
+            return VariableProvider.GetVariablesFor(semanticVersion, gitVersionContext.Configuration, gitVersionContext.IsCurrentCommitTagged);
+        }
+
+        IRepository GetRepository(string gitDirectory)
+        {
+            try
+            {
+                var repository = new Repository(gitDirectory);
+
+                var branch = repository.Head;
+                if (branch.Tip == null)
+                {
+                    throw new WarningException("No Tip found. Has repo been initialized?");
+                }
+                return repository;
+            }
+            catch (Exception exception)
+            {
+                if (exception.Message.Contains("LibGit2Sharp.Core.NativeMethods") || exception.Message.Contains("FilePathMarshaler"))
+                {
+                    throw new WarningException("Restart of the process may be required to load an updated version of LibGit2Sharp.");
+                }
+                throw;
+            }
+        }
     }
 }