Merge pull request #450 from revsys/feature/allow-redis-connection-kwargs

Feature/allow redis connection kwargs

Author: seanpar203

.gitignore

@@ -107,4 +107,5 @@ ENV/
 .direnv
 
 # mac
-.DS_Store
+.DS_Store
+.aider*

README.md

@@ -138,6 +138,8 @@ It can be customized by setting `HEALTHCHECK_CACHE_KEY` to another value:
     HEALTHCHECK_CACHE_KEY = "custom_healthcheck_key"
 ```
 
+Additional connection options may be specified by defining a variable ``HEALTHCHECK_REDIS_URL_OPTIONS`` on the settings module.
+
 ## Setting up monitoring
 
 You can use tools like Pingdom, StatusCake or other uptime robots to monitor service status.

docs/settings.rst

@@ -59,6 +59,10 @@ The cache backend uses the following setting:
      - String
      - `djangohealthcheck_test`
      - Specifies the name of the key to write to and read from to validate that the cache is working.
+   * - `HEALTHCHECK_REDIS_URL_OPTIONS`
+     - Dict
+     - {}
+     - Additional arguments which will be passed as keyword arguments to the Redis connection class initialiser.
 
 `psutil`
 --------

health_check/contrib/redis/backends.py

@@ -13,6 +13,7 @@ class RedisHealthCheck(BaseHealthCheckBackend):
     """Health check for Redis."""
 
     redis_url = getattr(settings, "REDIS_URL", "redis://localhost/1")
+    redis_url_options = getattr(settings, "HEALTHCHECK_REDIS_URL_OPTIONS", {})
 
     def check_status(self):
         """Check Redis service by pinging the redis instance with a redis connection."""
@@ -21,7 +22,7 @@ def check_status(self):
         logger.debug("Attempting to connect to redis...")
         try:
             # conn is used as a context to release opened resources later
-            with from_url(self.redis_url) as conn:
+            with from_url(self.redis_url, **self.redis_url_options) as conn:
                 conn.ping()  # exceptions may be raised upon ping
         except ConnectionRefusedError as e:
             self.add_error(

tests/test_redis.py

@@ -28,7 +28,7 @@ def test_redis_refused_connection(self, mocked_connection, mocked_getattr):
         assert len(redis_healthchecker.errors), 1
 
         # mock assertions
-        mocked_connection.assert_called_once_with("redis://localhost/1")
+        mocked_connection.assert_called_once_with("redis://localhost/1", **{})
 
     @mock.patch("health_check.contrib.redis.backends.getattr")
     @mock.patch("health_check.contrib.redis.backends.from_url")
@@ -50,7 +50,7 @@ def test_redis_timeout_error(self, mocked_connection, mocked_getattr):
         assert len(redis_healthchecker.errors), 1
 
         # mock assertions
-        mocked_connection.assert_called_once_with("redis://localhost/1")
+        mocked_connection.assert_called_once_with("redis://localhost/1", **{})
 
     @mock.patch("health_check.contrib.redis.backends.getattr")
     @mock.patch("health_check.contrib.redis.backends.from_url")
@@ -72,7 +72,7 @@ def test_redis_con_limit_exceeded(self, mocked_connection, mocked_getattr):
         assert len(redis_healthchecker.errors), 1
 
         # mock assertions
-        mocked_connection.assert_called_once_with("redis://localhost/1")
+        mocked_connection.assert_called_once_with("redis://localhost/1", **{})
 
     @mock.patch("health_check.contrib.redis.backends.getattr")
     @mock.patch("health_check.contrib.redis.backends.from_url")
@@ -92,4 +92,4 @@ def test_redis_conn_ok(self, mocked_connection, mocked_getattr):
         assert len(redis_healthchecker.errors), 0
 
         # mock assertions
-        mocked_connection.assert_called_once_with("redis://localhost/1")
+        mocked_connection.assert_called_once_with("redis://localhost/1", **{})