Merge pull request RedHatInsights#43 from AparnaKarve/liveness_with_test

Index Route test taking Liveness/Readiness into account

Author: jameswnl

collector/__init__.py

@@ -42,3 +42,4 @@
 
 else:
     LOGGER.warning('No worker set.')
+    WORKER = ''

collector/utils.py

@@ -2,8 +2,10 @@
 import logging
 from threading import current_thread
 
+import sys
 import redis
 import requests
+from gunicorn.arbiter import Arbiter
 
 from .env import SSL_VERIFY, REDIS_ENV, REDIS_PASSWORD, PROCESS_WINDOW
 
@@ -13,10 +15,22 @@
 # pylama:ignore=E1101
 requests.packages.urllib3.disable_warnings()
 
+if not (REDIS_ENV and REDIS_PASSWORD):
+    LOGGER.error('Environment not set properly for Redis')
+    sys.exit(Arbiter.APP_LOAD_ERROR)
 
 REDIS = redis.Redis(**json.loads(REDIS_ENV), password=REDIS_PASSWORD)
 
 
+def ping_redis() -> bool:
+    """Call ping on Redis."""
+    try:
+        return REDIS.ping()
+    except (redis.exceptions.ConnectionError, redis.exceptions.ResponseError):
+        LOGGER.warning('Redis Ping unsuccessful')
+        return False
+
+
 def processed(key: str) -> bool:
     """If an account has been processed within the window."""
     return REDIS.get(key)

server.py

@@ -41,11 +41,24 @@ def create_application():
 @APP.route(f'{ROUTE_PREFIX}/', methods=['GET'], strict_slashes=False)
 def get_root():
     """Root Endpoint for 3scale."""
+    if not collector.WORKER:
+        return_code = 500
+        status = 'Error'
+        message = 'No worker set'
+    elif not collector.utils.ping_redis():
+        return_code = 500
+        status = 'Error'
+        message = 'Required service not operational'
+    else:
+        return_code = 200
+        status = 'OK'
+        message = 'Up and Running'
+
     return jsonify(
-        status='OK',
+        status=status,
         version=API_VERSION,
-        message='Up and Running'
-    )
+        message=message
+    ), return_code
 
 
 @APP.route(f'{ROUTE_PREFIX}/v{API_VERSION}/version', methods=['GET'])

tests/collector/conftest.py renamed to tests/conftest.py

@@ -0,0 +1,56 @@
+import collector
+from server import APP
+
+# R0201 = Method could be a function Used when a method doesn't use its bound
+# instance, and so could be written as a function.
+
+# pylint: disable=R0201
+
+
+class TestRoot:
+    """Test various use cases for the index route."""
+
+    def test_route_with_no_worker(self, mocker):
+        """Test index route when there is no worker set."""
+        client = APP.test_client(mocker)
+        url = '/'
+
+        redis = mocker.MagicMock()
+        mocker.patch.object(collector.utils, 'REDIS', redis)
+
+        response = client.get(url)
+        assert response.get_data() == \
+            b'{"message":"No worker set","status":"Error","version":"1.0"}\n'
+        assert response.status_code == 500
+
+    def test_route_with_redis_present(self, mocker):
+        """Test index route when redis is present."""
+        client = APP.test_client(mocker)
+
+        worker = mocker.MagicMock()
+        mocker.patch.object(collector, 'WORKER', worker)
+
+        url = '/'
+
+        redis = mocker.MagicMock()
+        mocker.patch.object(collector.utils, 'REDIS', redis)
+
+        response = client.get(url)
+        assert response.get_data() == \
+            b'{"message":"Up and Running","status":"OK","version":"1.0"}\n'
+        assert response.status_code == 200
+
+    def test_route_with_redis_absent(self, mocker):
+        """Test index route when there is no redis."""
+        client = APP.test_client(mocker)
+
+        worker = mocker.MagicMock()
+        mocker.patch.object(collector, 'WORKER', worker)
+
+        url = '/'
+
+        response = client.get(url)
+        assert response.get_data() == \
+            b'{"message":"Required service not operational",' \
+            b'"status":"Error","version":"1.0"}\n'
+        assert response.status_code == 500