[FIX] tool-install: Use restore action config options (#44309)

Co-authored-by: Noah Gilson <[email protected]>

Author: edvilme

eng/dogfood.sh

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

src/Cli/dotnet/ToolPackage/IToolPackageDownloader.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Threading.Tasks;
+using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.ToolPackage;
 using NuGet.Versioning;
 
@@ -16,15 +17,17 @@ IToolPackage InstallPackage(PackageLocation packageLocation,
             string targetFramework = null,
             bool isGlobalTool = false,
             bool isGlobalToolRollForward = false,
-            bool verifySignatures = true
+            bool verifySignatures = true,
+            RestoreActionConfig restoreActionConfig = null
         );
 
         NuGetVersion GetNuGetVersion(
             PackageLocation packageLocation,
             PackageId packageId,
             VerbosityOptions verbosity,
             VersionRange versionRange = null,
-            bool isGlobalTool = false
+            bool isGlobalTool = false,
+            RestoreActionConfig restoreActionConfig = null
         );
     }
 }

src/Cli/dotnet/ToolPackage/ToolPackageDownloader.cs

@@ -72,7 +72,8 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
             string targetFramework = null,
             bool isGlobalTool = false,
             bool isGlobalToolRollForward = false,
-            bool verifySignatures = true
+            bool verifySignatures = true,
+            RestoreActionConfig restoreActionConfig = null
             )
         {
             var packageRootDirectory = _toolPackageStore.GetRootPackageDirectory(packageId);
@@ -96,7 +97,14 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
                     var toolDownloadDir = isGlobalTool ? _globalToolStageDir : _localToolDownloadDir;
                     var assetFileDirectory = isGlobalTool ? _globalToolStageDir : _localToolAssetDir;
 
-                    var nugetPackageDownloader = new NuGetPackageDownloader.NuGetPackageDownloader(toolDownloadDir, verboseLogger: nugetLogger, verifySignatures: verifySignatures, shouldUsePackageSourceMapping: true, verbosityOptions: verbosity, currentWorkingDirectory: _currentWorkingDirectory);
+                    var nugetPackageDownloader = new NuGetPackageDownloader.NuGetPackageDownloader(
+                        toolDownloadDir,
+                        verboseLogger: nugetLogger,
+                        verifySignatures: verifySignatures,
+                        shouldUsePackageSourceMapping: true,
+                        restoreActionConfig: restoreActionConfig,
+                        verbosityOptions: verbosity,
+                        currentWorkingDirectory: _currentWorkingDirectory);
 
                     var packageSourceLocation = new PackageSourceLocation(packageLocation.NugetConfig, packageLocation.RootConfigDirectory, packageLocation.SourceFeedOverrides, packageLocation.AdditionalFeeds);
 
@@ -380,7 +388,8 @@ public NuGetVersion GetNuGetVersion(
             PackageId packageId,
             VerbosityOptions verbosity,
             VersionRange versionRange = null,
-            bool isGlobalTool = false)
+            bool isGlobalTool = false,
+            RestoreActionConfig restoreActionConfig = null)
         {
             ILogger nugetLogger = new NullLogger();
 
@@ -399,7 +408,8 @@ public NuGetVersion GetNuGetVersion(
                 packageInstallDir: isGlobalTool ? _globalToolStageDir : _localToolDownloadDir,
                 verboseLogger: nugetLogger,
                 shouldUsePackageSourceMapping: true,
-                verbosityOptions: verbosity);
+                verbosityOptions: verbosity,
+                restoreActionConfig: restoreActionConfig);
 
             var packageSourceLocation = new PackageSourceLocation(
                 nugetConfig: packageLocation.NugetConfig,

src/Cli/dotnet/commands/dotnet-tool/install/ToolInstallGlobalOrToolPathCommand.cs

@@ -51,6 +51,8 @@ internal class ToolInstallGlobalOrToolPathCommand : CommandBase
         private readonly string _currentWorkingDirectory;
         private readonly bool? _verifySignatures;
 
+        internal readonly RestoreActionConfig restoreActionConfig;
+
         public ToolInstallGlobalOrToolPathCommand(
             ParseResult parseResult,
             PackageId? packageId = null,
@@ -86,11 +88,11 @@ public ToolInstallGlobalOrToolPathCommand(
             var configOption = parseResult.GetValue(ToolInstallCommandParser.ConfigOption);
             var sourceOption = parseResult.GetValue(ToolInstallCommandParser.AddSourceOption);
             var packageSourceLocation = new PackageSourceLocation(string.IsNullOrEmpty(configOption) ? null : new FilePath(configOption), additionalSourceFeeds: sourceOption);
-            var restoreAction = new RestoreActionConfig(DisableParallel: parseResult.GetValue(ToolCommandRestorePassThroughOptions.DisableParallelOption),
+            restoreActionConfig = new RestoreActionConfig(DisableParallel: parseResult.GetValue(ToolCommandRestorePassThroughOptions.DisableParallelOption),
                 NoCache: (parseResult.GetValue(ToolCommandRestorePassThroughOptions.NoCacheOption) || parseResult.GetValue(ToolCommandRestorePassThroughOptions.NoHttpCacheOption)),
                 IgnoreFailedSources: parseResult.GetValue(ToolCommandRestorePassThroughOptions.IgnoreFailedSourcesOption),
                 Interactive: parseResult.GetValue(ToolCommandRestorePassThroughOptions.InteractiveRestoreOption));
-            nugetPackageDownloader ??= new NuGetPackageDownloader(tempDir, verboseLogger: new NullLogger(), restoreActionConfig: restoreAction, verbosityOptions: _verbosity, verifySignatures: verifySignatures ?? true);
+            nugetPackageDownloader ??= new NuGetPackageDownloader(tempDir, verboseLogger: new NullLogger(), restoreActionConfig: restoreActionConfig, verbosityOptions: _verbosity, verifySignatures: verifySignatures ?? true);
             _shellShimTemplateFinder = new ShellShimTemplateFinder(nugetPackageDownloader, tempDir, packageSourceLocation);
             _store = store;
 
@@ -192,7 +194,8 @@ private int ExecuteInstallCommand(PackageId packageId)
                         verbosity: _verbosity,
                         isGlobalTool: true,
                         isGlobalToolRollForward: _allowRollForward,
-                        verifySignatures: _verifySignatures ?? true
+                        verifySignatures: _verifySignatures ?? true,
+                        restoreActionConfig: restoreActionConfig
                     );
 
                     EnsureVersionIsHigher(oldPackageNullable, newInstalledPackage, _allowPackageDowngrade);
@@ -239,7 +242,8 @@ private NuGetVersion GetBestMatchNugetVersion(PackageId packageId, VersionRange
                 packageId: packageId,
                 versionRange: versionRange,
                 verbosity: _verbosity,
-                isGlobalTool: true
+                isGlobalTool: true,
+                restoreActionConfig: restoreActionConfig
             );
         }
 

src/Cli/dotnet/commands/dotnet-tool/install/ToolInstallLocalCommand.cs

@@ -3,6 +3,7 @@
 
 using System.CommandLine;
 using Microsoft.DotNet.Cli;
+using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.Cli.ToolPackage;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.ToolManifest;
@@ -28,6 +29,8 @@ internal class ToolInstallLocalCommand : CommandBase
         private readonly bool _allowRollForward;
         private readonly bool _updateAll;
 
+        internal RestoreActionConfig restoreActionConfig;
+
         public ToolInstallLocalCommand(
             ParseResult parseResult,
             PackageId? packageId = null,
@@ -53,7 +56,13 @@ public ToolInstallLocalCommand(
                                   new ToolManifestFinder(new DirectoryPath(Directory.GetCurrentDirectory()));
             _toolManifestEditor = toolManifestEditor ?? new ToolManifestEditor();
             _localToolsResolverCache = localToolsResolverCache ?? new LocalToolsResolverCache();
-            _toolLocalPackageInstaller = new ToolInstallLocalInstaller(parseResult, toolPackageDownloader, runtimeJsonPathForTests);
+
+            restoreActionConfig = new RestoreActionConfig(DisableParallel: parseResult.GetValue(ToolCommandRestorePassThroughOptions.DisableParallelOption),
+                NoCache: (parseResult.GetValue(ToolCommandRestorePassThroughOptions.NoCacheOption) || parseResult.GetValue(ToolCommandRestorePassThroughOptions.NoHttpCacheOption)),
+                IgnoreFailedSources: parseResult.GetValue(ToolCommandRestorePassThroughOptions.IgnoreFailedSourcesOption),
+                Interactive: parseResult.GetValue(ToolCommandRestorePassThroughOptions.InteractiveRestoreOption));
+
+            _toolLocalPackageInstaller = new ToolInstallLocalInstaller(parseResult, toolPackageDownloader, runtimeJsonPathForTests, restoreActionConfig);
             _allowRollForward = parseResult.GetValue(ToolInstallCommandParser.RollForwardOption);
             _allowPackageDowngrade = parseResult.GetValue(ToolInstallCommandParser.AllowPackageDowngradeOption);
         }

src/Cli/dotnet/commands/dotnet-tool/install/ToolInstallLocalInstaller.cs

@@ -3,6 +3,7 @@
 
 using System.CommandLine;
 using Microsoft.DotNet.Cli;
+using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.Cli.ToolPackage;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.ToolPackage;
@@ -20,11 +21,13 @@ internal class ToolInstallLocalInstaller
         private readonly string _configFilePath;
         private readonly string[] _sources;
         private readonly VerbosityOptions _verbosity;
+        private readonly RestoreActionConfig _restoreActionConfig;
 
         public ToolInstallLocalInstaller(
             ParseResult parseResult,
             IToolPackageDownloader toolPackageDownloader = null,
-            string runtimeJsonPathForTests = null)
+            string runtimeJsonPathForTests = null,
+            RestoreActionConfig restoreActionConfig = null)
         {
             _parseResult = parseResult;
             _configFilePath = parseResult.GetValue(ToolInstallCommandParser.ConfigOption);
@@ -37,7 +40,7 @@ public ToolInstallLocalInstaller(
                     = ToolPackageFactory.CreateToolPackageStoresAndDownloader(
                         additionalRestoreArguments: parseResult.OptionValuesToBeForwarded(ToolInstallCommandParser.GetCommand()), runtimeJsonPathForTests: runtimeJsonPathForTests);
             _toolPackageDownloader = toolPackageDownloader ?? toolPackageStoresAndDownloader.downloader;
-
+            _restoreActionConfig = restoreActionConfig;
 
             TargetFrameworkToInstall = BundledTargetFramework.GetTargetFrameworkMoniker();
         }
@@ -70,7 +73,8 @@ public IToolPackage Install(FilePath manifestFile, PackageId packageId)
                         packageId,
                         verbosity: _verbosity,
                         versionRange,
-                        TargetFrameworkToInstall
+                        TargetFrameworkToInstall,
+                        restoreActionConfig: _restoreActionConfig
                         );
 
                 return toolDownloadedPackage;

test/Microsoft.DotNet.Tools.Tests.ComponentMocks/ToolPackageDownloaderMock.cs

@@ -7,6 +7,7 @@
 using System.Linq;
 using System.Text.Json;
 using Microsoft.DotNet.Cli;
+using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.Cli.ToolPackage;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.ToolPackage;
@@ -98,7 +99,8 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
             string targetFramework = null,
             bool isGlobalTool = false,
             bool isGlobalToolRollForward = false,
-            bool verifySignatures = false
+            bool verifySignatures = false,
+            RestoreActionConfig restoreActionConfig = null
             )
         {
             string rollbackDirectory = null;
@@ -311,7 +313,8 @@ public NuGetVersion GetNuGetVersion(
             PackageId packageId,
             VerbosityOptions verbosity,
             VersionRange versionRange = null,
-            bool isGlobalTool = false)
+            bool isGlobalTool = false,
+            RestoreActionConfig restoreActionConfig = null)
         {
             versionRange = VersionRange.Parse(versionRange?.OriginalString ?? "*");
 

test/dotnet.Tests/CommandTests/ToolInstallGlobalOrToolPathCommandTests.cs

@@ -77,6 +77,30 @@ public ToolInstallGlobalOrToolPathCommandTests(ITestOutputHelper log): base(log)
             _parseResult = Parser.Instance.Parse($"dotnet tool install -g {PackageId}");
         }
 
+        [Fact]
+        public void WhenPassingRestoreActionConfigOptions()
+        {
+            var parseResult = Parser.Instance.Parse($"dotnet tool install -g {PackageId} --ignore-failed-sources");
+            var toolInstallCommand = new ToolInstallGlobalOrToolPathCommand(parseResult);
+            toolInstallCommand.restoreActionConfig.IgnoreFailedSources.Should().BeTrue();
+        }
+
+        [Fact]
+        public void WhenPassingIgnoreFailedSourcesItShouldNotThrow()
+        {
+            _fileSystem.File.WriteAllText(Path.Combine(_temporaryDirectory, "nuget.config"), _nugetConfigWithInvalidSources);
+
+            var toolInstallGlobalOrToolPathCommand = new ToolInstallGlobalOrToolPathCommand(
+                Parser.Instance.Parse($"dotnet tool install -g {PackageId} --ignore-failed-sources"),
+                _packageId,
+                _createToolPackageStoreDownloaderUninstaller,
+                _createShellShimRepository,
+                new EnvironmentPathInstructionMock(_reporter, _pathToPlaceShim, true),
+                _reporter);
+
+            toolInstallGlobalOrToolPathCommand.Execute().Should().Be(0);
+            _fileSystem.File.Delete(Path.Combine(_temporaryDirectory, "nuget.config"));
+        }
         [Fact]
         public void WhenRunWithPackageIdItShouldCreateValidShim()
         {
@@ -967,6 +991,16 @@ public void SetPermission(string path, string chmodArgument)
             {
             }
         }
+
+        private string _nugetConfigWithInvalidSources = @"{
+<?xml version=""1.0"" encoding=""utf-8""?>
+<configuration>
+  <packageSources>
+    <add key=""nuget"" value=""https://api.nuget.org/v3/index.json"" />
+    <add key=""invalid_source"" value=""https://api.nuget.org/v3/invalid.json"" />
+  </packageSources>
+</configuration>
+}";
     }
 }
 

test/dotnet.Tests/CommandTests/ToolInstallLocalCommandTests.cs

@@ -89,6 +89,31 @@ public ToolInstallLocalCommandTests(ITestOutputHelper log) : base(log)
                     new DirectoryPath(Path.Combine(_temporaryDirectory, "cache")),
                     1);
         }
+        [Fact]
+        public void WhenPassingRestoreActionConfigOptions()
+        {
+            var parseResult = Parser.Instance.Parse($"dotnet tool install {_packageIdA.ToString()} --ignore-failed-sources");
+            var toolInstallCommand = new ToolInstallLocalCommand(parseResult);
+            toolInstallCommand.restoreActionConfig.IgnoreFailedSources.Should().BeTrue();
+        }
+
+        [Fact]
+        public void WhenPassingIgnoreFailedSourcesItShouldNotThrow()
+        {
+            _fileSystem.File.WriteAllText(Path.Combine(_temporaryDirectory, "nuget.config"), _nugetConfigWithInvalidSources);
+            var parseResult = Parser.Instance.Parse($"dotnet tool install {_packageIdA.ToString()} --ignore-failed-sources");
+            var toolInstallCommand = new ToolInstallLocalCommand(parseResult,
+                _packageIdA,
+                _toolPackageDownloaderMock,
+                _toolManifestFinder,
+                _toolManifestEditor,
+                _localToolsResolverCache,
+                _reporter);
+
+            toolInstallCommand.Execute().Should().Be(0);
+
+            _fileSystem.File.Delete(Path.Combine(_temporaryDirectory, "nuget.config"));
+        }
 
         [Fact]
         public void WhenRunWithPackageIdItShouldSaveToCacheAndAddToManifestFile()
@@ -485,6 +510,16 @@ out RestoredCommand restoredCommand
    ""isRoot"":true,
    ""tools"":{
    }
+}";
+
+        private string _nugetConfigWithInvalidSources = @"{
+<?xml version=""1.0"" encoding=""utf-8""?>
+<configuration>
+  <packageSources>
+    <add key=""nuget"" value=""https://api.nuget.org/v3/index.json"" />
+    <add key=""invalid_source"" value=""https://api.nuget.org/v3/invalid.json"" />
+  </packageSources>
+</configuration>
 }";
     }
 }