Add wait_ready script and update CI workflow to check API readiness

Author: tbotnz

.github/workflows/testrun.yml

@@ -35,8 +35,8 @@ jobs:
       - name: Start the stack
         run: docker compose -f docker-compose.ci.yml up -d
 
-      - name: Wait for services to be healthy
-        run: docker compose -f docker-compose.ci.yml exec -T netpalm-api-server python -c "print('ready')"
+      - name: Wait for API server to be ready
+        run: docker compose -f docker-compose.ci.yml exec -T netpalm-api-server python -m netpalm.wait_ready
 
       - name: Integration tests
         run: docker compose -f docker-compose.ci.yml exec -T netpalm-api-server pytest -m "not fulllab" -vv tests/integration

netpalm/wait_ready.py

@@ -0,0 +1,28 @@
+"""Block until the local gunicorn process is accepting connections on port 9000."""
+
+import socket
+import sys
+import time
+
+HOST = "127.0.0.1"
+PORT = 9000
+TIMEOUT = 120
+INTERVAL = 2
+
+
+def main() -> None:
+    deadline = time.monotonic() + TIMEOUT
+    while time.monotonic() < deadline:
+        try:
+            with socket.create_connection((HOST, PORT), timeout=2):
+                print(f"netpalm API ready on {HOST}:{PORT}")
+                return
+        except OSError:
+            time.sleep(INTERVAL)
+
+    print(f"netpalm API not ready after {TIMEOUT}s", file=sys.stderr)
+    sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()