Merge pull request #337 from qmfrederik/fixes/gitlab-tags

Fix the GitLab cloud provider, add unit tests

Author: AArnott

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -47,6 +47,15 @@ public class BuildIntegrationTests : RepoTestBase, IClassFixture<MSBuildFixture>
 
     public BuildIntegrationTests(ITestOutputHelper logger)
         : base(logger)
+    {
+        // MSBuildExtensions.LoadMSBuild will be called as part of the base constructor, because this class
+        // implements the IClassFixture<MSBuildFixture> interface. LoadMSBuild will load the MSBuild assemblies.
+        // This must happen _before_ any method that directly references types in the Microsoft.Build namespace has been called.
+        // Net, don't init MSBuild-related fields in the constructor, but in a method that is called by the constructor.
+        this.Init();
+    }
+
+    private void Init()
     {
         int seed = (int)DateTime.Now.Ticks;
         this.random = new Random(seed);
@@ -651,6 +660,53 @@ public async Task BuildNumber_VariousOptions(bool isPublic, VersionOptions.Cloud
         this.AssertStandardProperties(versionOptions, buildResult);
     }
 
+    [Fact]
+    public void GitLab_BuildTag()
+    {
+        // Based on the values defined in https://docs.gitlab.com/ee/ci/variables/#syntax-of-environment-variables-in-job-scripts
+        using (ApplyEnvironmentVariables(
+            CloudBuild.SuppressEnvironment.SetItems(
+                new Dictionary<string, string>()
+                {
+                    { "CI_COMMIT_TAG", "1.0.0" },
+                    { "CI_COMMIT_SHA", "1ecfd275763eff1d6b4844ea3168962458c9f27a" },
+                    { "GITLAB_CI", "true" },
+                    { "SYSTEM_TEAMPROJECTID", string.Empty }
+                })))
+        {
+            var activeCloudBuild = Nerdbank.GitVersioning.CloudBuild.Active;
+            Assert.NotNull(activeCloudBuild);
+            Assert.Null(activeCloudBuild.BuildingBranch);
+            Assert.Equal("refs/tags/1.0.0", activeCloudBuild.BuildingTag);
+            Assert.Equal("1ecfd275763eff1d6b4844ea3168962458c9f27a", activeCloudBuild.GitCommitId);
+            Assert.True(activeCloudBuild.IsApplicable);
+            Assert.False(activeCloudBuild.IsPullRequest);
+        }
+    }
+
+    [Fact]
+    public void GitLab_BuildBranch()
+    {
+        // Based on the values defined in https://docs.gitlab.com/ee/ci/variables/#syntax-of-environment-variables-in-job-scripts
+        using (ApplyEnvironmentVariables(
+            CloudBuild.SuppressEnvironment.SetItems(
+                new Dictionary<string, string>()
+                {
+                    { "CI_COMMIT_REF_NAME", "master" },
+                    { "CI_COMMIT_SHA", "1ecfd275763eff1d6b4844ea3168962458c9f27a" },
+                    { "GITLAB_CI", "true" },
+            })))
+        {
+            var activeCloudBuild = Nerdbank.GitVersioning.CloudBuild.Active;
+            Assert.NotNull(activeCloudBuild);
+            Assert.Equal("refs/heads/master", activeCloudBuild.BuildingBranch);
+            Assert.Null(activeCloudBuild.BuildingTag);
+            Assert.Equal("1ecfd275763eff1d6b4844ea3168962458c9f27a", activeCloudBuild.GitCommitId);
+            Assert.True(activeCloudBuild.IsApplicable);
+            Assert.False(activeCloudBuild.IsPullRequest);
+        }
+    }
+
     [Fact]
     public async Task PublicRelease_RegEx_SatisfiedByCheckedOutBranch()
     {

src/NerdBank.GitVersioning/CloudBuildServices/GitLab.cs

@@ -2,8 +2,6 @@
 {
     using System;
     using System.Collections.Generic;
-    using System.ComponentModel;
-    using System.Diagnostics;
     using System.IO;
 
     /// <summary>
@@ -15,11 +13,15 @@
     /// </remarks>
     internal class GitLab : ICloudBuild
     {
-        public string BuildingBranch => Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME");
+        public string BuildingBranch =>
+            Environment.GetEnvironmentVariable("CI_COMMIT_TAG") == null ? 
+                $"refs/heads/{Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME")}" : null;
 
-        public string BuildingRef => Environment.GetEnvironmentVariable("CI_COMMIT_TAG");
+        public string BuildingRef => this.BuildingBranch ?? this.BuildingTag;
 
-        public string BuildingTag => Environment.GetEnvironmentVariable("CI_COMMIT_TAG");
+        public string BuildingTag =>
+            Environment.GetEnvironmentVariable("CI_COMMIT_TAG") != null ?
+                $"refs/tags/{Environment.GetEnvironmentVariable("CI_COMMIT_TAG")}" : null;
 
         public string GitCommitId => Environment.GetEnvironmentVariable("CI_COMMIT_SHA");