Add multi-branch force (#50)

* Add multi-branch force

* Fix some excellent tests

* Normalize your directory separators, please

* Fix the most excellent test

* Add tests for new functionality

* Finally, some documentation

Author: beevee

Commands/ConvertSpec.cs

@@ -73,8 +73,8 @@ private void ConvertDepsSection(string configuration, List<string> children)
             writer.WriteLine("  deps:");
             if (deps.Force != null)
             {
-                deps.Force = deps.Force.Replace("%CURRENT_BRANCH%", "$CURRENT_BRANCH");
-                writer.WriteLine("    - force: " + deps.Force);
+                deps.Force = deps.Force.Select(x => x.Replace("%CURRENT_BRANCH%", "$CURRENT_BRANCH")).ToArray();
+                writer.WriteLine("    - force: " + string.Join(",", deps.Force));
             }
             if (deps.Deps == null)
                 return;

Common/DepsIniParser.cs

@@ -54,10 +54,10 @@ private List<Dep> GetDepsFromIni(IniData parsed)
             return deps;
         }
 
-        private string GetForceFromIni(IniData parsed)
+        private string[] GetForceFromIni(IniData parsed)
         {
             var force = parsed.GetValue("force", "main");
-            return force == "" ? null : force;
+            return force == "" ? null : force.Split(',');
         }
     }
 }

Common/ModuleGetter.cs

@@ -44,7 +44,7 @@ public void GetDeps()
             rootRepoTreeish = rootRepo.CurrentLocalTreeish().Value;
 
             var depsContent = new DepsParser(rootRepo.RepoPath).Get(rootModule.Configuration);
-            depsContent.Force = Helper.DefineForce(depsContent.Force, rootRepo);
+            depsContent.Force = depsContent.Force?.Select(f => Helper.DefineForce(f, rootRepo)).ToArray();
             Log.Info("OK");
 
             var queue = new DepsQueue();
@@ -74,7 +74,7 @@ private void TakeDepsToProcessFromQueue(DepsQueue queue, IList<DepWithParent> de
             }
         }
 
-        private void GetDeps(string force, DepsQueue queue, ModulesContainer processed)
+        private void GetDeps(string[] force, DepsQueue queue, ModulesContainer processed)
         {
             while (!queue.IsEmpty())
             {
@@ -95,7 +95,7 @@ private void GetDeps(string force, DepsQueue queue, ModulesContainer processed)
                 ConsoleWriter.WriteWarning($"Branch '{mergedBranch}' was not merged into some of dependencies");
         }
 
-        private void ProcessDeps(string force, List<DepWithParent> depsPool)
+        private void ProcessDeps(string[] force, List<DepWithParent> depsPool)
         {
             if (depsPool.Any())
                 Log.Info("Parallel update-deps iteration: " + depsPool.Select(d => d.Dep.ToString() + "(" + d.ParentModule + ")").Aggregate((a, b) => a + " " + b));
@@ -153,12 +153,12 @@ private static DepsContent GetCurrentModuleDeps(Dep dep)
             return deps;
         }
 
-        private void GetModule(Dep dep, string force)
+        private void GetModule(Dep dep, string[] force)
         {
             Log.Info($"{"[" + dep.Name + "]",-30}Update '{dep.Treeish ?? "master"}'");
             if (dep.Treeish == "$CURRENT_BRANCH")
             {
-                force = Helper.DefineForce(dep.Treeish, rootRepoTreeish);
+                force = new[] {Helper.DefineForce(dep.Treeish, rootRepoTreeish)};
                 dep.Treeish = null;
             }
             ConsoleWriter.WriteProgress(dep.Name + "   " + dep.Treeish);
@@ -170,7 +170,7 @@ private void GetModule(Dep dep, string force)
             GetFullModule(dep, force);
         }
 
-        private void GetFullModule(Dep dep, string force)
+        private void GetFullModule(Dep dep, string[] force)
         {
             var getInfo = new GetInfo();
             var module = modules.FirstOrDefault(m => m.Name.Equals(dep.Name));
@@ -194,7 +194,7 @@ private void GetFullModule(Dep dep, string force)
                 getInfo.CommitInfo = repo.GetCommitInfo();
             if (HooksHelper.InstallHooks(dep.Name))
                 getInfo.HookUpdated = true;
-            PrintProcessedModuleInfo(dep, getInfo, getInfo.Forced ? force : dep.Treeish);
+            PrintProcessedModuleInfo(dep, getInfo, getInfo.Forced ? getInfo.ForcedBranch : dep.Treeish);
             WarnIfNotMerged(repo);
         }
 
@@ -287,16 +287,16 @@ private void PrintProcessedModuleInfo(Dep dep, GetInfo getInfo, string treeish)
             }
         }
 
-        private void GetTreeish(GitRepository repo, Dep dep, string force, string treeish, GetInfo getInfo)
+        private void GetTreeish(GitRepository repo, Dep dep, string[] force, string treeish, GetInfo getInfo)
         {
             treeish = treeish ?? "master";
             Log.Info($"{"[" + dep.Name + "]",-30}Getting treeish '{treeish}'");
 
             var hasRemoteBranch = repo.HasRemoteBranch(treeish);
-            getInfo.Forced = HaveToForce(dep, force, repo);
+            getInfo.ForcedBranch = HaveToForce(dep, force, repo);
             if (getInfo.Forced)
             {
-                treeish = force;
+                treeish = getInfo.ForcedBranch;
                 Log.Info($"{"[" + dep.Name + "]",-30}treeish '{treeish}' was forced");
             }
 
@@ -390,15 +390,22 @@ private static void Reset(GitRepository repo, Dep dep)
             }
         }
 
-        private bool HaveToForce(Dep dep, string force, GitRepository repo)
+        private string HaveToForce(Dep dep, string[] force, GitRepository repo)
         {
-            if (!localBranchForce && repo.HasLocalBranch(force) && !repo.HasRemoteBranch(force))
-            {
-                ConsoleWriter.WriteWarning(
-                    $"Module '{repo.ModuleName}' has local-only branch '{force}' which will not be forced.\nUse --allow-local-branch-force key to force it");
-                return false;
-            }
-            return dep.Treeish == null && force != null && repo.HasRemoteBranch(force);
+            if (force != null)
+                foreach (var f in force)
+                {
+                    if (!localBranchForce && repo.HasLocalBranch(f) && !repo.HasRemoteBranch(f))
+                    {
+                        ConsoleWriter.WriteWarning(
+                            $"Module '{repo.ModuleName}' has local-only branch '{force}' which will not be forced.\nUse --allow-local-branch-force key to force it");
+                        continue;
+                    }
+
+                    if (dep.Treeish == null && repo.HasRemoteBranch(f))
+                        return f;
+                }
+            return null;
         }
 
         private LocalChangesAction DefineLocalChangesPolicy(GitRepository repo, string localSha, string remoteSha)
@@ -472,7 +479,8 @@ public enum LocalChangesPolicy
     public class GetInfo
     {
         public bool Cloned;
-        public bool Forced;
+        public bool Forced => ForcedBranch != null;
+        public string ForcedBranch;
         public bool Changed;
         public bool ForcedLocal;
         public bool Pulled;
@@ -483,7 +491,7 @@ public class GetInfo
         public GetInfo()
         {
             Cloned = false;
-            Forced = false;
+            ForcedBranch = null;
             Changed = false;
             ForcedLocal = false;
             Pulled = false;

Common/YamlParsers/ConfigurationYamlParser.cs

@@ -141,10 +141,10 @@ public Dictionary<string, IList<string>> GetConfigurationsHierarchy()
 
     public class DepsContent
     {
-        public string Force { get; set; }
+        public string[] Force { get; set; }
         public List<Dep> Deps { get; set; }
 
-        public DepsContent(string force, List<Dep> deps)
+        public DepsContent(string[] force, List<Dep> deps)
         {
             Force = force;
             Deps = deps;

Common/YamlParsers/DepsYamlParser.cs

@@ -155,14 +155,14 @@ private static DepsContent GetDepsFromSection(Dictionary<string, object> configS
                 return new DepsContent(null, new List<Dep>());
 
             var deps = new List<Dep>();
-            string force = null;
+            string[] force = null;
             foreach (var depSection in (List<object>) configSection["deps"])
             {
                 if (depSection is Dictionary<object, object>)
                 {
                     var dict = depSection as Dictionary<object, object>;
                     if (dict.Keys.Count == 1 && (string) dict.Keys.First() == "force")
-                        force = (string) dict.Values.First();
+                        force = ((string) dict.Values.First()).Split(',');
                     else
                         deps.Add(GetDepFromDictFormat(dict));
                 }

README-module.yaml.md

@@ -34,7 +34,12 @@ Example:
         - topology
         # to prefer current branch in deps
         - force: $CURRENT_BRANCH
-        # or use <moduleName>@$CURRENT_BRANCH to prefer current branch in some module
+        # or use <moduleName>@$CURRENT_BRANCH to prefer current branch in some module;
+        # you can also choose any specific branch name in deps:
+        # - force: mybestbranch
+        # or provide a comma-separated list of preferred branches:
+        # - force: mybestbranch,notsogoodbranch,leastfavoritebranch
+        # master branch is always the default option if all forced branches are missing
 
       # information on build of the present module in the present configuration
       build:

Tests/CommandsTests/TestConvertSpec.cs

@@ -63,7 +63,7 @@ private static void AddDeps(List<Dep> deps, string configuration = null, string
 
             var readedDeps = new DepsIniParser(new FileInfo(depsFileName)).Get();
             CollectionAssert.AreEquivalent(readedDeps.Deps, deps);
-            Assert.AreEqual(force, readedDeps.Force);
+            Assert.AreEqual(force, readedDeps.Force?.Single());
         }
 
         private static void WriteDeps(List<Dep> deps, string force, string depsFileName)
@@ -105,7 +105,7 @@ public void TestSimpleDepsWithForce()
 
             var yamlDeps = Yaml.DepsParser("module").Get();
             CollectionAssert.AreEqual(deps, yamlDeps.Deps);
-            Assert.AreEqual("$CURRENT_BRANCH", yamlDeps.Force);
+            Assert.AreEqual("$CURRENT_BRANCH", yamlDeps.Force.Single());
         }
 
         [Test]

Tests/CommandsTests/TestGet.cs

@@ -113,7 +113,7 @@ public void TestGetDepsOneDepWithForce()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("new", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"new"}, new List<Dep> {new Dep("B")})}
                 });
                 env.CreateRepo("B", null, new[] {"new"});
                 env.Get("A");
@@ -122,14 +122,50 @@ public void TestGetDepsOneDepWithForce()
             }
         }
 
+        [Test]
+        public void TestGetDepsOneDepWithMultipleForce()
+        {
+            using (var env = new TestEnvironment())
+            {
+                var dir = env.WorkingDirectory.Path;
+
+                env.CreateRepo("A", new Dictionary<string, DepsContent>
+                {
+                    {"full-build", new DepsContent(new[] {"priority", "new"}, new List<Dep> {new Dep("B")})}
+                });
+                env.CreateRepo("B", null, new[] {"new", "priority"});
+                env.Get("A");
+                Assert.IsTrue(Directory.Exists(Path.Combine(dir, "A")));
+                Assert.AreEqual("priority", new GitRepository("B", dir, Log).CurrentLocalTreeish().Value);
+            }
+        }
+
+        [Test]
+        public void TestGetDepsOneDepWithMultipleForceOneBranchMissing()
+        {
+            using (var env = new TestEnvironment())
+            {
+                var dir = env.WorkingDirectory.Path;
+
+                env.CreateRepo("A", new Dictionary<string, DepsContent>
+                {
+                    {"full-build", new DepsContent(new[] {"missing", "priority", "new"}, new List<Dep> {new Dep("B")})}
+                });
+                env.CreateRepo("B", null, new[] {"new", "priority"});
+                env.Get("A");
+                Assert.IsTrue(Directory.Exists(Path.Combine(dir, "A")));
+                Assert.AreEqual("priority", new GitRepository("B", dir, Log).CurrentLocalTreeish().Value);
+            }
+        }
+
         [Test]
         public void TestGetDepsOneDepWithResetThrowsDueToPolicy()
         {
             using (var env = new TestEnvironment())
             {
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("new", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"new"}, new List<Dep> {new Dep("B")})}
                 });
                 env.CreateRepo("B", null, new[] {"new"});
                 env.Get("A");
@@ -147,7 +183,7 @@ public void TestGetDepsOneDepWithResetChanges()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("new", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"new"}, new List<Dep> {new Dep("B")})}
                 });
                 env.CreateRepo("B", null, new[] {"new"});
                 env.Get("A");
@@ -170,7 +206,7 @@ public void TestGetDepsOneDepWithResetChangesAndCommit()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("new", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"new"}, new List<Dep> {new Dep("B")})}
                 });
                 env.CreateRepo("B", null, new[] {"new"});
                 env.Get("A");
@@ -268,7 +304,7 @@ public void TestGetDepsOneDepWithCurrentBranchForceOldStyle()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("%CURRENT_BRANCH%", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"%CURRENT_BRANCH%"}, new List<Dep> {new Dep("B")})}
                 }, new[] {"new"}, DepsFormatStyle.Ini);
                 env.Checkout("A", "new");
 
@@ -289,7 +325,7 @@ public void TestGetDepsOneDepWithCreatingNewRemoteBranch()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("%CURRENT_BRANCH%", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[]  {"%CURRENT_BRANCH%"}, new List<Dep> {new Dep("B")})}
                 }, new[] {"new"}, DepsFormatStyle.Ini);
                 env.Checkout("A", "new");
 
@@ -313,7 +349,7 @@ public void TestGetDepsOneDepWithForceAndTreeish()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("new", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"new"}, new List<Dep> {new Dep("B")})}
                 }, new[] {"new"}, DepsFormatStyle.Ini);
 
                 env.CreateRepo("B", new Dictionary<string, DepsContent>
@@ -339,7 +375,7 @@ public void TestGetDepsOneDepWithCurrentBranchForceNewStyle()
 
                 env.CreateRepo("A", new Dictionary<string, DepsContent>
                 {
-                    {"full-build", new DepsContent("$CURRENT_BRANCH", new List<Dep> {new Dep("B")})}
+                    {"full-build", new DepsContent(new[] {"$CURRENT_BRANCH"}, new List<Dep> {new Dep("B")})}
                 }, new[] {"new"});
                 env.Checkout("A", "new");
 
@@ -680,7 +716,7 @@ public void TestGetDepsWithBranchesClientBuild()
                 {
                     {"full-build", new DepsContent(null, new List<Dep>())}
                 }, new[] { "master", "branch1", "branch2" });
-                
+
                 env.Get("A");
                 Assert.IsTrue(Directory.Exists(Path.Combine(dir, "C")));
                 Assert.AreEqual("branch2", new GitRepository("C", dir, Log).CurrentLocalTreeish().Value);

Tests/Helpers/TestEnvironment.cs

@@ -117,7 +117,7 @@ private void CreateDepsYamlStyle(string path, Dictionary<string, DepsContent> de
   deps:{
                             (depsByConfig[config]
                                  .Force != null
-                                ? "\r\n    - force: " + depsByConfig[config].Force
+                                ? $"\r\n    - force: " + string.Join(",", depsByConfig[config].Force)
                                 : "")
                         }
 ", (current, dep) => current +
@@ -144,7 +144,7 @@ private void CreateDepsIniStyle(string path, Dictionary<string, DepsContent> dep
                 {
                     content = depsByConfig[config].Force != null
                         ? @"[main]
-force = " + depsByConfig[config].Force + "\r\n"
+force = " + string.Join(",", depsByConfig[config].Force) + "\r\n"
                         : "";
                     foreach (var dep in depsByConfig[config].Deps)
                     {