Skip to content

Write static graph restore arguments to standard input instead of passing on the command-line #4772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 12, 2022
Merged

Write static graph restore arguments to standard input instead of passing on the command-line #4772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e19feb9
Write static graph restore arguments to a file instead of passing on …
jeffkl Aug 29, 2022
76abfbe
Address comments
jeffkl Aug 31, 2022
04d764b
Address comments
jeffkl Sep 6, 2022
c8c0b29
Address comments
jeffkl Sep 15, 2022
2f8bf01
Use File.Create()
jeffkl Sep 28, 2022
40e5451
Write arguments to standard input instead
jeffkl Oct 5, 2022
6609578
Forgot a line of code to remove...
jeffkl Oct 6, 2022
0379037
Address comments
jeffkl Oct 7, 2022
a39271f
Address comments
jeffkl Oct 10, 2022
cf3c6f0
Use BinaryReader/BinaryWriter instead of JSON
jeffkl Oct 10, 2022
03f3cf8
Reduce test data
jeffkl Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 23 additions & 60 deletions src/NuGet.Core/NuGet.Build.Tasks.Console/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading.Tasks;

Expand All @@ -16,16 +14,6 @@ namespace NuGet.Build.Tasks.Console
/// </summary>
internal static class Program
{
/// <summary>
/// A <see cref="T:char[]" /> containing the equals sign '=' to be used to split key/value pairs that are separated by it.
/// </summary>
private static readonly char[] EqualSign = { '=' };

/// <summary>
/// A <see cref="T:char[]" /> containing the semicolon ';' to be used to split key/value pairs that are separated by it.
/// </summary>
private static readonly char[] Semicolon = { ';' };

/// <summary>
/// The main entry point to the console application.
/// </summary>
Expand All @@ -41,34 +29,36 @@ public static async Task<int> Main(string[] args)
}

NuGet.Common.Migrations.MigrationRunner.Run();

// Parse command-line arguments
if (!TryParseArguments(args, out (Dictionary<string, string> Options, FileInfo MSBuildExeFilePath, string EntryProjectFilePath, Dictionary<string, string> MSBuildGlobalProperties) arguments))
if (args.Length != 2)
{
return 1;
}

var msbuildFilePath = new FileInfo(args[0]);
var entryProjectPath = new FileInfo(args[1]);

// Enable MSBuild feature flags
MSBuildFeatureFlags.MSBuildExeFilePath = arguments.MSBuildExeFilePath.FullName;
MSBuildFeatureFlags.MSBuildExeFilePath = msbuildFilePath.FullName;
MSBuildFeatureFlags.EnableCacheFileEnumerations = true;
MSBuildFeatureFlags.LoadAllFilesAsReadonly = true;
MSBuildFeatureFlags.SkipEagerWildcardEvaluations = true;

#if NETFRAMEWORK
if (AppDomain.CurrentDomain.IsDefaultAppDomain())
{
// MSBuild.exe.config has binding redirects that change from time to time and its very hard to make sure that NuGet.Build.Tasks.Console.exe.config is correct.
// It also can be different per instance of Visual Studio so when running unit tests it always needs to match that instance of MSBuild
// The code below runs this EXE in an AppDomain as if its MSBuild.exe so the assembly search location is next to MSBuild.exe and all binding redirects are used
// allowing this process to evaluate MSBuild projects as if it is MSBuild.exe
var thisAssembly = Assembly.GetExecutingAssembly();
Assembly thisAssembly = Assembly.GetExecutingAssembly();

AppDomain appDomain = AppDomain.CreateDomain(
thisAssembly.FullName,
securityInfo: null,
info: new AppDomainSetup
{
ApplicationBase = arguments.MSBuildExeFilePath.DirectoryName,
ConfigurationFile = Path.Combine(arguments.MSBuildExeFilePath.DirectoryName, "MSBuild.exe.config")
ApplicationBase = msbuildFilePath.DirectoryName,
ConfigurationFile = Path.Combine(msbuildFilePath.DirectoryName, "MSBuild.exe.config")
});

return appDomain
Expand All @@ -78,19 +68,25 @@ public static async Task<int> Main(string[] args)
}
#endif

// Parse command-line arguments
if (!TryGetArguments(out StaticGraphRestoreArguments arguments))
{
return 1;
}

// Check whether the ask is to generate the restore graph file.
if (MSBuildStaticGraphRestore.IsOptionTrue("GenerateRestoreGraphFile", arguments.Options))
{
using (var dependencyGraphSpecGenerator = new MSBuildStaticGraphRestore(debug: debug))
{
return dependencyGraphSpecGenerator.WriteDependencyGraphSpec(arguments.EntryProjectFilePath, arguments.MSBuildGlobalProperties, arguments.Options) ? 0 : 1;
return dependencyGraphSpecGenerator.WriteDependencyGraphSpec(entryProjectPath.FullName, arguments.GlobalProperties, arguments.Options) ? 0 : 1;
}
}

// Otherwise run restore!
using (var dependencyGraphSpecGenerator = new MSBuildStaticGraphRestore(debug: debug))
{
return await dependencyGraphSpecGenerator.RestoreAsync(arguments.EntryProjectFilePath, arguments.MSBuildGlobalProperties, arguments.Options) ? 0 : 1;
return await dependencyGraphSpecGenerator.RestoreAsync(entryProjectPath.FullName, arguments.GlobalProperties, arguments.Options) ? 0 : 1;
}
}

Expand All @@ -103,58 +99,25 @@ private static bool IsDebug()
return string.Equals(Environment.GetEnvironmentVariable("DEBUG_RESTORE_TASK"), bool.TrueString, StringComparison.OrdinalIgnoreCase);
}

/// <summary>
/// Parses a semicolon delimited list of equal sign separated key value pairs.
/// </summary>
/// <param name="value">The string containing a semicolon delimited list of key value pairs to parse.</param>
/// <returns>A <see cref="Dictionary{String,String}" /> containing the list of items as key value pairs.</returns>
private static Dictionary<string, string> ParseSemicolonDelimitedListOfKeyValuePairs(string value)
{
var properties = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);

foreach (var pair in value
.Split(Semicolon, StringSplitOptions.RemoveEmptyEntries)
.Where(i => !string.IsNullOrWhiteSpace(i))
.Select(i => i.Split(EqualSign, 2))
.Where(i => i.Length == 2 && !string.IsNullOrWhiteSpace(i[0]) && !string.IsNullOrWhiteSpace(i[1])))
{
properties[pair[0].Trim()] = pair[1].Trim();
}

return properties;
}

/// <summary>
/// Parses command-line arguments.
/// </summary>
/// <param name="args">A <see cref="T:string[]" /> containing the process command-line arguments.</param>
/// <param name="arguments">A <see cref="T:Tuple&lt;Dictionary&lt;string, string&gt;, FileInfo, string, Dictionary&lt;string, string&gt;&gt;" /> that receives the parsed command-line arguments.</param>
/// <param name="staticGraphRestoreArguments">Receives the arguments as a <see cref="StaticGraphRestoreArguments" />.</param>
/// <returns><code>true</code> if the arguments were successfully parsed, otherwise <code>false</code>.</returns>
private static bool TryParseArguments(string[] args, out (Dictionary<string, string> Options, FileInfo MSBuildExeFilePath, string EntryProjectFilePath, Dictionary<string, string> MSBuildGlobalProperties) arguments)
private static bool TryGetArguments(out StaticGraphRestoreArguments staticGraphRestoreArguments)
{
if (args.Length != 4)
{
arguments = (null, null, null, null);

return false;
}
staticGraphRestoreArguments = null;

try
{
var options = ParseSemicolonDelimitedListOfKeyValuePairs(args[0]);
var msbuildExeFilePath = new FileInfo(args[1]);
var entryProjectFilePath = args[2];
var globalProperties = ParseSemicolonDelimitedListOfKeyValuePairs(args[3]);
using Stream stream = System.Console.OpenStandardInput();

arguments = (options, msbuildExeFilePath, entryProjectFilePath, globalProperties);
staticGraphRestoreArguments = StaticGraphRestoreArguments.Read(stream);

// Command-line is correct if no exceptions were thrown and the MSBuild path exists and an entry project were specified
return msbuildExeFilePath.Exists && !string.IsNullOrWhiteSpace(entryProjectFilePath);
return staticGraphRestoreArguments != null;
}
catch (Exception)
{
arguments = (null, null, null, null);

return false;
}
}
Expand Down
Loading