Skip to content

Commit 67c37f8

Browse files
committed
chore: Add remarks
1 parent 460b1f1 commit 67c37f8

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/Testcontainers/Configurations/WaitStrategies/IWaitForContainerOS.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,17 @@ public interface IWaitForContainerOS
8282
/// Waits until a TCP port is available from the test host to the container.
8383
/// This verifies that the port is exposed and reachable externally.
8484
/// </summary>
85+
/// <remarks>
86+
/// This does not necessarily mean that the TCP connection to the service running inside
87+
/// the container was successful. For container runtimes like Docker Desktop, Podman, or similar,
88+
/// this usually only indicates that the port has been mapped and that a connection could be
89+
/// established to the host-side proxy that maps the port.
90+
///
91+
/// This wait strategy is particularly useful for container runtimes that may take some time
92+
/// to finish setting up port mappings. In some cases, other strategies such as log-based
93+
/// readiness checks may indicate readiness before the runtime has fully configured the port
94+
/// mapping, leading to connection failures. This strategy helps to avoid that race condition.
95+
/// </remarks>
8596
/// <param name="containerPort">The TCP port of the service running inside the container.</param>
8697
/// <param name="waitStrategyModifier">The wait strategy modifier to cancel the readiness check.</param>
8798
/// <returns>A configured instance of <see cref="IWaitForContainerOS" />.</returns>

0 commit comments

Comments
 (0)