Starting a gitversion init config helper/wizard

Author: JakeGinnivan

GitVersionCore.Tests/ConfigProviderTests.cs

@@ -124,24 +124,6 @@ public void CanReadDefaultDocument()
         config.NextVersion.ShouldBe(null);
     }
 
-    [Test]
-    public void VerifyInit()
-    {
-        var config = typeof(Config);
-        var aliases = config.GetProperties()
-            .Where(p => p.GetCustomAttribute<ObsoleteAttribute>() == null)
-            .Select(p => ((YamlMemberAttribute) p.GetCustomAttribute(typeof(YamlMemberAttribute))).Alias);
-        var writer = new StringWriter();
-
-        ConfigSerialiser.WriteSample(writer);
-        var initFile = writer.GetStringBuilder().ToString();
-
-        foreach (var alias in aliases)
-        {
-            initFile.ShouldContain(alias);
-        }
-    }
-
     [Test]
     public void VerifyAliases()
     {

GitVersionCore/Configuration/ConfigSerialiser.cs

@@ -22,17 +22,5 @@ public static void Write(Config config, TextWriter writer)
             var serializer = new Serializer(SerializationOptions.None, new HyphenatedNamingConvention());
             serializer.Serialize(writer, config);
         }
-
-        public static void WriteSample(TextWriter writer)
-        {
-            writer.WriteLine("# assembly-versioning-scheme: MajorMinorPatchTag | MajorMinorPatch | MajorMinor | Major");
-            writer.WriteLine("# tag-prefix: '[vV|version-] # regex to match git tag prefix");
-            writer.WriteLine("# next-version: 1.0.0");
-            writer.WriteLine("# mode: ContinuousDelivery | ContinuousDeployment");
-            writer.WriteLine("# continuous-delivery-fallback-tag: ci");
-            writer.WriteLine("#branches:");
-            writer.WriteLine("#   release[/-]:\n    mode: ContinuousDelivery | ContinuousDeployment\n    tag: rc");
-            writer.WriteLine("#   develop:\n#    mode: ContinuousDelivery | ContinuousDeployment\n#    tag: alpha");
-        }
     }
 }

GitVersionCore/Configuration/ConfigurationProvider.cs

@@ -33,27 +33,22 @@ public static string GetEffectiveConfigAsString(string gitDirectory, IFileSystem
             return stringBuilder.ToString();
         }
 
-        public static void WriteSample(string workingDirectory, IFileSystem fileSystem)
+        static string GetConfigFilePath(string workingDirectory)
+        {
+            return Path.Combine(workingDirectory, "GitVersionConfig.yaml");
+        }
+
+        public static void Init(string workingDirectory, IFileSystem fileSystem)
         {
             var configFilePath = GetConfigFilePath(workingDirectory);
+            var config = new ConfigInitWizard().Run(Provide(workingDirectory, fileSystem));
+            if (config == null) return;
 
-            if (!fileSystem.Exists(configFilePath))
-            {
-                using (var stream = fileSystem.OpenWrite(configFilePath))
-                using (var writer = new StreamWriter(stream))
-                {
-                    ConfigSerialiser.WriteSample(writer);
-                }
-            }
-            else
+            using (var stream = fileSystem.OpenWrite(configFilePath))
+            using (var writer = new StreamWriter(stream))
             {
-                Logger.WriteError("Cannot write sample, GitVersionConfig.yaml already exists");
+                ConfigSerialiser.Write(config, writer);
             }
         }
-
-        static string GetConfigFilePath(string workingDirectory)
-        {
-            return Path.Combine(workingDirectory, "GitVersionConfig.yaml");
-        }
     }
 }

GitVersionCore/Configuration/Wizard/ConfigInitWizard.cs

@@ -0,0 +1,26 @@
+namespace GitVersion
+{
+    using System;
+    using System.Collections.Generic;
+
+    public class ConfigInitWizard
+    {
+        public Config Run(Config config)
+        {
+            Console.WriteLine("GitVersion init will guide you through setting GitVersion up to work for you");
+            var steps = new Queue<ConfigInitWizardStep>();
+            steps.Enqueue(new SimpleOrTutorialStep());
+
+            while (steps.Count > 0)
+            {
+                var currentStep = steps.Dequeue();
+                if (!currentStep.Apply(steps, config))
+                {
+                    return null;
+                }
+            }
+
+            return config;
+        }
+    }
+}

GitVersionCore/Configuration/Wizard/ConfigInitWizardStep.cs

@@ -0,0 +1,33 @@
+namespace GitVersion
+{
+    using System;
+    using System.Collections.Generic;
+
+    public abstract class ConfigInitWizardStep
+    {
+        public bool Apply(Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            Console.WriteLine(Prompt);
+            var input = Console.ReadLine();
+            if (input == null)
+            {
+                return false;
+            }
+            var resultWithDefaultApplied = string.IsNullOrEmpty(input) ? DefaultResult : input;
+            var stepResult = HandleResult(resultWithDefaultApplied, steps, config);
+            if (stepResult.InvalidResponse)
+            {
+                Console.WriteLine();
+                Console.ForegroundColor = ConsoleColor.Red;
+                Console.WriteLine("Invalid response!");
+                Console.ResetColor();
+                steps.Enqueue(this);
+            }
+            return true;
+        }
+
+        protected abstract StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config);
+        protected abstract string Prompt { get; }
+        protected abstract string DefaultResult { get; }
+    }
+}

GitVersionCore/Configuration/Wizard/ExpressSetupStep.cs

@@ -0,0 +1,24 @@
+namespace GitVersion
+{
+    using System;
+    using System.Collections.Generic;
+
+    public class ExpressSetupStep : ConfigInitWizardStep
+    {
+        protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            Console.WriteLine("Not done yet...");
+            return StepResult.Ok();
+        }
+
+        protected override string Prompt
+        {
+            get { return "Not done yet"; }
+        }
+
+        protected override string DefaultResult
+        {
+            get { return null; }
+        }
+    }
+}

GitVersionCore/Configuration/Wizard/GitFlowSetupStep.cs

@@ -0,0 +1,22 @@
+namespace GitVersion
+{
+    using System.Collections.Generic;
+
+    public class GitFlowSetupStep : ConfigInitWizardStep
+    {
+        protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            throw new System.NotImplementedException();
+        }
+
+        protected override string Prompt
+        {
+            get { throw new System.NotImplementedException(); }
+        }
+
+        protected override string DefaultResult
+        {
+            get { throw new System.NotImplementedException(); }
+        }
+    }
+}

GitVersionCore/Configuration/Wizard/GitHubFlowStep.cs

@@ -0,0 +1,22 @@
+namespace GitVersion
+{
+    using System.Collections.Generic;
+
+    public class GitHubFlowStep : ConfigInitWizardStep
+    {
+        protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            throw new System.NotImplementedException();
+        }
+
+        protected override string Prompt
+        {
+            get { throw new System.NotImplementedException(); }
+        }
+
+        protected override string DefaultResult
+        {
+            get { throw new System.NotImplementedException(); }
+        }
+    }
+}

GitVersionCore/Configuration/Wizard/PickBranchingStrategy1Step.cs

@@ -0,0 +1,38 @@
+namespace GitVersion
+{
+    using System;
+    using System.Collections.Generic;
+
+    public class PickBranchingStrategy1Step : ConfigInitWizardStep
+    {
+        protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            switch (result.ToLower())
+            {
+                case "y":
+                    Console.Write(@"Because you need to maintain multiple versions of your product in production at the same time, GitFlow is likely a good fit.
+
+GitFlow allows you to have new development happening on the 'develop' branch, patch issues in old minor versions with 'hotfix/' branches and support old major versions with 'support/' branches");
+                    steps.Enqueue(new PickBranchingStrategyStep());
+                    return StepResult.Ok();
+                case "n":
+                    steps.Enqueue(new PickBranchingStrategy2Step());
+                    return StepResult.Ok();
+            }
+
+            return StepResult.InvalidResponseSelected();
+        }
+
+        protected override string Prompt
+        {
+            get { return @"GitVersion can try to recommend you a branching strategy based on a few questions. 
+
+Do you need to maintain mutliple versions of your application simultanously in production? (y/n)"; }
+        }
+
+        protected override string DefaultResult
+        {
+            get { return null; }
+        }
+    }
+}

GitVersionCore/Configuration/Wizard/PickBranchingStrategy2Step.cs

@@ -0,0 +1,39 @@
+namespace GitVersion
+{
+    using System;
+    using System.Collections.Generic;
+
+    public class PickBranchingStrategy2Step : ConfigInitWizardStep
+    {
+        protected override StepResult HandleResult(string result, Queue<ConfigInitWizardStep> steps, Config config)
+        {
+            switch (result.ToLower())
+            {
+                case "y":
+                    Console.WriteLine("GitFlow is likely a good fit, the 'develop' branch can be used " +
+                                      "for active development while stabilising the next release.");
+                    Console.WriteLine();
+                    Console.WriteLine("GitHubFlow is designed for a lightwieght workflow where master is always " +
+                                      "good to deploy to production and feature branches are used to stabilise " +
+                                      "features, once stable they can be released in the next release");
+                    steps.Enqueue(new PickBranchingStrategyStep());
+                    return StepResult.Ok();
+                case "n":
+                    steps.Enqueue(new PickBranchingStrategy3Step());
+                    return StepResult.Ok();
+            }
+
+            return StepResult.InvalidResponseSelected();
+        }
+
+        protected override string Prompt
+        {
+            get { return "Do you stabilise releases while continuing work on the next version? (y/n)"; }
+        }
+
+        protected override string DefaultResult
+        {
+            get { return null; }
+        }
+    }
+}