Written unit tests that show the problems with Jenkins

Author: erik-am

src/GitVersionCore.Tests/BuildServers/EnvironmentVariableJenkinsTests.cs

@@ -9,6 +9,7 @@ public class EnvironmentVariableJenkinsTests
     string key = "JENKINS_URL";
     string branch = "GIT_BRANCH";
     string localBranch = "GIT_LOCAL_BRANCH";
+    string pipelineBranch = "BRANCH_NAME";
 
     private void SetEnvironmentVariableForDetection()
     {
@@ -60,4 +61,28 @@ public void JenkinsTakesLocalBranchNameNotRemoteName()
         Environment.SetEnvironmentVariable(branch, branchOrig);
         Environment.SetEnvironmentVariable(localBranch, localBranchOrig);
     }
+
+    [Test]
+    public void JenkinsTakesBranchNameInPipelineAsCode()
+    {
+        // Save original values so they can be restored
+        string branchOrig = Environment.GetEnvironmentVariable(branch);
+        string localBranchOrig = Environment.GetEnvironmentVariable(localBranch);
+        string pipelineBranchOrig = Environment.GetEnvironmentVariable(pipelineBranch);
+
+        // Set BRANCH_NAME in pipeline mode
+        Environment.SetEnvironmentVariable(pipelineBranch, "master");
+        // When Jenkins uses a Pipeline, GIT_BRANCH and GIT_LOCAL_BRANCH are not set:
+        Environment.SetEnvironmentVariable(branch, null);
+        Environment.SetEnvironmentVariable(localBranch, null);
+
+        // Test Jenkins GetCurrentBranch method now returns BRANCH_NAME
+        var j = new Jenkins();
+        j.GetCurrentBranch(true).ShouldBe("master");
+
+        // Restore environment variables
+        Environment.SetEnvironmentVariable(branch, branchOrig);
+        Environment.SetEnvironmentVariable(localBranch, localBranchOrig);
+        Environment.SetEnvironmentVariable(pipelineBranch, pipelineBranchOrig);
+    }
 }

src/GitVersionExe.Tests/GitVersionExe.Tests.csproj

@@ -114,6 +114,7 @@
     <Compile Include="HelpWriterTests.cs" />
     <Compile Include="JsonOutputOnBuildServer.cs" />
     <Compile Include="MsBuildProjectArgTest.cs" />
+    <Compile Include="PullRequestInJenkinsPipelineTest.cs" />
     <Compile Include="PullRequestInTeamCityTest.cs" />
     <Compile Include="AssemblyInfoFileUpdateTests.cs" />
     <Compile Include="VersionWriterTests.cs" />

src/GitVersionExe.Tests/PullRequestInJenkinsPipelineTest.cs

@@ -0,0 +1,60 @@
+using System;
+using GitTools.Testing;
+using LibGit2Sharp;
+using NUnit.Framework;
+using Shouldly;
+
+[TestFixture]
+public class PullRequestInJenkinsTest
+{
+    [TestCase]
+    public void GivenJenkinsPipelineHasDuplicatedOrigin_VersionIsCalculatedProperly()
+    {
+        string pipelineBranch = "BRANCH_NAME";
+        string pipelineBranchOrig = Environment.GetEnvironmentVariable(pipelineBranch);
+
+        using (var fixture = new EmptyRepositoryFixture())
+        {
+            var remoteRepositoryPath = PathHelper.GetTempPath();
+            Repository.Init(remoteRepositoryPath);
+            using (var remoteRepository = new Repository(remoteRepositoryPath))
+            {
+                remoteRepository.Config.Set("user.name", "Test");
+                remoteRepository.Config.Set("user.email", "[email protected]");
+                fixture.Repository.Network.Remotes.Add("origin", remoteRepositoryPath);
+                // Jenkins Pipeline will create a duplicate origin:
+                fixture.Repository.Network.Remotes.Add("origin1", remoteRepositoryPath);
+                Console.WriteLine("Created git repository at {0}", remoteRepositoryPath);
+                remoteRepository.MakeATaggedCommit("1.0.3");
+
+                var branch = remoteRepository.CreateBranch("FeatureBranch");
+                Commands.Checkout(remoteRepository, branch);
+                remoteRepository.MakeCommits(2);
+                Commands.Checkout(remoteRepository, remoteRepository.Head.Tip.Sha);
+                //Emulate merge commit
+                var mergeCommitSha = remoteRepository.MakeACommit().Sha;
+                Commands.Checkout(remoteRepository, "master"); // HEAD cannot be pointing at the merge commit
+                remoteRepository.Refs.Add("refs/heads/pull/5/head", new ObjectId(mergeCommitSha));
+
+                // Checkout PR commit
+                Commands.Fetch((Repository)fixture.Repository, "origin", new string[0], new FetchOptions(), null);
+                Commands.Checkout(fixture.Repository, mergeCommitSha);
+            }
+
+            // Emulating Jenkins environment variable
+            Environment.SetEnvironmentVariable(pipelineBranch, "PR-5");
+            Environment.SetEnvironmentVariable("JENKINS_URL", "url", EnvironmentVariableTarget.Process);
+
+            var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath);
+            
+            result.ExitCode.ShouldBe(0);
+            result.OutputVariables.FullSemVer.ShouldBe("1.0.4-PullRequest0005.3");
+
+            // Cleanup repository files
+            DirectoryHelper.DeleteDirectory(remoteRepositoryPath);
+
+            Environment.SetEnvironmentVariable(pipelineBranch, pipelineBranchOrig);
+            Environment.SetEnvironmentVariable("JENKINS_URL", null, EnvironmentVariableTarget.Process);
+        }
+    }
+}