Merge pull request #9556 from MaxWang-MS/nuget_restore

Adding the option to use nuget.exe for restore in build tools

Author: MaxWang-MS

Assets/MRTK/Core/Utilities/BuildAndDeploy/UwpAppxBuildTools.cs

@@ -90,13 +90,27 @@ public static async Task<bool> BuildAppxAsync(UwpBuildInfo buildInfo, Cancellati
             string storagePath = Path.GetFullPath(Path.Combine(Path.Combine(Application.dataPath, ".."), buildInfo.OutputDirectory));
             string solutionProjectPath = Path.GetFullPath(Path.Combine(storagePath, $@"{PlayerSettings.productName}.sln"));
 
+            int exitCode;
+
             // Building the solution requires first restoring NuGet packages - when built through
             // Visual Studio, VS does this automatically - when building via msbuild like we're doing here,
             // we have to do that step manually.
-            int exitCode = await Run(msBuildPath,
+            // We use msbuild for nuget restore by default, but if a path to nuget.exe is supplied then we use that executable
+            if (string.IsNullOrEmpty(buildInfo.NugetExecutablePath))
+            {
+                exitCode = await Run(msBuildPath,
                 $"\"{solutionProjectPath}\" /t:restore {GetMSBuildLoggingCommand(buildInfo.LogDirectory, "nugetRestore.log")}",
                 !Application.isBatchMode,
                 cancellationToken);
+            }
+            else
+            {
+                exitCode = await Run(buildInfo.NugetExecutablePath,
+                $"restore \"{solutionProjectPath}\"",
+                !Application.isBatchMode,
+                cancellationToken);
+            }
+            
             if (exitCode != 0)
             {
                 IsBuilding = false;

Assets/MRTK/Core/Utilities/BuildAndDeploy/UwpBuildDeployPreferences.cs

@@ -46,6 +46,7 @@ public static class UwpBuildDeployPreferences
         private const string EDITOR_PREF_MULTICORE_APPX_BUILD_ENABLED = "BuildDeployWindow_MulticoreAppxBuildEnabled";
         private const string EDITOR_PREF_RESEARCH_MODE_CAPABILITY_ENABLED = "BuildDeployWindow_ResearchModeCapabilityEnabled";
         private const string EDITOR_PREF_ALLOW_UNSAFE_CODE = "BuildDeployWindow_AllowUnsafeCode";
+        private const string EDITOR_PREF_NUGET_EXECUTABLE_PATH = "BuildDeployWindow_NugetExecutablePath";
 
         /// <summary>
         /// The current Build Configuration. (Debug, Release, or Master)
@@ -194,5 +195,14 @@ public static bool AllowUnsafeCode
             get => EditorPreferences.Get(EDITOR_PREF_ALLOW_UNSAFE_CODE, false);
             set => EditorPreferences.Set(EDITOR_PREF_ALLOW_UNSAFE_CODE, value);
         }
+
+        /// <summary>
+        /// Current value of the optional path to nuget.exe.
+        /// </summary>
+        public static string NugetExecutablePath
+        {
+            get => EditorPreferences.Get(EDITOR_PREF_NUGET_EXECUTABLE_PATH, string.Empty);
+            set => EditorPreferences.Set(EDITOR_PREF_NUGET_EXECUTABLE_PATH, value);
+        }
     }
 }

Assets/MRTK/Core/Utilities/BuildAndDeploy/UwpBuildInfo.cs

@@ -58,5 +58,10 @@ public UwpBuildInfo(bool isCommandLine = false) : base(isCommandLine)
         /// in the list to the manifest
         /// </summary>
         public List<string> DeviceCapabilities { get; set; } = null;
+
+        /// <summary>
+        /// Optional path to nuget.exe. Used when performing package restore with nuget.exe (instead of msbuild) is desired.
+        /// </summary>
+        public string NugetExecutablePath { get; set; }
     }
 }

Assets/MRTK/Core/Utilities/BuildAndDeploy/UwpPlayerBuildTools.cs

@@ -38,6 +38,9 @@ private static void ParseBuildCommandLine(ref UwpBuildInfo buildInfo)
                         // Note: the min sdk target cannot be changed.
                         EditorUserBuildSettings.wsaUWPSDK = arguments[++i];
                         break;
+                    case "-nugetPath":
+                        buildInfo.NugetExecutablePath = arguments[++i];
+                        break;
                 }
             }
         }

Assets/MRTK/Tools/BuildWindow/BuildDeployWindow.cs

@@ -139,6 +139,8 @@ private enum BuildDeployTab
 
         private readonly GUIContent ViewPlayerLogLabel = new GUIContent("View Player Log", "Launch notepad with more recent player log for listed AppX on either currently selected device or from all devices.");
 
+        private readonly GUIContent NugetPathLabel = new GUIContent("Nuget Executable Path", "Only set this when restoring packages with nuget.exe (instead of msbuild) is desired.");
+
         #endregion Labels
 
         #region Properties
@@ -563,6 +565,22 @@ private void RenderAppxBuildView()
                     // since there's a null texture issue when Unity reloads the assets during a build
                     MixedRealityBuildPreferences.DrawAppLauncherModelField(appxCancellationTokenSource == null);
 
+                    // Draw the section for nuget executable path
+                    EditorGUILayout.LabelField("Nuget Path (Optional)", EditorStyles.boldLabel);
+
+                    string nugetExecutablePath = EditorGUILayout.TextField(NugetPathLabel, UwpBuildDeployPreferences.NugetExecutablePath);
+                    using (new EditorGUILayout.HorizontalScope())
+                    {
+                        if (GUILayout.Button("Select Nuget Executable Path"))
+                        {
+                            nugetExecutablePath = EditorUtility.OpenFilePanel(
+                                "Select Nuget Executable Path", "", "exe");
+                        }
+                        if (GUILayout.Button("Use msbuild for Restore & Clear Path"))
+                        {
+                            nugetExecutablePath = "";
+                        }
+                    }
                     if (c.changed)
                     {
                         UwpBuildDeployPreferences.PlatformToolset = PLATFORM_TOOLSET_VALUES[newPlatformToolsetIndex];
@@ -571,6 +589,7 @@ private void RenderAppxBuildView()
                         UwpBuildDeployPreferences.ResearchModeCapabilityEnabled = researchModeEnabled;
                         UwpBuildDeployPreferences.ForceRebuild = forceRebuildAppx;
                         UwpBuildDeployPreferences.MulticoreAppxBuildEnabled = multicoreAppxBuildEnabled;
+                        UwpBuildDeployPreferences.NugetExecutablePath = nugetExecutablePath;
                     }
                 }
             }