Skip to content

Commit 0477f4a

Browse files
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 0477f4a

29 files changed

Lines changed: 76 additions & 75 deletions

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ public void SetEnvironmentVariableForTest()
2929
public void DevelopBranch()
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]
3838
public void EscapeValues()
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public void GetCurrentBranchShouldHandlePullRequests()
7676
public void GetSetParameterMessageShouldReturnEmptyArray()
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();
@@ -89,7 +89,7 @@ public void GetEmptyGenerateSetVersionMessage()
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

Lines changed: 3 additions & 3 deletions
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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ public void GenerateBuildVersion()
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ public void CanApplyToCurrentContextEnvironmentVariableNotSet()
5555
public void GenerateSetVersionMessage(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']")]
6464
public void GenerateSetParameterMessage(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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ public void GetSetParameterMessage()
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);
@@ -119,7 +119,7 @@ public void GetSetParameterMessage()
119119
public void SkipEmptySetParameterMessage()
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,7 +167,7 @@ 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]
@@ -177,7 +177,7 @@ public void GetEmptyGenerateSetVersionMessage()
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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ public void SetUp()
3232
public void GenerateSetVersionMessageReturnsVersionAsIsAlthoughThisIsNotUsedByJenkins()
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]
3939
public void GenerateMessageTest()
4040
{
41-
var generatedParameterMessages = this.buildServer.GenerateSetParameterMessage("name", "value");
41+
var generatedParameterMessages = this.buildServer.SetOutputVariables("name", "value");
4242
generatedParameterMessages.Length.ShouldBe(1);
4343
generatedParameterMessages[0].ShouldBe("GitVersion_name=value");
4444
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ public void JenkinsTakesBranchNameInPipelineAsCode()
9797
public void GenerateSetVersionMessageReturnsVersionAsIsAlthoughThisIsNotUsedByJenkins()
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]
104104
public void GenerateMessageTest()
105105
{
106-
var generatedParameterMessages = this.buildServer.GenerateSetParameterMessage("name", "value");
106+
var generatedParameterMessages = this.buildServer.SetOutputVariables("name", "value");
107107
generatedParameterMessages.Length.ShouldBe(1);
108108
generatedParameterMessages[0].ShouldBe("GitVersion_name=value");
109109
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,21 @@ public void SetUp()
1919
public void DevelopBranch()
2020
{
2121
var vars = new TestableGitVersionVariables { FullSemVer = "0.0.0-Unstable4" };
22-
var message = this.buildServer.GenerateSetVersionMessage(vars);
22+
var message = this.buildServer.SetBuildNumber(vars);
2323
Assert.That(message, Is.EqualTo(null));
2424
}
2525

2626
[Test]
2727
public void EscapeValues()
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
}
3232

3333
[Test]
3434
public void BuildNumber()
3535
{
36-
var message = this.buildServer.GenerateSetParameterMessage("SemVer", "0.8.0-unstable568");
36+
var message = this.buildServer.SetOutputVariables("SemVer", "0.8.0-unstable568");
3737
Assert.That(message[1], Is.EqualTo("##myget[buildNumber '0.8.0-unstable568']"));
3838
}
3939
}

0 commit comments

Comments
 (0)