Add ICliHostEnvironment service and --non-interactive flag for clean CI output (#12135)

* Initial plan

* Add CI environment detection and disable interactive elements in CI

Co-authored-by: davidfowl <[email protected]>

* Refactor CIEnvironmentDetector to use DI with IConfiguration

Co-authored-by: davidfowl <[email protected]>

* Refactor to ICliHostEnvironment with --non-interactive flag support

Co-authored-by: davidfowl <[email protected]>

* Pass nonInteractive flag directly to CliHostEnvironment constructor

Co-authored-by: davidfowl <[email protected]>

* Add InteractionService.IsAvailable check for interactivity configuration

Co-authored-by: davidfowl <[email protected]>

* Fix DI registration for ICliHostEnvironment in tests

Co-authored-by: davidfowl <[email protected]>

* Add InvalidOperationException to Prompt methods when interactive input not supported

Co-authored-by: davidfowl <[email protected]>

* Move CI environment variables array to static readonly field

Co-authored-by: davidfowl <[email protected]>

* Use IConfiguration with using directive instead of fully qualified name

Co-authored-by: davidfowl <[email protected]>

* Add tests for InteractionService.IsAvailable property

Co-authored-by: davidfowl <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: davidfowl <[email protected]>

Author: Copilot

src/Aspire.Cli/Commands/DeployCommand.cs

@@ -16,8 +16,8 @@ internal sealed class DeployCommand : PublishCommandBase
 {
     private readonly Option<bool> _clearCacheOption;
 
-    public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext)
-        : base("deploy", DeployCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext)
+    public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext, ICliHostEnvironment hostEnvironment)
+        : base("deploy", DeployCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext, hostEnvironment)
     {
         _clearCacheOption = new Option<bool>("--clear-cache")
         {

src/Aspire.Cli/Commands/PublishCommand.cs

@@ -34,8 +34,8 @@ internal sealed class PublishCommand : PublishCommandBase
 {
     private readonly IPublishCommandPrompter _prompter;
 
-    public PublishCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, IPublishCommandPrompter prompter, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext)
-        : base("publish", PublishCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext)
+    public PublishCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, IPublishCommandPrompter prompter, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext, ICliHostEnvironment hostEnvironment)
+        : base("publish", PublishCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext, hostEnvironment)
     {
         ArgumentNullException.ThrowIfNull(prompter);
         _prompter = prompter;

src/Aspire.Cli/Commands/PublishCommandBase.cs

@@ -27,6 +27,7 @@ internal abstract class PublishCommandBase : BaseCommand
     protected readonly IDotNetSdkInstaller _sdkInstaller;
 
     private readonly IFeatures _features;
+    private readonly ICliHostEnvironment _hostEnvironment;
 
     protected abstract string OperationCompletedPrefix { get; }
     protected abstract string OperationFailedPrefix { get; }
@@ -40,20 +41,22 @@ private static bool IsCompletionStateError(string completionState) =>
     private static bool IsCompletionStateWarning(string completionState) =>
         completionState == CompletionStates.CompletedWithWarning;
 
-    protected PublishCommandBase(string name, string description, IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext)
+    protected PublishCommandBase(string name, string description, IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext, ICliHostEnvironment hostEnvironment)
         : base(name, description, features, updateNotifier, executionContext, interactionService)
     {
         ArgumentNullException.ThrowIfNull(runner);
         ArgumentNullException.ThrowIfNull(projectLocator);
         ArgumentNullException.ThrowIfNull(telemetry);
         ArgumentNullException.ThrowIfNull(sdkInstaller);
         ArgumentNullException.ThrowIfNull(features);
+        ArgumentNullException.ThrowIfNull(hostEnvironment);
 
         _runner = runner;
         _projectLocator = projectLocator;
         _telemetry = telemetry;
         _sdkInstaller = sdkInstaller;
         _features = features;
+        _hostEnvironment = hostEnvironment;
 
         var projectOption = new Option<FileInfo?>("--project")
         {
@@ -122,6 +125,12 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
 
             var env = new Dictionary<string, string>();
 
+            // Set interactivity enabled based on host environment capabilities
+            if (!_hostEnvironment.SupportsInteractiveInput)
+            {
+                env[KnownConfigNames.InteractivityEnabled] = "false";
+            }
+
             var waitForDebugger = parseResult.GetValue<bool?>("--wait-for-debugger") ?? false;
             if (waitForDebugger)
             {
@@ -345,7 +354,7 @@ public async Task<bool> ProcessAndDisplayPublishingActivitiesAsync(IAsyncEnumera
     {
         var stepCounter = 1;
         var steps = new Dictionary<string, StepInfo>();
-        var logger = new ConsoleActivityLogger();
+        var logger = new ConsoleActivityLogger(_hostEnvironment);
         logger.StartSpinner();
         PublishingActivity? publishingActivity = null;
 
@@ -731,16 +740,26 @@ private class TaskInfo
     /// <summary>
     /// Starts the terminal infinite progress bar.
     /// </summary>
-    private static void StartTerminalProgressBar()
+    private void StartTerminalProgressBar()
     {
+        // Skip terminal progress bar in non-interactive environments
+        if (!_hostEnvironment.SupportsInteractiveOutput)
+        {
+            return;
+        }
         Console.Write("\u001b]9;4;3\u001b\\");
     }
 
     /// <summary>
     /// Stops the terminal progress bar.
     /// </summary>
-    private static void StopTerminalProgressBar()
+    private void StopTerminalProgressBar()
     {
+        // Skip terminal progress bar in non-interactive environments
+        if (!_hostEnvironment.SupportsInteractiveOutput)
+        {
+            return;
+        }
         Console.Write("\u001b]9;4;0\u001b\\");
     }
 }

src/Aspire.Cli/Commands/RootCommand.cs

@@ -56,6 +56,11 @@ public RootCommand(
         debugOption.Recursive = true;
         Options.Add(debugOption);
 
+        var nonInteractiveOption = new Option<bool>("--non-interactive");
+        nonInteractiveOption.Description = "Run the command in non-interactive mode, disabling all interactive prompts and spinners";
+        nonInteractiveOption.Recursive = true;
+        Options.Add(nonInteractiveOption);
+
         var waitForDebuggerOption = new Option<bool>("--wait-for-debugger");
         waitForDebuggerOption.Description = RootCommandStrings.WaitForDebuggerArgumentDescription;
         waitForDebuggerOption.Recursive = true;

src/Aspire.Cli/Interaction/ConsoleInteractionService.cs

@@ -18,19 +18,22 @@ internal class ConsoleInteractionService : IInteractionService
 
     private readonly IAnsiConsole _ansiConsole;
     private readonly CliExecutionContext _executionContext;
+    private readonly ICliHostEnvironment _hostEnvironment;
 
-    public ConsoleInteractionService(IAnsiConsole ansiConsole, CliExecutionContext executionContext)
+    public ConsoleInteractionService(IAnsiConsole ansiConsole, CliExecutionContext executionContext, ICliHostEnvironment hostEnvironment)
     {
         ArgumentNullException.ThrowIfNull(ansiConsole);
         ArgumentNullException.ThrowIfNull(executionContext);
+        ArgumentNullException.ThrowIfNull(hostEnvironment);
         _ansiConsole = ansiConsole;
         _executionContext = executionContext;
+        _hostEnvironment = hostEnvironment;
     }
 
     public async Task<T> ShowStatusAsync<T>(string statusText, Func<Task<T>> action)
     {
-        // In debug mode, avoid interactive progress as it conflicts with debug logging
-        if (_executionContext.DebugMode)
+        // In debug mode or non-interactive environments, avoid interactive progress as it conflicts with debug logging
+        if (_executionContext.DebugMode || !_hostEnvironment.SupportsInteractiveOutput)
         {
             DisplaySubtleMessage(statusText);
             return await action();
@@ -43,8 +46,8 @@ public async Task<T> ShowStatusAsync<T>(string statusText, Func<Task<T>> action)
 
     public void ShowStatus(string statusText, Action action)
     {
-        // In debug mode, avoid interactive progress as it conflicts with debug logging
-        if (_executionContext.DebugMode)
+        // In debug mode or non-interactive environments, avoid interactive progress as it conflicts with debug logging
+        if (_executionContext.DebugMode || !_hostEnvironment.SupportsInteractiveOutput)
         {
             DisplaySubtleMessage(statusText);
             action();
@@ -59,6 +62,12 @@ public void ShowStatus(string statusText, Action action)
     public async Task<string> PromptForStringAsync(string promptText, string? defaultValue = null, Func<string, ValidationResult>? validator = null, bool isSecret = false, bool required = false, CancellationToken cancellationToken = default)
     {
         ArgumentNullException.ThrowIfNull(promptText, nameof(promptText));
+
+        if (!_hostEnvironment.SupportsInteractiveInput)
+        {
+            throw new InvalidOperationException(InteractionServiceStrings.InteractiveInputNotSupported);
+        }
+
         var prompt = new TextPrompt<string>(promptText)
         {
             IsSecret = isSecret,
@@ -86,6 +95,11 @@ public async Task<T> PromptForSelectionAsync<T>(string promptText, IEnumerable<T
         ArgumentNullException.ThrowIfNull(choices, nameof(choices));
         ArgumentNullException.ThrowIfNull(choiceFormatter, nameof(choiceFormatter));
 
+        if (!_hostEnvironment.SupportsInteractiveInput)
+        {
+            throw new InvalidOperationException(InteractionServiceStrings.InteractiveInputNotSupported);
+        }
+
         // Check if the choices collection is empty to avoid throwing an InvalidOperationException
         if (!choices.Any())
         {
@@ -108,6 +122,11 @@ public async Task<IReadOnlyList<T>> PromptForSelectionsAsync<T>(string promptTex
         ArgumentNullException.ThrowIfNull(choices, nameof(choices));
         ArgumentNullException.ThrowIfNull(choiceFormatter, nameof(choiceFormatter));
 
+        if (!_hostEnvironment.SupportsInteractiveInput)
+        {
+            throw new InvalidOperationException(InteractionServiceStrings.InteractiveInputNotSupported);
+        }
+
         // Check if the choices collection is empty to avoid throwing an InvalidOperationException
         if (!choices.Any())
         {
@@ -203,6 +222,11 @@ public void DisplayCancellationMessage()
 
     public Task<bool> ConfirmAsync(string promptText, bool defaultValue = true, CancellationToken cancellationToken = default)
     {
+        if (!_hostEnvironment.SupportsInteractiveInput)
+        {
+            throw new InvalidOperationException(InteractionServiceStrings.InteractiveInputNotSupported);
+        }
+
         return _ansiConsole.ConfirmAsync(promptText, defaultValue, cancellationToken);
     }
 

src/Aspire.Cli/Program.cs

@@ -54,6 +54,9 @@ private static string GetGlobalSettingsPath()
 
     private static async Task<IHost> BuildApplicationAsync(string[] args)
     {
+        // Check for --non-interactive flag early
+        var nonInteractive = args?.Any(a => a == "--non-interactive") ?? false;
+
         var settings = new HostApplicationBuilderSettings
         {
             Configuration = new ConfigurationManager()
@@ -109,6 +112,11 @@ private static async Task<IHost> BuildApplicationAsync(string[] args)
         // Shared services.
         builder.Services.AddSingleton(_ => BuildCliExecutionContext(debugMode));
         builder.Services.AddSingleton(BuildAnsiConsole);
+        builder.Services.AddSingleton<ICliHostEnvironment>(provider =>
+        {
+            var configuration = provider.GetRequiredService<IConfiguration>();
+            return new CliHostEnvironment(configuration, nonInteractive);
+        });
         AddInteractionServices(builder);
         builder.Services.AddSingleton<IProjectLocator, ProjectLocator>();
         builder.Services.AddSingleton<ISolutionLocator, SolutionLocator>();
@@ -262,7 +270,8 @@ private static void AddInteractionServices(HostApplicationBuilder builder)
                 var ansiConsole = provider.GetRequiredService<IAnsiConsole>();
                 ansiConsole.Profile.Width = 256; // VS code terminal will handle wrapping so set a large width here.
                 var executionContext = provider.GetRequiredService<CliExecutionContext>();
-                var consoleInteractionService = new ConsoleInteractionService(ansiConsole, executionContext);
+                var hostEnvironment = provider.GetRequiredService<ICliHostEnvironment>();
+                var consoleInteractionService = new ConsoleInteractionService(ansiConsole, executionContext, hostEnvironment);
                 return new ExtensionInteractionService(consoleInteractionService,
                     provider.GetRequiredService<IExtensionBackchannel>(),
                     extensionPromptEnabled);
@@ -279,7 +288,8 @@ private static void AddInteractionServices(HostApplicationBuilder builder)
             {
                 var ansiConsole = provider.GetRequiredService<IAnsiConsole>();
                 var executionContext = provider.GetRequiredService<CliExecutionContext>();
-                return new ConsoleInteractionService(ansiConsole, executionContext);
+                var hostEnvironment = provider.GetRequiredService<ICliHostEnvironment>();
+                return new ConsoleInteractionService(ansiConsole, executionContext, hostEnvironment);
             });
         }
     }

src/Aspire.Cli/Resources/InteractionServiceStrings.Designer.cs

@@ -214,4 +214,7 @@
   <data name="CustomChoiceLabel" xml:space="preserve">
     <value>Other (specify next)</value>
   </data>
+  <data name="InteractiveInputNotSupported" xml:space="preserve">
+    <value>Interactive input is not supported in this environment. Use the --non-interactive flag or ensure the CLI is running in an interactive terminal.</value>
+  </data>
 </root>