OPT: run integration tests in a containerized stack

Author: oduludo

config.py

@@ -59,6 +59,9 @@
         dbname=env('DB_DATABASE'),
     )
 elif env('DB_CONNECTION') == 'postgresql':
+
+    host = 'db' if env('INTEGRATION_TEST') else env('DB_HOST', 'localhost')
+
     DATABASE_URL = "postgresql://{user}:{password}@{host}:{port}/{dbname}".format(
         user=env('DB_USERNAME', 'root'),
         password=env('DB_PASSWORD', ''),

docker-compose.yml

@@ -1,5 +1,6 @@
 services:
   db:
+    hostname: db
     image: postgres
     restart: always
     environment:
@@ -10,6 +11,12 @@ services:
       - pgdata:/var/lib/postgresql/data
     ports:
       - '5432:5432'
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U $${POSTGRES_USER} -d $${POSTGRES_DB}" ]
+      interval: 10s
+      retries: 5
+      start_period: 30s
+      timeout: 10s
 
 volumes:
   pgdata:

elekto/constants.py

@@ -13,16 +13,23 @@
 # limitations under the License.
 #
 # Author(s):         Manish Sahani <rec.manish.sahani@gmail.com>
+import os
 
 # Application's CSRF Security
 CSRF_STATE = 'state'
 AUTH_STATE = 'authentication'
 
-# Github Endpoints
-GITHUB_AUTHORIZE = 'https://github.com/login/oauth/authorize'
-GITHUB_ACCESS = 'https://github.com/login/oauth/access_token'
-GITHUB_PROFILE = 'https://api.github.com/user'
+# GitHub Endpoints
+# TODO: Make the GitHub externally configurable/overridable. If not specified in env, use github.com
+github_host = 'https://github.com'
+# github_host = 'http://localhost:9000'
 
+if os.environ.get('INTEGRATION_TEST') == 'true':
+    github_host = 'http://github:9000'
+
+GITHUB_AUTHORIZE = f'{github_host}/login/oauth/authorize'
+GITHUB_ACCESS = f'{github_host}/login/oauth/access_token'
+GITHUB_PROFILE = f'{github_host}/user'
 
 # Election attributes related constants
 ELEC_STAT_COMPLETED = 'completed'

entrypoint.sh

@@ -12,7 +12,7 @@ if [ "$APP_DEBUG" == "True" ]; then
   echo "in Debug mode"
   ./console --run
 else
-  if [ $APP_CONNECT == "socket" ]; then
+  if [ "$APP_CONNECT" == "socket" ]; then
     # socket mode for fronting by nginx
     echo "with a socket connection on $APP_PORT"
     uwsgi --module elekto:APP --processes 8 --socket :$APP_PORT

integration_tests/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.11
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+RUN playwright install
+RUN playwright install-deps
+
+COPY tests tests
+
+CMD ["pytest", "tests"]

integration_tests/Makefile

@@ -13,3 +13,7 @@ venv: clean
 .PHONY: test
 test:
 	$(PYTEST)
+
+.PHONY: dctest
+dctest:
+	docker compose --profile test up --abort-on-container-exit --exit-code-from integration_tests

integration_tests/README.md

@@ -26,3 +26,5 @@ Tests can be run from the `elekto/integration_tests` directory. Tests runner is
 using Playwright. A virtual environment is required to run the tests. Tests assume all infra runs at the default ports.
 - Create the virtual env with `make venv`. This will also install dependencies.
 - Run tests with `make test`.
+
+To run tests entirely in a Docker Compose setup, use `make dctest`.

integration_tests/docker-compose.yaml

@@ -0,0 +1,42 @@
+include:
+  - ../docker-compose.yml # Defines the `db` service
+  - ../../github-static-mock/docker-compose.yaml
+
+services:
+  integration_tests:
+    build: .
+    environment:
+      ELEKTO_HOST: "elekto:8000"
+      GITHUB_HOST: "github:9000"
+    depends_on:
+      elekto:
+        condition: service_healthy
+      db:
+        condition: service_healthy
+    profiles:
+      - test
+    volumes:
+      - "./tests:/app/tests"
+  elekto:
+    build: ../
+    user: "root" # To access /app/meta/.git/FETCH_HEAD
+    ports:
+      # Links will point to `http://elekto:8000/`, so you must manually patch the URLs to localhost in your browser
+      # after each redirect. Exposing the Elekto service allows for manual checking during tests if desired.
+      - "8000:8000"
+    environment:
+      DB_CONNECTION: postgresql
+      DB_PORT: 5432
+      INTEGRATION_TEST: true
+      APP_PORT: 8000
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://0.0.0.0:8000/app/" ]
+      interval: 10s
+      retries: 5
+      start_period: 5s
+      timeout: 10s
+    depends_on:
+      db:
+        condition: service_healthy
+    profiles:
+      - test

integration_tests/tests/conftest.py

@@ -1,11 +1,12 @@
+import os
 import pytest
 
 from utils.github_mock.client import GithubMockUtilityClient
 
 
 @pytest.fixture
 def host() -> str:
-    return 'http://localhost:8000'
+    return 'http://' + os.environ.get('ELEKTO_HOST', 'localhost:8000')
 
 
 @pytest.fixture
@@ -25,7 +26,7 @@ def app_url(host: str) -> str:
 
 @pytest.fixture
 def github_mock_host() -> str:
-    return 'http://localhost:9000'
+    return 'http://' + os.environ.get('GITHUB_HOST', 'localhost:9000')
 
 
 @pytest.fixture

integration_tests/tests/test_login.py

@@ -1,11 +1,16 @@
+import os
+
 import pytest
 from playwright.sync_api import Page, expect
 
 from utils.github_mock import GithubMockUtilityClient, User
 
 
+ELEKTO_HOST = os.environ.get('ELEKTO_HOST', 'localhost:8000')
+
+
 def logout(page: Page) -> None:
-    page.goto('http://localhost:8000/app')
+    page.goto(f'http://{ELEKTO_HOST}/app')
     logout_link = page.get_by_role('link', name='Logout')
     if logout_link.is_visible():
         logout_link.click()