Add quality metrics for dotnetup (#52792)

Author: nagilson

.github/copilot-instructions.md

@@ -34,6 +34,8 @@ dotnetup:
   - `dotnet build d:\sdk\src\Installer\dotnetup\dotnetup.csproj`
   - `dotnet test d:\sdk\test\dotnetup.Tests\dotnetup.Tests.csproj`
 - Do not run `dotnet build` from within the dotnetup directory as restore may fail.
+- When running dotnetup directly (e.g. `dotnet run`), use the repo-local dogfood dotnet instance:
+  - `d:\sdk\.dotnet\dotnet run --project d:\sdk\src\Installer\dotnetup\dotnetup.csproj -- <args>`
 
 Output Considerations:
 - When considering how output should look, solicit advice from baronfel.

Directory.Packages.props

@@ -118,6 +118,11 @@
     <PackageVersion Include="Spectre.Console" Version="0.53.0" />
     <PackageVersion Include="System.CodeDom" Version="$(SystemCodeDomPackageVersion)" />
     <PackageVersion Include="System.CommandLine" Version="$(SystemCommandLineVersion)" />
+
+    <!-- OpenTelemetry packages for dotnetup telemetry -->
+    <PackageVersion Include="Azure.Monitor.OpenTelemetry.Exporter" Version="1.3.0" />
+    <PackageVersion Include="OpenTelemetry" Version="1.9.0" />
+    <PackageVersion Include="OpenTelemetry.Exporter.Console" Version="1.9.0" />
     <PackageVersion Include="System.CommandLine.NamingConventionBinder" Version="$(SystemCommandLineNamingConventionBinderVersion)" />
     <PackageVersion Include="System.ComponentModel.Composition" Version="$(SystemComponentModelCompositionPackageVersion)" />
     <PackageVersion Include="System.Composition.AttributedModel" Version="$(SystemCompositionAttributedModelPackageVersion)" />

src/Installer/Microsoft.Dotnet.Installation/DotnetInstallException.cs

@@ -0,0 +1,110 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Microsoft.Dotnet.Installation;
+
+/// <summary>
+/// Error codes for .NET installation failures.
+/// </summary>
+public enum DotnetInstallErrorCode
+{
+    /// <summary>Unknown error.</summary>
+    Unknown,
+
+    /// <summary>The requested version was not found in the releases index.</summary>
+    VersionNotFound,
+
+    /// <summary>The requested release was not found.</summary>
+    ReleaseNotFound,
+
+    /// <summary>No matching file was found for the platform/architecture.</summary>
+    NoMatchingReleaseFileForPlatform,
+
+    /// <summary>Failed to download the archive.</summary>
+    DownloadFailed,
+
+    /// <summary>Archive hash verification failed.</summary>
+    HashMismatch,
+
+    /// <summary>Failed to extract the archive.</summary>
+    ExtractionFailed,
+
+    /// <summary>The channel or version format is invalid.</summary>
+    InvalidChannel,
+
+    /// <summary>Network connectivity issue.</summary>
+    NetworkError,
+
+    /// <summary>Insufficient permissions.</summary>
+    PermissionDenied,
+
+    /// <summary>Disk space issue.</summary>
+    DiskFull,
+
+    /// <summary>Failed to fetch the releases manifest from Microsoft servers.</summary>
+    ManifestFetchFailed,
+
+    /// <summary>Failed to parse the releases manifest (invalid JSON or schema).</summary>
+    ManifestParseFailed,
+
+    /// <summary>The archive file is corrupted or truncated.</summary>
+    ArchiveCorrupted,
+
+    /// <summary>Another installation process is already running.</summary>
+    InstallationLocked,
+
+    /// <summary>Failed to read/write the dotnetup installation manifest.</summary>
+    LocalManifestError,
+
+    /// <summary>The dotnetup installation manifest is corrupted.</summary>
+    LocalManifestCorrupted,
+}
+
+/// <summary>
+/// Exception thrown when a .NET installation operation fails.
+/// </summary>
+public class DotnetInstallException : Exception
+{
+    /// <summary>
+    /// Gets the error code for this exception.
+    /// </summary>
+    public DotnetInstallErrorCode ErrorCode { get; }
+
+    /// <summary>
+    /// Gets the version that was being installed, if applicable.
+    /// </summary>
+    public string? Version { get; }
+
+    /// <summary>
+    /// Gets the component being installed (SDK, Runtime, etc.).
+    /// </summary>
+    public string? Component { get; }
+
+    public DotnetInstallException(DotnetInstallErrorCode errorCode, string message)
+        : base(message)
+    {
+        ErrorCode = errorCode;
+    }
+
+    public DotnetInstallException(DotnetInstallErrorCode errorCode, string message, Exception innerException)
+        : base(message, innerException)
+    {
+        ErrorCode = errorCode;
+    }
+
+    public DotnetInstallException(DotnetInstallErrorCode errorCode, string message, string? version = null, string? component = null)
+        : base(message)
+    {
+        ErrorCode = errorCode;
+        Version = version;
+        Component = component;
+    }
+
+    public DotnetInstallException(DotnetInstallErrorCode errorCode, string message, Exception innerException, string? version = null, string? component = null)
+        : base(message, innerException)
+    {
+        ErrorCode = errorCode;
+        Version = version;
+        Component = component;
+    }
+}

src/Installer/Microsoft.Dotnet.Installation/IProgressTarget.cs

@@ -1,45 +1,38 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System;
-using System.Collections.Generic;
-using System.Text;
-
 namespace Microsoft.Dotnet.Installation;
 
 public interface IProgressTarget
 {
-    public IProgressReporter CreateProgressReporter();
+    IProgressReporter CreateProgressReporter();
 }
 
 public interface IProgressReporter : IDisposable
 {
-    public IProgressTask AddTask(string description, double maxValue);
+    IProgressTask AddTask(string description, double maxValue);
 }
 
 public interface IProgressTask
 {
     string Description { get; set; }
     double Value { get; set; }
     double MaxValue { get; set; }
-
-
 }
 
 public class NullProgressTarget : IProgressTarget
 {
     public IProgressReporter CreateProgressReporter() => new NullProgressReporter();
-    class NullProgressReporter : IProgressReporter
+
+    private sealed class NullProgressReporter : IProgressReporter
     {
-        public void Dispose()
-        {
-        }
+        public void Dispose() { }
+
         public IProgressTask AddTask(string description, double maxValue)
-        {
-            return new NullProgressTask(description);
-        }
+            => new NullProgressTask(description);
     }
-    class NullProgressTask : IProgressTask
+
+    private sealed class NullProgressTask : IProgressTask
     {
         public NullProgressTask(string description)
         {

src/Installer/Microsoft.Dotnet.Installation/Internal/ChannelVersionResolver.cs

@@ -10,6 +10,37 @@ namespace Microsoft.Dotnet.Installation.Internal;
 
 internal class ChannelVersionResolver
 {
+    /// <summary>
+    /// Channel keyword for the latest stable release.
+    /// </summary>
+    public const string LatestChannel = "latest";
+
+    /// <summary>
+    /// Channel keyword for the latest preview release.
+    /// </summary>
+    public const string PreviewChannel = "preview";
+
+    /// <summary>
+    /// Channel keyword for the latest Long Term Support (LTS) release.
+    /// </summary>
+    public const string LtsChannel = "lts";
+
+    /// <summary>
+    /// Channel keyword for the latest Standard Term Support (STS) release.
+    /// </summary>
+    public const string StsChannel = "sts";
+
+    /// <summary>
+    /// Known channel keywords that are always valid.
+    /// </summary>
+    public static readonly IReadOnlyList<string> KnownChannelKeywords = [LatestChannel, PreviewChannel, LtsChannel, StsChannel];
+
+    /// <summary>
+    /// Maximum reasonable major version number. .NET versions are currently single-digit;
+    /// anything above 99 is clearly invalid input (e.g., typos, random numbers).
+    /// </summary>
+    internal const int MaxReasonableMajorVersion = 99;
+
     private ReleaseManifest _releaseManifest = new();
 
     public ChannelVersionResolver()
@@ -25,7 +56,7 @@ public ChannelVersionResolver(ReleaseManifest releaseManifest)
     public IEnumerable<string> GetSupportedChannels(bool includeFeatureBands = true)
     {
         var productIndex = _releaseManifest.GetReleasesIndex();
-        return ["latest", "preview", "lts", "sts",
+        return [..KnownChannelKeywords,
             ..productIndex
                 .Where(p => p.IsSupported)
                 .OrderByDescending(p => p.LatestReleaseVersion)
@@ -57,6 +88,89 @@ static IEnumerable<string> GetChannelsForProduct(Product product, bool includeFe
         return GetLatestVersionForChannel(installRequest.Channel, installRequest.Component);
     }
 
+    /// <summary>
+    /// Checks if a channel string looks like a valid .NET version/channel format.
+    /// This is a preliminary validation before attempting resolution.
+    /// </summary>
+    /// <param name="channel">The channel string to validate</param>
+    /// <returns>True if the format appears valid, false if clearly invalid</returns>
+    public static bool IsValidChannelFormat(string channel)
+    {
+        if (string.IsNullOrWhiteSpace(channel))
+        {
+            return false;
+        }
+
+        // Known keywords are always valid
+        if (KnownChannelKeywords.Any(k => string.Equals(k, channel, StringComparison.OrdinalIgnoreCase)))
+        {
+            return true;
+        }
+
+        // Check for prerelease suffix (e.g., "10.0.100-preview.1.32640")
+        var dashIndex = channel.IndexOf('-');
+        var hasPrerelease = dashIndex >= 0;
+        var versionPart = hasPrerelease ? channel.Substring(0, dashIndex) : channel;
+
+        // Try to parse as a version-like string
+        var parts = versionPart.Split('.');
+        if (parts.Length == 0 || parts.Length > 4)
+        {
+            return false;
+        }
+
+        // First part must be a valid major version
+        if (!int.TryParse(parts[0], out var major) || major < 0 || major > MaxReasonableMajorVersion)
+        {
+            return false;
+        }
+
+        // If there are more parts, validate them
+        if (parts.Length >= 2)
+        {
+            if (!int.TryParse(parts[1], out var minor) || minor < 0)
+            {
+                return false;
+            }
+        }
+
+        if (parts.Length >= 3)
+        {
+            var patch = parts[2];
+            if (string.IsNullOrEmpty(patch))
+            {
+                return false;
+            }
+
+            // Allow either:
+            //  - a fully specified numeric patch (e.g., "103"), optionally with a prerelease suffix, or
+            //  - a feature band pattern with a numeric prefix and "xx" suffix (e.g., "1xx", "101xx"),
+            //    but NOT with a prerelease suffix (wildcards with prerelease not supported).
+            if (patch.EndsWith("xx", StringComparison.OrdinalIgnoreCase))
+            {
+                if (hasPrerelease)
+                {
+                    return false;
+                }
+
+                var prefix = patch.Substring(0, patch.Length - 2);
+                if (prefix.Length == 0 || !int.TryParse(prefix, out _))
+                {
+                    return false;
+                }
+            }
+            else
+            {
+                if (!int.TryParse(patch, out var numericPatch) || numericPatch < 0)
+                {
+                    return false;
+                }
+            }
+        }
+
+        return true;
+    }
+
     /// <summary>
     /// Parses a version channel string into its components.
     /// </summary>
@@ -97,18 +211,18 @@ static IEnumerable<string> GetChannelsForProduct(Product product, bool includeFe
     /// <returns>Latest fully specified version string, or null if not found</returns>
     public ReleaseVersion? GetLatestVersionForChannel(UpdateChannel channel, InstallComponent component)
     {
-        if (string.Equals(channel.Name, "lts", StringComparison.OrdinalIgnoreCase) || string.Equals(channel.Name, "sts", StringComparison.OrdinalIgnoreCase))
+        if (string.Equals(channel.Name, LtsChannel, StringComparison.OrdinalIgnoreCase) || string.Equals(channel.Name, StsChannel, StringComparison.OrdinalIgnoreCase))
         {
-            var releaseType = string.Equals(channel.Name, "lts", StringComparison.OrdinalIgnoreCase) ? ReleaseType.LTS : ReleaseType.STS;
+            var releaseType = string.Equals(channel.Name, LtsChannel, StringComparison.OrdinalIgnoreCase) ? ReleaseType.LTS : ReleaseType.STS;
             var productIndex = _releaseManifest.GetReleasesIndex();
             return GetLatestVersionByReleaseType(productIndex, releaseType, component);
         }
-        else if (string.Equals(channel.Name, "preview", StringComparison.OrdinalIgnoreCase))
+        else if (string.Equals(channel.Name, PreviewChannel, StringComparison.OrdinalIgnoreCase))
         {
             var productIndex = _releaseManifest.GetReleasesIndex();
             return GetLatestPreviewVersion(productIndex, component);
         }
-        else if (string.Equals(channel.Name, "latest", StringComparison.OrdinalIgnoreCase))
+        else if (string.Equals(channel.Name, LatestChannel, StringComparison.OrdinalIgnoreCase))
         {
             var productIndex = _releaseManifest.GetReleasesIndex();
             return GetLatestActiveVersion(productIndex, component);