From cde27bb21b5a1b628771715251eaf435cfdb90ac Mon Sep 17 00:00:00 2001
From: Jeff Kluge <jeffkl@microsoft.com>
Date: Thu, 15 Jun 2017 11:10:23 -0700
Subject: [PATCH] Only disable module restore when NuGet is evaluating
 CBTModules.proj (#84)

We explicitly disable module restore when we run NuGet.exe restore against the modules package config.  All other cases should restore modules unless a user is manually running nuget.exe restore CBTModules.proj.

Fixes #83

Also update CBT.NuGet module to 1.0.110
---
 .build/CBT/build.props                   |  4 +-
 .build/local/CBTModules/CBTModules.proj  |  2 +-
 src/CBT.Core.UnitTests/BuildPropsTest.cs | 89 ++++++++++++------------
 3 files changed, 49 insertions(+), 46 deletions(-)

diff --git a/.build/CBT/build.props b/.build/CBT/build.props
index d634e80..39aef4c 100644
--- a/.build/CBT/build.props
+++ b/.build/CBT/build.props
@@ -81,8 +81,8 @@
     <CBTModuleRestoreCommandArguments Condition=" '$(CBTModuleRestoreCommandAdditionalArguments)' != '' ">$(CBTModuleRestoreCommandArguments) $(CBTModuleRestoreCommandAdditionalArguments)</CBTModuleRestoreCommandArguments>
 
     <CBTModuleNuGetAssetsFlagFile Condition=" '$(CBTModuleNuGetAssetsFlagFile)' == '' ">$(CBTIntermediateOutputPath)\AssetsLockFilePath.flag</CBTModuleNuGetAssetsFlagFile>
-    <!-- ExcludeRestorePackageImports implies that we are running under a nuget.exe 4.x process and module restoration should be disabled. -->
-    <RestoreCBTModules Condition=" '$(ExcludeRestorePackageImports)' == 'true' ">false</RestoreCBTModules>
+    <!-- Do not restore CBT modules when NuGet is evaluating CBTModules.proj. -->
+    <RestoreCBTModules Condition=" $(RestoreGraphProjectInput.Contains($(CBTModulePackageConfigPath))) ">false</RestoreCBTModules>
     <CBTModulesRestored Condition=" '$(RestoreCBTModules)' != 'false' And '$(BuildingInsideVisualStudio)' != 'true' And '$(CBTModulesRestored)' != 'true' And Exists('$(CBTCoreAssemblyPath)') ">$(CBTCoreAssemblyPath.GetType().Assembly.GetType('System.AppDomain').GetProperty('CurrentDomain').GetValue(null, null).CreateInstanceFromAndUnwrap($(CBTCoreAssemblyPath), $(CBTModuleRestoreTaskName)).Execute($(CBTModuleImportsAfter.Split(';')), $(CBTModuleImportsBefore.Split(';')), $(CBTModuleExtensionsPath), $(CBTModulePropertiesFile), $(CBTNuGetDownloaderAssemblyPath), $(CBTNuGetDownloaderClassName), '$(CBTNuGetDownloaderArguments)', $(CBTModuleRestoreInputs.Split(';')), $(CBTModulePackageConfigPath), $(NuGetPackagesPath), $(CBTPackagesFallbackPath), $(CBTModuleRestoreCommand), $(CBTModuleRestoreCommandArguments), $(MSBuildProjectFullPath), $(CBTModuleNuGetAssetsFlagFile)))</CBTModulesRestored>
 
   </PropertyGroup>
diff --git a/.build/local/CBTModules/CBTModules.proj b/.build/local/CBTModules/CBTModules.proj
index 53c2c3f..f9bb3e7 100644
--- a/.build/local/CBTModules/CBTModules.proj
+++ b/.build/local/CBTModules/CBTModules.proj
@@ -4,7 +4,7 @@
     <TargetFramework>net45</TargetFramework>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="CBT.NuGet" Version="1.0.97" />
+    <PackageReference Include="CBT.NuGet" Version="1.0.110" />
     <PackageReference Include="CBT.Traversal" Version="1.0.31" />
     <PackageReference Include="CBT.DotNetFx" Version="4.5.0-beta03" />
   </ItemGroup>
diff --git a/src/CBT.Core.UnitTests/BuildPropsTest.cs b/src/CBT.Core.UnitTests/BuildPropsTest.cs
index c6c3f71..86cef4a 100644
--- a/src/CBT.Core.UnitTests/BuildPropsTest.cs
+++ b/src/CBT.Core.UnitTests/BuildPropsTest.cs
@@ -14,7 +14,7 @@ namespace CBT.Core.UnitTests
     /// </summary>
     public class BuildPropsTest : TestBase
     {
-        private ProjectRootElement _project;
+        private readonly ProjectRootElement _project;
 
         public BuildPropsTest()
         {
@@ -26,50 +26,50 @@ public BuildPropsTest()
         public void RequiredPropertiesTest()
         {
             string defaultCondition = " '$({0})' == '' ";
-            List<Property> knownProperties = new List<Property>()
+            List<Property> knownProperties = new List<Property>
             {
-                {new Property("MSBuildAllProjects", @"$(MSBuildAllProjects);$(MSBuildThisFileFullPath)", string.Empty)},
-                {new Property("EnlistmentRoot", @"$({0}.TrimEnd('\\'))", " '$({0})' != '' ")},
-                {new Property("CBTGlobalPath", @"$(MSBuildThisFileDirectory)", defaultCondition)},
-                {new Property("CBTGlobalPath", @"$(CBTGlobalPath.TrimEnd('\\'))", string.Empty)},
-                {new Property("CBTLocalPath", @"$([System.IO.Path]::GetDirectoryName($(CBTGlobalPath)))\Local", @" '$({0})' == '' And Exists('$([System.IO.Path]::GetDirectoryName($(CBTGlobalPath)))\Local') ")},
-                {new Property("CBTLocalPath", @"$(CBTLocalPath.TrimEnd('\\'))", string.Empty)},
-                {new Property("CBTLocalBuildExtensionsPath", @"$(CBTLocalPath)\Extensions", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\Extensions') ")},
-                {new Property("Configuration", @"$(DefaultProjectConfiguration)", @" '$({0})' == '' And '$(DefaultProjectConfiguration)' != '' ")},
-                {new Property("Platform", @"$(DefaultProjectPlatform)", @" '$({0})' == '' And '$(DefaultProjectPlatform)' != '' ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'CBTModules.proj'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\CBTModules.proj') ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules.proj'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules.proj') ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'project.json'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\project.json') ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'project.json'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\project.json') ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'packages.config'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\packages.config') ")},
-                {new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'packages.config'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\packages.config') ")},
-                {new Property("CBTPackagesFallbackPath", @"$([System.IO.Path]::Combine($(SolutionDir), 'packages'))", @" '$({0})' == '' And '$(SolutionDir)' != '' And '$(SolutionDir)' != '*Undefined*' And Exists('$(SolutionDir)')")},
-                {new Property("CBTPackagesFallbackPath", @"$([System.IO.Path]::Combine($([System.IO.Path]::GetDirectoryName($(MSBuildProjectDirectory))), 'packages'))", defaultCondition)},
-                {new Property("CBTCoreAssemblyPath", @"$(MSBuildThisFileDirectory)CBT.Core.dll", defaultCondition)},
-                {new Property("CBTModuleRestoreInputs", @"$(MSBuildThisFileFullPath);$(CBTCoreAssemblyPath);$(CBTModulePackageConfigPath)", defaultCondition)},
-                {new Property("CBTIntermediateOutputPath", @"$(MSBuildThisFileDirectory)obj", defaultCondition)},
-                {new Property("CBTModulePath", @"$(CBTIntermediateOutputPath)\Modules", defaultCondition)},
-                {new Property("CBTModulePropertiesFile", @"$(CBTModulePath)\$(MSBuildThisFile)", defaultCondition)},
-                {new Property("CBTModuleExtensionsPath", @"$(CBTModulePath)\Extensions", defaultCondition)},
-                {new Property("CBTModuleImportsBefore", @"%24(CBTLocalBuildExtensionsPath)\%24(MSBuildThisFile)", defaultCondition)},
-                {new Property("CBTModuleImportsAfter", string.Empty, defaultCondition)},
-                {new Property("CBTNuGetBinDir", @"$(CBTIntermediateOutputPath)\NuGet", defaultCondition)},
-                {new Property("CBTNuGetDownloaderAssemblyPath", @"$(CBTCoreAssemblyPath)", defaultCondition)},
-                {new Property("CBTNuGetDownloaderClassName", @"CBT.Core.Internal.DefaultNuGetDownloader", defaultCondition)},
-                {new Property("CBTModuleRestoreTaskName", @"CBT.Core.Tasks.RestoreModules", defaultCondition)},
-                {new Property("CBTModuleRestoreCommand", @"$(CBTNuGetBinDir)\NuGet.exe", defaultCondition)},
-                {new Property("CBTModuleRestoreCommandArguments", @"restore ""$(CBTModulePackageConfigPath)"" -NonInteractive", defaultCondition)},
-                {new Property("CBTModuleRestoreCommandArguments", @"$(CBTModuleRestoreCommandArguments) $(CBTModuleRestoreCommandAdditionalArguments)", @" '$(CBTModuleRestoreCommandAdditionalArguments)' != '' ")},
-                {new Property("CBTModuleNuGetAssetsFlagFile", @"$(CBTIntermediateOutputPath)\AssetsLockFilePath.flag", defaultCondition)},
-                {new Property("RestoreCBTModules", @"false", @" '$(ExcludeRestorePackageImports)' == 'true' ")},
-                {new Property("CBTModulesRestored", @"$(CBTCoreAssemblyPath.GetType().Assembly.GetType('System.AppDomain').GetProperty('CurrentDomain').GetValue(null, null).CreateInstanceFromAndUnwrap($(CBTCoreAssemblyPath), $(CBTModuleRestoreTaskName)).Execute($(CBTModuleImportsAfter.Split(';')), $(CBTModuleImportsBefore.Split(';')), $(CBTModuleExtensionsPath), $(CBTModulePropertiesFile), $(CBTNuGetDownloaderAssemblyPath), $(CBTNuGetDownloaderClassName), '$(CBTNuGetDownloaderArguments)', $(CBTModuleRestoreInputs.Split(';')), $(CBTModulePackageConfigPath), $(NuGetPackagesPath), $(CBTPackagesFallbackPath), $(CBTModuleRestoreCommand), $(CBTModuleRestoreCommandArguments), $(MSBuildProjectFullPath), $(CBTModuleNuGetAssetsFlagFile)))", @" '$(RestoreCBTModules)' != 'false' And '$(BuildingInsideVisualStudio)' != 'true' And '$(CBTModulesRestored)' != 'true' And Exists('$(CBTCoreAssemblyPath)') ")},
+                new Property("MSBuildAllProjects", @"$(MSBuildAllProjects);$(MSBuildThisFileFullPath)", string.Empty),
+                new Property("EnlistmentRoot", @"$({0}.TrimEnd('\\'))", " '$({0})' != '' "),
+                new Property("CBTGlobalPath", @"$(MSBuildThisFileDirectory)", defaultCondition),
+                new Property("CBTGlobalPath", @"$(CBTGlobalPath.TrimEnd('\\'))", string.Empty),
+                new Property("CBTLocalPath", @"$([System.IO.Path]::GetDirectoryName($(CBTGlobalPath)))\Local", @" '$({0})' == '' And Exists('$([System.IO.Path]::GetDirectoryName($(CBTGlobalPath)))\Local') "),
+                new Property("CBTLocalPath", @"$(CBTLocalPath.TrimEnd('\\'))", string.Empty),
+                new Property("CBTLocalBuildExtensionsPath", @"$(CBTLocalPath)\Extensions", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\Extensions') "),
+                new Property("Configuration", @"$(DefaultProjectConfiguration)", @" '$({0})' == '' And '$(DefaultProjectConfiguration)' != '' "),
+                new Property("Platform", @"$(DefaultProjectPlatform)", @" '$({0})' == '' And '$(DefaultProjectPlatform)' != '' "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'CBTModules.proj'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\CBTModules.proj') "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules.proj'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules.proj') "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'project.json'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\project.json') "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'project.json'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\project.json') "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'CBTModules', 'packages.config'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\CBTModules\packages.config') "),
+                new Property("CBTModulePackageConfigPath", @"$([System.IO.Path]::Combine($(CBTLocalPath), 'packages.config'))", @" '$({0})' == '' And '$(CBTLocalPath)' != '' And Exists('$(CBTLocalPath)\packages.config') "),
+                new Property("CBTPackagesFallbackPath", @"$([System.IO.Path]::Combine($(SolutionDir), 'packages'))", @" '$({0})' == '' And '$(SolutionDir)' != '' And '$(SolutionDir)' != '*Undefined*' And Exists('$(SolutionDir)')"),
+                new Property("CBTPackagesFallbackPath", @"$([System.IO.Path]::Combine($([System.IO.Path]::GetDirectoryName($(MSBuildProjectDirectory))), 'packages'))", defaultCondition),
+                new Property("CBTCoreAssemblyPath", @"$(MSBuildThisFileDirectory)CBT.Core.dll", defaultCondition),
+                new Property("CBTModuleRestoreInputs", @"$(MSBuildThisFileFullPath);$(CBTCoreAssemblyPath);$(CBTModulePackageConfigPath)", defaultCondition),
+                new Property("CBTIntermediateOutputPath", @"$(MSBuildThisFileDirectory)obj", defaultCondition),
+                new Property("CBTModulePath", @"$(CBTIntermediateOutputPath)\Modules", defaultCondition),
+                new Property("CBTModulePropertiesFile", @"$(CBTModulePath)\$(MSBuildThisFile)", defaultCondition),
+                new Property("CBTModuleExtensionsPath", @"$(CBTModulePath)\Extensions", defaultCondition),
+                new Property("CBTModuleImportsBefore", @"%24(CBTLocalBuildExtensionsPath)\%24(MSBuildThisFile)", defaultCondition),
+                new Property("CBTModuleImportsAfter", string.Empty, defaultCondition),
+                new Property("CBTNuGetBinDir", @"$(CBTIntermediateOutputPath)\NuGet", defaultCondition),
+                new Property("CBTNuGetDownloaderAssemblyPath", @"$(CBTCoreAssemblyPath)", defaultCondition),
+                new Property("CBTNuGetDownloaderClassName", @"CBT.Core.Internal.DefaultNuGetDownloader", defaultCondition),
+                new Property("CBTModuleRestoreTaskName", @"CBT.Core.Tasks.RestoreModules", defaultCondition),
+                new Property("CBTModuleRestoreCommand", @"$(CBTNuGetBinDir)\NuGet.exe", defaultCondition),
+                new Property("CBTModuleRestoreCommandArguments", @"restore ""$(CBTModulePackageConfigPath)"" -NonInteractive", defaultCondition),
+                new Property("CBTModuleRestoreCommandArguments", @"$(CBTModuleRestoreCommandArguments) $(CBTModuleRestoreCommandAdditionalArguments)", @" '$(CBTModuleRestoreCommandAdditionalArguments)' != '' "),
+                new Property("CBTModuleNuGetAssetsFlagFile", @"$(CBTIntermediateOutputPath)\AssetsLockFilePath.flag", defaultCondition),
+                new Property("RestoreCBTModules", @"false", @" $(RestoreGraphProjectInput.Contains($(CBTModulePackageConfigPath))) "),
+                new Property("CBTModulesRestored", @"$(CBTCoreAssemblyPath.GetType().Assembly.GetType('System.AppDomain').GetProperty('CurrentDomain').GetValue(null, null).CreateInstanceFromAndUnwrap($(CBTCoreAssemblyPath), $(CBTModuleRestoreTaskName)).Execute($(CBTModuleImportsAfter.Split(';')), $(CBTModuleImportsBefore.Split(';')), $(CBTModuleExtensionsPath), $(CBTModulePropertiesFile), $(CBTNuGetDownloaderAssemblyPath), $(CBTNuGetDownloaderClassName), '$(CBTNuGetDownloaderArguments)', $(CBTModuleRestoreInputs.Split(';')), $(CBTModulePackageConfigPath), $(NuGetPackagesPath), $(CBTPackagesFallbackPath), $(CBTModuleRestoreCommand), $(CBTModuleRestoreCommandArguments), $(MSBuildProjectFullPath), $(CBTModuleNuGetAssetsFlagFile)))", @" '$(RestoreCBTModules)' != 'false' And '$(BuildingInsideVisualStudio)' != 'true' And '$(CBTModulesRestored)' != 'true' And Exists('$(CBTCoreAssemblyPath)') ")
             };
             var propertiesToScan = _project.Properties.Where(p => p.Parent.Parent is ProjectRootElement);
             var propertiesEnumerator = propertiesToScan.GetEnumerator();
             foreach (var knownProperty in knownProperties)
             {
                 propertiesEnumerator.MoveNext();
-                var property = propertiesEnumerator.Current as ProjectPropertyElement;
+                var property = propertiesEnumerator.Current;
                 property.ShouldNotBe(null);
 
                 property.Name.ShouldBe(knownProperty.Name,StringCompareShould.IgnoreCase);
@@ -78,7 +78,7 @@ public void RequiredPropertiesTest()
                 property.Value.ShouldBe(String.Format(knownProperty.Value, property.Name), $"Property {property.Name} value is not as expected.");
             }
             propertiesEnumerator.Dispose();
-            knownProperties.Count.ShouldBe(propertiesToScan.Count(),$"Expecting properites under ProjectRootElement and actual properties differ. ");
+            knownProperties.Count.ShouldBe(propertiesToScan.Count(), "Expecting properites under ProjectRootElement and actual properties differ. ");
 
         }
 
@@ -91,7 +91,7 @@ public void RequiredItemsTest()
                 ItemType = "CBTParseError",
                 Include = "The 'EnlistmentRoot' property must be set.  Please ensure it is declared in a properties file before CBT Core is imported.",
                 Condition = " '$(EnlistmentRoot)' == '' ",
-                Metadata = new List<NameValueCondition>()
+                Metadata = new List<NameValueCondition>
                 {
                   new NameValueCondition { Name="Code", Value="CBT1000", Condition = string.Empty }
                 }
@@ -101,7 +101,7 @@ public void RequiredItemsTest()
                 ItemType = "CBTParseError",
                 Include = "Modules were not restored and the build cannot continue.  Refer to other errors for more information.",
                 Condition = " '$(CBTModulesRestored)' == 'false' ",
-                Metadata = new List<NameValueCondition>()
+                Metadata = new List<NameValueCondition>
                 {
                   new NameValueCondition { Name="Code", Value="CBT1001", Condition = string.Empty }
                 }
@@ -111,7 +111,7 @@ public void RequiredItemsTest()
                 ItemType = "CBTParseError",
                 Include = "The CBT modules packages.config or project.json file was not found under $(CBTLocalPath) or $(CBTLocalPath)\\CBTModules.  Please add a cbt modules packages file or set the property 'CBTModulePackageConfigPath' to a custom module packages file.",
                 Condition = " '$(CBTModulePackageConfigPath)' == '' ",
-                Metadata = new List<NameValueCondition>()
+                Metadata = new List<NameValueCondition>
                 {
                   new NameValueCondition { Name="Code", Value="CBT1002", Condition = string.Empty }
                 }
@@ -212,8 +212,11 @@ public void RestoreCBTModulesTargetTest()
         public void GenerateModuleAssetFlagFileTargetTest()
         {
 
-            var target = _project.Targets.FirstOrDefault(i => i.Name.Equals("GenerateModuleAssetFlagFile", StringComparison.OrdinalIgnoreCase));
+            ProjectTargetElement target = _project.Targets.FirstOrDefault(i => i.Name.Equals("GenerateModuleAssetFlagFile", StringComparison.OrdinalIgnoreCase));
 
+            target.ShouldNotBeNull();
+
+            // ReSharper disable once PossibleNullReferenceException
             target.Children.Count.ShouldBe(2);
             target.ShouldNotBe(null);
             target.Condition.ShouldBe(@" '$(RestoreOutputAbsolutePath)' != '' ");