chore: reflect tcp only in name and reduce code duplication

Author: hs-thimolimpert

src/Testcontainers/Configurations/WaitStrategies/HostPortWaitStrategy.cs

@@ -0,0 +1,46 @@
+using System.Net.Sockets;
+using System.Threading.Tasks;
+using DotNet.Testcontainers.Containers;
+
+namespace DotNet.Testcontainers.Configurations
+{
+  /// <summary>
+  /// Wait for a TCP connection to be established.
+  /// </summary>
+  /// <remarks>
+  /// Some docker configurations (DockerForMac & Rancher on Mac & Windows) allow establishing a connection to any mapped port.
+  /// https://forums.docker.com/t/port-forwarding-of-exposed-ports-behaves-unexpectedly/15807
+  /// In these cases, the mapped port is always available even if the container is not listening on it.
+  /// </remarks>
+  /// <param name="port">The container port to check.</param>
+  internal sealed class HostTcpPortWaitStrategy(int port) : IWaitUntil
+  {
+    // We don't have access to all mapped ports, so we need the user to provide the container port.
+    private readonly int _containerPort = port;
+
+    public async Task<bool> UntilAsync(IContainer container)
+    {
+      ushort hostPort;
+      try
+      {
+        hostPort = container.GetMappedPublicPort(_containerPort);
+      }
+      catch
+      {
+        return false;
+      }
+
+      using var tcpClient = new TcpClient();
+      try
+      {
+        await tcpClient.ConnectAsync(container.Hostname, hostPort)
+            .ConfigureAwait(false);
+        return tcpClient.Connected;
+      }
+      catch
+      {
+        return false;
+      }
+    }
+  }
+}

src/Testcontainers/Configurations/WaitStrategies/HostTcpPortWaitStrategy.cs

@@ -68,17 +68,13 @@ public interface IWaitForContainerOS
     IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
 
     /// <summary>
-    /// Waits until the tcp connection is established successfully from host.
+    /// Waits until the TCP port is available in the container and a connection can be established from the host to the container.
     /// </summary>
-    /// <remarks>
-    /// Some docker configurations (DockerForMac & Rancher on Mac & Windows) allow establishing a connection to any mapped port.
-    /// The test will always succeed in these cases.
-    /// </remarks>
     /// <param name="port">The container port to be checked.</param>
     /// <param name="waitStrategyModifier">The wait strategy modifier to cancel the readiness check.</param>
     /// <returns>A configured instance of <see cref="IWaitForContainerOS" />.</returns>
     [PublicAPI]
-    IWaitForContainerOS UntilHostPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
+    IWaitForContainerOS UntilHostTcpPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
 
 
     /// <summary>

src/Testcontainers/Configurations/WaitStrategies/IWaitForContainerOS.cs

@@ -94,6 +94,10 @@ public IEnumerable<WaitStrategy> Build()
     }
 
     /// <inheritdoc />
-    abstract public IWaitForContainerOS UntilHostPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null);
+    public IWaitForContainerOS UntilHostTcpPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
+    {
+      UntilPortIsAvailable(port, waitStrategyModifier);
+      return AddCustomWaitStrategy(new HostTcpPortWaitStrategy(port), waitStrategyModifier);
+    }
   }
 }

src/Testcontainers/Configurations/WaitStrategies/UntilTcpConnected.cs

@@ -25,12 +25,6 @@ public override IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string>
       return AddCustomWaitStrategy(new UntilUnixCommandIsCompleted(command.ToArray()), waitStrategyModifier);
     }
 
-    public override IWaitForContainerOS UntilHostPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
-    {
-      UntilPortIsAvailable(port, waitStrategyModifier);
-      return AddCustomWaitStrategy(new HostPortWaitStrategy(port), waitStrategyModifier);
-    }
-
     /// <inheritdoc />
     public override IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
     {

src/Testcontainers/Configurations/WaitStrategies/WaitForContainerOS.cs

@@ -25,12 +25,6 @@ public override IWaitForContainerOS UntilCommandIsCompleted(IEnumerable<string>
       return AddCustomWaitStrategy(new UntilWindowsCommandIsCompleted(command.ToArray()), waitStrategyModifier);
     }
 
-    public override IWaitForContainerOS UntilHostPortAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
-    {
-      UntilPortIsAvailable(port, waitStrategyModifier);
-      return AddCustomWaitStrategy(new HostPortWaitStrategy(port), waitStrategyModifier);
-    }
-
     /// <inheritdoc />
     public override IWaitForContainerOS UntilPortIsAvailable(int port, Action<IWaitStrategy> waitStrategyModifier = null)
     {

src/Testcontainers/Configurations/WaitStrategies/WaitForContainerUnix.cs

@@ -64,14 +64,14 @@ public UntilPortIsAvailable()
     }
 
     [UsedImplicitly]
-    public sealed class UntilHostPortIsAvailable : WindowsContainerTest
+    public sealed class UntilHostTcpPortIsAvailable : WindowsContainerTest
     {
-        public UntilHostPortIsAvailable()
+        public UntilHostTcpPortIsAvailable()
             : base(new ContainerBuilder()
                 .WithImage(CommonImages.ServerCore)
                 .WithEntrypoint("PowerShell", "-NoLogo", "-Command")
                 .WithCommand("$tcpListener = [System.Net.Sockets.TcpListener]80; $tcpListener.Start(); Start-Sleep -Seconds 120")
-                .WithWaitStrategy(Wait.ForWindowsContainer().UntilHostPortAvailable(80))
+                .WithWaitStrategy(Wait.ForWindowsContainer().UntilHostTcpPortAvailable(80))
                 .Build())
         {
         }

src/Testcontainers/Configurations/WaitStrategies/WaitForContainerWindows.cs

@@ -8,7 +8,7 @@ namespace DotNet.Testcontainers.Tests.Unit
   using JetBrains.Annotations;
   using Xunit;
 
-  public sealed class HostPortWaitStrategyTest : IAsyncLifetime
+  public sealed class HostTcpPortWaitStrategyTest : IAsyncLifetime
   {
     private const int listeningPort = 49152;
     private const int mappedPort = 49153;
@@ -20,7 +20,7 @@ public sealed class HostPortWaitStrategyTest : IAsyncLifetime
       .WithCommand("EXEC:cat")
       .WithPortBinding(listeningPort, true)
       .WithPortBinding(mappedPort, true)
-      .WithWaitStrategy(Wait.ForUnixContainer().UntilHostPortAvailable(listeningPort))
+      .WithWaitStrategy(Wait.ForUnixContainer().UntilHostTcpPortAvailable(listeningPort))
       .Build();
 
     public async ValueTask InitializeAsync()
@@ -35,9 +35,9 @@ public ValueTask DisposeAsync()
     }
 
     [Fact]
-    public async Task hostPortWaitStrategyIsSucceeded()
+    public async Task HostTcpPortWaitStrategyIsSucceeded()
     {
-      var hostPortWaitStrategy = new HostPortWaitStrategy(listeningPort);
+      var hostPortWaitStrategy = new HostTcpPortWaitStrategy(listeningPort);
 
       var succeeded = await hostPortWaitStrategy.UntilAsync(_container);
 
@@ -49,19 +49,19 @@ public async Task hostPortWaitStrategyIsSucceeded()
     /// This test might fail in docker configurations where mapped ports are always listened eg. DockerForMac (https://forums.docker.com/t/port-forwarding-of-exposed-ports-behaves-unexpectedly/15807/2)
     /// </summary>
     [Fact]
-    public async Task hostPortWaitStrategyFailsWhenPortNotListening()
+    public async Task HostTcpPortWaitStrategyFailsWhenPortNotListening()
     {
-      var hostPortWaitStrategy = new HostPortWaitStrategy(mappedPort);
+      var hostPortWaitStrategy = new HostTcpPortWaitStrategy(mappedPort);
 
       var succeeded = await hostPortWaitStrategy.UntilAsync(_container);
 
       Assert.False(succeeded);
     }
 
     [Fact]
-    public async Task hostPortWaitStrategyFailsWhenPortNotMapped()
+    public async Task HostTcpPortWaitStrategyFailsWhenPortNotMapped()
     {
-      var hostPortWaitStrategy = new HostPortWaitStrategy(unmappedPort);
+      var hostPortWaitStrategy = new HostTcpPortWaitStrategy(unmappedPort);
 
       var succeeded = await hostPortWaitStrategy.UntilAsync(_container);