Build agent now writes properties to file as environment variable exports

Author: davidkeaveny

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

@@ -1,5 +1,7 @@
 using GitVersion.BuildAgents;
 using GitVersion.Core.Tests.Helpers;
+using GitVersion.Helpers;
+using GitVersion.VersionCalculation;
 using Microsoft.Extensions.DependencyInjection;
 using NUnit.Framework;
 using Shouldly;
@@ -11,22 +13,37 @@ public class BitBucketPipelinesTests : TestBase
 {
     private IEnvironment environment;
     private BitBucketPipelines buildServer;
+    private IServiceProvider sp;
 
     [SetUp]
     public void SetEnvironmentVariableForTest()
     {
-        var sp = ConfigureServices(services => services.AddSingleton<BitBucketPipelines>());
+        this.sp = ConfigureServices(services => services.AddSingleton<BitBucketPipelines>());
         this.environment = sp.GetRequiredService<IEnvironment>();
         this.buildServer = sp.GetRequiredService<BitBucketPipelines>();
 
-        this.environment.SetEnvironmentVariable("BITBUCKET_WORKSPACE", "MyWorkspace");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.EnvironmentVariableName, "MyWorkspace");
+    }
+
+
+    [Test]
+    public void CanNotApplyToCurrentContextWhenEnvironmentVariableNotSet()
+    {
+        // Arrange
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.EnvironmentVariableName, "");
+
+        // Act
+        var result = this.buildServer.CanApplyToCurrentContext();
+
+        // Assert
+        result.ShouldBeFalse();
     }
 
     [Test]
     public void CalculateVersionOnMainBranch()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", "refs/heads/main");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/main");
 
         var vars = new TestableVersionVariables(fullSemVer: "1.2.3");
         var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
@@ -38,7 +55,7 @@ public void CalculateVersionOnMainBranch()
     public void CalculateVersionOnDevelopBranch()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", "refs/heads/develop");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/develop");
 
         var vars = new TestableVersionVariables(fullSemVer: "1.2.3-unstable.4");
         var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
@@ -50,7 +67,7 @@ public void CalculateVersionOnDevelopBranch()
     public void CalculateVersionOnFeatureBranch()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", "refs/heads/feature/my-work");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/feature/my-work");
 
         var vars = new TestableVersionVariables(fullSemVer: "1.2.3-beta.4");
         var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
@@ -62,7 +79,7 @@ public void CalculateVersionOnFeatureBranch()
     public void GetCurrentBranchShouldHandleBranches()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", "refs/heads/feature/my-work");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/feature/my-work");
 
         // Act
         var result = this.buildServer.GetCurrentBranch(false);
@@ -75,8 +92,8 @@ public void GetCurrentBranchShouldHandleBranches()
     public void GetCurrentBranchShouldHandleTags()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", null);
-        this.environment.SetEnvironmentVariable("BITBUCKET_TAG", "refs/heads/tags/1.2.3");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, null);
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.TagEnvironmentVariableName, "refs/heads/tags/1.2.3");
 
         // Act
         var result = this.buildServer.GetCurrentBranch(false);
@@ -89,14 +106,68 @@ public void GetCurrentBranchShouldHandleTags()
     public void GetCurrentBranchShouldHandlePullRequests()
     {
         // Arrange
-        this.environment.SetEnvironmentVariable("BITBUCKET_BRANCH", null);
-        this.environment.SetEnvironmentVariable("BITBUCKET_TAG", null);
-        this.environment.SetEnvironmentVariable("BITBUCKET_PR_ID", "refs/pull/1/merge");
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, null);
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.TagEnvironmentVariableName, null);
+        this.environment.SetEnvironmentVariable(BitBucketPipelines.PullRequestEnvironmentVariableName, "refs/pull/1/merge");
 
         // Act
         var result = this.buildServer.GetCurrentBranch(false);
 
         // Assert
         result.ShouldBeNull();
     }
+
+
+    [Test]
+    public void WriteAllVariablesToTheTextWriter()
+    {
+        var assemblyLocation = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
+        assemblyLocation.ShouldNotBeNull();
+        var f = PathHelper.Combine(assemblyLocation, "gitversion.env");
+
+        try
+        {
+            AssertVariablesAreWrittenToFile(f);
+        }
+        finally
+        {
+            File.Delete(f);
+        }
+    }
+
+    private void AssertVariablesAreWrittenToFile(string file)
+    {
+        var writes = new List<string?>();
+        var semanticVersion = new SemanticVersion
+        {
+            Major = 1,
+            Minor = 2,
+            Patch = 3,
+            PreReleaseTag = "beta1",
+            BuildMetaData = "5"
+        };
+
+        semanticVersion.BuildMetaData.CommitDate = new DateTimeOffset(2022, 4, 6, 16, 10, 59, TimeSpan.FromHours(10));
+        semanticVersion.BuildMetaData.Sha = "f28807e615e9f06aec8a33c87780374e0c1f6fb8";
+
+        var config = new TestEffectiveConfiguration();
+        var variableProvider = this.sp.GetRequiredService<IVariableProvider>();
+
+        var variables = variableProvider.GetVariablesFor(semanticVersion, config, false);
+
+        this.buildServer.WithPropertyFile(file);
+
+        this.buildServer.WriteIntegration(writes.Add, variables);
+
+        writes[1].ShouldBe("1.2.3-beta.1+5");
+
+        File.Exists(file).ShouldBe(true);
+
+        var props = File.ReadAllText(file);
+
+        props.ShouldContain("export GITVERSION_MAJOR=1");
+        props.ShouldContain("export GITVERSION_MINOR=2");
+        props.ShouldContain("export GITVERSION_SHA=f28807e615e9f06aec8a33c87780374e0c1f6fb8");
+        props.ShouldContain("export GITVERSION_COMMITDATE=2022-04-06");
+    }
 }

src/GitVersion.Core/BuildAgents/BitBucketPipelines.cs

@@ -5,22 +5,28 @@ namespace GitVersion.BuildAgents;
 
 public class BitBucketPipelines : BuildAgentBase
 {
-    public BitBucketPipelines(IEnvironment environment, ILog log) : base(environment, log)
-    {
-    }
+    public const string EnvironmentVariableName = "BITBUCKET_WORKSPACE";
+    public const string BranchEnvironmentVariableName = "BITBUCKET_BRANCH";
+    public const string TagEnvironmentVariableName = "BITBUCKET_TAG";
+    public const string PullRequestEnvironmentVariableName = "BITBUCKET_PR_ID";
+    private string? file;
+
+    public BitBucketPipelines(IEnvironment environment, ILog log) : base(environment, log) => WithPropertyFile("gitversion.env");
 
-    protected override string EnvironmentVariable => "BITBUCKET_WORKSPACE";
+    protected override string EnvironmentVariable => EnvironmentVariableName;
 
     public override string? GenerateSetVersionMessage(VersionVariables variables) => variables.FullSemVer;
 
+    public void WithPropertyFile(string propertiesFileName) => this.file = propertiesFileName;
+
     public override string[] GenerateSetParameterMessage(string name, string value) => new[]
     {
         $"GITVERSION_{name.ToUpperInvariant()}={value}"
     };
 
     public override string? GetCurrentBranch(bool usingDynamicRepos)
     {
-        var branchName = EvaluateEnvironmentVariable("BITBUCKET_BRANCH");
+        var branchName = EvaluateEnvironmentVariable(BranchEnvironmentVariableName);
         if (branchName != null && branchName.StartsWith("refs/heads/"))
         {
             return branchName;
@@ -29,6 +35,22 @@ public override string[] GenerateSetParameterMessage(string name, string value)
         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}' ... ");
+
+        var exports = variables
+            .Select(variable => $"export GITVERSION_{variable.Key.ToUpperInvariant()}={variable.Value}")
+            .ToList();
+
+        File.WriteAllLines(this.file, exports);
+    }
+
+
     private string? EvaluateEnvironmentVariable(string variableName)
     {
         var branchName = Environment.GetEnvironmentVariable(variableName);