Add helper functions for HealthCheck

helpers/healthcheck_helpers.py

@@ -1,48 +1,48 @@
-from fastapi import APIRouter, status
+from typing import Dict
-from datetime import datetime
 
-router = APIRouter()
+def health_check() -> Dict[str, str]:
-
-@router.get("/api/health", status_code=status.HTTP_200_OK)
-def health_check():
     """
-    Health check endpoint to verify service status.
+    Health check function to check if the service is running.
 
     Returns:
-        dict: JSON response indicating service is running.
+        A dictionary with a 'status' key indicating the service status.
     """
-    response = {
+    return {"status": "OK"}
-        "status": "ok",
-        "message": "Service is running",
-        "timestamp": datetime.utcnow().isoformat()
-    }
-    return response
 
-def is_service_running() -> bool:
+def is_service_healthy(response: Dict[str, str]) -> bool:
     """
-    Check if the service is running.
+    Check if the service is healthy based on the health check response.
+
+    Args:
+        response: The response dictionary from the health check.
 
     Returns:
-        bool: True if the service is running, False otherwise.
+        True if the service is healthy, False otherwise.
     """
-    # Add any necessary checks or logic here
+    return response.get("status") == "OK"
-    return True
 
-def get_service_uptime() -> float:
+def get_service_status() -> str:
     """
-    Get the service uptime in seconds.
+    Get the service status as a string.
 
     Returns:
-        float: Service uptime in seconds.
+        A string representing the service status.
     """
-    # Add logic to calculate service uptime
+    response = health_check()
-    return 3600.0  # Example: 1 hour uptime
+    if is_service_healthy(response):
+        return "Service is running"
+    else:
+        return "Service is not running"
 
-def get_service_version() -> str:
+def format_health_check_response(response: Dict[str, str]) -> str:
     """
-    Get the current service version.
+    Format the health check response as a string.
+
+    Args:
+        response: The response dictionary from the health check.
 
     Returns:
-        str: Service version string.
+        A formatted string representing the health check response.
     """
-    return "1.0.0"  # Example version
+    status = response.get("status", "Unknown")
+    return f"Service status: {status}"