Merge pull request #689 from onovotny/vso-build-name

Enable use of GitVersion variables in the VSO BuildNumber

Author: pascalberger

.gitignore

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

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

@@ -30,13 +30,26 @@ From a TFS build definition, select "Add a Step" and then in the Build category,
 
 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.
 
-The VSO build step updates the build number automatically to the GitVersion number.
+The VSO build step can update your build number with GitVersion variables. See below for details.
+
 
 ## Running inside TFS
 ### Using the GitVersion Variables
 GitVersion passes variables in the form of `GitVersion.*` (Eg: `GitVersion.Major`) to TFS Build and also writes `GITVERSION_*` (Eg: `GITVERSION_MAJOR`) environment variables that are available for any subsequent build step. 
 See [Variables](/more-info/variables/) for an overview of available variables.
 
+
+#### Using GitVersion variables in build name
+To use GitVersion's variables in the build name, just add them in the form `$(GITVERSION_FullSemVer)` into the Build definition's build number string. Then just ensure GitVersion is called with
+`/output buildserver` and it will replace those variables with the calculated version.
+The TFS GitVersion Build Step (above) handles this too, so if you're already using that, there's nothing extra to configure.
+
+If you currently use `$(rev:.r)` in your build number, that won't work correctly if you 
+use GitVersion variables as well due to the delayed expansion of the GitVersion vars. Instead,
+You might be able to use `$(GitVersion_BuildMetaData)` to achieve a similar result.
+See [Variables](/more-info/variables/) for more info on the variables.
+
+
 #### Known limitations
 * Due to [current limitations in TFS2015 On-Prem](https://github.com/Microsoft/vso-agent-tasks/issues/380) it's currently not possible to automatically set the build version in TFS2015 On-Prem. Instead a warning similar to `##[warning]Unable to process logging event:##vso[build.updatebuildnumber 1.0.0-unstable.1` is logged.
 * Due to a know limitation in TFS 2015 On-Prem it's currently not possible to use variables added during build in inputs of subsequent build tasks, since the variables are processed at the beginning of the build. 

src/GitVersionCore.Tests/BuildServers/BuildServerBaseTests.cs

@@ -39,9 +39,9 @@ public override bool CanApplyToCurrentContext()
             throw new NotImplementedException();
         }
 
-        public override string GenerateSetVersionMessage(string versionToUseForBuildNumber)
+        public override string GenerateSetVersionMessage(VersionVariables variables)
         {
-            return versionToUseForBuildNumber;
+            return variables.FullSemVer;
         }
 
         public override string[] GenerateSetParameterMessage(string name, string value)

src/GitVersionCore.Tests/BuildServers/ContinuaCiTests.cs

@@ -1,4 +1,5 @@
 using GitVersion;
+using GitVersionCore.Tests;
 using NUnit.Framework;
 
 [TestFixture]
@@ -9,7 +10,8 @@ public class ContinuaCiTests
     public void GenerateBuildVersion()
     {
         var versionBuilder = new ContinuaCi();
-        var continuaCiVersion = versionBuilder.GenerateSetVersionMessage("0.0.0-Beta4.7");
+        var vars = new TestableVersionVariables(fullSemVer: "0.0.0-Beta4.7");
+        var continuaCiVersion = versionBuilder.GenerateSetVersionMessage(vars);
         Assert.AreEqual("@@continua[setBuildVersion value='0.0.0-Beta4.7']", continuaCiVersion);
     }
 

src/GitVersionCore.Tests/BuildServers/JenkinsMessageGenerationTests.cs

@@ -13,7 +13,8 @@ public class JenkinsMessageGenerationTests
     public void GenerateSetVersionMessageReturnsVersionAsIs_AlthoughThisIsNotUsedByJenkins()
     {
         var j = new Jenkins();
-        j.GenerateSetVersionMessage("0.0.0-Beta4.7").ShouldBe("0.0.0-Beta4.7");
+        var vars = new TestableVersionVariables(fullSemVer: "0.0.0-Beta4.7");
+        j.GenerateSetVersionMessage(vars).ShouldBe("0.0.0-Beta4.7");
     }
 
     [Test]

src/GitVersionCore.Tests/BuildServers/MyGetTests.cs

@@ -1,4 +1,5 @@
 using GitVersion;
+using GitVersionCore.Tests;
 using NUnit.Framework;
 
 [TestFixture]
@@ -8,7 +9,8 @@ public class MyGetTests
     public void Develop_branch()
     {
         var versionBuilder = new MyGet();
-        var message = versionBuilder.GenerateSetVersionMessage("0.0.0-Unstable4");
+        var vars = new TestableVersionVariables(fullSemVer: "0.0.0-Unstable4");
+        var message = versionBuilder.GenerateSetVersionMessage(vars);
         Assert.AreEqual(null, message);
     }
 

src/GitVersionCore.Tests/BuildServers/TeamCityTests.cs

@@ -1,4 +1,5 @@
 using GitVersion;
+using GitVersionCore.Tests;
 using NUnit.Framework;
 
 [TestFixture]
@@ -8,7 +9,8 @@ public class TeamCityTests
     public void Develop_branch()
     {
         var versionBuilder = new TeamCity();
-        var tcVersion = versionBuilder.GenerateSetVersionMessage("0.0.0-Unstable4");
+        var vars = new TestableVersionVariables(fullSemVer: "0.0.0-Unstable4");
+        var tcVersion = versionBuilder.GenerateSetVersionMessage(vars);
         Assert.AreEqual("##teamcity[buildNumber '0.0.0-Unstable4']", tcVersion);
     }
 

src/GitVersionCore.Tests/BuildServers/VsoAgentTests.cs

@@ -1,16 +1,36 @@
-using GitVersion;
+using System;
+using GitVersion;
+using GitVersionCore.Tests;
 using NUnit.Framework;
 using Shouldly;
 
 [TestFixture]
 public class VsoAgentTests
 {
+
+    string key = "BUILD_BUILDNUMBER";
+
+
+    [SetUp]
+    public void SetEnvironmentVariableForTest()
+    {
+        Environment.SetEnvironmentVariable(key, "Some Build_Value $(GitVersion_FullSemVer) 20151310.3 $(UnknownVar) Release", EnvironmentVariableTarget.Process);
+    }
+
+    [TearDown]
+    public void ClearEnvironmentVariableForTest()
+    {
+        Environment.SetEnvironmentVariable(key, null, EnvironmentVariableTarget.Process);
+    }
+
     [Test]
     public void Develop_branch()
     {
         var versionBuilder = new VsoAgent();
-        var vsVersion = versionBuilder.GenerateSetVersionMessage("0.0.0-Unstable4");
-        vsVersion.ShouldBe("##vso[build.updatebuildnumber]0.0.0-Unstable4");
+        var vars = new TestableVersionVariables(fullSemVer: "0.0.0-Unstable4");
+        var vsVersion = versionBuilder.GenerateSetVersionMessage(vars);
+
+        vsVersion.ShouldBe("##vso[build.updatebuildnumber]Some Build_Value 0.0.0-Unstable4 20151310.3 $(UnknownVar) Release");
     }
 
     [Test]

src/GitVersionCore.Tests/GitVersionCore.Tests.csproj

@@ -169,6 +169,7 @@
     <Compile Include="ApprovalTestsConfig.cs" />
     <Compile Include="Fixtures\RepositoryFixtureBase.cs" />
     <Compile Include="SemanticVersionTests.cs" />
+    <Compile Include="TestableVersionVariables.cs" />
     <Compile Include="TestEffectiveConfiguration.cs" />
     <Compile Include="TestFileSystem.cs" />
     <Compile Include="TestStream.cs" />

src/GitVersionCore.Tests/TestableVersionVariables.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace GitVersionCore.Tests
+{
+    using GitVersion;
+    class TestableVersionVariables : VersionVariables
+    {
+        public TestableVersionVariables(string major = "", string minor = "", string patch = "", string buildMetaData = "", string buildMetaDataPadded = "", string fullBuildMetaData = "", string branchName = "", string sha = "", string majorMinorPatch = "", string semVer = "", string legacySemVer = "", string legacySemVerPadded = "", string fullSemVer = "", string assemblySemVer = "", string preReleaseTag = "", string preReleaseTagWithDash = "", string informationalVersion = "", string commitDate = "") : base(major, minor, patch, buildMetaData, buildMetaDataPadded, fullBuildMetaData, branchName, sha, majorMinorPatch, semVer, legacySemVer, legacySemVerPadded, fullSemVer, assemblySemVer, preReleaseTag, preReleaseTagWithDash, informationalVersion, commitDate)
+        {
+        }
+    }
+}