Add environment variable support for StartProcess & Tools

* Add EnvironmentVariables to ProcessSettings * Add EnvironmentVariables to ToolSettings * Fixes cake-build#1092
devlead · Jul 21, 2016 · 1acc02f · 1acc02f
1 parent 8b44082
commit 1acc02f
Show file tree

Hide file tree

Showing 7 changed files with 83 additions and 1 deletion.
diff --git a/src/Cake.Core/CakeRuntime.cs b/src/Cake.Core/CakeRuntime.cs
@@ -16,6 +16,11 @@ public sealed class CakeRuntime : ICakeRuntime
         /// </summary>
         public FrameworkName TargetFramework { get; private set; }
 
+        /// <summary>
+        /// Gets the version of Cake executing the script.
+        /// </summary>
+        public Version CakeVersion { get; private set; }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="CakeRuntime"/> class.
         /// </summary>
@@ -26,6 +31,7 @@ public CakeRuntime()
             // that this actually is what happens on Mono.
             var frameworkName = AppDomain.CurrentDomain.SetupInformation.TargetFrameworkName;
             TargetFramework = new FrameworkName(frameworkName ?? ".NETFramework,Version=v4.5");
+            CakeVersion = typeof(ICakeRuntime).Assembly.GetName().Version;
         }
     }
 }
diff --git a/src/Cake.Core/ICakeRuntime.cs b/src/Cake.Core/ICakeRuntime.cs
@@ -1,6 +1,8 @@
 // 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 System;
 using System.Runtime.Versioning;
 
 namespace Cake.Core
@@ -15,5 +17,11 @@ public interface ICakeRuntime
         /// </summary>
         /// <returns>The target framework.</returns>
         FrameworkName TargetFramework { get; }
+
+        /// <summary>
+        /// Gets the version of Cake executing the script.
+        /// </summary>
+        /// <returns>The Cake.exe version.</returns>
+        Version CakeVersion { get; }
     }
 }
diff --git a/src/Cake.Core/IO/ProcessRunner.cs b/src/Cake.Core/IO/ProcessRunner.cs
@@ -3,7 +3,10 @@
 // See the LICENSE file in the project root for more information.
 using System;
 using System.Collections.Concurrent;
+using System.Collections.Generic;
+using System.Collections.Specialized;
 using System.Diagnostics;
+using System.Linq;
 using Cake.Core.Diagnostics;
 
 namespace Cake.Core.IO
@@ -78,6 +81,17 @@ public IProcess Start(FilePath filePath, ProcessSettings settings)
                 RedirectStandardOutput = settings.RedirectStandardOutput
             };
 
+            // Add environment variables
+            info.EnvironmentVariables["CAKE"] = "True";
+            info.EnvironmentVariables["CAKE_VERSION"] = _environment.Runtime.CakeVersion.ToString(3);
+            if (settings.EnvironmentVariables != null)
+            {
+                foreach (var environmentVariable in settings.EnvironmentVariables)
+                {
+                    info.EnvironmentVariables[environmentVariable.Key] = environmentVariable.Value;
+                }
+            }
+
             // Start and return the process.
             var process = Process.Start(info);
 

diff --git a/src/Cake.Core/IO/ProcessSettings.cs b/src/Cake.Core/IO/ProcessSettings.cs
@@ -1,6 +1,9 @@
 // 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 System.Collections.Generic;
+
 namespace Cake.Core.IO
 {
     /// <summary>
@@ -38,5 +41,21 @@ public sealed class ProcessSettings
         ///   <c>true</c> if process output will be suppressed; otherwise, <c>false</c>.
         /// </value>
         public bool Silent { get; set; }
+
+        /// <summary>
+        /// Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// StartProcess("cmd", new ProcessSettings{
+        ///         Arguments = "/c set",
+        ///         EnvironmentVariables = new Dictionary&lt;string, string&gt;{
+        ///             { "CI", "True" },
+        ///             { "TEMP", MakeAbsolute(Directory("./Temp")).FullPath }
+        ///         }
+        ///     }); 
+        /// </code>
+        /// </example>
+        public IDictionary<string, string> EnvironmentVariables { get; set; }
     }
 }
diff --git a/src/Cake.Core/Tooling/Tool.cs b/src/Cake.Core/Tooling/Tool.cs
@@ -205,6 +205,10 @@ protected IProcess RunProcess(
             {
                 info.WorkingDirectory = workingDirectory.MakeAbsolute(_environment).FullPath;
             }
+            if (info.EnvironmentVariables == null)
+            {
+                info.EnvironmentVariables = GetEnvironmentVariables(settings);
+            }
 
             // Run the process.
             var process = _processRunner.Start(toolPath, info);
@@ -254,6 +258,16 @@ protected virtual IEnumerable<FilePath> GetAlternativeToolPaths(TSettings settin
             return Enumerable.Empty<FilePath>();
         }
 
+        /// <summary>
+        /// Gets the environment variables.
+        /// </summary>
+        /// <param name="settings">The settings.</param>
+        /// <returns>The environment variables for the tool.</returns>
+        protected virtual IDictionary<string, string> GetEnvironmentVariables(TSettings settings)
+        {
+            return settings.EnvironmentVariables;
+        }
+
         private FilePath GetToolPath(TSettings settings)
         {
             if (_tools != null)

diff --git a/src/Cake.Core/Tooling/ToolSettings.cs b/src/Cake.Core/Tooling/ToolSettings.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 using System;
+using System.Collections.Generic;
 using Cake.Core.IO;
 
 namespace Cake.Core.Tooling
@@ -52,5 +53,18 @@ public class ToolSettings
         /// </example>
         /// <value>The delegate used to customize the <see cref="Cake.Core.IO.ProcessArgumentBuilder" />.</value>
         public Func<ProcessArgumentBuilder, ProcessArgumentBuilder> ArgumentCustomization { get; set; }
+
+        /// <summary>
+        /// Gets or sets search paths for files, directories for temporary files, application-specific options, and other similar information.
+        /// </summary>
+        /// <example>
+        /// <code>
+        /// MSBuild("./src/Cake.sln", new MSBuildSettings {
+        ///     EnvironmentVariables = new Dictionary&lt;string, string&gt;{
+        ///         { "TOOLSPATH", MakeAbsolute(Directory("./tools")).FullPath }
+        ///     }});
+        /// </code>
+        /// </example>
+        public IDictionary<string, string> EnvironmentVariables { get; set; }
     }
 }
diff --git a/src/Cake.Testing/FakeRuntime.cs b/src/Cake.Testing/FakeRuntime.cs
@@ -1,4 +1,5 @@
-using System.Runtime.Versioning;
+using System;
+using System.Runtime.Versioning;
 using Cake.Core;
 
 namespace Cake.Testing
@@ -13,12 +14,18 @@ public sealed class FakeRuntime : ICakeRuntime
         /// </summary>
         public FrameworkName TargetFramework { get; set; }
 
+        /// <summary>
+        /// Gets the version of Cake executing the script.
+        /// </summary>
+        public Version CakeVersion { get; private set; }
+
         /// <summary>
         /// Initializes a new instance of the <see cref="FakeRuntime"/> class.
         /// </summary>
         public FakeRuntime()
         {
             TargetFramework = new FrameworkName(".NETFramework,Version=v4.5");
+            CakeVersion = typeof(ICakeRuntime).Assembly.GetName().Version;
         }
     }
 }