[#163] #EXTEND 'assemblyName: DotNet.Testcontainers; function: IDocke…

…rContainer'

{Add ExecAsync to execute shell commands in running containers.}

README.md

@@ -41,10 +41,10 @@ The pre-configured Testcontainers below are supported. Further examples can be f
 
 - CouchDB (couchdb:2.3.1)
 - MsSql (server:2017-CU14-ubuntu)
-- MySql (mysql:8.0.15)
-- PostgreSql (postgres:11.2)
-- Redis (redis:5.0.5)
-- RabbitMQ (rabbitmq:3.7.15)
+- MySql (mysql:8.0.18)
+- PostgreSql (postgres:11.5)
+- Redis (redis:5.0.6)
+- RabbitMQ (rabbitmq:3.7.21)
 
 ## Examples
 

src/DotNet.Testcontainers.Tests/DotNet.Testcontainers.Tests.csproj

@@ -6,10 +6,10 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="coverlet.msbuild" Version="2.7.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.3.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
     <PackageReference Include="MyCouch" Version="7.1.0" />
     <PackageReference Include="MySql.Data" Version="8.0.18" />
-    <PackageReference Include="Npgsql" Version="4.1.1" />
+    <PackageReference Include="Npgsql" Version="4.1.2" />
     <PackageReference Include="RabbitMQ.Client" Version="5.1.2" />
     <PackageReference Include="StackExchange.Redis" Version="2.0.601" />
     <PackageReference Include="System.Data.SqlClient" Version="4.7.0" />

src/DotNet.Testcontainers.Tests/Unit/Containers/Linux/TestcontainersContainerTest.cs

@@ -289,6 +289,23 @@ public async Task WaitStrategy()
           await testcontainer.StartAsync();
         }
       }
+
+      [Fact]
+      public async Task ExecCommandInRunningContainer()
+      {
+        // Given
+        var testcontainersBuilder = new TestcontainersBuilder<TestcontainersContainer>()
+          .WithImage("alpine")
+          .WithCommand("/bin/ash", "-c", "tail -f /dev/null");
+
+        // When
+        // Then
+        using (var testcontainer = testcontainersBuilder.Build())
+        {
+          await testcontainer.StartAsync();
+          Assert.Equal(255, await testcontainer.ExecAsync(new [] { "/bin/ash", "-c", "exit 255" }));
+        }
+      }
     }
   }
 }

src/DotNet.Testcontainers.Tests/Unit/Containers/TestcontainersWaitStrategyTest.cs

@@ -35,33 +35,27 @@ public Task<bool> While(string id)
     public class Timeout : IWaitUntil, IWaitWhile
     {
       [Fact]
-      public async Task UntilAfter1ms()
+      public async Task UntilAfter1Ms()
       {
-        await Assert.ThrowsAsync<TimeoutException>(async () =>
-        {
-          await WaitStrategy.WaitUntil(() => this.Until(string.Empty), timeout: 1);
-        });
+        await Assert.ThrowsAsync<TimeoutException>(() => WaitStrategy.WaitUntil(() => this.Until(string.Empty), timeout: 1));
       }
 
       [Fact]
-      public async Task WhileAfter1ms()
+      public async Task WhileAfter1Ms()
       {
-        await Assert.ThrowsAsync<TimeoutException>(async () =>
-        {
-          await WaitStrategy.WaitWhile(() => this.While(string.Empty), timeout: 1);
-        });
+        await Assert.ThrowsAsync<TimeoutException>(() => WaitStrategy.WaitWhile(() => this.While(string.Empty), timeout: 1));
       }
 
       public async Task<bool> Until(string id)
       {
         await Task.Delay(TimeSpan.FromSeconds(1));
-        return true;
+        return false;
       }
 
       public async Task<bool> While(string id)
       {
         await Task.Delay(TimeSpan.FromSeconds(1));
-        return false;
+        return true;
       }
     }
 
@@ -70,19 +64,13 @@ public class Rethrow : IWaitUntil, IWaitWhile
       [Fact]
       public async Task RethrowUntil()
       {
-        await Assert.ThrowsAsync<NotImplementedException>(async () =>
-        {
-          await WaitStrategy.WaitUntil(() => this.Until(string.Empty));
-        });
+        await Assert.ThrowsAsync<NotImplementedException>(() => WaitStrategy.WaitUntil(() => this.Until(string.Empty)));
       }
 
       [Fact]
       public async Task RethrowWhile()
       {
-        await Assert.ThrowsAsync<NotImplementedException>(async () =>
-        {
-          await WaitStrategy.WaitWhile(() => this.While(string.Empty));
-        });
+        await Assert.ThrowsAsync<NotImplementedException>(() => WaitStrategy.WaitWhile(() => this.While(string.Empty)));
       }
 
       public Task<bool> Until(string id)

src/DotNet.Testcontainers.Tests/Unit/Containers/WaitUntilOperationSucceedsTest.cs → src/DotNet.Testcontainers.Tests/Unit/Containers/WaitUntilOperationSucceededTest.cs

@@ -5,7 +5,7 @@ namespace DotNet.Testcontainers.Tests.Unit.Containers
   using Testcontainers.Containers.WaitStrategies;
   using Xunit;
 
-  public class WaitUntilOperationSucceedsTest
+  public class WaitUntilOperationSucceededTest
   {
     [Theory]
     [InlineData( 1,  1)]
@@ -16,16 +16,21 @@ public class WaitUntilOperationSucceedsTest
     [InlineData( 0,  0)]
     public async Task UntilMaxRepeats(int maxCallCount, int expectedCallsCount)
     {
+      // Given
       var callCounter = 0;
+
+      // When
       await Assert.ThrowsAsync<TimeoutException>(async () =>
       {
-        var wait = new WaitUntilOperationSucceeds(() =>
+        var wait = new WaitUntilOperationSucceeded(() =>
         {
           callCounter += 1;
           return false;
         }, maxCallCount);
         await WaitStrategy.WaitUntil(() => wait.Until(string.Empty));
       });
+
+      // Then
       Assert.Equal(expectedCallsCount, callCounter);
     }
 
@@ -40,9 +45,14 @@ await Assert.ThrowsAsync<TimeoutException>(async () =>
     [InlineData(10,  7)]
     public async Task UntilSomeRepeats(int maxCallCount, int expectedCallsCount)
     {
+      // Given
       var callCounter = 0;
-      var wait = new WaitUntilOperationSucceeds(() => ++callCounter >= expectedCallsCount, maxCallCount);
+
+      // When
+      var wait = new WaitUntilOperationSucceeded(() => ++callCounter >= expectedCallsCount, maxCallCount);
       await WaitStrategy.WaitUntil(() => wait.Until(string.Empty));
+
+      // Then
       Assert.Equal(expectedCallsCount, callCounter);
     }
   }

src/DotNet.Testcontainers/Containers/Builders/ITestcontainersBuilder.cs

@@ -5,7 +5,7 @@ namespace DotNet.Testcontainers.Containers.Builders
   using DotNet.Testcontainers.Containers.WaitStrategies;
   using DotNet.Testcontainers.Images;
 
-  public interface ITestcontainersBuilder<T>
+  public interface ITestcontainersBuilder<out T>
   {
     ITestcontainersBuilder<T> ConfigureContainer(Action<T> moduleConfiguration);
 
@@ -131,7 +131,7 @@ public interface ITestcontainersBuilder<T>
     /// <summary>
     /// Sets the output consumer to capture the Testcontainer stdout and stderr messages.
     /// </summary>
-    /// <param name="outputConsumer">Output consumer to capture stdout and strerr.</param>
+    /// <param name="outputConsumer">Output consumer to capture stdout and stderr.</param>
     /// <returns>A configured instance of <see cref="ITestcontainersBuilder{T}"/>.</returns>
     ITestcontainersBuilder<T> WithOutputConsumer(IOutputConsumer outputConsumer);
 

src/DotNet.Testcontainers/Containers/Configurations/Databases/MySqlTestcontainerConfiguration.cs

@@ -5,7 +5,7 @@ namespace DotNet.Testcontainers.Containers.Configurations.Databases
 
   public sealed class MySqlTestcontainerConfiguration : TestcontainerDatabaseConfiguration
   {
-    public MySqlTestcontainerConfiguration() : base("mysql:8.0.15", 3306)
+    public MySqlTestcontainerConfiguration() : base("mysql:8.0.18", 3306)
     {
       this.Environments["MYSQL_ALLOW_EMPTY_PASSWORD"] = "yes";
     }

src/DotNet.Testcontainers/Containers/Configurations/Databases/PostgreSqlTestcontainerConfiguration.cs

@@ -5,7 +5,7 @@ namespace DotNet.Testcontainers.Containers.Configurations.Databases
 
   public sealed class PostgreSqlTestcontainerConfiguration : TestcontainerDatabaseConfiguration
   {
-    public PostgreSqlTestcontainerConfiguration() : base("postgres:11.2", 5432)
+    public PostgreSqlTestcontainerConfiguration() : base("postgres:11.5", 5432)
     {
     }
 

src/DotNet.Testcontainers/Containers/Configurations/Databases/RedisTestcontainerConfiguration.cs

@@ -6,7 +6,7 @@ namespace DotNet.Testcontainers.Containers.Configurations.Databases
 
   public sealed class RedisTestcontainerConfiguration : TestcontainerDatabaseConfiguration
   {
-    public RedisTestcontainerConfiguration() : base("redis:5.0.5", 6379)
+    public RedisTestcontainerConfiguration() : base("redis:5.0.6", 6379)
     {
     }
 

src/DotNet.Testcontainers/Containers/Configurations/MessageBrokers/RabbitMqTestcontainerConfiguration.cs

@@ -5,7 +5,7 @@ namespace DotNet.Testcontainers.Containers.Configurations.MessageBrokers
 
   public sealed class RabbitMqTestcontainerConfiguration : TestcontainerMessageBrokerConfiguration
   {
-    public RabbitMqTestcontainerConfiguration() : base("rabbitmq:3.7.15", 5672)
+    public RabbitMqTestcontainerConfiguration() : base("rabbitmq:3.7.21", 5672)
     {
     }
 

src/DotNet.Testcontainers/Containers/IDockerContainer.cs

@@ -1,6 +1,8 @@
 namespace DotNet.Testcontainers.Containers
 {
   using System;
+  using System.Collections.Generic;
+  using System.Threading;
   using System.Threading.Tasks;
 
   public interface IDockerContainer : IDisposable
@@ -52,5 +54,13 @@ public interface IDockerContainer : IDisposable
     /// </summary>
     /// <returns>A task that represents the asynchronous stop operation of a Testcontainer.</returns>
     Task StopAsync();
+
+    /// <summary>
+    /// Executes a command in the running Testcontainer.
+    /// </summary>
+    /// <param name="command">Shell command.</param>
+    /// <param name="ct">Cancellation token.</param>
+    /// <returns>Task that completes when the shell command has been executed.</returns>
+    Task<long> ExecAsync(IList<string> command, CancellationToken ct = default);
   }
 }

src/DotNet.Testcontainers/Containers/Modules/TestcontainersContainer.cs

@@ -1,6 +1,7 @@
 namespace DotNet.Testcontainers.Containers.Modules
 {
   using System;
+  using System.Collections.Generic;
   using System.Linq;
   using System.Threading;
   using System.Threading.Tasks;
@@ -52,11 +53,7 @@ public string Name
     {
       get
       {
-        if (this.container == null)
-        {
-          throw new InvalidOperationException(ContainerIsNotRunning);
-        }
-
+        this.ThrowIfContainerIsNotRunning();
         return this.container.Names.FirstOrDefault() ?? string.Empty;
       }
     }
@@ -65,11 +62,7 @@ public string IpAddress
     {
       get
       {
-        if (this.container == null)
-        {
-          throw new InvalidOperationException(ContainerIsNotRunning);
-        }
-
+        this.ThrowIfContainerIsNotRunning();
         var ipAddress = this.container.NetworkSettings.Networks.FirstOrDefault();
         return ipAddress.Value?.IPAddress ?? string.Empty;
       }
@@ -79,11 +72,7 @@ public string MacAddress
     {
       get
       {
-        if (this.container == null)
-        {
-          throw new InvalidOperationException(ContainerIsNotRunning);
-        }
-
+        this.ThrowIfContainerIsNotRunning();
         var macAddress = this.container.NetworkSettings.Networks.FirstOrDefault();
         return macAddress.Value?.MacAddress ?? string.Empty;
       }
@@ -98,11 +87,7 @@ public ushort GetMappedPublicPort(int privatePort)
 
     public ushort GetMappedPublicPort(string privatePort)
     {
-      if (this.container == null)
-      {
-        throw new InvalidOperationException(ContainerIsNotRunning);
-      }
-
+      this.ThrowIfContainerIsNotRunning();
       var mappedPort = this.container.Ports.FirstOrDefault(port => $"{port.PrivatePort}".Equals(privatePort));
       return mappedPort?.PublicPort ?? ushort.MinValue;
     }
@@ -126,6 +111,12 @@ public async Task StopAsync()
       await this.Stop();
     }
 
+    public Task<long> ExecAsync(IList<string> command, CancellationToken ct = default)
+    {
+      this.ThrowIfContainerIsNotRunning();
+      return TestcontainersClient.Instance.ExecAsync(this.Id, command, ct);
+    }
+
     public void Dispose()
     {
       this.Dispose(true);
@@ -145,6 +136,14 @@ protected virtual void Dispose(bool disposing)
       this.disposed = true;
     }
 
+    private void ThrowIfContainerIsNotRunning()
+    {
+      if (this.container == null)
+      {
+        throw new InvalidOperationException(ContainerIsNotRunning);
+      }
+    }
+
     private async Task Create()
     {
       if (!this.HasId)

src/DotNet.Testcontainers/Containers/WaitStrategies/WaitUntilOperationSucceeds.cs → src/DotNet.Testcontainers/Containers/WaitStrategies/WaitUntilOperationSucceeded.cs

@@ -3,14 +3,15 @@ namespace DotNet.Testcontainers.Containers.WaitStrategies
   using System;
   using System.Threading.Tasks;
 
-  internal class WaitUntilOperationSucceeds : WaitUntilContainerIsRunning
+  internal class WaitUntilOperationSucceeded : WaitUntilContainerIsRunning
   {
     private readonly int maxCallCount;
+
     private readonly Func<bool> operation;
 
     private int tryCount = 0;
 
-    public WaitUntilOperationSucceeds(Func<bool> operation, int maxCallCount = 4)
+    public WaitUntilOperationSucceeded(Func<bool> operation, int maxCallCount = 4)
     {
       this.maxCallCount = maxCallCount;
       this.operation = operation;

src/DotNet.Testcontainers/DotNet.Testcontainers.csproj

@@ -9,7 +9,7 @@
     <PackageReference Include="Docker.DotNet" Version="3.125.2" />
     <PackageReference Include="Serilog.Extensions.Logging" Version="3.0.1" />
     <PackageReference Include="Serilog.Settings.Configuration" Version="3.1.0" />
-    <PackageReference Include="Serilog.Sinks.File" Version="4.0.0" />
+    <PackageReference Include="Serilog.Sinks.File" Version="4.1.0" />
     <PackageReference Include="SharpZipLib" Version="1.2.0" />
   </ItemGroup>
   <Import Project="$(MSBuildThisFileDirectory)../Shared.msbuild" />