Bug fix. Networking workload (NTttcp). Handle OperationCanceledExceptions in ProcessProxy to avoid the need to handle them everywhere else in the code.

Author: brdeyo

.pipelines/azure-pipelines-linux.yml

@@ -16,7 +16,7 @@ resources:
     options: --entrypoint=""
 
 variables:
-  VcVersion : 1.13.12
+  VcVersion : 1.13.13
   ROOT: $(Build.SourcesDirectory)
   CDP_DEFINITION_BUILD_COUNT: $[counter('', 0)] # needed for onebranch.pipeline.version task https://aka.ms/obpipelines/versioning
   ENABLE_PRS_DELAYSIGN: 1

src/VirtualClient/Module.props

@@ -125,9 +125,6 @@
         <!-- SSH.Net -->
         <SSH_Net_PackageVersion>2020.0.2</SSH_Net_PackageVersion>
 
-        <!-- Swashbuckle.AspNetCore -->
-        <Swashbuckle_AspNetCore_PackageVersion>6.1.1</Swashbuckle_AspNetCore_PackageVersion>
-
         <!-- System.CommandLine -->
         <System_CommandLine_PackageVersion>2.0.0-beta1.21308.1</System_CommandLine_PackageVersion>
 

src/VirtualClient/VirtualClient.Common/ProcessProxy.cs

@@ -348,15 +348,22 @@ public virtual IProcessProxy WriteInput(string input)
         /// </summary>
         public virtual async Task WaitForExitAsync(CancellationToken cancellationToken, TimeSpan? timeout = null)
         {
-            if (timeout == null)
+            try
             {
-                await this.UnderlyingProcess.WaitForExitAsync(cancellationToken).ConfigureAwait(false);
-                this.exitTime = DateTime.UtcNow;
+                if (timeout == null)
+                {
+                    await this.UnderlyingProcess.WaitForExitAsync(cancellationToken).ConfigureAwait(false);
+                    this.exitTime = DateTime.UtcNow;
+                }
+                else
+                {
+                    await this.UnderlyingProcess.WaitForExitAsync(cancellationToken).WaitAsync(timeout.Value).ConfigureAwait(false);
+                    this.exitTime = DateTime.UtcNow;
+                }
             }
-            else
+            catch (OperationCanceledException)
             {
-                await this.UnderlyingProcess.WaitForExitAsync(cancellationToken).WaitAsync(timeout.Value).ConfigureAwait(false);
-                this.exitTime = DateTime.UtcNow;
+                // Expected whenever the CancellationToken receives a cancellation request.
             }
         }
 

src/VirtualClient/VirtualClient.Main/ApiManager.cs

@@ -3,7 +3,6 @@
 
 namespace VirtualClient
 {
-    using System;
     using System.Collections.Generic;
     using System.IO.Abstractions;
     using System.Reflection;
@@ -15,8 +14,6 @@ namespace VirtualClient
     using Microsoft.Extensions.Configuration;
     using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.Logging;
-    using Microsoft.OpenApi.Models;
-    using Swashbuckle.AspNetCore.SwaggerUI;
     using VirtualClient.Api;
     using VirtualClient.Common.Extensions;
     using VirtualClient.Contracts;
@@ -63,21 +60,6 @@ private void ConfigureApplication(IWebHostBuilder hostBuilder, IServiceCollectio
         {
             hostBuilder.Configure(apiService =>
             {
-                // Enable middleware to serve generated Swagger as a JSON endpoint.
-                apiService.UseSwagger();
-
-                // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
-                // specifying the Swagger JSON endpoint.
-                apiService.UseSwaggerUI(doc =>
-                {
-                    doc.SwaggerEndpoint("/swagger/v1/swagger.json", "Virtual Client API (v1)");
-
-                    // "Try it Out" only for GET methods.
-                    doc.SupportedSubmitMethods(SubmitMethod.Delete, SubmitMethod.Get, SubmitMethod.Head, SubmitMethod.Post, SubmitMethod.Put);
-                    doc.RoutePrefix = string.Empty;
-                    doc.ConfigObject.DefaultModelRendering = ModelRendering.Example;
-                });
-
                 apiService.UseApiVersioning();
                 apiService.UseMiddleware<ApiExceptionMiddleware>(dependencies.GetService<ILogger>());
                 apiService.UseMvc();
@@ -147,34 +129,6 @@ private void ConfigureServices(IWebHostBuilder hostBuilder, IServiceCollection d
                     options.AssumeDefaultVersionWhenUnspecified = true;
                     options.DefaultApiVersion = new ApiVersion(1, 0);
                 });
-
-                // Add OpenAPI/Swagger definition.
-                // https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio
-                // https://github.com/domaindrivendev/Swashbuckle.AspNetCore
-                // https://idratherbewriting.com/learnapidoc
-                services.AddSwaggerGen(doc =>
-                {
-                    doc.SwaggerDoc("v1", new OpenApiInfo
-                    {
-                        Version = "v1",
-                        Title = "Virtual Client API",
-                        Description = "Virtual Client REST API/service.",
-                        Contact = new OpenApiContact()
-                        {
-                            Name = "Virtual Client Team",
-                            Email = "crc_vc_fte@microsoft.com",
-                            Url = new Uri("https://microsoft.github.io/VirtualClient/")
-                        },
-                        License = new OpenApiLicense
-                        {
-                            Name = "API License",
-                            Url = new Uri("https://github.com/microsoft/VirtualClient/blob/main/LICENSE")
-                        },
-                    });
-
-                    // All JSON input and output objects are expected to be in camel-case.
-                    doc.DescribeAllParametersInCamelCase();
-                });
             });
         }
 

src/VirtualClient/VirtualClient.Main/VirtualClient.Main.csproj

@@ -15,7 +15,6 @@
         <!-- Global package dependency versions are defined in the Module.props for the solution. -->
         <PackageReference Include="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="$(Microsoft_AspNetCore_Mvc_NewtonsoftJson_PackageVersion)" />
         <PackageReference Include="Microsoft.Win32.Registry" Version="$(Microsoft_Win32_Registry_PackageVersion)" />
-        <PackageReference Include="Swashbuckle.AspNetCore" Version="$(Swashbuckle_AspNetCore_PackageVersion)" />
         <PackageReference Include="System.CommandLine" Version="$(System_CommandLine_PackageVersion)" />
     </ItemGroup>