align BuildAgentBase implementations

Author: ThomasPiskol

src/GitVersion.Core.Tests/BuildAgents/AzurePipelinesTests.cs

@@ -80,4 +80,43 @@ public void AzurePipelinesBuildNumberWithSemVer(string buildNumberFormat, string
         var logMessage = this.buildServer.GenerateSetVersionMessage(vars);
         logMessage.ShouldBe(logPrefix + expectedBuildNumber);
     }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleBranches()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", $"refs/heads/{MainBranch}");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBe($"refs/heads/{MainBranch}");
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleTags()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", "refs/tags/1.0.0");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandlePullRequests()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("BUILD_SOURCEBRANCH", "refs/pull/1/merge");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
 }

src/GitVersion.Core.Tests/BuildAgents/BuildKiteTests.cs

@@ -72,7 +72,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/pull/55/head");
+        result.ShouldBeNull();
     }
 
     [Test]

src/GitVersion.Core.Tests/BuildAgents/CodeBuildTests.cs

@@ -1,5 +1,6 @@
 using GitVersion.BuildAgents;
 using GitVersion.Core.Tests.Helpers;
+using GitVersion.Helpers;
 using GitVersion.VersionCalculation;
 using Microsoft.Extensions.DependencyInjection;
 using NUnit.Framework;
@@ -54,7 +55,8 @@ public void PicksUpBranchNameFromEnvironmentFromWebHook()
     public void WriteAllVariablesToTheTextWriter()
     {
         var assemblyLocation = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
-        var f = Path.Combine(assemblyLocation, "codebuild_this_file_should_be_deleted.properties");
+        assemblyLocation.ShouldNotBeNull();
+        var f = PathHelper.Combine(assemblyLocation, "codebuild_this_file_should_be_deleted.properties");
 
         try
         {
@@ -68,7 +70,7 @@ public void WriteAllVariablesToTheTextWriter()
 
     private void AssertVariablesAreWrittenToFile(string file)
     {
-        var writes = new List<string>();
+        var writes = new List<string?>();
         var semanticVersion = new SemanticVersion
         {
             Major = 1,
@@ -100,4 +102,30 @@ private void AssertVariablesAreWrittenToFile(string file)
         props.ShouldContain("GitVersion_Major=1");
         props.ShouldContain("GitVersion_Minor=2");
     }
+
+    [Test]
+    public void GetCurrentBranchShouldHandleTags()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("CODEBUILD_WEBHOOK_HEAD_REF", "refs/tags/1.0.0");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
+
+    [Test]
+    public void GetCurrentBranchShouldHandlePullRequests()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable("CODEBUILD_SOURCE_VERSION", "refs/pull/1/merge");
+
+        // Act
+        var result = this.buildServer.GetCurrentBranch(false);
+
+        // Assert
+        result.ShouldBeNull();
+    }
 }

src/GitVersion.Core.Tests/BuildAgents/SpaceAutomationTests.cs

@@ -1,11 +1,10 @@
-using GitVersion;
 using GitVersion.BuildAgents;
 using GitVersion.Core.Tests.Helpers;
 using Microsoft.Extensions.DependencyInjection;
 using NUnit.Framework;
 using Shouldly;
 
-namespace GitVersionCore.Tests.BuildAgents;
+namespace GitVersion.Core.Tests.BuildAgents;
 
 [TestFixture]
 public class SpaceAutomationTests : TestBase
@@ -71,7 +70,7 @@ public void GetCurrentBranchShouldHandleTags()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/tags/1.0.0");
+        result.ShouldBeNull();
     }
 
     [Test]
@@ -84,7 +83,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
-        result.ShouldBe("refs/pull/1/merge");
+        result.ShouldBeNull();
     }
 
     [Test]

src/GitVersion.Core/BuildAgents/AzurePipelines.cs

@@ -21,7 +21,17 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         $"##vso[task.setvariable variable=GitVersion.{name};isOutput=true]{value}"
     };
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("BUILD_SOURCEBRANCH");
+    public override string? GetCurrentBranch(bool usingDynamicRepos)
+    {
+        // https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables
+        // BUILD_SOURCEBRANCH does not contain the branch name if the build was triggered by a tag or pull request.
+        string? branchName = Environment.GetEnvironmentVariable("BUILD_SOURCEBRANCH");
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
+    }
 
     public override bool PreventFetch() => true;
 

src/GitVersion.Core/BuildAgents/BuildKite.cs

@@ -30,9 +30,9 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         }
         else
         {
-            // For pull requests BUILDKITE_BRANCH refers to the head, so adjust the
-            // branch name for pull request versioning to function as expected
-            return string.Format("refs/pull/{0}/head", pullRequest);
+            // To align the behavior with the other BuildAgent implementations
+            // we return here also null.
+            return null;
         }
     }
 

src/GitVersion.Core/BuildAgents/CodeBuild.cs

@@ -25,18 +25,24 @@ public override string[] GenerateSetParameterMessage(string name, string value)
 
     public override string? GetCurrentBranch(bool usingDynamicRepos)
     {
-        var currentBranch = Environment.GetEnvironmentVariable(WebHookEnvironmentVariableName);
-
-        if (currentBranch.IsNullOrEmpty())
+        string? branchName = Environment.GetEnvironmentVariable(WebHookEnvironmentVariableName);
+        if (string.IsNullOrEmpty(branchName))
         {
-            return Environment.GetEnvironmentVariable(SourceVersionEnvironmentVariableName);
+            branchName = Environment.GetEnvironmentVariable(SourceVersionEnvironmentVariableName);
         }
 
-        return currentBranch;
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
     }
 
     public override void WriteIntegration(Action<string?> writer, VersionVariables variables, bool updateBuildNumber = true)
     {
+        if (this.file is null)
+            return;
+
         base.WriteIntegration(writer, variables, updateBuildNumber);
         writer($"Outputting variables to '{this.file}' ... ");
         File.WriteAllLines(this.file, GenerateBuildLogOutput(variables));

src/GitVersion.Core/BuildAgents/SpaceAutomation.cs

@@ -13,7 +13,15 @@ public SpaceAutomation(IEnvironment environment, ILog log) : base(environment, l
 
     protected override string EnvironmentVariable => EnvironmentVariableName;
 
-    public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("JB_SPACE_GIT_BRANCH");
+    public override string? GetCurrentBranch(bool usingDynamicRepos)
+    {
+        string? branchName = Environment.GetEnvironmentVariable("JB_SPACE_GIT_BRANCH");
+        if (branchName != null && branchName.StartsWith("refs/heads/"))
+        {
+            return branchName;
+        }
+        return null;
+    }
 
     public override string[] GenerateSetParameterMessage(string name, string value) => Array.Empty<string>();