HotfixBranchScenarios.cs

using System.Linq;
using GitTools.Testing;
using GitVersion.Core.Tests.Helpers;
using GitVersion.Extensions;
using GitVersion.Model.Configuration;
using GitVersion.VersionCalculation;
using LibGit2Sharp;
using NUnit.Framework;

namespace GitVersion.Core.Tests.IntegrationTests
{
    [TestFixture]
    public class HotfixBranchScenarios : TestBase
    {
        [Test]
        // This test actually validates #465 as well
        public void PatchLatestReleaseExample()
        {
            using var fixture = new BaseGitFlowRepositoryFixture("1.2.0");
            // create hotfix
            Commands.Checkout(fixture.Repository, MainBranch);
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("hotfix/1.2.1"));
            fixture.Repository.MakeACommit();

            fixture.AssertFullSemver("1.2.1-beta.1+1");
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("1.2.1-beta.1+2");
            fixture.Repository.ApplyTag("1.2.1-beta.1");
            fixture.AssertFullSemver("1.2.1-beta.1");
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("1.2.1-beta.2+3");

            // Merge hotfix branch to main
            Commands.Checkout(fixture.Repository, MainBranch);

            fixture.Repository.MergeNoFF("hotfix/1.2.1", Generate.SignatureNow());
            fixture.AssertFullSemver("1.2.1+4");

            fixture.Repository.ApplyTag("1.2.1");
            fixture.AssertFullSemver("1.2.1");

            // Verify develop version
            Commands.Checkout(fixture.Repository, "develop");
            fixture.AssertFullSemver("1.3.0-alpha.1");

            fixture.Repository.MergeNoFF("hotfix/1.2.1", Generate.SignatureNow());
            fixture.AssertFullSemver("1.3.0-alpha.5");
        }

        [Test]
        public void CanTakeVersionFromHotfixesBranch()
        {
            using var fixture = new BaseGitFlowRepositoryFixture(r =>
            {
                r.MakeATaggedCommit("1.0.0");
                r.MakeATaggedCommit("1.1.0");
                r.MakeATaggedCommit("2.0.0");
            });
            // Merge hotfix branch to support
            Commands.Checkout(fixture.Repository, MainBranch);
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("support-1.1", (Commit)fixture.Repository.Tags.Single(t => t.FriendlyName == "1.1.0").Target));
            fixture.AssertFullSemver("1.1.0");

            // create hotfix branch
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("hotfixes/1.1.1"));
            fixture.AssertFullSemver("1.1.0"); // We are still on a tagged commit
            fixture.Repository.MakeACommit();

            fixture.AssertFullSemver("1.1.1-beta.1+1");
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("1.1.1-beta.1+2");
        }

        [Test]
        public void PatchOlderReleaseExample()
        {
            using var fixture = new BaseGitFlowRepositoryFixture(r =>
            {
                r.MakeATaggedCommit("1.0.0");
                r.MakeATaggedCommit("1.1.0");
                r.MakeATaggedCommit("2.0.0");
            });
            // Merge hotfix branch to support
            Commands.Checkout(fixture.Repository, MainBranch);
            var tag = fixture.Repository.Tags.Single(t => t.FriendlyName == "1.1.0");
            var supportBranch = fixture.Repository.CreateBranch("support-1.1", (Commit)tag.Target);
            Commands.Checkout(fixture.Repository, supportBranch);
            fixture.AssertFullSemver("1.1.0");

            // create hotfix branch
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("hotfix-1.1.1"));
            fixture.AssertFullSemver("1.1.0"); // We are still on a tagged commit
            fixture.Repository.MakeACommit();

            fixture.AssertFullSemver("1.1.1-beta.1+1");
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("1.1.1-beta.1+2");

            // Create feature branch off hotfix branch and complete
            Commands.Checkout(fixture.Repository, fixture.Repository.CreateBranch("feature/fix"));
            fixture.AssertFullSemver("1.1.1-fix.1+2");
            fixture.Repository.MakeACommit();
            fixture.AssertFullSemver("1.1.1-fix.1+3");

            fixture.Repository.CreatePullRequestRef("feature/fix", "hotfix-1.1.1", normalise: true, prNumber: 8);
            fixture.AssertFullSemver("1.1.1-PullRequest0008.4");
            Commands.Checkout(fixture.Repository, "hotfix-1.1.1");
            fixture.Repository.MergeNoFF("feature/fix", Generate.SignatureNow());
            fixture.AssertFullSemver("1.1.1-beta.1+4");

            // Merge hotfix into support branch to complete hotfix
            Commands.Checkout(fixture.Repository, "support-1.1");
            fixture.Repository.MergeNoFF("hotfix-1.1.1", Generate.SignatureNow());
            fixture.AssertFullSemver("1.1.1+5");
            fixture.Repository.ApplyTag("1.1.1");
            fixture.AssertFullSemver("1.1.1");

            // Verify develop version
            Commands.Checkout(fixture.Repository, "develop");
            fixture.AssertFullSemver("2.1.0-alpha.1");
            fixture.Repository.MergeNoFF("support-1.1", Generate.SignatureNow());
            fixture.AssertFullSemver("2.1.0-alpha.7");
        }

        /// <summary>
        /// Create a feature branch from a hotfix branch, and merge back, then delete it
        /// </summary>
        [Test]
        public void FeatureOnHotfixFeatureBranchDeleted()
        {
            var config = new Config
            {
                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatchTag,
                VersioningMode = VersioningMode.ContinuousDeployment
            };

            using var fixture = new EmptyRepositoryFixture();
            var release450 = "release/4.5.0";
            var hotfix451 = "hotfix/4.5.1";
            var support45 = "support/4.5";
            var tag450 = "4.5.0";
            var featureBranch = "feature/some-bug-fix";

            fixture.Repository.MakeACommit("initial");
            fixture.Repository.CreateBranch("develop");
            Commands.Checkout(fixture.Repository, "develop");

            // create release branch
            fixture.Repository.CreateBranch(release450);
            Commands.Checkout(fixture.Repository, release450);
            fixture.AssertFullSemver("4.5.0-beta.0", config);
            fixture.Repository.MakeACommit("blabla");
            Commands.Checkout(fixture.Repository, "develop");
            fixture.Repository.MergeNoFF(release450, Generate.SignatureNow());
            Commands.Checkout(fixture.Repository, MainBranch);
            fixture.Repository.MergeNoFF(release450, Generate.SignatureNow());

            // create support branch
            fixture.Repository.CreateBranch(support45);
            Commands.Checkout(fixture.Repository, support45);
            fixture.Repository.ApplyTag(tag450);
            fixture.AssertFullSemver("4.5.0", config);

            // create hotfix branch
            fixture.Repository.CreateBranch(hotfix451);
            Commands.Checkout(fixture.Repository, hotfix451);

            // feature branch from hotfix
            fixture.Repository.CreateBranch(featureBranch);
            Commands.Checkout(fixture.Repository, featureBranch);
            fixture.Repository.MakeACommit("blabla"); // commit 1
            Commands.Checkout(fixture.Repository, hotfix451);
            fixture.Repository.MergeNoFF(featureBranch, Generate.SignatureNow()); // commit 2
            fixture.Repository.Branches.Remove(featureBranch);
            fixture.AssertFullSemver("4.5.1-beta.2", config);
        }

        /// <summary>
        /// Create a feature branch from a hotfix branch, and merge back, but don't delete it
        /// </summary>
        [Test]
        public void FeatureOnHotfixFeatureBranchNotDeleted()
        {
            var config = new Config
            {
                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatchTag,
                VersioningMode = VersioningMode.ContinuousDeployment
            };

            using var fixture = new EmptyRepositoryFixture();
            var release450 = "release/4.5.0";
            var hotfix451 = "hotfix/4.5.1";
            var support45 = "support/4.5";
            var tag450 = "4.5.0";
            var featureBranch = "feature/some-bug-fix";

            fixture.Repository.MakeACommit("initial");
            fixture.Repository.CreateBranch("develop");
            Commands.Checkout(fixture.Repository, "develop");

            // create release branch
            fixture.Repository.CreateBranch(release450);
            Commands.Checkout(fixture.Repository, release450);
            fixture.AssertFullSemver("4.5.0-beta.0", config);
            fixture.Repository.MakeACommit("blabla");
            Commands.Checkout(fixture.Repository, "develop");
            fixture.Repository.MergeNoFF(release450, Generate.SignatureNow());
            Commands.Checkout(fixture.Repository, MainBranch);
            fixture.Repository.MergeNoFF(release450, Generate.SignatureNow());

            // create support branch
            fixture.Repository.CreateBranch(support45);
            Commands.Checkout(fixture.Repository, support45);
            fixture.Repository.ApplyTag(tag450);
            fixture.AssertFullSemver("4.5.0", config);

            // create hotfix branch
            fixture.Repository.CreateBranch(hotfix451);
            Commands.Checkout(fixture.Repository, hotfix451);

            // feature branch from hotfix
            fixture.Repository.CreateBranch(featureBranch);
            Commands.Checkout(fixture.Repository, featureBranch);
            fixture.Repository.MakeACommit("blabla"); // commit 1
            Commands.Checkout(fixture.Repository, hotfix451);
            fixture.Repository.MergeNoFF(featureBranch, Generate.SignatureNow()); // commit 2
            fixture.AssertFullSemver("4.5.1-beta.2", config);
        }

        [Test]
        public void HotfixMergeIncrementsVersion()
        {
            var config = new Config
            {
                AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatchTag,
                VersioningMode = VersioningMode.ContinuousDeployment
            };

            using var fixture = new EmptyRepositoryFixture();

            // initialize gitflow

            const string devBranch = "develop";

            fixture.Repository.MakeACommit("setup repo");
            fixture.Repository.CreateBranch(devBranch);
            Commands.Checkout(fixture.Repository, devBranch);

            // make some changes on dev

            fixture.Repository.MakeACommit("add stuff");
            fixture.Repository.MakeACommit("add more stuff");

            // start a release

            const string releaseBranch = "release/1.0";

            fixture.Repository.CreateBranch(releaseBranch);
            Commands.Checkout(fixture.Repository, releaseBranch);
            fixture.Repository.MakeACommit("fix some minor thing");

            fixture.AssertFullSemver("1.0.0-beta.1", config);

            Commands.Checkout(fixture.Repository, MainBranch);
            fixture.Repository.MergeNoFF(releaseBranch, Generate.SignatureNow());

            fixture.AssertFullSemver("1.0.0-ci.0", config);
            fixture.ApplyTag("1.0");
            fixture.AssertFullSemver("1.0.0", config);

            // start hotfix

            const string hotfixBranch = "hotfix/something-important";

            fixture.Repository.CreateBranch(hotfixBranch);
            fixture.Repository.MakeACommit("fix the important issue");
            // fixture.AssertFullSemver("1.0.1-beta.1"); // FAILS, not sure if hotfixes should have beta tag
            fixture.AssertFullSemver("1.0.1-ci.1", config); // PASSES
            fixture.Repository.MakeACommit("fix something else");
            // fixture.AssertFullSemver("1.0.1-beta.2"); // FAILS, not sure if hotfixes should have beta tag
            fixture.AssertFullSemver("1.0.1-ci.2", config); // PASSES

            Commands.Checkout(fixture.Repository, MainBranch);
            fixture.Repository.MergeNoFF(hotfixBranch, Generate.SignatureNow());

            fixture.AssertFullSemver("1.0.1-ci.2", config);
        }
    }
}