Initial support for overriding the location of cake.exe the TRX uses

src/Cake.VisualStudio.csproj

@@ -87,6 +87,7 @@
     <Compile Include="Configuration\BindingParser.cs" />
     <Compile Include="Configuration\ConfigurationExtensions.cs" />
     <Compile Include="Configuration\ConfigurationParser.cs" />
+    <Compile Include="Configuration\ToolLocator.cs" />
     <Compile Include="ContentType\CakeContentTypeDefinition.cs" />
     <Compile Include="Editor\IndentationResult.cs" />
     <Compile Include="Editor\LineExtensions.cs" />

src/Configuration/ConfigurationParser.cs

@@ -2,16 +2,20 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using Cake.VisualStudio.Helpers;
 using IniParser;
 using IniParser.Model.Configuration;
 using IniParser.Parser;
+using System.IO;
+using System.Linq;
 
 namespace Cake.VisualStudio.Configuration
 {
     internal sealed class ConfigurationParser
     {
         private static IniDataParser Parser => new IniDataParser(new IniParserConfiguration {AssigmentSpacer = ""});
         internal string SectionName { get; set; } = "TaskRunnerBindings";
+
         public ConfigurationParser(string filePath)
         {
             FilePath = filePath;
@@ -46,5 +50,51 @@ internal void RemoveBindings()
             var removeSection = data.Sections.RemoveSection(SectionName);
             parser.WriteFile(FilePath, data);
         }
+
+        /// <summary>
+        /// Gets a key from the Paths section of cake.config
+        /// </summary>
+        /// <param name="key">The key to retrieve.</param>
+        /// <returns>The config value</returns>
+        /// <remarks>
+        /// This defaults the key to Tools since that's what we're using currently.
+        /// I've left this an argument in case we add a non-standard key to cake.config to specifically override VS.
+        /// </remarks>
+        internal string GetToolsPath(string key = "Tools")
+        {
+            var parser = new FileIniDataParser(Parser);
+            var data = parser.ReadFile(FilePath);
+            if (data.Sections.ContainsSection("Paths"))
+            {
+                return data["Paths"].ReadValues(key).LastOrDefault();
+            }
+            return null;
+        }
+
+        internal static string GetConfigFilePath(string configPath, bool create = false)
+        {
+            string bindingPath;
+            var path = CakePackage.Dte?.Solution?.FindProjectItem(Constants.ConfigFileName);
+            if (path != null && path.FileCount == 1)
+            {
+                bindingPath = path.FileNames[1];
+            }
+            else
+            {
+                var cpath = Path.Combine(Path.GetDirectoryName(configPath), Constants.ConfigFileName);
+                try
+                {
+
+                    if (!File.Exists(cpath) && create) File.Create(cpath).Close();
+                    if (File.Exists(cpath)) ProjectHelpers.GetSolutionItemsProject(CakePackage.Dte).AddFileToProject(cpath);
+                }
+                catch
+                {
+                    // ignored
+                }
+                bindingPath = cpath;
+            }
+            return string.IsNullOrWhiteSpace(bindingPath) ? null : bindingPath; // remove the empty string scenario
+        }
     }
 }

src/Configuration/ToolLocator.cs

@@ -0,0 +1,67 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using Cake.VisualStudio.Helpers;
+using Microsoft.VisualStudio.Shell;
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Cake.VisualStudio.Configuration
+{
+    internal sealed class ToolLocator
+    {
+        private readonly string _executable;
+        private List<string> KnownPaths { get; set; } = new List<string>();
+
+        public ToolLocator(string executableName)
+        {
+            _executable = executableName;
+        }
+
+        public ToolLocator AddEnvironmentVariables(string variable = "CAKE_PATHS_TOOLS")
+        {
+            var env = Environment.GetEnvironmentVariable(variable);
+            if (!string.IsNullOrWhiteSpace(env) && Directory.Exists(env))
+            {
+                KnownPaths.Add(env);
+            }
+            return this;
+        }
+
+        public ToolLocator AddKnownPaths(params string[] paths)
+        {
+            KnownPaths.AddRange(paths);
+            return this;
+        }
+
+        public ToolLocator AddConfigPath(Func<ConfigurationParser> configFunc)
+        {
+            var path = configFunc?.Invoke()?.GetToolsPath();
+            if (path != null)
+            {
+                KnownPaths.Add(path);
+                KnownPaths.Add(Path.Combine(path, "Cake"));
+            }
+            return this;
+        }
+
+        public string Locate(string workingDirectory)
+        {
+            foreach (var path in KnownPaths.Select(p => p.TrimPrefix("./")))
+            {
+                var fullPath = Path.Combine(workingDirectory, path, _executable);
+                if (File.Exists(fullPath)) return fullPath;
+            }
+            if (PathHelpers.ExistsOnPath(_executable))
+            {
+                return _executable; // assume PATH
+            }
+            return null;
+        }
+    }
+}

src/TaskRunner/TaskRunner.cs

@@ -10,6 +10,7 @@
 using System.Threading.Tasks;
 using System.Windows.Media;
 using System.Windows.Media.Imaging;
+using Cake.VisualStudio.Configuration;
 using Cake.VisualStudio.Helpers;
 using Microsoft.VisualStudio.TaskRunnerExplorer;
 
@@ -82,19 +83,6 @@ private ITaskRunnerNode NotFoundNode(string configPath)
                 Description = message,
                 Command = new TaskRunnerCommand(Path.GetDirectoryName(configPath), "echo", message),
             };
-            /*
-             * return new TaskRunnerNode("Cake")
-            {
-                Children =
-                {
-                    new TaskRunnerNode("Cake.exe not found", true)
-                    {
-                        Description = message,
-                        Command = new TaskRunnerCommand(Path.GetDirectoryName(configPath), "echo", message),
-                    }
-                }
-            };
-            */
         }
 
         private ITaskRunnerNode LoadHierarchy(string configPath)
@@ -141,17 +129,16 @@ private ITaskRunnerCommand GetCommand(string cwd, string arguments)
 
         private static string GetCakePath(string cwd)
         {
-            var knownPaths = new[] {"tools/Cake/Cake.exe", "Cake/Cake.exe", "Cake.exe"};
-            foreach (var path in knownPaths)
-            {
-                var fullPath = Path.Combine(cwd, path);
-                if (File.Exists(fullPath)) return fullPath;
-            }
-            if (PathHelpers.ExistsOnPath("cake.exe") || PathHelpers.ExistsOnPath("cake"))
-            {
-                return "cake"; // assume PATH
-            }
-            return null;
+            var locator = new ToolLocator("cake.exe")
+                .AddConfigPath(() => new ConfigurationParser(ConfigurationParser.GetConfigFilePath(cwd)))
+                .AddEnvironmentVariables()
+                .AddKnownPaths("tools/Cake", "Cake", ".");
+            var path = locator.Locate(cwd);
+            return string.IsNullOrWhiteSpace(path)
+                ? PathHelpers.ExistsOnPath("cake.exe")
+                    ? "cake"
+                    : null
+                : path;
         }
 
         private static string GetExecutableFolder()

src/TaskRunner/TaskRunnerConfig.cs

@@ -35,40 +35,13 @@ public void Dispose()
 
         public string LoadBindings(string configPath)
         {
-            string bindingPath = GetBindingPath(configPath) ?? configPath + ".bindings";
-
+            string bindingPath = ConfigurationParser.GetConfigFilePath(configPath) ?? configPath + ".bindings";
             return File.Exists(bindingPath) ? new ConfigurationParser(bindingPath).LoadBinding().ToXml() : "<binding />";
         }
 
-        private string GetBindingPath(string configPath, bool create = false)
-        {
-            string bindingPath;
-            var path = CakePackage.Dte.Solution?.FindProjectItem(Constants.ConfigFileName);
-            if (path != null && path.FileCount == 1)
-            {
-                bindingPath = path.FileNames[1];
-            }
-            else
-            {
-                var cpath = Path.Combine(Path.GetDirectoryName(configPath), Constants.ConfigFileName);
-                try
-                {
-
-                    if (!File.Exists(cpath) && create) File.Create(cpath).Close();
-                    if (File.Exists(cpath)) ProjectHelpers.GetSolutionItemsProject(CakePackage.Dte).AddFileToProject(cpath);
-                }
-                catch
-                {
-                    // ignored
-                }
-                bindingPath = cpath;
-            }
-            return string.IsNullOrWhiteSpace(bindingPath) ? null : bindingPath; // remove the empty string scenario
-        }
-
         public bool SaveBindings(string configPath, string bindingsXml)
         {
-            string bindingPath = GetBindingPath(configPath, true) ?? configPath + ".bindings";
+            string bindingPath = ConfigurationParser.GetConfigFilePath(configPath, true) ?? configPath + ".bindings";
             var config = new ConfigurationParser(bindingPath);
             try
             {