NET tool roll forward error experience

src/Cli/dotnet/CommonLocalizableStrings.resx

@@ -735,5 +735,23 @@ The default is 'false.' However, when targeting .NET 7 or lower, the default is
   </data>
   <data name="ToolSettingsNotFound" xml:space="preserve">
     <value>Tool settings file does not exist for the tool {0}.</value>
+   </data>
+  <data name="ToolPackageRuntimeConfigIncompatible" xml:space="preserve">
+    <value>Installation failed.
+
+This app wasn't installed because it requires .NET {1} to run, which is not installed. This can be resolved by one of the following:
+
+1. Install .NET {1} with the following link
+
+https://aka.ms/dotnet/download/sdk 
+
+2. Install with the `--allow-roll-forward` flag, using with the following command.
+
+dotnet tool install {0}{2} --allow-roll-forward
+
+3. Install with `--force` and manually configure the tool to run, using with the following command.
+
+dotnet tool install {0}{2} --force 
+</value>
   </data>
-</root>
+</root>

src/Cli/dotnet/NugetPackageDownloader/NuGetPackageDownloader.cs

@@ -12,6 +12,7 @@
 using NuGet.Protocol;
 using NuGet.Protocol.Core.Types;
 using NuGet.Versioning;
+using Microsoft.DotNet.Cli;
 
 namespace Microsoft.DotNet.Cli.NuGetPackageDownloader
 {
@@ -132,17 +133,11 @@ public async Task<string> DownloadPackageAsync(PackageId packageId,
             return nupkgPath;
         }
 
-        private bool verbosityGreaterThanMinimal()
-        {
-            return _verbosityOptions != VerbosityOptions.quiet && _verbosityOptions != VerbosityOptions.q
-                && _verbosityOptions != VerbosityOptions.minimal && _verbosityOptions != VerbosityOptions.m;
-        }
-
         private void VerifySigning(string nupkgPath)
         {
             if (!_verifySignatures && !_validationMessagesDisplayed)
             {
-                if (verbosityGreaterThanMinimal())
+                if (!(_verbosityOptions.IsQuiet() || _verbosityOptions.IsMinimal()))
                 {
                     _reporter.WriteLine(LocalizableStrings.NuGetPackageSignatureVerificationSkipped);
                 }

src/Cli/dotnet/ToolPackage/IToolPackageDownloader.cs

@@ -1,7 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Threading.Tasks;
 using Microsoft.DotNet.ToolPackage;
 using NuGet.Versioning;
 
@@ -15,7 +14,8 @@ IToolPackage InstallPackage(PackageLocation packageLocation,
             VersionRange versionRange = null,
             string targetFramework = null,
             bool isGlobalTool = false,
-            bool isGlobalToolRollForward = false
+            bool isGlobalToolRollForward = false,
+            bool forceInstall = false
         );
 
         NuGetVersion GetNuGetVersion(

src/Cli/dotnet/ToolPackage/ToolPackageDownloader.cs

@@ -1,14 +1,7 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.CommandLine;
 using System.Reflection;
-using System.Runtime.InteropServices;
-using System.Threading.Tasks;
 using Microsoft.DotNet.Cli.NuGetPackageDownloader;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.ToolPackage;
@@ -27,10 +20,9 @@
 using NuGet.Versioning;
 using NuGet.Configuration;
 using Microsoft.TemplateEngine.Utils;
-using System.Text.Json;
-using System.Xml;
-using System.Text.Json.Nodes;
 using Newtonsoft.Json.Linq;
+using System.Text.Json;
+using static Microsoft.DotNet.NativeWrapper.NETCoreSdkResolverNativeWrapper;
 
 namespace Microsoft.DotNet.Cli.ToolPackage
 {
@@ -77,7 +69,8 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
             VersionRange versionRange = null,
             string targetFramework = null,
             bool isGlobalTool = false,
-            bool isGlobalToolRollForward = false
+            bool isGlobalToolRollForward = false,
+            bool forceInstall = false
             )
         {
             var packageRootDirectory = _toolPackageStore.GetRootPackageDirectory(packageId);
@@ -111,7 +104,7 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
                     }
                     NuGetVersion packageVersion = nugetPackageDownloader.GetBestPackageVersionAsync(packageId, versionRange, packageSourceLocation).GetAwaiter().GetResult();
 
-                    rollbackDirectory = isGlobalTool ? toolDownloadDir.Value: Path.Combine(toolDownloadDir.Value, packageId.ToString(), packageVersion.ToString());
+                    rollbackDirectory = isGlobalTool ? toolDownloadDir.Value : Path.Combine(toolDownloadDir.Value, packageId.ToString(), packageVersion.ToString());
 
                     if (isGlobalTool)
                     {
@@ -134,17 +127,17 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
                     {
                         DownloadAndExtractPackage(packageId, nugetPackageDownloader, toolDownloadDir.Value, packageVersion, packageSourceLocation, includeUnlisted: givenSpecificVersion).GetAwaiter().GetResult();
                     }
-                    else if(isGlobalTool)
+                    else if (isGlobalTool)
                     {
                         throw new ToolPackageException(
                             string.Format(
                                 CommonLocalizableStrings.ToolPackageConflictPackageId,
                                 packageId,
                                 packageVersion.ToNormalizedString()));
                     }
-                                       
+
                     CreateAssetFile(packageId, packageVersion, toolDownloadDir, assetFileDirectory, _runtimeJsonPath, targetFramework);
-                    
+
                     DirectoryPath toolReturnPackageDirectory;
                     DirectoryPath toolReturnJsonParentDirectory;
 
@@ -168,12 +161,17 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
                                     packageDirectory: toolReturnPackageDirectory,
                                     assetsJsonParentDirectory: toolReturnJsonParentDirectory);
 
+                    if (!forceInstall && !isGlobalToolRollForward)
+                    {
+                        CheckIfRequiredRuntimeIsInstalled(toolPackageInstance, packageId, isGlobalTool);
+                    }
+
                     if (isGlobalToolRollForward)
                     {
                         UpdateRuntimeConfig(toolPackageInstance);
                     }
 
-                    return toolPackageInstance;
+                    return toolPackageInstance;   
                 },
                 rollback: () =>
                 {
@@ -190,6 +188,44 @@ public IToolPackage InstallPackage(PackageLocation packageLocation, PackageId pa
                 });
         }
 
+        private static void CheckIfRequiredRuntimeIsInstalled(
+            ToolPackageInstance toolPackageInstance,
+            PackageId packageId,
+            bool isGlobalTool
+            )
+        {
+            var executableFilePath = toolPackageInstance.Commands[0].Executable;
+            var runtimeConfigFilePath = Path.ChangeExtension(executableFilePath.ToString(), ".runtimeconfig.json");
+
+            // Check if the runtimeconfig.json file is compatible with the current runtime
+            if (File.Exists(runtimeConfigFilePath))
+            {
+                string tfmValue = "";
+                JsonElement rootElement = JsonDocument.Parse(File.ReadAllText(runtimeConfigFilePath)).RootElement;
+
+                if (rootElement.TryGetProperty("runtimeOptions", out JsonElement runtimeOptionsElement) &&
+                    runtimeOptionsElement.TryGetProperty("tfm", out JsonElement tfmElement))
+                {
+                    tfmValue = new string(tfmElement.GetString().Where(c => char.IsDigit(c) || c == '.').ToArray());
+                }
+                var result = InitializeForRuntimeConfig(runtimeConfigFilePath);
+
+                // Error if tool is incompatible
+                var global = isGlobalTool ? " -g" : "";
+                switch (result)
+                {
+                    case InitializationRuntimeConfigResult.Success:
+                        break;
+
+                    default:
+                        throw new GracefulException(
+                                string.Format(
+                                CommonLocalizableStrings.ToolPackageRuntimeConfigIncompatible,
+                                packageId, tfmValue, global));
+                }
+            }
+        }
+
         // The following methods are copied from the LockFileUtils class in Nuget.Client
         private static void AddToolsAssets(
             ManagedCodeConventions managedCodeConventions,

src/Cli/dotnet/commands/dotnet-tool/install/LocalizableStrings.resx

@@ -247,4 +247,7 @@ If you would like to create a manifest, use the `--create-manifest-if-needed` fl
   <data name="AllowPackageDowngradeOptionDescription" xml:space="preserve">
     <value>Allow package downgrade when installing a .NET tool package.</value>
   </data>
+  <data name="ForceInstallOptionName" xml:space="preserve">
+    <value>Forces a tool to be installed even if a compatible .NET runtime is not installed.</value>
+  </data>
 </root>

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

@@ -57,7 +57,12 @@ internal static class ToolInstallCommandParser
         public static readonly CliOption<bool> AllowPackageDowngradeOption = new("--allow-downgrade")
         {
             Description = LocalizableStrings.AllowPackageDowngradeOptionDescription
-        }; 
+        };
+
+        public static readonly CliOption<bool> ForceInstallOption = new("--force")
+        {
+            Description = LocalizableStrings.ForceInstallOptionName
+        };
 
         public static readonly CliOption<VerbosityOptions> VerbosityOption = CommonOptions.VerbosityOption;
 
@@ -98,6 +103,7 @@ private static CliCommand ConstructCommand()
             command.Options.Add(CreateManifestIfNeededOption);
             command.Options.Add(AllowPackageDowngradeOption);
             command.Options.Add(RollForwardOption);
+            command.Options.Add(ForceInstallOption);
 
             command.SetAction((parseResult) => new ToolInstallCommand(parseResult).Execute());
 

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

@@ -48,7 +48,7 @@ internal class ToolInstallGlobalOrToolPathCommand : CommandBase
         private readonly bool _allowRollForward;
         private readonly bool _allowPackageDowngrade;
         private readonly bool _updateAll;
-
+        private readonly bool _forceInstall;
 
         public ToolInstallGlobalOrToolPathCommand(
             ParseResult parseResult,
@@ -95,6 +95,7 @@ public ToolInstallGlobalOrToolPathCommand(
             _createToolPackageStoreDownloaderUninstaller = createToolPackageStoreDownloaderUninstaller ??
                                                   ToolPackageFactory.CreateToolPackageStoresAndDownloaderAndUninstaller;
             _updateAll = parseResult.GetValue(ToolUpdateCommandParser.UpdateAllOption);
+            _forceInstall = parseResult.GetValue(ToolInstallCommandParser.ForceInstallOption);
 
             _reporter = (reporter ?? Reporter.Output);
         }
@@ -190,7 +191,8 @@ private int ExecuteInstallCommand(PackageId packageId)
                         targetFramework: _framework,
                         verbosity: _verbosity,
                         isGlobalTool: true,
-                        isGlobalToolRollForward: _allowRollForward
+                        isGlobalToolRollForward: _allowRollForward,
+                        forceInstall: _forceInstall
                     );
 
                     EnsureVersionIsHigher(oldPackageNullable, newInstalledPackage, _allowPackageDowngrade);

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

@@ -22,6 +22,7 @@ internal class ToolInstallLocalCommand : CommandBase
         private readonly IReporter _reporter;
         private readonly PackageId? _packageId;
         private readonly bool _allowPackageDowngrade;
+         private readonly bool _forceInstall;
 
         private readonly string _explicitManifestFile;
         private readonly bool _createManifestIfNeeded;
@@ -56,6 +57,7 @@ public ToolInstallLocalCommand(
             _toolLocalPackageInstaller = new ToolInstallLocalInstaller(parseResult, toolPackageDownloader, runtimeJsonPathForTests);
             _allowRollForward = parseResult.GetValue(ToolInstallCommandParser.RollForwardOption);
             _allowPackageDowngrade = parseResult.GetValue(ToolInstallCommandParser.AllowPackageDowngradeOption);
+            _forceInstall = parseResult.GetValue(ToolInstallCommandParser.ForceInstallOption);
         }
 
         public override int Execute()
@@ -93,11 +95,11 @@ private int ExecuteInstallCommand(PackageId packageId)
 
             if (!existingPackageWithPackageId.Any())
             {
-                return InstallNewTool(manifestFile, packageId);
+                return InstallNewTool(manifestFile, packageId, _forceInstall);
             }
 
             var existingPackage = existingPackageWithPackageId.Single();
-            var toolDownloadedPackage = _toolLocalPackageInstaller.Install(manifestFile, packageId);
+            var toolDownloadedPackage = _toolLocalPackageInstaller.Install(manifestFile, packageId, _forceInstall);
 
             InstallToolUpdate(existingPackage, toolDownloadedPackage, manifestFile, packageId);
 
@@ -154,10 +156,10 @@ public int InstallToolUpdate(ToolManifestPackage existingPackage, IToolPackage t
             return 0;
         }
 
-        public int InstallNewTool(FilePath manifestFile, PackageId packageId)
+        public int InstallNewTool(FilePath manifestFile, PackageId packageId, bool forceInstall)
         {
             IToolPackage toolDownloadedPackage =
-                _toolLocalPackageInstaller.Install(manifestFile, packageId);
+                _toolLocalPackageInstaller.Install(manifestFile, packageId, forceInstall);
 
             _toolManifestEditor.Add(
                 manifestFile,

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

@@ -42,7 +42,7 @@ public ToolInstallLocalInstaller(
             TargetFrameworkToInstall = BundledTargetFramework.GetTargetFrameworkMoniker();
         }
 
-        public IToolPackage Install(FilePath manifestFile, PackageId packageId)
+        public IToolPackage Install(FilePath manifestFile, PackageId packageId, bool forceInstall)
         {
             if (!string.IsNullOrEmpty(_configFilePath) && !File.Exists(_configFilePath))
             {
@@ -70,7 +70,8 @@ public IToolPackage Install(FilePath manifestFile, PackageId packageId)
                         packageId,
                         verbosity: _verbosity,
                         versionRange,
-                        TargetFrameworkToInstall
+                        TargetFrameworkToInstall,
+                        forceInstall: forceInstall
                         );
 
                 return toolDownloadedPackage;