Merge pull request #2933 from jhy871167495/main

Avoid throwing WarningException by skip call gitPreparer when building a tagged version

Author: asbjornu

src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs

@@ -541,6 +541,79 @@ public void CalculateVersionFromWorktreeHead()
         version.Sha.ShouldBe(commits.First().Sha);
     }
 
+    [Test]
+    [Category(NoMono)]
+    [Description(NoMonoDescription)]
+    public void CalculateVersionVariables_TwoBranchHasSameCommitHeadDetachedAndNotTagged_ThrowException()
+    {
+        // Setup
+        using var fixture = new RemoteRepositoryFixture();
+        var repoDir = new DirectoryInfo(fixture.RepositoryPath);
+        var Init = fixture.LocalRepositoryFixture.Repository.MakeACommit("Init commit");
+        var branchV1 = fixture.LocalRepositoryFixture.Repository.CreateBranch("feature/1.0");
+        fixture.LocalRepositoryFixture.Checkout("feature/1.0");
+        var commit = fixture.LocalRepositoryFixture.Repository.MakeACommit("feat: a new commit");
+        var branchV2 = fixture.LocalRepositoryFixture.Repository.CreateBranch("support/1.0");
+        fixture.LocalRepositoryFixture.Checkout(commit.Sha);
+
+        using var worktreeFixture = new LocalRepositoryFixture(new Repository(fixture.LocalRepositoryFixture.RepositoryPath));
+        var gitVersionOptions = new GitVersionOptions { WorkingDirectory = worktreeFixture.RepositoryPath };
+
+        var environment = new TestEnvironment();
+        environment.SetEnvironmentVariable(AzurePipelines.EnvironmentVariableName, "true");
+
+        this.sp = GetServiceProvider(gitVersionOptions, environment: environment);
+
+        var lazyContext = this.sp.GetService<Lazy<GitVersionContext>>();
+        var context = lazyContext.Value;
+
+        var preparer = this.sp.GetService<IGitPreparer>();
+        var sut = sp.GetService<IGitVersionCalculateTool>();
+
+        // Execute & Verify
+        var exception = Assert.Throws<WarningException>(() => sut.CalculateVersionVariables());
+        exception.Message.ShouldBe("Failed to try and guess branch to use. Move one of the branches along a commit to remove warning");
+    }
+
+    [Test]
+    [Category(NoMono)]
+    [Description(NoMonoDescription)]
+    public void CalculateVersionVariables_TwoBranchHasSameCommitHeadDetachedAndTagged_ReturnSemver()
+    {
+        // Setup
+        using var fixture = new RemoteRepositoryFixture();
+        var repoDir = new DirectoryInfo(fixture.RepositoryPath);
+        var Init = fixture.LocalRepositoryFixture.Repository.MakeACommit("Init commit");
+        var branchV1 = fixture.LocalRepositoryFixture.Repository.CreateBranch("feature/1.0");
+        fixture.LocalRepositoryFixture.Checkout("feature/1.0");
+        var commit = fixture.LocalRepositoryFixture.Repository.MakeACommit("feat: a new commit");
+        var branchV2 = fixture.LocalRepositoryFixture.Repository.CreateBranch("support/1.0");
+        fixture.LocalRepositoryFixture.ApplyTag("1.0.1");
+        fixture.LocalRepositoryFixture.Checkout(commit.Sha);
+
+        using var worktreeFixture = new LocalRepositoryFixture(new Repository(fixture.LocalRepositoryFixture.RepositoryPath));
+        var gitVersionOptions = new GitVersionOptions { WorkingDirectory = worktreeFixture.RepositoryPath };
+
+        var environment = new TestEnvironment();
+        environment.SetEnvironmentVariable(AzurePipelines.EnvironmentVariableName, "true");
+
+        this.sp = GetServiceProvider(gitVersionOptions, environment: environment);
+
+        var lazyContext = this.sp.GetService<Lazy<GitVersionContext>>();
+        var context = lazyContext.Value;
+
+        var preparer = this.sp.GetService<IGitPreparer>();
+        var sut = sp.GetService<IGitVersionCalculateTool>();
+
+        // Execute
+        var version = sut.CalculateVersionVariables();
+
+        // Verify
+        version.SemVer.ShouldBe("1.0.1");
+        var commits = worktreeFixture.Repository.Head.Commits;
+        version.Sha.ShouldBe(commits.First().Sha);
+    }
+
     private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVersionOptions, ILog logger = null, IGitRepository repository = null, IFileSystem fs = null)
     {
         this.sp = GetServiceProvider(gitVersionOptions, logger, repository, fs);
@@ -555,6 +628,13 @@ private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVe
     private static IServiceProvider GetServiceProvider(GitVersionOptions gitVersionOptions, ILog log = null, IGitRepository repository = null, IFileSystem fileSystem = null, IEnvironment environment = null) =>
         ConfigureServices(services =>
         {
+            services.AddSingleton<IGitVersionContextFactory, GitVersionContextFactory>();
+            services.AddSingleton(sp =>
+            {
+                var options = sp.GetService<IOptions<GitVersionOptions>>();
+                var contextFactory = sp.GetService<IGitVersionContextFactory>();
+                return new Lazy<GitVersionContext?>(() => contextFactory?.Create(options?.Value));
+            });
             if (log != null) services.AddSingleton(log);
             if (fileSystem != null) services.AddSingleton(fileSystem);
             if (repository != null) services.AddSingleton(repository);

src/GitVersion.Core/Core/GitVersionCalculateTool.cs

@@ -40,7 +40,13 @@ public GitVersionCalculateTool(ILog log, INextVersionCalculator nextVersionCalcu
 
     public VersionVariables CalculateVersionVariables()
     {
-        this.gitPreparer.Prepare(); //we need to prepare the repository before using it for version calculation
+        bool isCurrentCommitTagged = this.versionContext.IsValueCreated &&
+            this.versionContext.Value.IsCurrentCommitTagged;
+
+        if (!isCurrentCommitTagged)
+        {
+            this.gitPreparer.Prepare(); //we need to prepare the repository before using it for version calculation
+        }
 
         var gitVersionOptions = this.options.Value;