📝 Added Basic UntilHttp Documentation

testcontainers · Dec 2, 2022 · bfa4e19 · bfa4e19
1 parent 011ae92
commit bfa4e19
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/api/wait_strategies.md b/docs/api/wait_strategies.md
@@ -28,5 +28,30 @@ _ = new TestcontainersBuilder<TestcontainersContainer>()
   .Build();
 ```
 
+## Wait until Http Request is successful
+
+You can wait for an HttpResponseCode or even compare the Response Body of an http request to an exposed port on your container
+
+```csharp
+_ = new TestcontainersBuilder<TestcontainersContainer>()
+  .WithWaitStrategy(
+    Wait.ForUnixContainer()
+      .UntilHttp() //Default to a GET to localhost:80 [ExposedfromContianer] Expecting 200 with no response body Validation 
+  .Build();
+```
+or with Options 
+```csharp
+_ = new TestcontainersBuilder<TestcontainersContainer>()
+  .WithWaitStrategy(
+    Wait.ForUnixContainer()
+      .UntilHttp( options => {
+        options.Port = [YourServiceExposedPort];
+        options.Path = [RequestPath];
+        options.Method = [HttpRequestMethod];
+        options.ExpectedResponseCodes = new(){ HttpStatusCode.OK, HttpStatusCode.Accepted };
+      })
+  .Build();
+```
+
 [docker-docs-healthcheck]: https://docs.docker.com/engine/reference/builder/#healthcheck
 
diff --git a/src/Testcontainers/Configurations/UntilHttpOptions.cs b/src/Testcontainers/Configurations/UntilHttpOptions.cs
@@ -7,6 +7,9 @@ namespace DotNet.Testcontainers.Configurations
   using System.Net.Http;
   using System.Security;
 
+  /// <summary>
+  /// Configured the Request and Response Behaviour of the UntilHttp Wait
+  /// </summary>
   public class UntilHttpOptions
   {
     public UntilHttpOptions()