Added an option to disable download progress bars.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/CommonCommandSettings.cs

@@ -120,6 +120,10 @@ protected set
         [CommandOption( "--timeout" )]
         public double? Timeout { get; set; }
 
+        [Description( "Does not show the progress bar for downloads." )]
+        [CommandOption( "--no-progress" )]
+        public bool NoProgress { get; set; }
+
         public ImmutableDictionary<string, string> Properties { get; protected set; } =
             ImmutableDictionary.Create<string, string>( StringComparer.OrdinalIgnoreCase );
 

src/PostSharp.Engineering.BuildTools/Dependencies/DependenciesHelper.cs

@@ -528,7 +528,7 @@ private static bool DownloadBuild(
             Directory.CreateDirectory( restoreDirectory );
             context.Console.WriteMessage( $"Downloading {dependencyName} build #{buildNumber} of {ciBuildTypeId}" );
 
-            if ( !teamCity.TryDownloadArtifacts( context.Console, ciBuildTypeId, buildNumber, artifactsPath, restoreDirectory ) )
+            if ( !teamCity.TryDownloadArtifacts( context.Console, ciBuildTypeId, buildNumber, artifactsPath, restoreDirectory, !context.Settings.NoProgress ) )
             {
                 return false;
             }

src/PostSharp.Engineering.BuildTools/Tools/TeamCity/TeamCityClient.cs

@@ -128,7 +128,13 @@ public bool TryGetBranchFromBuildNumber( ConsoleHelper console, CiBuildId buildI
             }
         }
 
-        public bool TryDownloadArtifacts( ConsoleHelper console, string buildTypeId, int buildNumber, string artifactsPath, string restoreDirectory )
+        public bool TryDownloadArtifacts(
+            ConsoleHelper console,
+            string buildTypeId,
+            int buildNumber,
+            string artifactsPath,
+            string restoreDirectory,
+            bool showProgress )
         {
             IEnumerable<DownloadedFile> GetFiles( string urlOrPath, string targetDirectory )
             {
@@ -182,7 +188,7 @@ IEnumerable<DownloadedFile> GetFiles( string urlOrPath, string targetDirectory )
 
             var files = GetFiles( basePath, baseTargetDirectory );
 
-            var success = FileDownloader.DownloadAsync( files, this._httpClient, console )
+            var success = FileDownloader.DownloadAsync( files, this._httpClient, console, showProgress )
                 .GetAwaiter()
                 .GetResult();
 

src/PostSharp.Engineering.BuildTools/Utilities/FileDownloader.cs

@@ -16,35 +16,42 @@ internal class FileDownloader : IDisposable
     private readonly SemaphoreSlim _throttler = new( 4, 4 );
     private readonly IEnumerable<DownloadedFile> _files;
     private readonly HttpClient _httpClient;
-    private readonly ProgressContext _progressContext;
+    private readonly ProgressContext? _progressContext;
     private readonly ConsoleHelper _console;
     private readonly StringTrimmer _descriptionTrimmer;
     private readonly CancellationToken _cancellationToken;
 
     private bool _used;
 
-    public static Task<bool> DownloadAsync( IEnumerable<DownloadedFile> files, HttpClient httpClient, ConsoleHelper console )
+    public static Task<bool> DownloadAsync( IEnumerable<DownloadedFile> files, HttpClient httpClient, ConsoleHelper console, bool showProgress )
     {
         var cancellationToken = ConsoleHelper.CancellationToken;
 
-        return Task.Run(
-            () => AnsiConsole.Progress()
-                .Columns(
-                    new TaskDescriptionColumn(),
-                    new ProgressBarColumn(),
-                    new DownloadedColumn(),
-                    new TransferSpeedColumn(),
-                    new RemainingTimeColumn(),
-                    new ElapsedTimeColumn(),
-                    new SpinnerColumn() )
-                .StartAsync( ctx => new FileDownloader( files, httpClient, ctx, console, cancellationToken ).DownloadAsync() ),
-            cancellationToken );
+        if ( showProgress )
+        {
+            return Task.Run(
+                () => AnsiConsole.Progress()
+                    .Columns(
+                        new TaskDescriptionColumn(),
+                        new ProgressBarColumn(),
+                        new DownloadedColumn(),
+                        new TransferSpeedColumn(),
+                        new RemainingTimeColumn(),
+                        new ElapsedTimeColumn(),
+                        new SpinnerColumn() )
+                    .StartAsync( ctx => new FileDownloader( files, httpClient, ctx, console, cancellationToken ).DownloadAsync() ),
+                cancellationToken );
+        }
+        else
+        {
+            return new FileDownloader( files, httpClient, null, console, cancellationToken ).DownloadAsync();
+        }
     }
 
     private FileDownloader(
         IEnumerable<DownloadedFile> files,
         HttpClient httpClient,
-        ProgressContext progressContext,
+        ProgressContext? progressContext,
         ConsoleHelper console,
         CancellationToken cancellationToken )
     {
@@ -57,7 +64,7 @@ private FileDownloader(
     }
 
     private async Task<(bool Result, DownloadedFile File, Exception? Exception)> DownloadFileAsync(
-        ProgressTask progress,
+        ProgressTask? progress,
         DownloadedFile file )
     {
         var attempt = 0;
@@ -70,13 +77,13 @@ private FileDownloader(
                 {
                     if ( attempt > 0 )
                     {
-                        ((IProgress<double>) progress).Report( 0 );
+                        ((IProgress<double>?) progress)?.Report( 0 );
 
                         var delay = Math.Pow( 2, attempt );
 
                         for ( var i = delay; i > 0; i-- )
                         {
-                            progress.Description( this._descriptionTrimmer.Trim( $"{file.Description} failed, retrying in {i} seconds" ) );
+                            progress?.Description( this._descriptionTrimmer.Trim( $"{file.Description} failed, retrying in {i} seconds" ) );
 
                             await Task.Delay( TimeSpan.FromSeconds( 1 ), this._cancellationToken );
                         }
@@ -86,7 +93,7 @@ private FileDownloader(
 
                     if ( attempt == 0 )
                     {
-                        progress.StartTask();
+                        progress?.StartTask();
                     }
 
                     var response = await this._httpClient.GetAsync( file.SourceUrl, HttpCompletionOption.ResponseHeadersRead, this._cancellationToken );
@@ -110,7 +117,7 @@ private FileDownloader(
                     while ( (bytesRead = await httpStream.ReadAsync( buffer, 0, buffer.Length, this._cancellationToken )) != 0 )
                     {
                         await fileStream.WriteAsync( buffer, 0, bytesRead, this._cancellationToken );
-                        progress.Increment( bytesRead );
+                        progress?.Increment( bytesRead );
                     }
 
                     return (true, file, null);
@@ -124,7 +131,7 @@ private FileDownloader(
                         continue;
                     }
 
-                    progress.Description( this._descriptionTrimmer.Trim( $"{file.Description} failed: {e.Message}" ) );
+                    progress?.Description( this._descriptionTrimmer.Trim( $"{file.Description} failed: {e.Message}" ) );
 
                     return (false, file, e);
                 }
@@ -153,7 +160,7 @@ private async Task<bool> DownloadAsync()
 
         foreach ( var file in this._files )
         {
-            var progress = this._progressContext.AddTask( this._descriptionTrimmer.Trim( file.Description ), false, file.Length );
+            var progress = this._progressContext?.AddTask( this._descriptionTrimmer.Trim( file.Description ), false, file.Length );
             var task = this.DownloadFileAsync( progress, file );
 
             pendingDownloads.Add( task );