Implement feature that allows tasks to get the global properties

ref/Microsoft.Build.Framework/net/Microsoft.Build.Framework.cs

@@ -193,6 +193,10 @@ public partial interface IBuildEngine5 : Microsoft.Build.Framework.IBuildEngine,
     {
         void LogTelemetry(string eventName, System.Collections.Generic.IDictionary<string, string> properties);
     }
+    public partial interface IBuildEngine6 : Microsoft.Build.Framework.IBuildEngine, Microsoft.Build.Framework.IBuildEngine2, Microsoft.Build.Framework.IBuildEngine3, Microsoft.Build.Framework.IBuildEngine4, Microsoft.Build.Framework.IBuildEngine5
+    {
+        System.Collections.Generic.IReadOnlyDictionary<string, string> GetGlobalProperties();
+    }
     public partial interface ICancelableTask : Microsoft.Build.Framework.ITask
     {
         void Cancel();

ref/Microsoft.Build.Framework/netstandard/Microsoft.Build.Framework.cs

@@ -193,6 +193,10 @@ public partial interface IBuildEngine5 : Microsoft.Build.Framework.IBuildEngine,
     {
         void LogTelemetry(string eventName, System.Collections.Generic.IDictionary<string, string> properties);
     }
+    public partial interface IBuildEngine6 : Microsoft.Build.Framework.IBuildEngine, Microsoft.Build.Framework.IBuildEngine2, Microsoft.Build.Framework.IBuildEngine3, Microsoft.Build.Framework.IBuildEngine4, Microsoft.Build.Framework.IBuildEngine5
+    {
+        System.Collections.Generic.IReadOnlyDictionary<string, string> GetGlobalProperties();
+    }
     public partial interface ICancelableTask : Microsoft.Build.Framework.ITask
     {
         void Cancel();

ref/Microsoft.Build.Utilities.Core/net/Microsoft.Build.Utilities.Core.cs

@@ -351,6 +351,7 @@ protected Task(System.Resources.ResourceManager taskResources, string helpKeywor
         public Microsoft.Build.Framework.IBuildEngine3 BuildEngine3 { get { throw null; } }
         public Microsoft.Build.Framework.IBuildEngine4 BuildEngine4 { get { throw null; } }
         public Microsoft.Build.Framework.IBuildEngine5 BuildEngine5 { get { throw null; } }
+        public Microsoft.Build.Framework.IBuildEngine6 BuildEngine6 { get { throw null; } }
         protected string HelpKeywordPrefix { get { throw null; } set { } }
         public Microsoft.Build.Framework.ITaskHost HostObject { get { throw null; } set { } }
         public Microsoft.Build.Utilities.TaskLoggingHelper Log { get { throw null; } }

ref/Microsoft.Build.Utilities.Core/netstandard/Microsoft.Build.Utilities.Core.cs

@@ -196,6 +196,7 @@ protected Task(System.Resources.ResourceManager taskResources, string helpKeywor
         public Microsoft.Build.Framework.IBuildEngine3 BuildEngine3 { get { throw null; } }
         public Microsoft.Build.Framework.IBuildEngine4 BuildEngine4 { get { throw null; } }
         public Microsoft.Build.Framework.IBuildEngine5 BuildEngine5 { get { throw null; } }
+        public Microsoft.Build.Framework.IBuildEngine6 BuildEngine6 { get { throw null; } }
         protected string HelpKeywordPrefix { get { throw null; } set { } }
         public Microsoft.Build.Framework.ITaskHost HostObject { get { throw null; } set { } }
         public Microsoft.Build.Utilities.TaskLoggingHelper Log { get { throw null; } }

src/Build.UnitTests/BackEnd/TaskHostConfiguration_Tests.cs

@@ -52,6 +52,7 @@ public void ConstructorWithNullName()
                     _continueOnErrorDefault,
                     null,
                     @"c:\my tasks\mytask.dll",
+                    null,
                     null);
             }
            );
@@ -79,6 +80,7 @@ public void ConstructorWithEmptyName()
                     _continueOnErrorDefault,
                     String.Empty,
                     @"c:\my tasks\mytask.dll",
+                    null,
                     null);
             }
            );
@@ -106,6 +108,7 @@ public void ConstructorWithNullLocation()
                     _continueOnErrorDefault,
                     "TaskName",
                     null,
+                    null,
                     null);
             }
            );
@@ -135,6 +138,7 @@ public void ConstructorWithEmptyLocation()
                     _continueOnErrorDefault,
                     "TaskName",
                     String.Empty,
+                    null,
                     null);
             }
            );
@@ -162,7 +166,9 @@ public void TestValidConstructors()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
+                null,
                 null);
+
             TaskHostConfiguration config2 = new TaskHostConfiguration(
                 1,
                 Directory.GetCurrentDirectory(),
@@ -178,6 +184,7 @@ public void TestValidConstructors()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
+                null,
                 null);
 
             IDictionary<string, object> parameters = new Dictionary<string, object>();
@@ -196,7 +203,8 @@ public void TestValidConstructors()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                parameters);
+                parameters,
+                null);
 
             IDictionary<string, object> parameters2 = new Dictionary<string, object>();
             parameters2.Add("Text", "Hello!");
@@ -219,7 +227,8 @@ public void TestValidConstructors()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                parameters2);
+                parameters2,
+                null);
         }
 
         /// <summary>
@@ -228,6 +237,12 @@ public void TestValidConstructors()
         [Fact]
         public void TestTranslationWithNullDictionary()
         {
+            var expectedGlobalProperties = new Dictionary<string, string>
+            {
+                ["Property1"] = "Value1",
+                ["Property2"] = "Value2"
+            };
+
             TaskHostConfiguration config = new TaskHostConfiguration(
                 1,
                 Directory.GetCurrentDirectory(),
@@ -243,7 +258,8 @@ public void TestTranslationWithNullDictionary()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                null);
+                null,
+                expectedGlobalProperties);
 
             ((ITranslatable)config).Translate(TranslationHelpers.GetWriteTranslator());
             INodePacket packet = TaskHostConfiguration.FactoryForDeserialization(TranslationHelpers.GetReadTranslator());
@@ -255,6 +271,8 @@ public void TestTranslationWithNullDictionary()
             Assert.Equal(config.TaskLocation, deserializedConfig.TaskLocation);
 #endif
             Assert.Null(deserializedConfig.TaskParameters);
+
+            Assert.Equal(expectedGlobalProperties, deserializedConfig.GlobalProperties);
         }
 
         /// <summary>
@@ -278,7 +296,8 @@ public void TestTranslationWithEmptyDictionary()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                new Dictionary<string, object>());
+                new Dictionary<string, object>(),
+                new Dictionary<string, string>());
 
             ((ITranslatable)config).Translate(TranslationHelpers.GetWriteTranslator());
             INodePacket packet = TaskHostConfiguration.FactoryForDeserialization(TranslationHelpers.GetReadTranslator());
@@ -291,6 +310,9 @@ public void TestTranslationWithEmptyDictionary()
 #endif
             Assert.NotNull(deserializedConfig.TaskParameters);
             Assert.Equal(config.TaskParameters.Count, deserializedConfig.TaskParameters.Count);
+
+            Assert.NotNull(deserializedConfig.GlobalProperties);
+            Assert.Equal(config.GlobalProperties.Count, deserializedConfig.GlobalProperties.Count);
         }
 
         /// <summary>
@@ -317,7 +339,8 @@ public void TestTranslationWithValueTypesInDictionary()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                parameters);
+                parameters,
+                null);
 
             ((ITranslatable)config).Translate(TranslationHelpers.GetWriteTranslator());
             INodePacket packet = TaskHostConfiguration.FactoryForDeserialization(TranslationHelpers.GetReadTranslator());
@@ -357,7 +380,8 @@ public void TestTranslationWithITaskItemInDictionary()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                parameters);
+                parameters,
+                null);
 
             ((ITranslatable)config).Translate(TranslationHelpers.GetWriteTranslator());
             INodePacket packet = TaskHostConfiguration.FactoryForDeserialization(TranslationHelpers.GetReadTranslator());
@@ -396,7 +420,8 @@ public void TestTranslationWithITaskItemArrayInDictionary()
                 _continueOnErrorDefault,
                 "TaskName",
                 @"c:\MyTasks\MyTask.dll",
-                parameters);
+                parameters,
+                null);
 
             ((ITranslatable)config).Translate(TranslationHelpers.GetWriteTranslator());
             INodePacket packet = TaskHostConfiguration.FactoryForDeserialization(TranslationHelpers.GetReadTranslator());

src/Build.UnitTests/BackEnd/TaskHost_Tests.cs

@@ -634,6 +634,78 @@ public void LogErrorAfterTaskIsDone()
         }
 #endif
 
+        /// <summary>
+        /// Verifies that tasks can get global properties.
+        /// </summary>
+        [Fact]
+        public void TasksCanGetGlobalProperties()
+        {
+            string projectFileContents = @"
+<Project>
+  <UsingTask TaskName='test' TaskFactory='RoslynCodeTaskFactory' AssemblyFile='$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll'>
+    <Task>
+      <Code><![CDATA[
+        var globalProperties = ((IBuildEngine6)BuildEngine).GetGlobalProperties();
+
+        Log.LogMessage(""Global properties:"");
+        foreach (var item in globalProperties)
+        {
+            Log.LogMessage($""{item.Key}: '{item.Value}'"");
+        }
+      ]]></Code>
+    </Task>
+  </UsingTask>
+  <Target Name='Build'>
+      <test/>
+  </Target>
+</Project>";
+
+            Dictionary<string, string> globalProperties = new Dictionary<string, string>
+            {
+                ["Property1"] = "Value_%",
+                ["Property2"] = "Value_$",
+                ["Property3"] = "Value_@",
+                ["Property4"] = "Value_'",
+                ["Property5"] = "Value_;",
+                ["Property6"] = "Value_?",
+                ["Property7"] = "Value_*",
+            };
+
+            MockLogger mockLogger = Helpers.BuildProjectWithNewOMExpectSuccess(projectFileContents, globalProperties);
+
+            foreach (var item in globalProperties)
+            {
+                mockLogger.AssertLogContains($"{item.Key}: '{item.Value}'");
+            }
+        }
+
+        /// <summary>
+        /// Verifies that if the user specifies no global properties, tasks get back an empty collection.
+        /// </summary>
+        [Fact]
+        public void TasksGetNoGlobalPropertiesIfNoneSpecified()
+        {
+            string projectFileContents = @"
+<Project>
+  <UsingTask TaskName='test' TaskFactory='RoslynCodeTaskFactory' AssemblyFile='$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll'>
+    <Task>
+      <Code><![CDATA[
+        var globalProperties = ((IBuildEngine6)BuildEngine).GetGlobalProperties();
+
+        Log.LogMessage($""Global property count: {globalProperties.Count}"");
+      ]]></Code>
+    </Task>
+  </UsingTask>
+  <Target Name='Build'>
+      <test/>
+  </Target>
+</Project>";
+
+            MockLogger mockLogger = Helpers.BuildProjectWithNewOMExpectSuccess(projectFileContents);
+
+            mockLogger.AssertLogContains("Global property count: 0");
+        }
+
         #region Helper Classes
 
         /// <summary>

src/Build/BackEnd/Components/RequestBuilder/TaskHost.cs

@@ -33,7 +33,7 @@ internal class TaskHost :
 #if FEATURE_APPDOMAIN
         MarshalByRefObject,
 #endif
-        IBuildEngine5
+        IBuildEngine6
     {
         /// <summary>
         /// True if the "secret" environment variable MSBUILDNOINPROCNODE is set. 
@@ -647,6 +647,19 @@ public void LogTelemetry(string eventName, IDictionary<string, string> propertie
 
         #endregion
 
+        #region IBuildEngine6 Members
+
+        /// <summary>
+        /// Gets the global properties for the current project.
+        /// </summary>
+        /// <returns>An <see cref="IReadOnlyDictionary{String, String}" /> containing the global properties of the current project.</returns>
+        public IReadOnlyDictionary<string, string> GetGlobalProperties()
+        {
+            return _requestEntry.RequestConfiguration.GlobalProperties.ToDictionary();
+        }
+
+        #endregion
+
         /// <summary>
         /// Called by the internal MSBuild task.
         /// Does not take the lock because it is called by another request builder thread.

src/Build/Instance/TaskFactories/TaskHostTask.cs

@@ -273,7 +273,8 @@ public bool Execute()
                         BuildEngine.ContinueOnError,
                         _taskType.Type.FullName,
                         AssemblyUtilities.GetAssemblyLocation(_taskType.Type.GetTypeInfo().Assembly),
-                        _setParameters
+                        _setParameters,
+                        new Dictionary<string, string>(_buildComponentHost.BuildParameters.GlobalProperties)
                     );
 
             try

src/Framework/IBuildEngine6.cs

@@ -0,0 +1,19 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+
+namespace Microsoft.Build.Framework
+{
+    /// <summary>
+    /// This interface extends <see cref="IBuildEngine5" /> to allow tasks to get the current project's global properties.
+    /// </summary>
+    public interface IBuildEngine6 : IBuildEngine5
+    {
+        /// <summary>
+        /// Gets the global properties for the current project.
+        /// </summary>
+        /// <returns>An <see cref="IReadOnlyDictionary{String, String}" /> containing the global properties of the current project.</returns>
+        IReadOnlyDictionary<string, string> GetGlobalProperties();
+    }
+}

src/MSBuild/OutOfProcTaskHostNode.cs

@@ -36,7 +36,7 @@ internal class OutOfProcTaskHostNode :
 #if CLR2COMPATIBILITY
         IBuildEngine3
 #else
-        IBuildEngine5
+        IBuildEngine6
 #endif
     {
         /// <summary>
@@ -442,6 +442,19 @@ public void LogTelemetry(string eventName, IDictionary<string, string> propertie
 
         #endregion
 
+        #region IBuildEngine6 Implementation
+
+        /// <summary>
+        /// Gets the global properties for the current project.
+        /// </summary>
+        /// <returns>An <see cref="IReadOnlyDictionary{String, String}" /> containing the global properties of the current project.</returns>
+        public IReadOnlyDictionary<string, string> GetGlobalProperties()
+        {
+            return new Dictionary<string, string>(_currentConfiguration.GlobalProperties);
+        }
+
+        #endregion
+
 #endif
 
         #region INodePacketFactory Members