Fix flakey tests by making them async (#144)

* Fix flakey tests by converting them to async and synchronizing code blocks

* Use the same timeout for all tests

* Use signals to gracefully shut down the mock server

Author: qmfrederik

tests/KubernetesClient.Tests/AuthTests.cs

@@ -20,12 +20,14 @@
 
 namespace k8s.Tests
 {
-    public class AuthTests
-        : TestBase
+    public class AuthTests
     {
-        public AuthTests(ITestOutputHelper testOutput) : base(testOutput)
+        private readonly ITestOutputHelper testOutput;
+
+        public AuthTests(ITestOutputHelper testOutput)
         {
-        }
+            this.testOutput = testOutput;
+        }
 
         private static HttpOperationResponse<V1PodList> ExecuteListPods(IKubernetes client)
         {
@@ -35,7 +37,7 @@ private static HttpOperationResponse<V1PodList> ExecuteListPods(IKubernetes clie
         [Fact]
         public void Anonymous()
         {
-            using (var server = new MockKubeApiServer(TestOutput))
+            using (var server = new MockKubeApiServer(testOutput))
             {
                 var client = new Kubernetes(new KubernetesClientConfiguration
                 {
@@ -48,7 +50,7 @@ public void Anonymous()
                 Assert.Equal(1, listTask.Body.Items.Count);
             }
 
-            using (var server = new MockKubeApiServer(TestOutput, cxt =>
+            using (var server = new MockKubeApiServer(testOutput, cxt =>
             {
                 cxt.Response.StatusCode = (int)HttpStatusCode.Unauthorized;
                 return Task.FromResult(false);
@@ -71,7 +73,7 @@ public void BasicAuth()
             const string testName = "test_name";
             const string testPassword = "test_password";
 
-            using (var server = new MockKubeApiServer(TestOutput, cxt =>
+            using (var server = new MockKubeApiServer(testOutput, cxt =>
             {
                 var header = cxt.Request.Headers["Authorization"].FirstOrDefault();
 
@@ -182,7 +184,7 @@ public void Cert()
 
             var clientCertificateValidationCalled = false;
 
-            using (var server = new MockKubeApiServer(TestOutput, listenConfigure: options =>
+            using (var server = new MockKubeApiServer(testOutput, listenConfigure: options =>
             {
                 options.UseHttps(new HttpsConnectionAdapterOptions
                 {
@@ -264,7 +266,7 @@ public void Token()
         {
             const string token = "testingtoken";
 
-            using (var server = new MockKubeApiServer(TestOutput, cxt =>
+            using (var server = new MockKubeApiServer(testOutput, cxt =>
             {
                 var header = cxt.Request.Headers["Authorization"].FirstOrDefault();
 

tests/KubernetesClient.Tests/Kubernetes.Exec.Tests.cs

@@ -22,6 +22,8 @@ namespace k8s.Tests
     public class PodExecTests
         : WebSocketTestBase
     {
+        private readonly ITestOutputHelper testOutput;
+
         /// <summary>
         ///     Create a new <see cref="KubeApiClient"/> exec-in-pod test suite.
         /// </summary>
@@ -31,6 +33,7 @@ public class PodExecTests
         public PodExecTests(ITestOutputHelper testOutput)
             : base(testOutput)
         {
+            this.testOutput = testOutput;
         }
 
         /// <summary>
@@ -49,7 +52,7 @@ public async Task Exec_DefaultContainer_StdOut()
 
             using (Kubernetes client = CreateTestClient())
             {
-                Log.LogInformation("Invoking exec operation...");
+                testOutput.WriteLine("Invoking exec operation...");
 
                 WebSocket clientSocket = await client.WebSocketNamespacedPodExecAsync(
                     name: "mypod",
@@ -63,19 +66,19 @@ public async Task Exec_DefaultContainer_StdOut()
                 );
                 Assert.Equal(K8sProtocol.ChannelV1, clientSocket.SubProtocol); // For WebSockets, the Kubernetes API defaults to the binary channel (v1) protocol.
 
-                Log.LogInformation("Client socket connected (socket state is {ClientSocketState}). Waiting for server-side socket to become available...", clientSocket.State);
+                testOutput.WriteLine($"Client socket connected (socket state is {clientSocket.State}). Waiting for server-side socket to become available...");
 
                 WebSocket serverSocket = await WebSocketTestAdapter.AcceptedPodExecV1Connection;
-                Log.LogInformation("Server-side socket is now available (socket state is {ServerSocketState}). Sending data to server socket...", serverSocket.State);
+                testOutput.WriteLine($"Server-side socket is now available (socket state is {serverSocket.State}). Sending data to server socket...");
 
                 const int STDOUT = 1;
                 const string expectedOutput = "This is text send to STDOUT.";
 
                 int bytesSent = await SendMultiplexed(serverSocket, STDOUT, expectedOutput);
-                Log.LogInformation("Sent {ByteCount} bytes to server socket; receiving from client socket...", bytesSent);
+                testOutput.WriteLine($"Sent {bytesSent} bytes to server socket; receiving from client socket...");
 
                 (string receivedText, byte streamIndex, int bytesReceived) = await ReceiveTextMultiplexed(clientSocket);
-                Log.LogInformation("Received {ByteCount} bytes from client socket ('{ReceivedText}', stream {StreamIndex}).", bytesReceived, receivedText, streamIndex);
+                testOutput.WriteLine($"Received {bytesReceived} bytes from client socket ('{receivedText}', stream {streamIndex}).");
 
                 Assert.Equal(STDOUT, streamIndex);
                 Assert.Equal(expectedOutput, receivedText);

tests/KubernetesClient.Tests/KubernetesClient.Tests.csproj

@@ -9,6 +9,7 @@
       <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" />
       <PackageReference Include="Microsoft.Extensions.Logging" Version="2.0.0" />
       <PackageReference Include="System.Reactive" Version="3.1.1" />
+      <PackageReference Include="Nito.AsyncEx" Version="4.0.1" />
   </ItemGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'netcoreapp2.0' ">
@@ -19,7 +20,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.7.0-preview-20180221-13" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.7.0" />
     <PackageReference Include="xunit" Version="2.3.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.3.1" NoWarn="NU1701" />
 

tests/KubernetesClient.Tests/TestBase.cs

@@ -6,11 +6,13 @@
 
 namespace k8s.Tests
 {
-    public class V1StatusObjectViewTests
-        : TestBase
+    public class V1StatusObjectViewTests
     {
-        public V1StatusObjectViewTests(ITestOutputHelper testOutput) : base(testOutput)
+        private readonly ITestOutputHelper testOutput;
+
+        public V1StatusObjectViewTests(ITestOutputHelper testOutput)
         {
+            this.testOutput = testOutput;
         }
 
         [Fact]
@@ -22,7 +24,7 @@ public void ReturnStatus()
                 Status = "test status"
             };
 
-            using (var server = new MockKubeApiServer(TestOutput, resp: JsonConvert.SerializeObject(v1Status)))
+            using (var server = new MockKubeApiServer(testOutput, resp: JsonConvert.SerializeObject(v1Status)))
             {
                 var client = new Kubernetes(new KubernetesClientConfiguration
                 {
@@ -52,7 +54,7 @@ public void ReturnObject()
                 }
             };
 
-            using (var server = new MockKubeApiServer(TestOutput, resp: JsonConvert.SerializeObject(corev1Namespace)))
+            using (var server = new MockKubeApiServer(testOutput, resp: JsonConvert.SerializeObject(corev1Namespace)))
             {
                 var client = new Kubernetes(new KubernetesClientConfiguration
                 {