From a58ff460faeaacd18124be1168618d0b5b926d41 Mon Sep 17 00:00:00 2001
From: Sergei Shitikov <rw4lll@gmail.com>
Date: Sun, 29 Sep 2024 14:46:54 +0200
Subject: [PATCH] refactored WaitForHealthCheck strategy and added more
 granular exceptions

---
 src/Exception/ContainerException.php          | 21 ++++++
 src/Exception/ContainerNotReadyException.php  |  6 +-
 src/Exception/ContainerStateException.php     | 14 ++++
 .../ContainerWaitingTimeoutException.php      | 14 +---
 src/Exception/HealthCheckFailedException.php  | 14 ++++
 .../HealthCheckNotConfiguredException.php     | 14 ++++
 .../UnknownHealthStatusException.php          | 14 ++++
 src/Wait/WaitForHealthCheck.php               | 73 +++++++++++++------
 8 files changed, 131 insertions(+), 39 deletions(-)
 create mode 100644 src/Exception/ContainerException.php
 create mode 100644 src/Exception/ContainerStateException.php
 create mode 100644 src/Exception/HealthCheckFailedException.php
 create mode 100644 src/Exception/HealthCheckNotConfiguredException.php
 create mode 100644 src/Exception/UnknownHealthStatusException.php

diff --git a/src/Exception/ContainerException.php b/src/Exception/ContainerException.php
new file mode 100644
index 0000000..f0d02a3
--- /dev/null
+++ b/src/Exception/ContainerException.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Testcontainers\Exception;
+
+class ContainerException extends \RuntimeException
+{
+    protected string $containerId;
+
+    public function __construct(string $message, string $containerId = '', ?\Throwable $previous = null)
+    {
+        $this->containerId = $containerId;
+        parent::__construct($message, 0, $previous);
+    }
+
+    public function getContainerId(): string
+    {
+        return $this->containerId;
+    }
+}
diff --git a/src/Exception/ContainerNotReadyException.php b/src/Exception/ContainerNotReadyException.php
index 1b5f677..200983f 100644
--- a/src/Exception/ContainerNotReadyException.php
+++ b/src/Exception/ContainerNotReadyException.php
@@ -4,10 +4,6 @@ declare(strict_types=1);
 
 namespace Testcontainers\Exception;
 
-class ContainerNotReadyException extends \RuntimeException
+class ContainerNotReadyException extends ContainerException
 {
-    public function __construct(string $id, ?\Throwable $previous = null)
-    {
-        parent::__construct(sprintf('Container %s is not ready', $id), 0, $previous);
-    }
 }
diff --git a/src/Exception/ContainerStateException.php b/src/Exception/ContainerStateException.php
new file mode 100644
index 0000000..c91cb07
--- /dev/null
+++ b/src/Exception/ContainerStateException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Testcontainers\Exception;
+
+class ContainerStateException extends ContainerException
+{
+    public function __construct(string $containerId, ?\Throwable $previous = null)
+    {
+        $message = sprintf('Unable to retrieve state for container %s', $containerId);
+        parent::__construct($message, $containerId, $previous);
+    }
+}
diff --git a/src/Exception/ContainerWaitingTimeoutException.php b/src/Exception/ContainerWaitingTimeoutException.php
index e6d1c18..62c5803 100644
--- a/src/Exception/ContainerWaitingTimeoutException.php
+++ b/src/Exception/ContainerWaitingTimeoutException.php
@@ -4,19 +4,11 @@ declare(strict_types=1);
 
 namespace Testcontainers\Exception;
 
-class ContainerWaitingTimeoutException extends \RuntimeException
+class ContainerWaitingTimeoutException extends ContainerNotReadyException
 {
-    protected string $containerId;
-
     public function __construct(string $containerId, ?string $message = null, ?\Throwable $previous = null)
     {
-        $this->containerId = $containerId;
         $message ??= sprintf('Timeout reached while waiting for container %s', $containerId);
-        parent::__construct($message, 0, $previous);
+        parent::__construct($message, $containerId, $previous);
     }
-
-    public function getContainerId(): string
-    {
-        return $this->containerId;
-    }
-}
+}
\ No newline at end of file
diff --git a/src/Exception/HealthCheckFailedException.php b/src/Exception/HealthCheckFailedException.php
new file mode 100644
index 0000000..b1b7c08
--- /dev/null
+++ b/src/Exception/HealthCheckFailedException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Testcontainers\Exception;
+
+class HealthCheckFailedException extends ContainerNotReadyException
+{
+    public function __construct(string $containerId, ?\Throwable $previous = null)
+    {
+        $message = sprintf('Health check failed: Container %s is unhealthy', $containerId);
+        parent::__construct($message, $containerId, $previous);
+    }
+}
diff --git a/src/Exception/HealthCheckNotConfiguredException.php b/src/Exception/HealthCheckNotConfiguredException.php
new file mode 100644
index 0000000..65a5766
--- /dev/null
+++ b/src/Exception/HealthCheckNotConfiguredException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Testcontainers\Exception;
+
+class HealthCheckNotConfiguredException extends ContainerNotReadyException
+{
+    public function __construct(string $containerId, ?\Throwable $previous = null)
+    {
+        $message = sprintf('Health check not configured for container %s', $containerId);
+        parent::__construct($message, $containerId, $previous);
+    }
+}
diff --git a/src/Exception/UnknownHealthStatusException.php b/src/Exception/UnknownHealthStatusException.php
new file mode 100644
index 0000000..86cbd3c
--- /dev/null
+++ b/src/Exception/UnknownHealthStatusException.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Testcontainers\Exception;
+
+class UnknownHealthStatusException extends ContainerNotReadyException
+{
+    public function __construct(string $containerId, string $status, ?\Throwable $previous = null)
+    {
+        $message = sprintf('Unknown health status %s for container %s', $status, $containerId);
+        parent::__construct($message, $containerId, $previous);
+    }
+}
diff --git a/src/Wait/WaitForHealthCheck.php b/src/Wait/WaitForHealthCheck.php
index 9bef414..289adaf 100644
--- a/src/Wait/WaitForHealthCheck.php
+++ b/src/Wait/WaitForHealthCheck.php
@@ -4,43 +4,70 @@ declare(strict_types=1);
 
 namespace Testcontainers\Wait;
 
-use Docker\Docker;
-use Http\Client\Socket\Exception\TimeoutException;
+use Docker\API\Model\ContainersIdJsonGetResponse200;
 use Testcontainers\Container\StartedTestContainer;
-use Testcontainers\Exception\ContainerNotReadyException;
+use Testcontainers\Exception\ContainerStateException;
+use Testcontainers\Exception\ContainerWaitingTimeoutException;
+use Testcontainers\Exception\HealthCheckFailedException;
+use Testcontainers\Exception\HealthCheckNotConfiguredException;
+use Testcontainers\Exception\UnknownHealthStatusException;
 
-//TODO: not ready yet
+/**
+ * Wait strategy that waits until the container's health status is 'healthy'.
+ *
+ * Possible health statuses:
+ * - "none":      No health check configured.
+ * - "starting":  Health check is in progress.
+ * - "healthy":   Container is healthy.
+ * - "unhealthy": Container is unhealthy.
+ */
 class WaitForHealthCheck extends BaseWaitStrategy
 {
-    public function __construct(protected int $timeout = 5000, protected int $pollInterval = 1000)
-    {
-        parent::__construct($timeout, $pollInterval);
-    }
-
     public function wait(StartedTestContainer $container): void
     {
-        $startTime = microtime(true) * 1000;
+        $startTime = microtime(true);
 
         while (true) {
-            $elapsedTime = (microtime(true) * 1000) - $startTime;
+            $elapsedTime = (microtime(true) - $startTime) * 1000;
 
             if ($elapsedTime > $this->timeout) {
-                throw new TimeoutException(sprintf("Health check not healthy after %d ms", $this->timeout));
+                throw new ContainerWaitingTimeoutException($container->getId());
             }
 
-            /** @var \Psr\Http\Message\ResponseInterface | null $containerInspect */
-            $containerInspect = $container->getClient()->containerInspect($container->getId(), [], Docker::FETCH_RESPONSE);
-            //$containerStatus = $containerInspect?->getArrayCopy() ?? null;
-            $containerStatus = '';
-            if ($containerStatus === 'healthy') {
-                return;
+            /** @var ContainersIdJsonGetResponse200|null $containerInspect */
+            $containerInspect = $container->getClient()->containerInspect($container->getId());
+
+            $containerState = $containerInspect?->getState();
+
+            if ($containerState !== null) {
+                $health = $containerState->getHealth();
+
+                if ($health !== null) {
+                    $status = $health->getStatus();
+
+                    switch ($status) {
+                        case 'healthy':
+                            return; // Container is healthy
+                        case 'starting':
+                            // Health check is still in progress; continue waiting
+                            break;
+                        case 'unhealthy':
+                            throw new HealthCheckFailedException($container->getId());
+                        case 'none':
+                            throw new HealthCheckNotConfiguredException($container->getId());
+                        default:
+                            throw new UnknownHealthStatusException($container->getId(), (string)$status);
+                    }
+                } else {
+                    // Health is null; treat as 'none' status
+                    throw new HealthCheckNotConfiguredException($container->getId());
+                }
+            } else {
+                // Container state is null
+                throw new ContainerStateException($container->getId());
             }
 
-            if ($containerStatus === 'unhealthy') {
-                throw new ContainerNotReadyException(sprintf("Health check failed: %s", $containerStatus));
-            }
-
-            usleep($this->pollInterval * 1000);  // Sleep for the polling interval
+            usleep($this->pollInterval * 1000);
         }
     }
 }