Vso build step

.gitignore

@@ -39,6 +39,7 @@ ForSample/
 *NugetTaskBuild*
 *NugetRefBuild*
 *NugetExeBuild*
+*GitVersionVsoTaskBuild*
 *GemBuild*
 
 # Visual Studio profiler

appveyor.yml

@@ -24,6 +24,10 @@ build_script:
   - cmd: 7z a "GitVersion_%GitVersion_NuGetVersion%.zip" .\build\NuGetCommandLineBuild\Tools\*.*
   - cmd: appveyor PushArtifact "GitVersion_%GitVersion_NuGetVersion%.zip"
 
+  - ps: .\build\Update-GitVersionVsoTaskVersion.ps1 .\build\GitVersionVsoTaskBuild\task.json $env:GitVersion_Major $env:GitVersion_Minor $env:GitVersion_Patch
+  - cmd: 7z a "GitVersionVsoBuildTask_%GitVersion_NuGetVersion%.zip" .\build\GitVersionVsoTaskBuild\*.*
+  - cmd: appveyor PushArtifact "GitVersionVsoBuildTask_%GitVersion_NuGetVersion%.zip"
+
 test_script:
   - nunit-console "src\GitVersionTask.Tests\bin\%CONFIGURATION%\GitVersionTask.Tests.dll" "src\GitVersionExe.Tests\bin\%CONFIGURATION%\GitVersionExe.Tests.dll" "src\GitVersionCore.Tests\bin\%CONFIGURATION%\GitVersionCore.Tests.dll" /noshadow
 

build/Update-GitVersionVsoTaskVersion.ps1

@@ -0,0 +1,17 @@
+param (
+[string] $filePath,
+[string] $major,
+[string] $minor,
+[string] $patch
+)
+
+# Get the task.json as a powershell object
+$task = Get-Content -Raw -Path $filePath | ConvertFrom-Json
+
+$task.version.Major = $major
+$task.version.Minor = $minor
+$task.version.Patch = $patch
+
+# get this as a string again
+
+ConvertTo-Json $task | Set-Content -Path $filePath

docs/more-info/build-server-setup/tfs-build-vnext.md

@@ -0,0 +1,25 @@
+# Visual Studio Online (Build vNext) Setup
+## Basic Usage
+In [Visual Studio Online](https://www.visualstudio.com/) build vNext (the web based build system) you can add GitVersion as a Build Step. This requires a one-time setup to import the GitVersion task into your VSO instance.
+
+## Installing/updating the VSO Build Step
+1. Install the `tfx` command line tool as shown [here](https://github.com/Microsoft/tfs-cli/blob/master/docs/buildtasks.md)
+2. Download the GitVersion VSO extension from the latest release on the [GitVersion releases page](https://github.com/GitTools/GitVersion/releases) and unzip.
+3. Run `tfx login` if you haven't yet, make sure to use `https://<server>.visualstudio.com/DefaultCollection` as the URL and provide a Personal Access Token
+4. From the directory outside of where you unzipped the task, run `tfx upload .\GitVersionVsoTask` where GitVersionVsoTask is the directory containing the files.
+5. It should successfully install
+
+## Using the GitVersion VSO Build Step
+From a VSO vNext Build Definition, select "Add a Step" and then in the Build category, choose GitVersion and Click Add. You'll probably want to drag the task to be at or near the top to ensure it executes before your other build steps.
+
+If you want the GitVersionTask to update AssemblyInfo files, check the box in the task configuration. For advanced usage, you can pass additional options to the GitVersion exe in the Additional arguments section.
+
+## Using the GitVersion Variables
+GitVersion writes build parameters into VSO, so they will automatically be passed to your build scripts to use. It also writes GITVERSION_* environment variables that are available for any subsequent build step.
+
+
+## Running inside Visual Studio Online
+* We output the individual values of the GitVersion version as the build parameter: `GitVersion.*` (Eg: `GitVersion.Major`) if you need access to them in your build script
+
+### NuGet in VSO
+* If you use a command script to build your NuPkg, use `%GITVERSION_NUGETVERSION%` as the version parameter: `nuget.exe pack path\to\my.nuspec -version %GITVERSION_NUGETVERSION%`

src/GitVersionCore.Tests/BuildServers/BuildServerBaseTests.cs

@@ -44,5 +44,10 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         {
             return new string[0];
         }
+
+        public override string GetCurrentBranch()
+        {
+            throw new NotImplementedException();
+        }
     }
 }

src/GitVersionCore.Tests/BuildServers/VsoAgentTests.cs

@@ -0,0 +1,27 @@
+using GitVersion;
+using NUnit.Framework;
+using Shouldly;
+
+[TestFixture]
+public class VsoAgentTests
+{
+    [Test]
+    public void Develop_branch()
+    {
+        var versionBuilder = new VsoAgent();
+        var vsVersion = versionBuilder.GenerateSetVersionMessage("0.0.0-Unstable4");
+        //  Assert.AreEqual("##vso[task.setvariable variable=GitBuildNumber;]0.0.0-Unstable4", vsVersion);
+
+        vsVersion.ShouldBe(null);
+    }
+
+    [Test]
+    public void EscapeValues()
+    {
+        var versionBuilder = new VsoAgent();
+        var vsVersion = versionBuilder.GenerateSetParameterMessage("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
+
+        vsVersion[0].ShouldBe("##vso[task.setvariable variable=GitVersion.Foo;]0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
+    }
+
+}

src/GitVersionCore.Tests/Fixtures/LocalRepositoryFixture.cs

@@ -0,0 +1,9 @@
+using GitVersion;
+using LibGit2Sharp;
+
+public class LocalRepositoryFixture : RepositoryFixtureBase
+{
+    public LocalRepositoryFixture(Config configuration, IRepository repository) : base(configuration, repository)
+    {
+    }
+}

src/GitVersionCore.Tests/Fixtures/RemoteRepositoryFixture.cs

@@ -1,31 +1,30 @@
 using System;
-
-    using GitVersion;
-    using LibGit2Sharp;
+using GitVersion;
+using LibGit2Sharp;
 
 public class RemoteRepositoryFixture : RepositoryFixtureBase
 {
-    public string LocalRepositoryPath;
-    public IRepository LocalRepository;
-
     public RemoteRepositoryFixture(Func<string, IRepository> builder, Config configuration)
         : base(builder, configuration)
     {
-        CloneRepository();
+        CreateLocalRepository();
     }
 
     public RemoteRepositoryFixture(Config configuration)
         : base(CreateNewRepository, configuration)
     {
-        CloneRepository();
+        CreateLocalRepository();
     }
 
+    public LocalRepositoryFixture LocalRepositoryFixture { get; private set; }
+
+
     /// <summary>
     /// Simulates running on build server
     /// </summary>
     public void InitialiseRepo()
     {
-        new GitPreparer(null, null, new Authentication(), null, false, LocalRepositoryPath).Initialise(true);
+        new GitPreparer(null, null, new Authentication(), null, false, LocalRepositoryFixture.RepositoryPath).Initialise(true, null);
     }
 
     static IRepository CreateNewRepository(string path)
@@ -38,25 +37,14 @@ static IRepository CreateNewRepository(string path)
         return repo;
     }
 
-    void CloneRepository()
+    void CreateLocalRepository()
     {
-        LocalRepositoryPath = PathHelper.GetTempPath();
-        LibGit2Sharp.Repository.Clone(RepositoryPath, LocalRepositoryPath);
-        LocalRepository = new Repository(LocalRepositoryPath);
+        LocalRepositoryFixture = CloneRepository();
     }
 
     public override void Dispose()
     {
-        LocalRepository.Dispose();
-        try
-        {
-            DirectoryHelper.DeleteDirectory(LocalRepositoryPath);
-        }
-        catch (Exception e)
-        {
-            Console.WriteLine("Failed to clean up repository path at {0}. Received exception: {1}", RepositoryPath, e.Message);
-        }
-
+        LocalRepositoryFixture.Dispose();
         base.Dispose();
     }
 }

src/GitVersionCore.Tests/Fixtures/RepositoryFixtureBase.cs

@@ -9,25 +9,29 @@
 public abstract class RepositoryFixtureBase : IDisposable
 {
     Dictionary<string, string> participants = new Dictionary<string, string>();
-    public string RepositoryPath;
-    public IRepository Repository;
     Config configuration;
     StringBuilder diagramBuilder;
 
     protected RepositoryFixtureBase(Func<string, IRepository> repoBuilder, Config configuration)
+        : this(configuration, repoBuilder(PathHelper.GetTempPath()))
+    {
+    }
+
+    protected RepositoryFixtureBase(Config configuration, IRepository repository)
     {
         ConfigurationProvider.ApplyDefaultsTo(configuration);
         diagramBuilder = new StringBuilder();
         diagramBuilder.AppendLine("@startuml");
         this.configuration = configuration;
-        RepositoryPath = PathHelper.GetTempPath();
-        Repository = repoBuilder(RepositoryPath);
+        Repository = repository;
         Repository.Config.Set("user.name", "Test");
         Repository.Config.Set("user.email", "[email protected]");
         IsForTrackedBranchOnly = true;
     }
 
     public bool IsForTrackedBranchOnly { private get; set; }
+    public IRepository Repository { get; private set; }
+    public string RepositoryPath { get { return Repository.Info.WorkingDirectory.TrimEnd('\\'); } }
 
     public void Checkout(string branch)
     {
@@ -190,4 +194,11 @@ public virtual void Dispose()
         Trace.WriteLine(string.Empty);
         Trace.WriteLine(diagramBuilder.ToString());
     }
+
+    public LocalRepositoryFixture CloneRepository(Config config = null)
+    {
+        var localPath = PathHelper.GetTempPath();
+        LibGit2Sharp.Repository.Clone(RepositoryPath, localPath);
+        return new LocalRepositoryFixture(config ?? new Config(), new Repository(localPath));
+    }
 }

src/GitVersionCore.Tests/GitHelperTests.cs

@@ -0,0 +1,75 @@
+namespace GitVersionCore.Tests
+{
+    using GitVersion;
+    using LibGit2Sharp;
+    using NUnit.Framework;
+    using Shouldly;
+
+    public class GitHelperTests
+    {
+        [Test]
+        public void NormalisationOfPullRequestsWithFetch()
+        {
+            using (var fixture = new EmptyRepositoryFixture(new Config()))
+            {
+                fixture.Repository.MakeACommit();
+
+                fixture.Repository.CreateBranch("feature/foo").Checkout();
+                fixture.Repository.MakeACommit();
+                var commit = fixture.Repository.CreatePullRequestRef("feature/foo", "master", prNumber: 3);
+                using (var localFixture = fixture.CloneRepository())
+                {
+                    localFixture.Checkout(commit.Sha);
+                    GitHelper.NormalizeGitDirectory(localFixture.RepositoryPath, new Authentication(), noFetch: false, currentBranch: string.Empty);
+
+                    var normalisedPullBranch = localFixture.Repository.FindBranch("pull/3/merge");
+                    normalisedPullBranch.ShouldNotBe(null);
+                }
+            }
+        }
+
+        [Test]
+        public void NormalisationOfPullRequestsWithoutFetch()
+        {
+            using (var fixture = new EmptyRepositoryFixture(new Config()))
+            {
+                fixture.Repository.MakeACommit();
+
+                fixture.Repository.CreateBranch("feature/foo").Checkout();
+                fixture.Repository.MakeACommit();
+                var commit = fixture.Repository.CreatePullRequestRef("feature/foo", "master", prNumber: 3, allowFastFowardMerge: true);
+                using (var localFixture = fixture.CloneRepository())
+                {
+                    localFixture.Checkout(commit.Sha);
+                    GitHelper.NormalizeGitDirectory(localFixture.RepositoryPath, new Authentication(), noFetch: true, currentBranch: "refs/pull/3/merge");
+
+                    var normalisedPullBranch = localFixture.Repository.FindBranch("pull/3/merge");
+                    normalisedPullBranch.ShouldNotBe(null);
+                }
+            }
+        }
+
+        [Test]
+        public void UpdatesLocalBranchesWhen()
+        {
+            using (var fixture = new EmptyRepositoryFixture(new Config()))
+            {
+                fixture.Repository.MakeACommit();
+
+                fixture.Repository.CreateBranch("feature/foo").Checkout();
+                fixture.Repository.MakeACommit();
+                using (var localFixture = fixture.CloneRepository())
+                {
+                    localFixture.Checkout("feature/foo");
+                    // Advance remote
+                    var advancedCommit = fixture.Repository.MakeACommit();
+                    GitHelper.NormalizeGitDirectory(localFixture.RepositoryPath, new Authentication(), noFetch: false, currentBranch: null);
+
+                    var normalisedBranch = localFixture.Repository.FindBranch("feature/foo");
+                    normalisedBranch.ShouldNotBe(null);
+                    normalisedBranch.Tip.Sha.ShouldBe(advancedCommit.Sha);
+                }
+            }
+        }
+    }
+}