chore : Do not block async context on acquire lock (#1188)

Signed-off-by: Andre Hofmeister <[email protected]>
testcontainers · Jun 6, 2024 · 56d3eab · 56d3eab
1 parent 66bb577
commit 56d3eab
Show file tree

Hide file tree

Showing 9 changed files with 60 additions and 56 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -57,7 +57,7 @@
         <PackageVersion Include="MySqlConnector" Version="2.2.5"/>
         <PackageVersion Include="NATS.Client" Version="1.0.8"/>
         <PackageVersion Include="Neo4j.Driver" Version="5.5.0"/>
-        <PackageVersion Include="Npgsql" Version="6.0.10"/>
+        <PackageVersion Include="Npgsql" Version="6.0.11"/>
         <PackageVersion Include="Oracle.ManagedDataAccess.Core" Version="3.21.90"/>
         <PackageVersion Include="RabbitMQ.Client" Version="6.4.0"/>
         <PackageVersion Include="RavenDB.Client" Version="5.4.100"/>

diff --git a/src/Testcontainers/Configurations/WaitStrategies/RetryLimitExceededException.cs b/src/Testcontainers/Configurations/WaitStrategies/RetryLimitExceededException.cs
@@ -1,4 +1,4 @@
-namespace DotNet.Testcontainers.Configurations
+namespace DotNet.Testcontainers.Configurations
 {
   using System;
 

diff --git a/src/Testcontainers/Containers/DockerContainer.cs b/src/Testcontainers/Containers/DockerContainer.cs
@@ -261,34 +261,34 @@ public Task<long> GetExitCodeAsync(CancellationToken ct = default)
     /// <inheritdoc />
     public virtual async Task StartAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        var futureResources = Array.Empty<IFutureResource>()
-          .Concat(_configuration.Mounts)
-          .Concat(_configuration.Networks);
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
 
-        await Task.WhenAll(futureResources.Select(resource => resource.CreateAsync(ct)))
-          .ConfigureAwait(false);
+      var futureResources = Array.Empty<IFutureResource>()
+        .Concat(_configuration.Mounts)
+        .Concat(_configuration.Networks);
 
-        await Task.WhenAll(_configuration.Containers.Select(resource => resource.StartAsync(ct)))
-          .ConfigureAwait(false);
+      await Task.WhenAll(futureResources.Select(resource => resource.CreateAsync(ct)))
+        .ConfigureAwait(false);
 
-        await UnsafeCreateAsync(ct)
-          .ConfigureAwait(false);
+      await Task.WhenAll(_configuration.Containers.Select(resource => resource.StartAsync(ct)))
+        .ConfigureAwait(false);
 
-        await UnsafeStartAsync(ct)
-          .ConfigureAwait(false);
-      }
+      await UnsafeCreateAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeStartAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />
     public virtual async Task StopAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeStopAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeStopAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />
@@ -344,7 +344,8 @@ protected override async ValueTask DisposeAsyncCore()
         return;
       }
 
-      using (_ = AcquireLock())
+      using (_ = await AcquireLockAsync()
+               .ConfigureAwait(false))
       {
         if (Guid.Empty.Equals(_configuration.SessionId))
         {

diff --git a/src/Testcontainers/Images/FutureDockerImage.cs b/src/Testcontainers/Images/FutureDockerImage.cs
@@ -77,21 +77,21 @@ public string GetHostname()
     /// <inheritdoc />
     public async Task CreateAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeCreateAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeCreateAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />
     public async Task DeleteAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeDeleteAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeDeleteAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />

diff --git a/src/Testcontainers/Networks/DockerNetwork.cs b/src/Testcontainers/Networks/DockerNetwork.cs
@@ -43,21 +43,21 @@ public string Name
     /// <inheritdoc />
     public async Task CreateAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeCreateAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeCreateAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />
     public async Task DeleteAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeDeleteAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeDeleteAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />

diff --git a/src/Testcontainers/Resource.cs b/src/Testcontainers/Resource.cs
@@ -60,9 +60,12 @@ protected virtual ValueTask DisposeAsyncCore()
     /// <summary>
     /// Acquires a lock to access the resource thread-safe.
     /// </summary>
-    /// <returns>An <see cref="IDisposable" /> that releases the lock on <see cref="IDisposable.Dispose" />.</returns>
-    protected virtual IDisposable AcquireLock()
+    /// <returns>A <see cref="IDisposable" /> that releases the lock on <see cref="IDisposable.Dispose" />.</returns>
+    protected virtual async Task<IDisposable> AcquireLockAsync(CancellationToken ct = default)
     {
+      await _semaphoreSlim.WaitAsync(ct)
+        .ConfigureAwait(false);
+
       return new Lock(_semaphoreSlim);
     }
 
@@ -102,7 +105,6 @@ private sealed class Lock : IDisposable
       public Lock(SemaphoreSlim semaphoreSlim)
       {
         _semaphoreSlim = semaphoreSlim;
-        _semaphoreSlim.Wait();
       }
 
       public void Dispose()

diff --git a/src/Testcontainers/Testcontainers.csproj b/src/Testcontainers/Testcontainers.csproj
@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net6.0;net8.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+    <LangVersion>latest</LangVersion>
     <Configurations>Debug;Release</Configurations>
     <RootNamespace>DotNet.Testcontainers</RootNamespace>
   </PropertyGroup>

diff --git a/src/Testcontainers/Volumes/DockerVolume.cs b/src/Testcontainers/Volumes/DockerVolume.cs
@@ -43,21 +43,21 @@ public string Name
     /// <inheritdoc />
     public async Task CreateAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeCreateAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeCreateAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />
     public async Task DeleteAsync(CancellationToken ct = default)
     {
-      using (_ = AcquireLock())
-      {
-        await UnsafeDeleteAsync(ct)
-          .ConfigureAwait(false);
-      }
+      using var disposable = await AcquireLockAsync(ct)
+        .ConfigureAwait(false);
+
+      await UnsafeDeleteAsync(ct)
+        .ConfigureAwait(false);
     }
 
     /// <inheritdoc />

diff --git a/tests/Testcontainers.Platform.Linux.Tests/WaitStrategyTest.cs b/tests/Testcontainers.Platform.Linux.Tests/WaitStrategyTest.cs
@@ -1,4 +1,4 @@
-namespace Testcontainers.Tests;
+namespace Testcontainers.Tests;
 
 public sealed class WaitStrategyTest
 {