Support RID-specific .NET Tool packages (#48575)

Author: dsplaisted

eng/dogfood.ps1

@@ -47,6 +47,7 @@ try {
 
   $env:PATH = "$TestDotnetRoot;$env:Path"
   $env:DOTNET_ROOT = $TestDotnetRoot
+  $env:DOTNET_ADD_GLOBAL_TOOLS_TO_PATH="0"
 
   # Avoid downloading Microsoft.Net.Sdk.Compilers.Toolset from feed
   # Locally built SDK package version is Major.Minor.0-dev, which won't be available.

eng/dogfood.sh

@@ -25,4 +25,5 @@ export MicrosoftNETBuildExtensionsTargets="$artifacts_dir/bin/$configuration/Sdk
 
 export PATH=$testDotnetRoot:$PATH
 export DOTNET_ROOT=$testDotnetRoot
+export DOTNET_ADD_GLOBAL_TOOLS_TO_PATH=0
 export PS1="(dogfood) $PS1"

eng/restore-toolset.ps1

@@ -51,6 +51,7 @@ set DOTNET_MSBUILD_SDK_RESOLVER_CLI_DIR=$env:DOTNET_INSTALL_DIR
 
 set PATH=$env:DOTNET_INSTALL_DIR;%PATH%
 set NUGET_PACKAGES=$env:NUGET_PACKAGES
+set DOTNET_ADD_GLOBAL_TOOLS_TO_PATH=0
 
 DOSKEY killdotnet=taskkill /F /IM dotnet.exe /T ^& taskkill /F /IM VSTest.Console.exe /T ^& taskkill /F /IM msbuild.exe /T
 "@
@@ -70,6 +71,7 @@ DOSKEY killdotnet=taskkill /F /IM dotnet.exe /T ^& taskkill /F /IM VSTest.Consol
 
 `$env:PATH="$env:DOTNET_INSTALL_DIR;" + `$env:PATH
 `$env:NUGET_PACKAGES="$env:NUGET_PACKAGES"
+`$env:DOTNET_ADD_GLOBAL_TOOLS_TO_PATH="0"
 
 function killdotnet {
   taskkill /F /IM dotnet.exe /T

eng/restore-toolset.sh

@@ -61,6 +61,7 @@ export DOTNET_MSBUILD_SDK_RESOLVER_CLI_DIR=$DOTNET_INSTALL_DIR
 
 export PATH=$DOTNET_INSTALL_DIR:\$PATH
 export NUGET_PACKAGES=$NUGET_PACKAGES
+export DOTNET_ADD_GLOBAL_TOOLS_TO_PATH=0
 "
 
   echo "$scriptContents" > ${scriptPath}

src/Cli/dotnet/CliStrings.resx

@@ -319,6 +319,9 @@
   <data name="ToolSettingsUnsupportedRunner" xml:space="preserve">
     <value>Command '{0}' uses unsupported runner '{1}'."</value>
   </data>
+  <data name="ToolUnsupportedRuntimeIdentifier" xml:space="preserve">
+    <value>The tool does not support the current architecture or operating system ({0}). Supported runtimes: {1}</value>
+  </data>
   <data name="ShellShimConflict" xml:space="preserve">
     <value>Command '{0}' conflicts with an existing command from another tool.</value>
   </data>
@@ -413,6 +416,9 @@ setx PATH "%PATH%;{0}"
   <data name="ToolPackageConflictPackageId" xml:space="preserve">
     <value>Tool '{0}' (version '{1}') is already installed.</value>
   </data>
+  <data name="ToolPackageNotATool" xml:space="preserve">
+    <value>Package {0} is not a .NET tool.</value>
+  </data>
   <data name="FailedToFindStagedToolPackage" xml:space="preserve">
     <value>Failed to find staged tool package '{0}'.</value>
   </data>
@@ -435,7 +441,10 @@ setx PATH "%PATH%;{0}"
     <value>More than one packaged shim is available: {0}.</value>
   </data>
   <data name="FailedToReadNuGetLockFile" xml:space="preserve">
-    <value>Failed to read NuGet LockFile for tool package '{0}': {1}</value>
+    <value>Failed to read NuGet assets file for tool package '{0}': {1}</value>
+  </data>
+  <data name="FailedToFindLibraryInAssetsFile" xml:space="preserve">
+    <value>Failed to find library in NuGet assets file for tool package '{0}': {1}</value>
   </data>
   <data name="LevelArgumentName" xml:space="preserve">
     <value>LEVEL</value>

src/Cli/dotnet/CommandFactory/CommandResolution/LocalToolsCommandResolver.cs

@@ -7,6 +7,7 @@
 using Microsoft.DotNet.Cli.ToolPackage;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.Extensions.EnvironmentAbstractions;
+using NuGet.DependencyResolver;
 using NuGet.Frameworks;
 
 namespace Microsoft.DotNet.Cli.CommandFactory.CommandResolution;
@@ -82,22 +83,39 @@ private CommandSpec GetPackageCommandSpecUsingMuxer(CommandResolverArguments arg
                 NuGetFramework.Parse(BundledTargetFramework.GetTargetFrameworkMoniker()),
                 Constants.AnyRid,
                 toolCommandName),
-            out var restoredCommand))
+            out var toolCommand))
         {
-            if (!_fileSystem.File.Exists(restoredCommand.Executable.Value))
+            if (!_fileSystem.File.Exists(toolCommand.Executable.Value))
             {
                 throw new GracefulException(string.Format(CliStrings.NeedRunToolRestore,
                     toolCommandName.ToString()));
             }
 
-            if (toolManifestPackage.RollForward || allowRollForward)
+            if (toolCommand.Runner == "dotnet")
             {
-                arguments.CommandArguments = ["--allow-roll-forward", .. arguments.CommandArguments];
+                if (toolManifestPackage.RollForward || allowRollForward)
+                {
+                    arguments.CommandArguments = ["--allow-roll-forward", .. arguments.CommandArguments];
+                }
+
+                return MuxerCommandSpecMaker.CreatePackageCommandSpecUsingMuxer(
+                    toolCommand.Executable.Value,
+                    arguments.CommandArguments);
             }
+            else if (toolCommand.Runner == "executable")
+            {
+                var escapedArgs = ArgumentEscaper.EscapeAndConcatenateArgArrayForProcessStart(
+                    arguments.CommandArguments);
 
-            return MuxerCommandSpecMaker.CreatePackageCommandSpecUsingMuxer(
-                restoredCommand.Executable.Value,
-                arguments.CommandArguments);
+                return new CommandSpec(
+                    toolCommand.Executable.Value,
+                    escapedArgs);
+            }
+            else
+            {
+                throw new GracefulException(string.Format(CliStrings.ToolSettingsUnsupportedRunner,
+                    toolCommand.Name, toolCommand.Runner));
+            }
         }
         else
         {

src/Cli/dotnet/Commands/CliCommandStrings.resx

@@ -1938,16 +1938,6 @@ Your project targets multiple frameworks. Specify which framework to run using '
   <data name="ToolInstallationFailedContactAuthor" xml:space="preserve">
     <value>Tool '{0}' failed to install. Contact the tool author for assistance.</value>
   </data>
-  <data name="ToolInstallationFailedWithRestoreGuidance" xml:space="preserve">
-    <value>Tool '{0}' failed to install. This failure may have been caused by:
-
-* You are attempting to install a preview release and did not use the --version option to specify the version.
-* A package by this name was found, but it was not a .NET tool.
-* The required NuGet feed cannot be accessed, perhaps because of an Internet connection problem.
-* You mistyped the name of the tool.
-
-For more reasons, including package naming enforcement, visit https://aka.ms/failure-installing-tool</value>
-  </data>
   <data name="ToolInstallationRestoreFailed" xml:space="preserve">
     <value>The tool package could not be restored.</value>
   </data>
@@ -2486,4 +2476,4 @@ To display a value, specify the corresponding command-line option without provid
   <data name="SolutionAddReferencedProjectsOptionDescription" xml:space="preserve">
     <value>Recursively add projects' ReferencedProjects to solution</value>
   </data>
-</root>
+</root>

src/Cli/dotnet/Commands/Pack/PackCommandParser.cs

@@ -84,7 +84,10 @@ private static Command ConstructCommand()
         command.Options.Add(CommonOptions.VersionSuffixOption);
         command.Options.Add(ConfigurationOption);
         command.Options.Add(CommonOptions.DisableBuildServersOption);
-        RestoreCommandParser.AddImplicitRestoreOptions(command, includeRuntimeOption: true, includeNoDependenciesOption: true);
+
+        // Don't include runtime option because we want to include it specifically and allow the short version ("-r") to be used
+        RestoreCommandParser.AddImplicitRestoreOptions(command, includeRuntimeOption: false, includeNoDependenciesOption: true);
+        command.Options.Add(CommonOptions.RuntimeOption(CliCommandStrings.BuildRuntimeOptionDescription));
 
         command.SetAction(PackCommand.Run);
 

src/Cli/dotnet/Commands/Tool/Install/LocalToolsResolverCacheExtensions.cs

@@ -33,7 +33,7 @@ public static void SaveToolPackage(
         }
 
         localToolsResolverCache.Save(
-            new Dictionary<RestoredCommandIdentifier, RestoredCommand>
+            new Dictionary<RestoredCommandIdentifier, ToolCommand>
             {
                 [new RestoredCommandIdentifier(
                         toolDownloadedPackage.Id,

src/Cli/dotnet/Commands/Tool/Install/ToolInstallCommandLowLevelErrorConverter.cs

@@ -12,12 +12,7 @@ internal static class InstallToolCommandLowLevelErrorConverter
 {
     public static IEnumerable<string> GetUserFacingMessages(Exception ex, PackageId packageId)
     {
-        if (ex is ToolPackageException)
-        {
-            yield return ex.Message;
-            yield return string.Format(CliCommandStrings.ToolInstallationFailedWithRestoreGuidance, packageId);
-        }
-        else if (ex is ToolConfigurationException)
+        if (ex is ToolConfigurationException)
         {
             yield return string.Format(CliCommandStrings.InvalidToolConfiguration, ex.Message);
             yield return string.Format(CliCommandStrings.ToolInstallationFailedContactAuthor, packageId);
@@ -31,8 +26,7 @@ public static IEnumerable<string> GetUserFacingMessages(Exception ex, PackageId
 
     public static bool ShouldConvertToUserFacingError(Exception ex)
     {
-        return ex is ToolPackageException
-               || ex is ToolConfigurationException
+        return ex is ToolConfigurationException
                || ex is ShellShimException;
     }
 }