docstrings and doctests

Signed-off-by: Keval Mahajan <mahajankeval23@gmail.com>

Author: kevalmahajan

mcpgateway/services/gateway_service.py

@@ -2145,6 +2145,22 @@ async def check_health_of_gateways(self, db: Session, gateways: List[DbGateway],
         semaphore = asyncio.Semaphore(concurrency_limit)
 
         async def limited_check(gateway: DbGateway):
+            """
+            Checks the health of a single gateway while respecting a concurrency limit.
+
+            This function checks the health of the given database gateway, ensuring that
+            the number of concurrent checks does not exceed a predefined limit. The check
+            is performed asynchronously and uses a semaphore to manage concurrency.
+
+            Args:
+                gateway (DbGateway): The database gateway whose health is to be checked.
+
+            Returns:
+                None: This function performs an action (checking health) but does not return any value.
+
+            Raises:
+                Any exceptions raised during the health check will be propagated to the caller.
+            """
             async with semaphore:
                 await self._check_single_gateway_health(db, gateway, user_email)
 

mcpgateway/services/server_service.py

@@ -1229,7 +1229,16 @@ async def aggregate_metrics(self, db: Session) -> ServerMetrics:
             >>> from unittest.mock import MagicMock
             >>> service = ServerService()
             >>> db = MagicMock()
-            >>> db.execute.return_value.scalar.return_value = 0
+            >>> # Mocking the result to return values that can be compared with integers
+            >>> db.execute.return_value.one.return_value = MagicMock(
+            ...     total_executions=10,
+            ...     successful_executions=8,
+            ...     failed_executions=2,
+            ...     min_response_time=0.1,
+            ...     max_response_time=0.5,
+            ...     avg_response_time=0.3,
+            ...     last_execution_time="2023-12-01T12:00:00"
+            ... )
             >>> import asyncio
             >>> result = asyncio.run(service.aggregate_metrics(db))
             >>> hasattr(result, 'total_executions')