Moved defaulting config out of the ctor of Config class and into ConfigurationProvider

JakeGinnivan · JakeGinnivan · commit bcca05f74f7c · 2015-07-22T17:18:55.000+08:00
This allows a new empty instance of the config to be spun up. It also means all the defaulting logic and values are in a similar place rather than spread around the codebase
diff --git a/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt b/src/GitVersionCore.Tests/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt
@@ -1,29 +1,48 @@
-﻿assembly-versioning-scheme: MajorMinorPatch
-mode: ContinuousDelivery
-tag-prefix: '[vV]'
-continuous-delivery-fallback-tag: ci
-branches:
-  master:
-    tag: 
-    increment: Patch
-    prevent-increment-of-merged-branch-version: true
-  release[/-]:
-    tag: beta
-  feature[/-]:
-    tag: useBranchName
-    increment: Inherit
-  hotfix[/-]:
-    tag: beta
-  support[/-]:
-    tag: 
-    increment: Patch
-    prevent-increment-of-merged-branch-version: true
-  develop:
-    mode: ContinuousDeployment
-    tag: unstable
-    increment: Minor
-    track-merge-target: true
-  (pull|pull\-requests|pr)[/-]:
-    tag: PullRequest
-    increment: Inherit
-    tag-number-pattern: '[/-](?<number>\d+)[-/]'
+﻿assembly-versioning-scheme: MajorMinorPatch
+mode: ContinuousDelivery
+tag-prefix: '[vV]'
+continuous-delivery-fallback-tag: ci
+branches:
+  master:
+    mode: ContinuousDelivery
+    tag: 
+    increment: Patch
+    prevent-increment-of-merged-branch-version: true
+    track-merge-target: false
+  release[/-]:
+    mode: ContinuousDelivery
+    tag: beta
+    increment: Patch
+    prevent-increment-of-merged-branch-version: true
+    track-merge-target: false
+  feature[/-]:
+    mode: ContinuousDelivery
+    tag: useBranchName
+    increment: Inherit
+    prevent-increment-of-merged-branch-version: false
+    track-merge-target: false
+  (pull|pull\-requests|pr)[/-]:
+    mode: ContinuousDelivery
+    tag: PullRequest
+    increment: Inherit
+    prevent-increment-of-merged-branch-version: false
+    tag-number-pattern: '[/-](?<number>\d+)[-/]'
+    track-merge-target: false
+  hotfix[/-]:
+    mode: ContinuousDelivery
+    tag: beta
+    increment: Patch
+    prevent-increment-of-merged-branch-version: false
+    track-merge-target: false
+  support[/-]:
+    mode: ContinuousDelivery
+    tag: 
+    increment: Patch
+    prevent-increment-of-merged-branch-version: true
+    track-merge-target: false
+  develop:
+    mode: ContinuousDeployment
+    tag: unstable
+    increment: Minor
+    prevent-increment-of-merged-branch-version: false
+    track-merge-target: true
diff --git a/src/GitVersionCore.Tests/Fixtures/RepositoryFixtureBase.cs b/src/GitVersionCore.Tests/Fixtures/RepositoryFixtureBase.cs
@@ -16,6 +16,7 @@ public abstract class RepositoryFixtureBase : IDisposable
 
     protected RepositoryFixtureBase(Func<string, IRepository> repoBuilder, Config configuration)
     {
+        ConfigurationProvider.ApplyDefaultsTo(configuration);
         diagramBuilder = new StringBuilder();
         diagramBuilder.AppendLine("@startuml");
         this.configuration = configuration;
diff --git a/src/GitVersionCore.Tests/GitVersionContextBuilder.cs b/src/GitVersionCore.Tests/GitVersionContextBuilder.cs
@@ -58,7 +58,9 @@ public GitVersionContextBuilder AddBranch(string branchName)
 
         public GitVersionContext Build()
         {
-            return new GitVersionContext(repository ?? CreateRepository(), config ?? new Config());
+            var configuration = config ?? new Config();
+            ConfigurationProvider.ApplyDefaultsTo(configuration);
+            return new GitVersionContext(repository ?? CreateRepository(), configuration);
         }
 
         IRepository CreateRepository()
diff --git a/src/GitVersionCore.Tests/GitVersionContextTests.cs b/src/GitVersionCore.Tests/GitVersionContextTests.cs
@@ -15,6 +15,7 @@ public void CanInheritVersioningMode(VersioningMode mode)
             {
                 VersioningMode = mode
             };
+            ConfigurationProvider.ApplyDefaultsTo(config);
 
             var mockBranch = new MockBranch("master") { new MockCommit { CommitterEx = SignatureBuilder.SignatureNow() } };
             var mockRepository = new MockRepository
@@ -34,10 +35,19 @@ public void UsesBranchSpecificConfigOverTopLevelDefaults()
         {
             var config = new Config
             {
-                VersioningMode = VersioningMode.ContinuousDelivery
+                VersioningMode = VersioningMode.ContinuousDelivery,
+                Branches =
+                {
+                    {
+                        "develop", new BranchConfig
+                        {
+                            VersioningMode = VersioningMode.ContinuousDeployment,
+                            Tag = "alpha"
+                        }
+                    }
+                }
             };
-            config.Branches["develop"].VersioningMode = VersioningMode.ContinuousDeployment;
-            config.Branches["develop"].Tag = "alpha";
+            ConfigurationProvider.ApplyDefaultsTo(config);
             var develop = new MockBranch("develop") { new MockCommit { CommitterEx = SignatureBuilder.SignatureNow() } };
             var mockRepository = new MockRepository
             {
@@ -54,9 +64,14 @@ public void UsesBranchSpecificConfigOverTopLevelDefaults()
         [Test]
         public void CanFindParentBranchForInheritingIncrementStrategy()
         {
-            var config = new Config();
-            config.Branches["develop"].Increment = IncrementStrategy.Major;
-            config.Branches["feature[/-]"].Increment = IncrementStrategy.Inherit;
+            var config = new Config
+            {
+                Branches =
+                {
+                    { "develop", new BranchConfig { Increment = IncrementStrategy.Major} },
+                    { "feature[/-]", new BranchConfig { Increment = IncrementStrategy.Inherit} }
+                }
+            };
 
             using (var repo = new EmptyRepositoryFixture(config))
             {
diff --git a/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/DevelopScenarios.cs
@@ -55,8 +55,13 @@ public void WhenDevelopBranchedFromTaggedCommitOnMasterVersionDoesNotChange()
     [Test]
     public void CanChangeDevelopTagViaConfig()
     {
-        var config = new Config();
-        config.Branches["develop"].Tag = "alpha";
+        var config = new Config
+        {
+            Branches =
+            {
+                { "develop", new BranchConfig { Tag = "alpha" } }
+            }
+        };
         using (var fixture = new EmptyRepositoryFixture(config))
         {
             fixture.Repository.MakeATaggedCommit("1.0.0");
@@ -100,8 +105,13 @@ public void MergingReleaseBranchBackIntoDevelopWithMergingToMaster_DoesBumpDevel
     [Test]
     public void CanHandleContinuousDelivery()
     {
-        var config = new Config();
-        config.Branches["develop"].VersioningMode = VersioningMode.ContinuousDelivery;
+        var config = new Config
+        {
+            Branches =
+            {
+                { "develop", new BranchConfig { VersioningMode = VersioningMode.ContinuousDelivery} }
+            }
+        };
         using (var fixture = new EmptyRepositoryFixture(config))
         {
             fixture.Repository.MakeATaggedCommit("1.0.0");
diff --git a/src/GitVersionCore.Tests/IntegrationTests/FeatureBranchScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/FeatureBranchScenarios.cs
@@ -35,8 +35,13 @@ public void ShouldInheritIncrementCorrectlyWithMultiplePossibleParentsAndWeirdly
     [Test]
     public void BranchCreatedAfterFastForwardMergeShouldInheritCorrectly()
     {
-        var config = new Config();
-        config.Branches.Add("unstable", config.Branches["develop"]);
+        var config = new Config
+        {
+            Branches =
+            {
+                { "unstable", new BranchConfig { Increment = IncrementStrategy.Minor } }
+            }
+        };
 
         using (var fixture = new EmptyRepositoryFixture(config))
         {
diff --git a/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/ReleaseBranchScenarios.cs
@@ -89,8 +89,13 @@ public void ReleaseBranchWithNextVersionSetInConfig()
     [Test]
     public void CanTakeVersionFromReleaseBranchWithTagOverridden()
     {
-        var config = new Config();
-        config.Branches["release[/-]"].Tag = "rc";
+        var config = new Config
+        {
+            Branches =
+            {
+                { "release[/-]", new BranchConfig { Tag = "rc" } }
+            }
+        };
         using (var fixture = new EmptyRepositoryFixture(config))
         {
             fixture.Repository.MakeATaggedCommit("1.0.3");
diff --git a/src/GitVersionCore.Tests/IntegrationTests/VersionBumpingScenarios.cs b/src/GitVersionCore.Tests/IntegrationTests/VersionBumpingScenarios.cs
@@ -7,8 +7,13 @@ public class VersionBumpingScenarios
     [Test]
     public void AppliedPrereleaseTagCausesBump()
     {
-        var configuration = new Config();
-        configuration.Branches["master"].Tag = "pre";
+        var configuration = new Config
+        {
+            Branches =
+            {
+                { "master", new BranchConfig { Tag = "pre" } }
+            }
+        };
         using (var fixture = new EmptyRepositoryFixture(configuration))
         {
             fixture.Repository.MakeACommit();
diff --git a/src/GitVersionCore.Tests/SemanticVersionTests.cs b/src/GitVersionCore.Tests/SemanticVersionTests.cs
@@ -26,9 +26,9 @@ public class SemanticVersionTests
     [TestCase("1.2.3+4.Branch.Foo", 1, 2, 3, null, null, 4, "Foo", null, null, null, null)]
     [TestCase("1.2.3+randomMetaData", 1, 2, 3, null, null, null, null, null, "randomMetaData", null, null)]
     [TestCase("1.2.3-beta.1+4.Sha.12234.Othershiz", 1, 2, 3, "beta", 1, 4, null, "12234", "Othershiz", null, null)]
-    [TestCase("1.2.3", 1, 2, 3, null, null, null, null, null, null, null, Config.DefaultTagPrefix)]
-    [TestCase("v1.2.3", 1, 2, 3, null, null, null, null, null, null, "1.2.3", Config.DefaultTagPrefix)]
-    [TestCase("V1.2.3", 1, 2, 3, null, null, null, null, null, null, "1.2.3", Config.DefaultTagPrefix)]
+    [TestCase("1.2.3", 1, 2, 3, null, null, null, null, null, null, null, ConfigurationProvider.DefaultTagPrefix)]
+    [TestCase("v1.2.3", 1, 2, 3, null, null, null, null, null, null, "1.2.3", ConfigurationProvider.DefaultTagPrefix)]
+    [TestCase("V1.2.3", 1, 2, 3, null, null, null, null, null, null, "1.2.3", ConfigurationProvider.DefaultTagPrefix)]
     [TestCase("version-1.2.3", 1, 2, 3, null, null, null, null, null, null, "1.2.3", "version-")]
     public void ValidateVersionParsing(
         string versionString, int major, int minor, int patch, string tag, int? tagNumber, int? numberOfBuilds,
diff --git a/src/GitVersionCore/BranchConfigurationCalculator.cs b/src/GitVersionCore/BranchConfigurationCalculator.cs
@@ -14,7 +14,9 @@ public static KeyValuePair<string, BranchConfig> GetBranchConfiguration(Commit c
 
             if (matchingBranches.Length == 0)
             {
-                return new KeyValuePair<string, BranchConfig>(string.Empty, new BranchConfig());
+                var branchConfig = new BranchConfig();
+                ConfigurationProvider.ApplyBranchDefaults(config, branchConfig);
+                return new KeyValuePair<string, BranchConfig>(string.Empty, branchConfig);
             }
             if (matchingBranches.Length == 1)
             {
diff --git a/src/GitVersionCore/Configuration/BranchConfig.cs b/src/GitVersionCore/Configuration/BranchConfig.cs
@@ -37,6 +37,6 @@ public BranchConfig(BranchConfig branchConfiguration)
         public string TagNumberPattern { get; set; }
 
         [YamlMember(Alias = "track-merge-target")]
-        public bool TrackMergeTarget { get; set; }
+        public bool? TrackMergeTarget { get; set; }
     }
 }
diff --git a/src/GitVersionCore/Configuration/Config.cs b/src/GitVersionCore/Configuration/Config.cs
@@ -6,53 +6,10 @@
 
     public class Config
     {
-        internal const string DefaultTagPrefix = "[vV]";
-
         Dictionary<string, BranchConfig> branches = new Dictionary<string, BranchConfig>();
 
-        public Config()
-        {
-            AssemblyVersioningScheme = AssemblyVersioningScheme.MajorMinorPatch;
-            TagPrefix = DefaultTagPrefix;
-            VersioningMode = GitVersion.VersioningMode.ContinuousDelivery;
-            ContinuousDeploymentFallbackTag = "ci";
-
-            Branches["master"] = new BranchConfig
-            {
-                Tag = string.Empty,
-                Increment = IncrementStrategy.Patch,
-                PreventIncrementOfMergedBranchVersion = true
-            };
-            Branches["release[/-]"] = new BranchConfig { Tag = "beta" };
-            Branches["feature[/-]"] = new BranchConfig
-            {
-                Increment = IncrementStrategy.Inherit,
-                Tag = "useBranchName"
-            };
-            Branches["hotfix[/-]"] = new BranchConfig { Tag = "beta" };
-            Branches["support[/-]"] = new BranchConfig
-            {
-                Tag = string.Empty,
-                Increment = IncrementStrategy.Patch,
-                PreventIncrementOfMergedBranchVersion = true
-            };
-            Branches["develop"] = new BranchConfig
-            {
-                Tag = "unstable",
-                Increment = IncrementStrategy.Minor,
-                VersioningMode = GitVersion.VersioningMode.ContinuousDeployment,
-                TrackMergeTarget = true
-            };
-            Branches[@"(pull|pull\-requests|pr)[/-]"] = new BranchConfig
-            {
-                Tag = "PullRequest",
-                TagNumberPattern = @"[/-](?<number>\d+)[-/]",
-                Increment = IncrementStrategy.Inherit
-            };
-        }
-
         [YamlMember(Alias = "assembly-versioning-scheme")]
-        public AssemblyVersioningScheme AssemblyVersioningScheme { get; set; }
+        public AssemblyVersioningScheme? AssemblyVersioningScheme { get; set; }
 
         [YamlMember(Alias = "mode")]
         public VersioningMode? VersioningMode { get; set; }
diff --git a/src/GitVersionCore/Configuration/ConfigurationProvider.cs b/src/GitVersionCore/Configuration/ConfigurationProvider.cs
@@ -1,13 +1,84 @@
 namespace GitVersion
 {
     using System.IO;
+    using System.Linq;
     using System.Text;
     using GitVersion.Configuration.Init.Wizard;
     using GitVersion.Helpers;
 
     public class ConfigurationProvider
     {
-        public static Config Provide(string workingDirectory, IFileSystem fileSystem)
+        internal const string DefaultTagPrefix = "[vV]";
+
+        public static Config Provide(string workingDirectory, IFileSystem fileSystem, bool applyDefaults = true)
+        {
+            var readConfig = ReadConfig(workingDirectory, fileSystem);
+            if (applyDefaults)
+                ApplyDefaultsTo(readConfig);
+            return readConfig;
+        }
+
+        public static void ApplyDefaultsTo(Config config)
+        {
+            config.AssemblyVersioningScheme = config.AssemblyVersioningScheme ?? AssemblyVersioningScheme.MajorMinorPatch;
+            config.TagPrefix = config.TagPrefix ?? DefaultTagPrefix;
+            config.VersioningMode = config.VersioningMode ?? VersioningMode.ContinuousDelivery;
+            config.ContinuousDeploymentFallbackTag = config.ContinuousDeploymentFallbackTag ?? "ci";
+            var configBranches = config.Branches.ToList();
+
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "master"), defaultTag: string.Empty, defaultPreventIncrement: true);
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "release[/-]"), defaultTag: "beta", defaultPreventIncrement: true);
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "feature[/-]"), defaultIncrementStrategy: IncrementStrategy.Inherit);
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, @"(pull|pull\-requests|pr)[/-]"),
+                defaultTag: "PullRequest",
+                defaultTagNumberPattern: @"[/-](?<number>\d+)[-/]",
+                defaultIncrementStrategy: IncrementStrategy.Inherit);
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "hotfix[/-]"), defaultTag: "beta");
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "support[/-]"), defaultTag: string.Empty, defaultPreventIncrement: true);
+            ApplyBranchDefaults(config, GetOrCreateBranchDefaults(config, "develop"), 
+                defaultTag: "unstable",
+                defaultIncrementStrategy: IncrementStrategy.Minor,
+                defaultVersioningMode: VersioningMode.ContinuousDeployment,
+                defaultTrackMergeTarget: true);
+
+            // Any user defined branches should have other values defaulted after known branches filled in
+            // This allows users to override one value of 
+            foreach (var branchConfig in configBranches)
+            {
+                ApplyBranchDefaults(config, branchConfig.Value);
+            }
+        }
+
+        static BranchConfig GetOrCreateBranchDefaults(Config config, string branch)
+        {
+            if (!config.Branches.ContainsKey(branch))
+            {
+                var branchConfig = new BranchConfig();
+                config.Branches.Add(branch, branchConfig);
+                return branchConfig;
+            }
+
+            return config.Branches[branch];
+        }
+
+        public static void ApplyBranchDefaults(Config config,
+            BranchConfig branchConfig, 
+            string defaultTag = "useBranchName",
+            IncrementStrategy defaultIncrementStrategy = IncrementStrategy.Patch,
+            bool defaultPreventIncrement = false,
+            VersioningMode? defaultVersioningMode = null, // Looked up from main config
+            bool defaultTrackMergeTarget = false,
+            string defaultTagNumberPattern = null)
+        {
+            branchConfig.Tag = branchConfig.Tag ?? defaultTag;
+            branchConfig.TagNumberPattern = branchConfig.TagNumberPattern ?? defaultTagNumberPattern;
+            branchConfig.Increment = branchConfig.Increment ?? defaultIncrementStrategy;
+            branchConfig.PreventIncrementOfMergedBranchVersion = branchConfig.PreventIncrementOfMergedBranchVersion ?? defaultPreventIncrement;
+            branchConfig.TrackMergeTarget = branchConfig.TrackMergeTarget ?? defaultTrackMergeTarget;
+            branchConfig.VersioningMode = branchConfig.VersioningMode ?? defaultVersioningMode ?? config.VersioningMode;
+        }
+
+        static Config ReadConfig(string workingDirectory, IFileSystem fileSystem)
         {
             var configFilePath = GetConfigFilePath(workingDirectory);
 
diff --git a/src/GitVersionCore/GitVersionContext.cs b/src/GitVersionCore/GitVersionContext.cs
diff --git a/src/GitVersionExe.Tests/AssemblyInfoFileUpdateTests.cs b/src/GitVersionExe.Tests/AssemblyInfoFileUpdateTests.cs

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ public abstract class RepositoryFixtureBase : IDisposable`
`16`	`16`
`17`	`17`	`protected RepositoryFixtureBase(Func<string, IRepository> repoBuilder, Config configuration)`
`18`	`18`	`{`
	`19`	`+ ConfigurationProvider.ApplyDefaultsTo(configuration);`
`19`	`20`	`diagramBuilder = new StringBuilder();`
`20`	`21`	`diagramBuilder.AppendLine("@startuml");`
`21`	`22`	`this.configuration = configuration;`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,9 @@ public GitVersionContextBuilder AddBranch(string branchName)`
`58`	`58`
`59`	`59`	`public GitVersionContext Build()`
`60`	`60`	`{`
`61`		`- return new GitVersionContext(repository ?? CreateRepository(), config ?? new Config());`
	`61`	`+ var configuration = config ?? new Config();`
	`62`	`+ ConfigurationProvider.ApplyDefaultsTo(configuration);`
	`63`	`+ return new GitVersionContext(repository ?? CreateRepository(), configuration);`
`62`	`64`	`}`
`63`	`65`
`64`	`66`	`IRepository CreateRepository()`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,9 @@ public static KeyValuePair<string, BranchConfig> GetBranchConfiguration(Commit c`
`14`	`14`
`15`	`15`	`if (matchingBranches.Length == 0)`
`16`	`16`	`{`
`17`		`- return new KeyValuePair<string, BranchConfig>(string.Empty, new BranchConfig());`
	`17`	`+ var branchConfig = new BranchConfig();`
	`18`	`+ ConfigurationProvider.ApplyBranchDefaults(config, branchConfig);`
	`19`	`+ return new KeyValuePair<string, BranchConfig>(string.Empty, branchConfig);`
`18`	`20`	`}`
`19`	`21`	`if (matchingBranches.Length == 1)`
`20`	`22`	`{`