Merge pull request #450 from AndyGerlicher/PromoteMSB3644ToError

Promote Framework not found (MSB3644) warning to error

Author: AndyGerlicher

src/XMakeTasks/GetReferenceAssemblyPaths.cs

@@ -21,6 +21,11 @@ namespace Microsoft.Build.Tasks
     public class GetReferenceAssemblyPaths : TaskExtension
     {
         #region Data
+        /// <summary>
+        /// Environment variable name for the override error on missing reference assembly directory.
+        /// </summary>
+        private const string WARNONNOREFERENCEASSEMBLYDIRECTORY = "MSBUILDWARNONNOREFERENCEASSEMBLYDIRECTORY";
+
         /// <summary>
         /// This is the sentinel assembly for .NET FX 3.5 SP1
         /// Used to determine if SP1 of 3.5 is installed
@@ -43,7 +48,7 @@ public class GetReferenceAssemblyPaths : TaskExtension
         private IList<string> _tfmPathsNoProfile;
 
         /// <summary>
-        /// Target framework moniker string passd into the task
+        /// Target framework moniker string passed into the task
         /// </summary>
         private string _targetFrameworkMoniker;
 
@@ -241,7 +246,7 @@ public override bool Execute()
                     _tfmPathsNoProfile = GetPaths(_rootPath, monikerWithNoProfile);
                 }
 
-                // The path with out the profile is just the referecne assembly paths.
+                // The path with out the profile is just the reference assembly paths.
                 if (!targetingProfile)
                 {
                     _tfmPathsNoProfile = _tfmPaths;
@@ -281,10 +286,22 @@ private IList<String> GetPaths(string rootPath, FrameworkNameVersioning framewor
                 pathsToReturn = ToolLocationHelper.GetPathToReferenceAssemblies(rootPath, frameworkmoniker);
             }
 
-            // No reference assembly paths could be found, log a warning as there could be future errors which may be confusing because of this.
+            // No reference assembly paths could be found, log an error so an invalid build will not be produced.
+            // 1/26/16: Note this was changed from a warning to an error (see GitHub #173). Also added the escape hatch 
+            // (set MSBUILDWARNONNOREFERENCEASSEMBLYDIRECTORY = 1) in case this causes issues.
+            // TODO: This should be removed for Dev15
             if (pathsToReturn.Count == 0)
             {
-                Log.LogWarningWithCodeFromResources("GetReferenceAssemblyPaths.NoReferenceAssemblyDirectoryFound", frameworkmoniker.ToString());
+                var warn = Environment.GetEnvironmentVariable(WARNONNOREFERENCEASSEMBLYDIRECTORY);
+
+                if (string.Equals(warn, "1", StringComparison.Ordinal))
+                {
+                    Log.LogWarningWithCodeFromResources("GetReferenceAssemblyPaths.NoReferenceAssemblyDirectoryFound", frameworkmoniker.ToString());
+                }
+                else
+                {
+                    Log.LogErrorWithCodeFromResources("GetReferenceAssemblyPaths.NoReferenceAssemblyDirectoryFound", frameworkmoniker.ToString());
+                }
             }
 
             return pathsToReturn;

src/XMakeTasks/UnitTests/GetReferencePaths_Tests.cs

@@ -157,16 +157,51 @@ public void TestGeneralFrameworkMonikerNonExistent()
             MockEngine engine = new MockEngine();
             GetReferenceAssemblyPaths getReferencePaths = new GetReferenceAssemblyPaths();
             getReferencePaths.BuildEngine = engine;
-            // Make a framework which does not exist, intentional mispelling of framework
+            // Make a framework which does not exist, intentional misspelling of framework
             getReferencePaths.TargetFrameworkMoniker = ".NetFramewok, Version=v99.0";
-            getReferencePaths.Execute();
+            bool success = getReferencePaths.Execute();
+            Assert.False(success);
+            string[] returnedPaths = getReferencePaths.ReferenceAssemblyPaths;
+            Assert.Equal(0, returnedPaths.Length);
+            string displayName = getReferencePaths.TargetFrameworkMonikerDisplayName;
+            Assert.Null(displayName);
+            FrameworkNameVersioning frameworkMoniker = new FrameworkNameVersioning(getReferencePaths.TargetFrameworkMoniker);
+            string message = ResourceUtilities.FormatResourceString("GetReferenceAssemblyPaths.NoReferenceAssemblyDirectoryFound", frameworkMoniker.ToString());
+            engine.AssertLogContains("ERROR MSB3644: " + message);
+        }
+
+        /// <summary>
+        /// Test the case where the target framework moniker is empty when using MSBUILDWARNONNOREFERENCEASSEMBLYDIRECTORY
+        /// override. Expect there to be a warning logged.
+        /// TODO: This should be removed for Dev15 (override feature removed)
+        /// </summary>
+        [Fact]
+        public void TestGeneralFrameworkMonikerNonExistentOverrideError()
+        {
+            MockEngine engine = new MockEngine();
+            GetReferenceAssemblyPaths getReferencePaths = new GetReferenceAssemblyPaths();
+            getReferencePaths.BuildEngine = engine;
+            // Make a framework which does not exist, intentional misspelling of framework
+            getReferencePaths.TargetFrameworkMoniker = ".NetFramewok, Version=v99.0";
+            
+            try
+            {
+                Environment.SetEnvironmentVariable("MSBUILDWARNONNOREFERENCEASSEMBLYDIRECTORY", "1");
+                bool success = getReferencePaths.Execute();
+                Assert.True(success);
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable("MSBUILDWARNONNOREFERENCEASSEMBLYDIRECTORY", null);
+            }
+            
             string[] returnedPaths = getReferencePaths.ReferenceAssemblyPaths;
             Assert.Equal(0, returnedPaths.Length);
             string displayName = getReferencePaths.TargetFrameworkMonikerDisplayName;
             Assert.Null(displayName);
             FrameworkNameVersioning frameworkMoniker = new FrameworkNameVersioning(getReferencePaths.TargetFrameworkMoniker);
             string message = ResourceUtilities.FormatResourceString("GetReferenceAssemblyPaths.NoReferenceAssemblyDirectoryFound", frameworkMoniker.ToString());
-            engine.AssertLogContains(message);
+            engine.AssertLogContains("WARNING MSB3644: " + message);
         }
 
         /// <summary>