Add redis to docker-compose and config, conftest

Author: hjwp

docker-compose.yml

@@ -7,6 +7,7 @@ services:
       dockerfile: Dockerfile
     depends_on:
       - postgres
+      - redis
     environment:
       - DB_HOST=postgres
       - DB_PASSWORD=abc123
@@ -27,3 +28,8 @@ services:
     ports:
       - "54321:5432"
 
+  redis:
+    image: redis:alpine
+    ports:
+      - "63791:6379"
+

mypy.ini

@@ -3,5 +3,5 @@ ignore_missing_imports = False
 mypy_path = ./src
 check_untyped_defs = True
 
-[mypy-pytest.*,sqlalchemy.*]
+[mypy-pytest.*,sqlalchemy.*,redis.*]
 ignore_missing_imports = True

requirements.txt

@@ -2,9 +2,11 @@
 sqlalchemy
 flask
 psycopg2-binary
+redis
 
 # tests
 pytest
 pytest-icdiff
 mypy
 requests
+tenacity

src/allocation/config.py

@@ -13,3 +13,9 @@ def get_api_url():
     host = os.environ.get("API_HOST", "localhost")
     port = 5005 if host == "localhost" else 80
     return f"http://{host}:{port}"
+
+
+def get_redis_host_and_port():
+    host = os.environ.get("REDIS_HOST", "localhost")
+    port = 63791 if host == "localhost" else 6379
+    return dict(host=host, port=port)

tests/conftest.py

@@ -1,10 +1,14 @@
 # pylint: disable=redefined-outer-name
+import shutil
+import subprocess
 import time
 from pathlib import Path
 
 import pytest
+import redis
 import requests
-from requests.exceptions import ConnectionError
+from requests.exceptions import RequestException
+from redis.exceptions import RedisError
 from sqlalchemy.exc import OperationalError
 from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker, clear_mappers
@@ -48,11 +52,22 @@ def wait_for_webapp_to_come_up():
     while time.time() < deadline:
         try:
             return requests.get(url)
-        except ConnectionError:
+        except RequestException:
             time.sleep(0.5)
     pytest.fail("API never came up")
 
 
+def wait_for_redis_to_come_up():
+    deadline = time.time() + 5
+    r = redis.Redis(**config.get_redis_host_and_port())
+    while time.time() < deadline:
+        try:
+            return r.ping()
+        except RedisError:
+            time.sleep(0.5)
+    pytest.fail("Redis never came up")
+
+
 @pytest.fixture(scope="session")
 def postgres_db():
     engine = create_engine(config.get_postgres_uri())
@@ -78,3 +93,15 @@ def restart_api():
     (Path(__file__).parent / "../src/allocation/entrypoints/flask_app.py").touch()
     time.sleep(0.5)
     wait_for_webapp_to_come_up()
+
+
+@pytest.fixture
+def restart_redis_pubsub():
+    wait_for_redis_to_come_up()
+    if not shutil.which("docker-compose"):
+        print("skipping restart, assumes running in container")
+        return
+    subprocess.run(
+        ["docker-compose", "restart", "-t", "0", "redis_pubsub"],
+        check=True,
+    )