Implemented branch config keyed by well known keys

JakeGinnivan · JakeGinnivan · commit b725ab890858 · 2016-09-03T18:26:41.000+08:00
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -227,6 +227,9 @@ If you don't specify the regex the inbuilt for that branch config will be used (
 We don't envision many people needing to change most of these configuration
 values, but here they are if you need to:
 
+### regex
+This is the regex which is used to match the current branch to the correct branch configuration.
+
 ### branches
 The header for all the individual branch configuration.
 
diff --git a/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -17,61 +17,68 @@ branches:
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    regex: master
     is-develop: false
     is-release-branch: false
     is-mainline: true
-  releases?[/-]:
+  release:
     mode: ContinuousDelivery
     tag: beta
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    regex: releases?[/-]
     is-develop: false
     is-release-branch: true
     is-mainline: false
-  features?[/-]:
+  feature:
     mode: ContinuousDelivery
     tag: useBranchName
     increment: Inherit
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
+    regex: features?[/-]
     is-develop: false
     is-release-branch: false
     is-mainline: false
-  (pull|pull\-requests|pr)[/-]:
+  pull-request:
     mode: ContinuousDelivery
     tag: PullRequest
     increment: Inherit
     prevent-increment-of-merged-branch-version: false
     tag-number-pattern: '[/-](?<number>\d+)[-/]'
     track-merge-target: false
+    regex: (pull|pull\-requests|pr)[/-]
     is-develop: false
     is-release-branch: false
     is-mainline: false
-  hotfix(es)?[/-]:
+  hotfix:
     mode: ContinuousDelivery
     tag: beta
     increment: Patch
     prevent-increment-of-merged-branch-version: false
     track-merge-target: false
+    regex: hotfix(es)?[/-]
     is-develop: false
     is-release-branch: false
     is-mainline: false
-  support[/-]:
+  support:
     mode: ContinuousDelivery
     tag: ''
     increment: Patch
     prevent-increment-of-merged-branch-version: true
     track-merge-target: false
+    regex: support[/-]
     is-develop: false
     is-release-branch: false
     is-mainline: true
-  dev(elop)?(ment)?$:
+  develop:
     mode: ContinuousDeployment
     tag: alpha
     increment: Minor
     prevent-increment-of-merged-branch-version: false
     track-merge-target: true
+    regex: dev(elop)?(ment)?$
     is-develop: true
     is-release-branch: false
     is-mainline: false
diff --git a/src/GitVersionCore.Tests/ConfigProviderTests.cs b/src/GitVersionCore.Tests/ConfigProviderTests.cs
@@ -4,7 +4,6 @@
 using Shouldly;
 using System;
 using System.ComponentModel;
-using System.Configuration;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -86,7 +85,7 @@ public void CanRemoveTag()
         var config = ConfigurationProvider.Provide(repoPath, fileSystem);
 
         config.NextVersion.ShouldBe("2.0.0");
-        config.Branches["releases?[/-]"].Tag.ShouldBe(string.Empty);
+        config.Branches["release"].Tag.ShouldBe(string.Empty);
     }
 
     [Test]
@@ -98,7 +97,7 @@ public void RegexIsRequired()
     bug:
         tag: bugfix";
         SetupConfigFileContent(text);
-        var ex = Should.Throw<ConfigurationException>(() => ConfigurationProvider.Provide(repoPath, fileSystem));
+        var ex = Should.Throw<GitVersionConfigurationException>(() => ConfigurationProvider.Provide(repoPath, fileSystem));
         ex.Message.ShouldBe("Branch configuration 'bug' is missing required configuration 'regex'");
     }
 
@@ -109,7 +108,7 @@ public void CanProvideConfigForNewBranch()
 next-version: 2.0.0
 branches:
     bug:
-        regex: bug[/-]:
+        regex: 'bug[/-]'
         tag: bugfix";
         SetupConfigFileContent(text);
         var config = ConfigurationProvider.Provide(repoPath, fileSystem);
diff --git a/src/GitVersionCore.Tests/GitVersionContextTests.cs b/src/GitVersionCore.Tests/GitVersionContextTests.cs
@@ -40,7 +40,7 @@ public void UsesBranchSpecificConfigOverTopLevelDefaults()
                 Branches =
                 {
                     {
-                        "dev(elop)?(ment)?$", new BranchConfig
+                        "develop", new BranchConfig
                         {
                             VersioningMode = VersioningMode.ContinuousDeployment,
                             Tag = "alpha"
@@ -69,8 +69,8 @@ public void CanFindParentBranchForInheritingIncrementStrategy()
             {
                 Branches =
                 {
-                    { "dev(elop)?(ment)?$", new BranchConfig { Increment = IncrementStrategy.Major} },
-                    { "features?[/-]", new BranchConfig { Increment = IncrementStrategy.Inherit} }
+                    { "develop", new BranchConfig { Increment = IncrementStrategy.Major} },
+                    { "feature", new BranchConfig { Increment = IncrementStrategy.Inherit} }
                 }
             }.ApplyDefaults();
 
diff --git a/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs
@@ -62,7 +62,7 @@ public void CanChangeDevelopTagViaConfig()
             Branches =
             {
                 {
-                    "dev(elop)?(ment)?$", new BranchConfig
+                    "develop", new BranchConfig
                     {
                         Tag = "alpha"
                     }
@@ -128,7 +128,7 @@ public void CanHandleContinuousDelivery()
         {
             Branches =
             {
-                {"dev(elop)?(ment)?$", new BranchConfig
+                {"develop", new BranchConfig
                 {
                     VersioningMode = VersioningMode.ContinuousDelivery
                 }
diff --git a/src/GitVersionCore.Tests/IntegrationTests/FeatureBranchScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/FeatureBranchScenarios.cs
@@ -41,7 +41,7 @@ public void BranchCreatedAfterFastForwardMergeShouldInheritCorrectly()
         {
             Branches =
             {
-                { "unstable", new BranchConfig { Increment = IncrementStrategy.Minor } }
+                { "unstable", new BranchConfig { Increment = IncrementStrategy.Minor, Regex = "unstable"} }
             }
         };
 
@@ -183,7 +183,7 @@ public void ShouldUseConfiguredTag(string tag, string featureName, string preRel
         {
             Branches =
             {
-                { "features?[/-]", new BranchConfig { Tag = tag } }
+                { "feature", new BranchConfig { Tag = tag } }
             }
         };
 
diff --git a/src/GitVersionCore.Tests/IntegrationTests/OtherScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/OtherScenarios.cs
@@ -49,8 +49,9 @@ public void AllowNotHavingMaster()
         public void AllowHavingMainInsteadOfMaster()
         {
             var config = new Config();
-            config.Branches.Add("main", new BranchConfig
+            config.Branches.Add("master", new BranchConfig
             {
+                Regex = "main",
                 VersioningMode = VersioningMode.ContinuousDelivery,
                 Tag = "useBranchName",
                 Increment = IncrementStrategy.Patch,
diff --git a/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs
@@ -113,7 +113,7 @@ public void CanTakeVersionFromReleaseBranchWithTagOverridden()
         {
             Branches =
             {
-                { "releases?[/-]", new BranchConfig { Tag = "rc" } }
+                { "release", new BranchConfig { Tag = "rc" } }
             }
         };
         using (var fixture = new EmptyRepositoryFixture())
diff --git a/src/GitVersionCore.Tests/VersionCalculation/NextVersionCalculatorTests.cs b/src/GitVersionCore.Tests/VersionCalculation/NextVersionCalculatorTests.cs
@@ -62,8 +62,9 @@ public void PreReleaseTagCanUseBranchName()
             var semanticVersionBuildMetaData = new SemanticVersionBuildMetaData(2, "develop", "b1a34e", DateTimeOffset.Now);
             var sut = new NextVersionCalculator(baseCalculator, new TestMetaDataCalculator(semanticVersionBuildMetaData));
             var config = new Config();
-            config.Branches.Add("custom/", new BranchConfig
+            config.Branches.Add("custom", new BranchConfig
             {
+                Regex = "custom/",
                 Tag = "useBranchName"
             });
             var context = new GitVersionContextBuilder()
@@ -84,8 +85,9 @@ public void PreReleaseTagCanUseBranchNameVariable()
             var semanticVersionBuildMetaData = new SemanticVersionBuildMetaData(2, "develop", "b1a34e", DateTimeOffset.Now);
             var sut = new NextVersionCalculator(baseCalculator, new TestMetaDataCalculator(semanticVersionBuildMetaData));
             var config = new Config();
-            config.Branches.Add("custom/", new BranchConfig
+            config.Branches.Add("custom", new BranchConfig
             {
+                Regex = "custom/",
                 Tag = "alpha.{BranchName}"
             });
             var context = new GitVersionContextBuilder()
diff --git a/src/GitVersionCore/BranchConfigurationCalculator.cs b/src/GitVersionCore/BranchConfigurationCalculator.cs
@@ -17,8 +17,12 @@ public static KeyValuePair<string, BranchConfig> GetBranchConfiguration(Commit c
 
             if (matchingBranches.Length == 0)
             {
+                Logger.WriteInfo(string.Format(
+                    "No branch configuration found for branch {0}, falling back to default configuration",
+                    currentBranch.FriendlyName));
+
                 var branchConfig = new BranchConfig();
-                ConfigurationProvider.ApplyBranchDefaults(config, branchConfig);
+                ConfigurationProvider.ApplyBranchDefaults(config, branchConfig, "");
                 return new KeyValuePair<string, BranchConfig>(string.Empty, branchConfig);
             }
             if (matchingBranches.Length == 1)
@@ -49,8 +53,8 @@ static KeyValuePair<string, BranchConfig>[] LookupBranchConfiguration([NotNull]
             {
                 throw new ArgumentNullException("currentBranch");
             }
-            
-            return config.Branches.Where(b => Regex.IsMatch(currentBranch.FriendlyName, "^" + b.Key, RegexOptions.IgnoreCase)).ToArray();
+
+            return config.Branches.Where(b => Regex.IsMatch(currentBranch.FriendlyName, "^" + b.Value.Regex, RegexOptions.IgnoreCase)).ToArray();
         }
 
 
diff --git a/src/GitVersionCore/Configuration/BranchConfig.cs b/src/GitVersionCore/Configuration/BranchConfig.cs
@@ -10,6 +10,7 @@ public BranchConfig()
 
         public BranchConfig(BranchConfig branchConfiguration)
         {
+            Regex = branchConfiguration.Regex;
             VersioningMode = branchConfiguration.VersioningMode;
             Tag = branchConfiguration.Tag;
             Increment = branchConfiguration.Increment;
diff --git a/src/GitVersionCore/Configuration/Config.cs b/src/GitVersionCore/Configuration/Config.cs
@@ -86,7 +86,7 @@ public Dictionary<string, BranchConfig> Branches
             }
         }
 
-        private T MergeObjects<T>(T target, T source)
+        T MergeObjects<T>(T target, T source)
         {
             typeof(T).GetProperties()
                 .Where(prop => prop.CanRead && prop.CanWrite)
diff --git a/src/GitVersionCore/Configuration/ConfigurationProvider.cs b/src/GitVersionCore/Configuration/ConfigurationProvider.cs
diff --git a/src/GitVersionCore/Configuration/GitVersionConfigurationException.cs b/src/GitVersionCore/Configuration/GitVersionConfigurationException.cs
diff --git a/src/GitVersionCore/Configuration/LegacyConfig.cs b/src/GitVersionCore/Configuration/LegacyConfig.cs
diff --git a/src/GitVersionCore/Configuration/LegacyConfigNotifier.cs b/src/GitVersionCore/Configuration/LegacyConfigNotifier.cs
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
diff --git a/src/GitVersionCore/GitVersionCore.csproj b/src/GitVersionCore/GitVersionCore.csproj

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public void UsesBranchSpecificConfigOverTopLevelDefaults()`
`40`	`40`	`Branches =`
`41`	`41`	`{`
`42`	`42`	`{`
`43`		`- "dev(elop)?(ment)?$", new BranchConfig`
	`43`	`+ "develop", new BranchConfig`
`44`	`44`	`{`
`45`	`45`	`VersioningMode = VersioningMode.ContinuousDeployment,`
`46`	`46`	`Tag = "alpha"`
`@@ -69,8 +69,8 @@ public void CanFindParentBranchForInheritingIncrementStrategy()`
`69`	`69`	`{`
`70`	`70`	`Branches =`
`71`	`71`	`{`
`72`		`- { "dev(elop)?(ment)?$", new BranchConfig { Increment = IncrementStrategy.Major} },`
`73`		`- { "features?[/-]", new BranchConfig { Increment = IncrementStrategy.Inherit} }`
	`72`	`+ { "develop", new BranchConfig { Increment = IncrementStrategy.Major} },`
	`73`	`+ { "feature", new BranchConfig { Increment = IncrementStrategy.Inherit} }`
`74`	`74`	`}`
`75`	`75`	`}.ApplyDefaults();`
`76`	`76`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public void CanChangeDevelopTagViaConfig()`
`62`	`62`	`Branches =`
`63`	`63`	`{`
`64`	`64`	`{`
`65`		`- "dev(elop)?(ment)?$", new BranchConfig`
	`65`	`+ "develop", new BranchConfig`
`66`	`66`	`{`
`67`	`67`	`Tag = "alpha"`
`68`	`68`	`}`
`@@ -128,7 +128,7 @@ public void CanHandleContinuousDelivery()`
`128`	`128`	`{`
`129`	`129`	`Branches =`
`130`	`130`	`{`
`131`		`- {"dev(elop)?(ment)?$", new BranchConfig`
	`131`	`+ {"develop", new BranchConfig`
`132`	`132`	`{`
`133`	`133`	`VersioningMode = VersioningMode.ContinuousDelivery`
`134`	`134`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public void BranchCreatedAfterFastForwardMergeShouldInheritCorrectly()`
`41`	`41`	`{`
`42`	`42`	`Branches =`
`43`	`43`	`{`
`44`		`- { "unstable", new BranchConfig { Increment = IncrementStrategy.Minor } }`
	`44`	`+ { "unstable", new BranchConfig { Increment = IncrementStrategy.Minor, Regex = "unstable"} }`
`45`	`45`	`}`
`46`	`46`	`};`
`47`	`47`
`@@ -183,7 +183,7 @@ public void ShouldUseConfiguredTag(string tag, string featureName, string preRel`
`183`	`183`	`{`
`184`	`184`	`Branches =`
`185`	`185`	`{`
`186`		`- { "features?[/-]", new BranchConfig { Tag = tag } }`
	`186`	`+ { "feature", new BranchConfig { Tag = tag } }`
`187`	`187`	`}`
`188`	`188`	`};`
`189`	`189`
Original file line number	Diff line number	Diff line change
`@@ -49,8 +49,9 @@ public void AllowNotHavingMaster()`
`49`	`49`	`public void AllowHavingMainInsteadOfMaster()`
`50`	`50`	`{`
`51`	`51`	`var config = new Config();`
`52`		`- config.Branches.Add("main", new BranchConfig`
	`52`	`+ config.Branches.Add("master", new BranchConfig`
`53`	`53`	`{`
	`54`	`+ Regex = "main",`
`54`	`55`	`VersioningMode = VersioningMode.ContinuousDelivery,`
`55`	`56`	`Tag = "useBranchName",`
`56`	`57`	`Increment = IncrementStrategy.Patch,`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ public void CanTakeVersionFromReleaseBranchWithTagOverridden()`
`113`	`113`	`{`
`114`	`114`	`Branches =`
`115`	`115`	`{`
`116`		`- { "releases?[/-]", new BranchConfig { Tag = "rc" } }`
	`116`	`+ { "release", new BranchConfig { Tag = "rc" } }`
`117`	`117`	`}`
`118`	`118`	`};`
`119`	`119`	`using (var fixture = new EmptyRepositoryFixture())`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,12 @@ public static KeyValuePair<string, BranchConfig> GetBranchConfiguration(Commit c`
`17`	`17`
`18`	`18`	`if (matchingBranches.Length == 0)`
`19`	`19`	`{`
	`20`	`+ Logger.WriteInfo(string.Format(`
	`21`	`+ "No branch configuration found for branch {0}, falling back to default configuration",`
	`22`	`+ currentBranch.FriendlyName));`
	`23`	`+`
`20`	`24`	`var branchConfig = new BranchConfig();`
`21`		`- ConfigurationProvider.ApplyBranchDefaults(config, branchConfig);`
	`25`	`+ ConfigurationProvider.ApplyBranchDefaults(config, branchConfig, "");`
`22`	`26`	`return new KeyValuePair<string, BranchConfig>(string.Empty, branchConfig);`
`23`	`27`	`}`
`24`	`28`	`if (matchingBranches.Length == 1)`
`@@ -49,8 +53,8 @@ static KeyValuePair<string, BranchConfig>[] LookupBranchConfiguration([NotNull]`
`49`	`53`	`{`
`50`	`54`	`throw new ArgumentNullException("currentBranch");`
`51`	`55`	`}`
`52`		`-`
`53`		`- return config.Branches.Where(b => Regex.IsMatch(currentBranch.FriendlyName, "^" + b.Key, RegexOptions.IgnoreCase)).ToArray();`
	`56`	`+`
	`57`	`+ return config.Branches.Where(b => Regex.IsMatch(currentBranch.FriendlyName, "^" + b.Value.Regex, RegexOptions.IgnoreCase)).ToArray();`
`54`	`58`	`}`
`55`	`59`
`56`	`60`