adds AioRedisHealthProvider

Author: kartaris

README.md

@@ -255,6 +255,16 @@ pyctuator = Pyctuator(...)  # arguments removed for brevity
 pyctuator.register_health_provider(RedisHealthProvider(r))
 ```
 
+Or if your service is using asynchronous Redis, to monitor the connection initialize a `AioRedisHealthProvider`:
+
+```python
+from redis import asyncio as aioredis
+
+r = aioredis.Redis()
+pyctuator = Pyctuator(...)  # arguments removed for brevity
+pyctuator.register_health_provider(AioRedisHealthProvider(r))
+```
+
 ### Custom Environment
 Out of the box, Pyctuator exposes Python's environment variables to Spring Boot Admin.
 

pyctuator/health/aioredis_health_provider.py

@@ -0,0 +1,23 @@
+import asyncio
+
+from pyctuator.health.health_provider import Status
+from pyctuator.health.redis_health_provider import RedisHealthStatus, RedisHealthDetails, RedisHealthProvider
+
+
+class AioRedisHealthProvider(RedisHealthProvider):
+    def get_health(self) -> RedisHealthStatus:
+        try:
+            info = asyncio.run(self.redis.info())
+
+            return RedisHealthStatus(
+                status=Status.UP,
+                details=RedisHealthDetails(
+                    version=info["redis_version"],
+                    mode=info["redis_mode"],
+                ))
+        except Exception as e:  # pylint: disable=broad-except
+            return RedisHealthStatus(
+                status=Status.DOWN,
+                details=RedisHealthDetails(
+                    failure=str(e)
+                ))

tests/health/test_aioredis_health_provider.py

@@ -0,0 +1,47 @@
+# pylint: disable=import-outside-toplevel
+
+import importlib.util
+import os
+
+import pytest
+
+@pytest.fixture
+def require_redis() -> None:
+    if not importlib.util.find_spec("redis"):
+        pytest.skip("redis is missing, skipping")
+
+
+@pytest.mark.usefixtures("require_redis")
+@pytest.fixture
+def require_redis_server() -> None:
+    should_test_with_redis = os.getenv("TEST_REDIS_SERVER", None)
+    if not should_test_with_redis:
+        pytest.skip("No Redis server (env TEST_REDIS_SERVER isn't True), skipping")
+
+@pytest.fixture
+def redis_host() -> str:
+    return os.getenv("REDIS_HOST", "localhost")
+
+@pytest.mark.usefixtures("require_redis", "require_redis_server")
+def test_aioredis_health(redis_host: str) -> None:
+    from redis.asyncio import Redis as AioRedis
+    from pyctuator.health.health_provider import Status
+    from pyctuator.health.aioredis_health_provider import AioRedisHealthProvider, RedisHealthStatus, RedisHealthDetails
+
+    redis_instance = AioRedis(host=redis_host)
+
+    health = AioRedisHealthProvider(redis_instance).get_health()
+    assert health == RedisHealthStatus(Status.UP, RedisHealthDetails("5.0.3", "standalone"))
+
+
+@pytest.mark.usefixtures("require_redis", "require_redis_server")
+def test_aioredis_bad_password(redis_host: str) -> None:
+    from redis.asyncio import Redis as AioRedis
+    from pyctuator.health.health_provider import Status
+    from pyctuator.health.aioredis_health_provider import AioRedisHealthProvider
+
+    redis_instance = AioRedis(host=redis_host, password="blabla")
+
+    health = AioRedisHealthProvider(redis_instance).get_health()
+    assert health.status == Status.DOWN
+    assert "Client sent AUTH, but no password is set" in str(health.details.failure)