Ensure devtunnels CLI is at least minimum required version (#11439)

* Ensure devtunnel CLI min version

Fixes #11342

* Added a test for min version logic

Author: DamianEdwards

src/Aspire.Hosting.DevTunnels/DevTunnelCli.cs

@@ -16,6 +16,8 @@ internal sealed class DevTunnelCli
     public const int ResourceConflictsWithExistingExitCode = 1;
     public const int ResourceNotFoundExitCode = 2;
 
+    public static readonly Version MinimumSupportedVersion = new(1, 0, 1435);
+
     private readonly string _cliPath;
 
     public static string GetCliPath(IConfiguration configuration) => configuration["ASPIRE_DEVTUNNEL_CLI_PATH"] ?? "devtunnel";
@@ -30,6 +32,9 @@ public DevTunnelCli(string filePath)
         _cliPath = filePath;
     }
 
+    public Task<int> GetVersionAsync(TextWriter? outputWriter = null, TextWriter? errorWriter = null, ILogger? logger = default, CancellationToken cancellationToken = default)
+        => RunAsync(["--version", "--nologo"], outputWriter, errorWriter, logger, cancellationToken);
+
     public Task<int> UserLoginMicrosoftAsync(ILogger? logger = default, CancellationToken cancellationToken = default)
         => RunAsync(["user", "login", "--entra", "--json", "--nologo"], null, null, useShellExecute: true, logger, cancellationToken);
 

src/Aspire.Hosting.DevTunnels/DevTunnelCliClient.cs

@@ -15,6 +15,40 @@ internal sealed class DevTunnelCliClient(IConfiguration configuration) : IDevTun
     private readonly JsonSerializerOptions _jsonOptions = new(JsonSerializerDefaults.Web) { Converters = { new JsonStringEnumConverter() } };
     private readonly DevTunnelCli _cli = new(DevTunnelCli.GetCliPath(configuration));
 
+    public async Task<Version> GetVersionAsync(ILogger? logger = default, CancellationToken cancellationToken = default)
+    {
+        using var outputWriter = new StringWriter();
+        using var errorWriter = new StringWriter();
+
+        var exitCode = await _cli.GetVersionAsync(outputWriter, errorWriter, logger, cancellationToken).ConfigureAwait(false);
+        var output = outputWriter.ToString().Trim();
+
+        if (exitCode == 0)
+        {
+            // Find the line with the version number. It will look like "Tunnel CLI version: 1.0.1435+d49a94cc24"
+            var prefix = "Tunnel CLI version:";
+            var versionLine = output.Split(['\r', '\n'], StringSplitOptions.RemoveEmptyEntries)
+                .FirstOrDefault(l => l.StartsWith(prefix, StringComparison.OrdinalIgnoreCase));
+            var versionString = versionLine?.Length > prefix.Length
+                ? versionLine[prefix.Length..].Trim()
+                : output;
+
+            // Trim the commit SHA suffix if present
+            if (versionString.IndexOf('+') is >= 0 and var plusIndex)
+            {
+                versionString = versionString[..plusIndex];
+            }
+
+            if (Version.TryParse(versionString, out var version))
+            {
+                return version;
+            }
+        }
+
+        var error = errorWriter.ToString().Trim();
+        throw new DistributedApplicationException($"Failed to get devtunnel CLI version. Output: '{output}'. Error: '{error}'");
+    }
+
     public async Task<DevTunnelStatus> CreateTunnelAsync(string tunnelId, DevTunnelOptions options, ILogger? logger = default, CancellationToken cancellationToken = default)
     {
         var attempts = 0;

src/Aspire.Hosting.DevTunnels/DevTunnelCliInstallationManager.cs

@@ -8,18 +8,36 @@ namespace Aspire.Hosting.DevTunnels;
 
 internal sealed class DevTunnelCliInstallationManager : RequiredCommandValidator
 {
+    private readonly IDevTunnelClient _devTunnelClient;
     private readonly IConfiguration _configuration;
+    private readonly ILogger _logger;
+    private readonly Version _minSupportedVersion;
     private string? _resolvedCommandPath;
 
 #pragma warning disable ASPIREINTERACTION001 // Interaction service is experimental.
     public DevTunnelCliInstallationManager(
+        IDevTunnelClient devTunnelClient,
         IConfiguration configuration,
         IInteractionService interactionService,
         ILogger<DevTunnelCliInstallationManager> logger)
+        : this(devTunnelClient, configuration, interactionService, logger, DevTunnelCli.MinimumSupportedVersion)
+    {
+
+    }
+
+    public DevTunnelCliInstallationManager(
+        IDevTunnelClient devTunnelClient,
+        IConfiguration configuration,
+        IInteractionService interactionService,
+        ILogger<DevTunnelCliInstallationManager> logger,
+        Version minSupportedVersion)
         : base(interactionService, logger)
 #pragma warning restore ASPIREINTERACTION001
     {
+        _devTunnelClient = devTunnelClient ?? throw new ArgumentNullException(nameof(devTunnelClient));
         _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
+        _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+        _minSupportedVersion = minSupportedVersion ?? throw new ArgumentNullException(nameof(minSupportedVersion));
     }
 
     /// <summary>
@@ -41,6 +59,17 @@ public DevTunnelCliInstallationManager(
 
     protected override string GetCommandPath() => DevTunnelCli.GetCliPath(_configuration);
 
+    protected internal override async Task<(bool IsValid, string? ValidationMessage)> OnResolvedAsync(string resolvedCommandPath, CancellationToken cancellationToken)
+    {
+        // Verify the version is supported
+        var version = await _devTunnelClient.GetVersionAsync(_logger, cancellationToken).ConfigureAwait(false);
+        if (version < _minSupportedVersion)
+        {
+            return (false, $"The installed devtunnel CLI version {version} is not supported. Version {_minSupportedVersion} or higher is required.");
+        }
+        return (true, null);
+    }
+
     protected override Task OnValidatedAsync(string resolvedCommandPath, CancellationToken cancellationToken)
     {
         _resolvedCommandPath = resolvedCommandPath;

src/Aspire.Hosting.DevTunnels/IDevTunnelClient.cs

@@ -7,6 +7,8 @@ namespace Aspire.Hosting.DevTunnels;
 
 internal interface IDevTunnelClient
 {
+    Task<Version> GetVersionAsync(ILogger? logger = default, CancellationToken cancellationToken = default);
+
     Task<UserLoginStatus> GetUserLoginStatusAsync(ILogger? logger = default, CancellationToken cancellationToken = default);
 
     Task<UserLoginStatus> UserLoginAsync(LoginProvider provider, ILogger? logger = default, CancellationToken cancellationToken = default);

src/Aspire.Hosting.DevTunnels/RequiredCommandValidator.cs

@@ -26,12 +26,22 @@ internal abstract class RequiredCommandValidator(IInteractionService interaction
     private readonly ILogger _logger = logger;
 
     private Task? _notificationTask;
+    private string? _notificationMessage;
 
     /// <summary>
     /// Returns the command string (file name or path) that should be validated.
     /// </summary>
     protected abstract string GetCommandPath();
 
+    /// <summary>
+    /// Called after the command has been successfully resolved to a full path.
+    /// Default implementation does nothing.
+    /// </summary>
+    /// <remarks>
+    /// Overrides can perform additional validation to verify the command is usable.
+    /// </remarks>
+    protected internal virtual Task<(bool IsValid, string? ValidationMessage)> OnResolvedAsync(string resolvedCommandPath, CancellationToken cancellationToken) => Task.FromResult((true, (string?)null));
+
     /// <summary>
     /// Called after the command has been successfully validated and resolved to a full path.
     /// Default implementation does nothing.
@@ -49,23 +59,34 @@ protected sealed override async Task ExecuteCoreAsync(CancellationToken cancella
         if (notificationTask is { IsCompleted: false })
         {
             // Failure notification is still being shown so just throw again.
-            throw GetCommandNotFoundException(command);
+            throw new DistributedApplicationException(_notificationMessage ?? $"Required command '{command}' was not found on PATH, at the specified location, or failed validation.");
         }
 
         if (string.IsNullOrWhiteSpace(command))
         {
             throw new InvalidOperationException("Command path cannot be null or empty.");
         }
         var resolved = ResolveCommand(command);
-        if (resolved is null)
+        var isValid = true;
+        string? validationMessage = null;
+        if (resolved is not null)
+        {
+            (isValid, validationMessage) = await OnResolvedAsync(resolved, cancellationToken).ConfigureAwait(false);
+        }
+        if (resolved is null || !isValid)
         {
             var link = GetHelpLink();
-            var message = link is null
-                ? $"Required command '{command}' was not found on PATH or at a specified location."
-                : $"Required command '{command}' was not found. See installation instructions for more details.";
+            var message = (link, validationMessage) switch
+            {
+                (null, not null) => validationMessage,
+                (not null, not null) => $"{validationMessage} See installation instructions for more details.",
+                (not null, null) => $"Required command '{command}' was not found. See installation instructions for more details.",
+                _ => $"Required command '{command}' was not found on PATH or at a specified location."
+            };
 
             _logger.LogWarning("{Message}", message);
 
+            _notificationMessage = message;
             if (_interactionService.IsAvailable == true)
             {
                 try
@@ -91,15 +112,13 @@ protected sealed override async Task ExecuteCoreAsync(CancellationToken cancella
                     _logger.LogDebug(ex, "Failed to show missing command notification");
                 }
             }
-            throw GetCommandNotFoundException(command);
+            throw new DistributedApplicationException(message);
         }
 
+        _notificationMessage = null;
         await OnValidatedAsync(resolved, cancellationToken).ConfigureAwait(false);
     }
 
-    private static DistributedApplicationException GetCommandNotFoundException(string command) =>
-        new($"Required command '{command}' was not found on PATH or at the specified location.");
-
     /// <summary>
     /// Optional link returned to guide users when the command is missing. Return null for no link.
     /// </summary>

tests/Aspire.Hosting.DevTunnels.Tests/DevTunnelCliInstallationManagerTests.cs

@@ -0,0 +1,117 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Logging.Abstractions;
+
+namespace Aspire.Hosting.DevTunnels.Tests;
+
+public class DevTunnelCliInstallationManagerTests
+{
+    [Theory]
+    [InlineData("1.0.1435", "1.0.1435", true)]
+    [InlineData("1.0.1435", "1.0.1436", true)]
+    [InlineData("1.0.1435", "1.1.1234", true)]
+    [InlineData("1.0.1435", "2.0.0", true)]
+    [InlineData("1.0.1435", "10.0.0", true)]
+    [InlineData("1.9.0", "1.10.0", true)]
+    [InlineData("1.0.1435", "1.0.1434", false)]
+    [InlineData("1.0.1435", "1.0.0", false)]
+    [InlineData("1.0.1435", "0.0.1", false)]
+    [InlineData("1.2.0", "1.1.999", false)]
+    public async Task OnResolvedAsync_ReturnsInvalidForUnsupportedVersion(string minVersion, string testVersion, bool expectedIsValid)
+    {
+        var logger = NullLoggerFactory.Instance.CreateLogger<DevTunnelCliInstallationManager>();
+        var configuration = new ConfigurationBuilder().Build();
+        var testCliVersion = Version.Parse(testVersion);
+        var devTunnelClient = new TestDevTunnelClient(testCliVersion);
+
+        var manager = new DevTunnelCliInstallationManager(devTunnelClient, configuration, new TestInteractionService(), logger, Version.Parse(minVersion));
+
+        var (isValid, validationMessage) = await manager.OnResolvedAsync("thepath", CancellationToken.None);
+
+        Assert.Equal(expectedIsValid, isValid);
+        if (expectedIsValid)
+        {
+            Assert.Null(validationMessage);
+        }
+        else
+        {
+            Assert.Contains(minVersion, validationMessage);
+            Assert.Contains(testVersion, validationMessage);
+        }
+    }
+
+#pragma warning disable ASPIREINTERACTION001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+    private sealed class TestInteractionService : IInteractionService
+    {
+        public bool IsAvailable => true;
+
+        public Task<InteractionResult<bool>> PromptConfirmationAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<InteractionResult<InteractionInput>> PromptInputAsync(string title, string? message, string inputLabel, string placeHolder, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<InteractionResult<InteractionInput>> PromptInputAsync(string title, string? message, InteractionInput input, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<InteractionResult<InteractionInputCollection>> PromptInputsAsync(string title, string? message, IReadOnlyList<InteractionInput> inputs, InputsDialogInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<InteractionResult<bool>> PromptMessageBoxAsync(string title, string message, MessageBoxInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<InteractionResult<bool>> PromptNotificationAsync(string title, string message, NotificationInteractionOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+    }
+#pragma warning restore ASPIREINTERACTION001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+
+    private sealed class TestDevTunnelClient(Version cliVersion) : IDevTunnelClient
+    {
+        public Task<Version> GetVersionAsync(ILogger? logger = null, CancellationToken cancellationToken = default) => Task.FromResult(cliVersion);
+
+        public Task<DevTunnelPortStatus> CreatePortAsync(string tunnelId, int portNumber, DevTunnelPortOptions options, ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<DevTunnelStatus> CreateTunnelAsync(string tunnelId, DevTunnelOptions options, ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<DevTunnelAccessStatus> GetAccessAsync(string tunnelId, int? portNumber = null, ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<DevTunnelStatus> GetTunnelAsync(string tunnelId, ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<UserLoginStatus> GetUserLoginStatusAsync(ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+
+        public Task<UserLoginStatus> UserLoginAsync(LoginProvider provider, ILogger? logger = null, CancellationToken cancellationToken = default)
+        {
+            throw new NotImplementedException();
+        }
+    }
+}