Skip to content

Add tests for GitLab CI to ignore branch name for tags #4402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 1, 2025
Merged

Add tests for GitLab CI to ignore branch name for tags #4402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bae738e
Do not return the tag as branch name for GitLab CI
AlphaYankee Aug 29, 2024
e4cf434
Add tests for GitLab CI to ignore branch name for tags
Bi0T1N Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion src/GitVersion.BuildAgents.Tests/Agents/GitLabCiTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,22 @@ namespace GitVersion.Agents.Tests;
[TestFixture]
public class GitLabCiTests : TestBase
{
private GitLabCi buildServer;
private IServiceProvider sp;
private GitLabCi buildServer;
private IEnvironment environment;

[SetUp]
public void SetUp()
{
this.sp = ConfigureServices(services => services.AddSingleton<GitLabCi>());
this.buildServer = this.sp.GetRequiredService<GitLabCi>();
this.environment = this.sp.GetRequiredService<IEnvironment>();
this.environment.SetEnvironmentVariable(GitLabCi.EnvironmentVariableName, "true");
}

[TearDown]
public void TearDown() => this.environment.SetEnvironmentVariable(GitLabCi.EnvironmentVariableName, null);

[Test]
public void GenerateSetVersionMessageReturnsVersionAsIsAlthoughThisIsNotUsedByJenkins()
{
Expand All @@ -34,6 +40,55 @@ public void GenerateMessageTest()
generatedParameterMessages[0].ShouldBe("GitVersion_name=value");
}

[TestCase("main", "main")]
[TestCase("dev", "dev")]
[TestCase("development", "development")]
[TestCase("my_cool_feature", "my_cool_feature")]
[TestCase("#3-change_projectname", "#3-change_projectname")]
public void GetCurrentBranchShouldHandleBranches(string branchName, string expectedResult)
{
this.environment.SetEnvironmentVariable("CI_COMMIT_REF_NAME", branchName);

var result = this.buildServer.GetCurrentBranch(false);

result.ShouldBe(expectedResult);
}

[TestCase("main", "", "main")]
[TestCase("v1.0.0", "v1.0.0", null)]
[TestCase("development", "", "development")]
[TestCase("v1.2.1", "v1.2.1", null)]
public void GetCurrentBranchShouldHandleTags(string branchName, string commitTag, string? expectedResult)
{
this.environment.SetEnvironmentVariable("CI_COMMIT_REF_NAME", branchName);
this.environment.SetEnvironmentVariable("CI_COMMIT_TAG", commitTag); // only set in pipelines for tags

var result = this.buildServer.GetCurrentBranch(false);

if (!string.IsNullOrEmpty(expectedResult))
{
result.ShouldBe(expectedResult);
}
else
{
result.ShouldBeNull();
}
}

[TestCase("main", "main")]
[TestCase("dev", "dev")]
[TestCase("development", "development")]
[TestCase("my_cool_feature", "my_cool_feature")]
[TestCase("#3-change_projectname", "#3-change_projectname")]
public void GetCurrentBranchShouldHandlePullRequests(string branchName, string expectedResult)
{
this.environment.SetEnvironmentVariable("CI_COMMIT_REF_NAME", branchName);

var result = this.buildServer.GetCurrentBranch(false);

result.ShouldBe(expectedResult);
}

[Test]
public void WriteAllVariablesToTheTextWriter()
{
Expand Down
13 changes: 12 additions & 1 deletion src/GitVersion.BuildAgents/Agents/GitLabCi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,18 @@ public override string[] GenerateSetParameterMessage(string name, string? value)
$"GitVersion_{name}={value}"
];

public override string? GetCurrentBranch(bool usingDynamicRepos) => Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME");
public override string? GetCurrentBranch(bool usingDynamicRepos)
{
// CI_COMMIT_REF_NAME can contain either the branch or the tag
// See https://docs.gitlab.com/ee/ci/variables/predefined_variables.html

// CI_COMMIT_TAG is only available in tag pipelines,
// so we can exit if CI_COMMIT_REF_NAME would return the tag
if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("CI_COMMIT_TAG")))
return null;

return Environment.GetEnvironmentVariable("CI_COMMIT_REF_NAME");
}

public override bool PreventFetch() => true;

Expand Down