Skip to content

Commit 67b3bfe

Browse files
arturcicarturcic
committed
Renamed build agent methods for consistency
Renamed `GenerateSetVersionMessage` to `SetBuildNumber` and `GenerateSetParameterMessage` to `SetOutputVariables` across all build agents. Updated tests and integrations to reflect these changes for clearer method purpose alignment.
1 parent fe6ef74 commit 67b3bfe

29 files changed

+100
-110
lines changed

‎src/GitVersion.BuildAgents.Tests/Agents/AzurePipelinesTests.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ public void SetEnvironmentVariableForTest()
2626
public void ClearEnvironmentVariableForTest() => this.environment.SetEnvironmentVariable(key, null);
2727

2828
[Test]
29-
public void DevelopBranch()
29+
public void ShouldSetBuildNumber()
3030
{
3131
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Unstable4" };
32-
var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
32+
var vsVersion = this.buildServer.SetBuildNumber(vars);
3333

3434
vsVersion.ShouldBe("##vso[build.updatebuildnumber]Some Build_Value 0.0.0-Unstable4 20151310.3 $(UnknownVar) Release");
3535
}
3636

3737
[Test]
38-
public void EscapeValues()
38+
public void ShouldSetOutputVariables()
3939
{
40-
var vsVersion = this.buildServer.GenerateSetParameterMessage("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
40+
var vsVersion = this.buildServer.SetOutputVariables("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
4141

4242
vsVersion.ShouldContain("##vso[task.setvariable variable=GitVersion.Foo]0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
4343
vsVersion.ShouldContain("##vso[task.setvariable variable=GitVersion.Foo;isOutput=true]0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
@@ -50,7 +50,7 @@ public void MissingEnvShouldNotBlowUp()
5050

5151
const string semver = "0.0.0-Unstable4";
5252
var vars = new TestableGitVersionVariables { FullSemVer = semver };
53-
var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
53+
var vsVersion = this.buildServer.SetBuildNumber(vars);
5454
vsVersion.ShouldBe(semver);
5555
}
5656

@@ -62,7 +62,7 @@ public void AzurePipelinesBuildNumberWithFullSemVer(string buildNumberFormat, st
6262
{
6363
this.environment.SetEnvironmentVariable(key, buildNumberFormat);
6464
var vars = new TestableGitVersionVariables { FullSemVer = myFullSemVer };
65-
var logMessage = this.buildServer.GenerateSetVersionMessage(vars);
65+
var logMessage = this.buildServer.SetBuildNumber(vars);
6666
logMessage.ShouldBe(logPrefix + expectedBuildNumber);
6767
}
6868

@@ -74,7 +74,7 @@ public void AzurePipelinesBuildNumberWithSemVer(string buildNumberFormat, string
7474
{
7575
this.environment.SetEnvironmentVariable(key, buildNumberFormat);
7676
var vars = new TestableGitVersionVariables { SemVer = mySemVer };
77-
var logMessage = this.buildServer.GenerateSetVersionMessage(vars);
77+
var logMessage = this.buildServer.SetBuildNumber(vars);
7878
logMessage.ShouldBe(logPrefix + expectedBuildNumber);
7979
}
8080
}

‎src/GitVersion.BuildAgents.Tests/Agents/BitBucketPipelinesTests.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void CalculateVersionOnMainBranch()
4646
this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/main");
4747

4848
var vars = new TestableGitVersionVariables { FullSemVer = "1.2.3" };
49-
var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
49+
var vsVersion = this.buildServer.SetBuildNumber(vars);
5050

5151
vsVersion.ShouldBe("1.2.3");
5252
}
@@ -58,7 +58,7 @@ public void CalculateVersionOnDevelopBranch()
5858
this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/develop");
5959

6060
var vars = new TestableGitVersionVariables { FullSemVer = "1.2.3-unstable.4" };
61-
var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
61+
var vsVersion = this.buildServer.SetBuildNumber(vars);
6262

6363
vsVersion.ShouldBe("1.2.3-unstable.4");
6464
}
@@ -70,7 +70,7 @@ public void CalculateVersionOnFeatureBranch()
7070
this.environment.SetEnvironmentVariable(BitBucketPipelines.BranchEnvironmentVariableName, "refs/heads/feature/my-work");
7171

7272
var vars = new TestableGitVersionVariables { FullSemVer = "1.2.3-beta.4" };
73-
var vsVersion = this.buildServer.GenerateSetVersionMessage(vars);
73+
var vsVersion = this.buildServer.SetBuildNumber(vars);
7474

7575
vsVersion.ShouldBe("1.2.3-beta.4");
7676
}

‎src/GitVersion.BuildAgents.Tests/Agents/BuildKiteTests.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,23 +73,23 @@ public void GetCurrentBranchShouldHandlePullRequests()
7373
}
7474

7575
[Test]
76-
public void GetSetParameterMessageShouldReturnEmptyArray()
76+
public void ShouldSetOutputVariables()
7777
{
7878
// Act
79-
var result = this.buildServer.GenerateSetParameterMessage("Foo", "Bar");
79+
var result = this.buildServer.SetOutputVariables("Foo", "Bar");
8080

8181
// Assert
8282
result.ShouldBeEmpty();
8383
}
8484

8585
[Test]
86-
public void GetEmptyGenerateSetVersionMessage()
86+
public void ShouldSetBuildNumber()
8787
{
8888
// Arrange
8989
var vars = new TestableGitVersionVariables { FullSemVer = "1.0.0" };
9090

9191
// Act
92-
var message = this.buildServer.GenerateSetVersionMessage(vars);
92+
var message = this.buildServer.SetBuildNumber(vars);
9393

9494
// Assert
9595
message.ShouldBeEmpty();

‎src/GitVersion.BuildAgents.Tests/Agents/BuildServerBaseTests.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void BuildNumberIsFullSemVer()
4646

4747
writes = [];
4848
buildAgent.WriteIntegration(writes.Add, variables, false);
49-
writes.ShouldNotContain(x => x != null && x.StartsWith("Executing GenerateSetVersionMessage for "));
49+
writes.ShouldNotContain(x => x != null && x.StartsWith("Set Build Number for "));
5050
}
5151

5252
private class BuildAgent(IEnvironment environment, ILog log, IFileSystem fileSystem) : BuildAgentBase(environment, log, fileSystem)
@@ -55,8 +55,8 @@ private class BuildAgent(IEnvironment environment, ILog log, IFileSystem fileSys
5555

5656
public override bool CanApplyToCurrentContext() => throw new NotImplementedException();
5757

58-
public override string GenerateSetVersionMessage(GitVersionVariables variables) => variables.FullSemVer;
58+
public override string SetBuildNumber(GitVersionVariables variables) => variables.FullSemVer;
5959

60-
public override string[] GenerateSetParameterMessage(string name, string? value) => [];
60+
public override string[] SetOutputVariables(string name, string? value) => [];
6161
}
6262
}

‎src/GitVersion.BuildAgents.Tests/Agents/ContinuaCiTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ public class ContinuaCiTests : TestBase
1212
public void SetUp() => this.sp = ConfigureServices(services => services.AddSingleton<ContinuaCi>());
1313

1414
[Test]
15-
public void GenerateBuildVersion()
15+
public void ShouldSetBuildNumber()
1616
{
1717
var buildServer = this.sp.GetRequiredService<ContinuaCi>();
1818
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Beta4.7" };
19-
var continuaCiVersion = buildServer.GenerateSetVersionMessage(vars);
19+
var continuaCiVersion = buildServer.SetBuildNumber(vars);
2020
Assert.That(continuaCiVersion, Is.EqualTo("@@continua[setBuildVersion value='0.0.0-Beta4.7']"));
2121
}
2222
}

‎src/GitVersion.BuildAgents.Tests/Agents/EnvRunTests.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,18 @@ public void CanApplyToCurrentContextEnvironmentVariableNotSet()
5252

5353
[TestCase("1.2.3")]
5454
[TestCase("1.2.3-rc4")]
55-
public void GenerateSetVersionMessage(string fullSemVer)
55+
public void ShouldSetBuildNumber(string fullSemVer)
5656
{
5757
var vars = new TestableGitVersionVariables { FullSemVer = fullSemVer };
58-
var version = this.buildServer.GenerateSetVersionMessage(vars);
58+
var version = this.buildServer.SetBuildNumber(vars);
5959
version.ShouldBe(fullSemVer);
6060
}
6161

6262
[TestCase("Version", "1.2.3", "@@envrun[set name='GitVersion_Version' value='1.2.3']")]
6363
[TestCase("Version", "1.2.3-rc4", "@@envrun[set name='GitVersion_Version' value='1.2.3-rc4']")]
64-
public void GenerateSetParameterMessage(string name, string? value, string expected)
64+
public void ShouldSetOutputVariables(string name, string? value, string expected)
6565
{
66-
var output = this.buildServer.GenerateSetParameterMessage(name, value);
66+
var output = this.buildServer.SetOutputVariables(name, value);
6767
output.ShouldHaveSingleItem();
6868
output[0].ShouldBe(expected);
6969
}

‎src/GitVersion.BuildAgents.Tests/Agents/GitHubActionsTests.cs

+8-8
Original file line numberDiff line numberDiff line change
@@ -103,23 +103,23 @@ public void GetCurrentBranchShouldHandlePullRequests()
103103
}
104104

105105
[Test]
106-
public void GetSetParameterMessage()
106+
public void ShouldSetOutputVariables()
107107
{
108108
// Assert
109109
this.environment.GetEnvironmentVariable("GitVersion_Something").ShouldBeNullOrWhiteSpace();
110110

111111
// Act
112-
var result = this.buildServer.GenerateSetParameterMessage("GitVersion_Something", "1.0.0");
112+
var result = this.buildServer.SetOutputVariables("GitVersion_Something", "1.0.0");
113113

114114
// Assert
115115
result.ShouldContain(_ => true, 0);
116116
}
117117

118118
[Test]
119-
public void SkipEmptySetParameterMessage()
119+
public void SkipEmptyOutputVariables()
120120
{
121121
// Act
122-
var result = this.buildServer.GenerateSetParameterMessage("Hello", string.Empty);
122+
var result = this.buildServer.SetOutputVariables("Hello", string.Empty);
123123

124124
// Assert
125125
result.ShouldBeEquivalentTo(Array.Empty<string>());
@@ -140,7 +140,7 @@ public void ShouldWriteIntegration()
140140
this.buildServer.WriteIntegration(s => list.Add(s), vars);
141141

142142
// Assert
143-
var expected = new List<string> { "Executing GenerateSetVersionMessage for 'GitHubActions'.", "", "Executing GenerateBuildLogOutput for 'GitHubActions'.", "Writing version variables to $GITHUB_ENV file for 'GitHubActions'." };
143+
var expected = new List<string> { "Set Build Number for 'GitHubActions'.", "", "Set Output Variables for 'GitHubActions'.", "Writing version variables to $GITHUB_ENV file for 'GitHubActions'." };
144144

145145
string.Join(PathHelper.NewLine, list)
146146
.ShouldBe(string.Join(PathHelper.NewLine, expected));
@@ -167,17 +167,17 @@ public void ShouldNotWriteIntegration()
167167
// Act
168168
this.buildServer.WriteIntegration(s => list.Add(s), vars, false);
169169

170-
list.ShouldNotContain(x => x != null && x.StartsWith("Executing GenerateSetVersionMessage for "));
170+
list.ShouldNotContain(x => x != null && x.StartsWith("Set Build Number for "));
171171
}
172172

173173
[Test]
174-
public void GetEmptyGenerateSetVersionMessage()
174+
public void ShouldSetBuildNumber()
175175
{
176176
// Arrange
177177
var vars = new TestableGitVersionVariables { FullSemVer = "1.0.0" };
178178

179179
// Act
180-
var message = this.buildServer.GenerateSetVersionMessage(vars);
180+
var message = this.buildServer.SetBuildNumber(vars);
181181

182182
// Assert
183183
message.ShouldBeEmpty();

‎src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ public void SetUp()
2929
public void TearDown() => this.environment.SetEnvironmentVariable(GitLabCi.EnvironmentVariableName, null);
3030

3131
[Test]
32-
public void GenerateSetVersionMessageReturnsVersionAsIsAlthoughThisIsNotUsedByJenkins()
32+
public void ShouldSetBuildNumber()
3333
{
3434
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Beta4.7" };
35-
this.buildServer.GenerateSetVersionMessage(vars).ShouldBe("0.0.0-Beta4.7");
35+
this.buildServer.SetBuildNumber(vars).ShouldBe("0.0.0-Beta4.7");
3636
}
3737

3838
[Test]
39-
public void GenerateMessageTest()
39+
public void ShouldSetOutputVariables()
4040
{
41-
var generatedParameterMessages = this.buildServer.GenerateSetParameterMessage("name", "value");
42-
generatedParameterMessages.Length.ShouldBe(1);
43-
generatedParameterMessages[0].ShouldBe("GitVersion_name=value");
41+
var result = this.buildServer.SetOutputVariables("name", "value");
42+
result.Length.ShouldBe(1);
43+
result[0].ShouldBe("GitVersion_name=value");
4444
}
4545

4646
[TestCase("main", "main")]

‎src/GitVersion.BuildAgents.Tests/Agents/JenkinsTests.cs

+6-6
Original file line numberDiff line numberDiff line change
@@ -94,18 +94,18 @@ public void JenkinsTakesBranchNameInPipelineAsCode()
9494
}
9595

9696
[Test]
97-
public void GenerateSetVersionMessageReturnsVersionAsIsAlthoughThisIsNotUsedByJenkins()
97+
public void ShouldSetBuildNumber()
9898
{
9999
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Beta4.7" };
100-
this.buildServer.GenerateSetVersionMessage(vars).ShouldBe("0.0.0-Beta4.7");
100+
this.buildServer.SetBuildNumber(vars).ShouldBe("0.0.0-Beta4.7");
101101
}
102102

103103
[Test]
104-
public void GenerateMessageTest()
104+
public void ShouldSetOutputVariables()
105105
{
106-
var generatedParameterMessages = this.buildServer.GenerateSetParameterMessage("name", "value");
107-
generatedParameterMessages.Length.ShouldBe(1);
108-
generatedParameterMessages[0].ShouldBe("GitVersion_name=value");
106+
var result = this.buildServer.SetOutputVariables("name", "value");
107+
result.Length.ShouldBe(1);
108+
result[0].ShouldBe("GitVersion_name=value");
109109
}
110110

111111
[Test]

‎src/GitVersion.BuildAgents.Tests/Agents/MyGetTests.cs

+5-12
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,17 @@ public void SetUp()
1616
}
1717

1818
[Test]
19-
public void DevelopBranch()
19+
public void ShouldSetBuildNumber()
2020
{
2121
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Unstable4" };
22-
var message = this.buildServer.GenerateSetVersionMessage(vars);
23-
Assert.That(message, Is.EqualTo(null));
22+
var message = this.buildServer.SetBuildNumber(vars);
23+
Assert.That(message, Is.EqualTo("##myget[buildNumber '0.0.0-Unstable4']"));
2424
}
2525

2626
[Test]
27-
public void EscapeValues()
27+
public void ShouldSetOutputVariables()
2828
{
29-
var message = this.buildServer.GenerateSetParameterMessage("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
29+
var message = this.buildServer.SetOutputVariables("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
3030
Assert.That(message[0], Is.EqualTo("##myget[setParameter name='GitVersion.Foo' value='0.8.0-unstable568 Branch:|'develop|' Sha:|'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb|'']"));
3131
}
32-
33-
[Test]
34-
public void BuildNumber()
35-
{
36-
var message = this.buildServer.GenerateSetParameterMessage("SemVer", "0.8.0-unstable568");
37-
Assert.That(message[1], Is.EqualTo("##myget[buildNumber '0.8.0-unstable568']"));
38-
}
3932
}

‎src/GitVersion.BuildAgents.Tests/Agents/SpaceAutomationTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,13 @@ public void GetCurrentBranchShouldHandlePullRequests()
8484
}
8585

8686
[Test]
87-
public void GetEmptyGenerateSetVersionMessage()
87+
public void ShouldSetBuildNumber()
8888
{
8989
// Arrange
9090
var vars = new TestableGitVersionVariables { FullSemVer = "1.0.0" };
9191

9292
// Act
93-
var message = this.buildServer.GenerateSetVersionMessage(vars);
93+
var message = this.buildServer.SetBuildNumber(vars);
9494

9595
// Assert
9696
message.ShouldBeEmpty();

‎src/GitVersion.BuildAgents.Tests/Agents/TeamCityTests.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ public void SetUp()
1616
}
1717

1818
[Test]
19-
public void DevelopBranch()
19+
public void ShouldSetBuildNumber()
2020
{
2121
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Unstable4" };
22-
var tcVersion = this.buildServer.GenerateSetVersionMessage(vars);
22+
var tcVersion = this.buildServer.SetBuildNumber(vars);
2323
Assert.That(tcVersion, Is.EqualTo("##teamcity[buildNumber '0.0.0-Unstable4']"));
2424
}
2525

2626
[Test]
27-
public void EscapeValues()
27+
public void ShouldSetOutputVariables()
2828
{
29-
var tcVersion = this.buildServer.GenerateSetParameterMessage("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
29+
var tcVersion = this.buildServer.SetOutputVariables("Foo", "0.8.0-unstable568 Branch:'develop' Sha:'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb'");
3030
Assert.Multiple(() =>
3131
{
3232
Assert.That(tcVersion[0], Is.EqualTo("##teamcity[setParameter name='GitVersion.Foo' value='0.8.0-unstable568 Branch:|'develop|' Sha:|'ee69bff1087ebc95c6b43aa2124bd58f5722e0cb|'']"));

‎src/GitVersion.BuildAgents/Agents/AppVeyor.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ internal class AppVeyor(IEnvironment environment, ILog log, IFileSystem fileSyst
1111

1212
protected override string EnvironmentVariable => EnvironmentVariableName;
1313

14-
public override string GenerateSetVersionMessage(GitVersionVariables variables)
14+
public override string SetBuildNumber(GitVersionVariables variables)
1515
{
1616
var buildNumber = Environment.GetEnvironmentVariable("APPVEYOR_BUILD_NUMBER");
1717
var apiUrl = Environment.GetEnvironmentVariable("APPVEYOR_API_URL") ?? throw new Exception("APPVEYOR_API_URL environment variable not set");
@@ -38,7 +38,7 @@ public override string GenerateSetVersionMessage(GitVersionVariables variables)
3838
return $"Set AppVeyor build number to '{variables.FullSemVer}'.";
3939
}
4040

41-
public override string[] GenerateSetParameterMessage(string name, string? value)
41+
public override string[] SetOutputVariables(string name, string? value)
4242
{
4343
var apiUrl = Environment.GetEnvironmentVariable("APPVEYOR_API_URL") ?? throw new Exception("APPVEYOR_API_URL environment variable not set");
4444
var httpClient = GetHttpClient(apiUrl);

‎src/GitVersion.BuildAgents/Agents/AzurePipelines.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ internal class AzurePipelines(IEnvironment environment, ILog log, IFileSystem fi
1111

1212
protected override string EnvironmentVariable => EnvironmentVariableName;
1313

14-
public override string[] GenerateSetParameterMessage(string name, string? value) =>
14+
public override string[] SetOutputVariables(string name, string? value) =>
1515
[
1616
$"##vso[task.setvariable variable=GitVersion.{name}]{value}",
1717
$"##vso[task.setvariable variable=GitVersion.{name};isOutput=true]{value}"
@@ -22,7 +22,7 @@ public override string[] GenerateSetParameterMessage(string name, string? value)
2222

2323
public override bool PreventFetch() => true;
2424

25-
public override string GenerateSetVersionMessage(GitVersionVariables variables)
25+
public override string SetBuildNumber(GitVersionVariables variables)
2626
{
2727
// For AzurePipelines, we'll get the Build Number and insert GitVersion variables where
2828
// specified

‎src/GitVersion.BuildAgents/Agents/BitBucketPipelines.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ public BitBucketPipelines(IEnvironment environment, ILog log, IFileSystem fileSy
2121

2222
protected override string EnvironmentVariable => EnvironmentVariableName;
2323

24-
public override string GenerateSetVersionMessage(GitVersionVariables variables) => variables.FullSemVer;
24+
public override string SetBuildNumber(GitVersionVariables variables) => variables.FullSemVer;
2525

2626
public void WithPropertyFile(string propertiesFileName) => this.propertyFile = propertiesFileName;
2727

2828
public void WithPowershellFile(string powershellFileName) => this.ps1File = powershellFileName;
2929

30-
public override string[] GenerateSetParameterMessage(string name, string? value) => [$"GITVERSION_{name.ToUpperInvariant()}={value}"];
30+
public override string[] SetOutputVariables(string name, string? value) => [$"GITVERSION_{name.ToUpperInvariant()}={value}"];
3131

3232
public override void WriteIntegration(Action<string?> writer, GitVersionVariables variables, bool updateBuildNumber = true)
3333
{

0 commit comments

Comments
 (0)