✅ Add an end-to-end integration test (#102)

* ✅ Add an end-to-end integration test

- Reworks top level of the app to avoid creating the app/routes on import.  This allows us to inject settings and get an appropriate app instance.
- Moves postman tests to a dedicated directory
- Adds the necessary scaffolding to integration test the API
- Adds a single test to simulate an election with all guardians
- Updates README, workflows, makefile to run the new test

* Minor README and pyproject file cleanup

Author: rkorsak

.github/workflows/pull_request.yml

@@ -40,5 +40,15 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
-      - name: Run Tests
-        run: make docker-test
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Change Directory
+        run: cd ${{ github.workspace }}
+      - name: Setup Environment
+        run: make environment
+      - name: Run Integration Tests
+        run: make test-integration
+      - name: Run Postman Tests
+        run: make docker-postman-test

.github/workflows/release.yml

@@ -41,8 +41,18 @@ jobs:
     steps:
       - name: Checkout Code
         uses: actions/checkout@v2
-      - name: Run Tests
-        run: make docker-test
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Change Directory
+        run: cd ${{ github.workspace }}
+      - name: Setup Environment
+        run: make environment
+      - name: Run Integration Tests
+        run: make test-integration
+      - name: Run Postman Tests
+        run: make docker-postman-test
 
   release:
     name: Release

Makefile

@@ -63,10 +63,10 @@ docker-run:
 docker-dev:
 	COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -f docker-compose.dev.yml up --build
 
-docker-test:
-	@echo 🧪 RUNNING TESTS IN DOCKER
+docker-postman-test:
+	@echo 🧪 RUNNING POSTMAN TESTS IN DOCKER
 	COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose \
-	-f tests/docker-compose.yml up \
+	-f tests/postman/docker-compose.yml up \
 	--build \
 	--abort-on-container-exit \
 	--exit-code-from test-runner
@@ -75,17 +75,21 @@ docker-test:
 lint:
 	@echo 💚 LINT
 	@echo 1.Pylint
-	poetry run pylint --extension-pkg-whitelist=pydantic app
+	poetry run pylint --extension-pkg-whitelist=pydantic app tests
 	@echo 2.Black Formatting
-	poetry run black --diff --check app
+	poetry run black --diff --check app tests
 	@echo 3.Mypy Static Typing
-	poetry run mypy --config-file=pyproject.toml app
+	poetry run mypy --config-file=pyproject.toml app tests
 	@echo 4.Documentation
 	poetry run mkdocs build --strict
 
 auto-lint:
-	poetry run black app
-	make lint 
+	poetry run black app tests
+	make lint
+
+test-integration:
+	@echo ✅ INTEGRATION TESTS
+	poetry run pytest . -x
 
 # Documentation
 docs-serve:

README.md

@@ -75,13 +75,19 @@ If the code fails to run, [make sure your Python interpreter is set](https://cod
 
 ## 🧪 Testing
 
-A Postman collection is available to test the API located in the `/tests` folder. You can do a few things with this:
+End-to-end integration tests can be found in the `/tests/integration` folder.  To see them in action, run:
+
+```bash
+make test-integration
+```
+
+A Postman collection is also available to test the API located in the `/tests/postman` folder. You can do a few things with this:
 
 - [Import into Postman](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/#importing-data-into-postman) for easy manual testing.
 - Run locally with the [Newman CLI](https://github.com/postmanlabs/newman).
 - Run the APIs and tests entirely in Docker by running:
   ```bash
-  make docker-test
+  make docker-postman-test
   ```
 
 ## 📝 Documentation

app/api/v1/api.py

@@ -0,0 +1,20 @@
+from fastapi import APIRouter
+from app.core.config import ApiMode, Settings
+from . import common
+from . import guardian
+from . import mediator
+
+
+def get_routes(settings: Settings) -> APIRouter:
+    api_router = APIRouter()
+
+    if settings.API_MODE == ApiMode.guardian:
+        api_router.include_router(guardian.router)
+    elif settings.API_MODE == ApiMode.mediator:
+        api_router.include_router(mediator.router)
+    else:
+        raise ValueError(f"Unknown API mode: {settings.API_MODE}")
+
+    api_router.include_router(common.router)
+
+    return api_router

app/api/v1/routes.py

@@ -20,6 +20,3 @@ class Settings(BaseSettings):
 
     class Config:
         case_sensitive = True
-
-
-settings = Settings()

app/core/config.py

@@ -1,29 +1,41 @@
 from logging import getLogger
+from typing import Optional
 from fastapi import FastAPI
 from starlette.middleware.cors import CORSMiddleware
 
-from app.api.v1.api import api_router
-from app.core.config import settings
+from app.api.v1.routes import get_routes
+from app.core.config import Settings
 
-logger = getLogger("app")
+logger = getLogger(__name__)
 
-app = FastAPI(
-    title=settings.PROJECT_NAME, openapi_url=f"{settings.API_V1_STR}/openapi.json"
-)
 
-logger.error(f"Starting API in {settings.API_MODE} mode")
+def get_app(settings: Optional[Settings] = None) -> FastAPI:
+    if not settings:
+        settings = Settings()
 
-# Set all CORS enabled origins
-if settings.BACKEND_CORS_ORIGINS:
-    app.add_middleware(
-        CORSMiddleware,
-        allow_origins=[str(origin) for origin in settings.BACKEND_CORS_ORIGINS],
-        allow_credentials=True,
-        allow_methods=["*"],
-        allow_headers=["*"],
+    web_app = FastAPI(
+        title=settings.PROJECT_NAME, openapi_url=f"{settings.API_V1_STR}/openapi.json"
     )
 
-app.include_router(api_router, prefix=settings.API_V1_STR)
+    logger.error(f"Starting API in {settings.API_MODE} mode")
+
+    # Set all CORS enabled origins
+    if settings.BACKEND_CORS_ORIGINS:
+        web_app.add_middleware(
+            CORSMiddleware,
+            allow_origins=[str(origin) for origin in settings.BACKEND_CORS_ORIGINS],
+            allow_credentials=True,
+            allow_methods=["*"],
+            allow_headers=["*"],
+        )
+
+    routes = get_routes(settings)
+    web_app.include_router(routes, prefix=settings.API_V1_STR)
+
+    return web_app
+
+
+app = get_app()
 
 if __name__ == "__main__":
     # IMPORTANT: This should only be used to debug the application.

app/main.py

@@ -21,15 +21,19 @@ mkdocs = "^1"
 mypy = "^0.782"
 pylint = "^2"
 pytest = "^6"
-
-[build-system]
-requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api"
+requests = "^2.24.0"
 
 [tool.black]
 target-version = ['py38']
 include = '\.pyi?$'
 
+[tool.pylint.'MESSAGES CONTROL']
+disable = "duplicate-code, missing-module-docstring, missing-class-docstring, missing-function-docstring, logging-fstring-interpolation"
+
+[build-system]
+requires = ["poetry>=0.12"]
+build-backend = "poetry.masonry.api"
+
 [mypy]
 python_version = 3.8
 warn_return_any = true
@@ -39,5 +43,3 @@ ignore_missing_imports = true
 follow_imports = "silent"
 show_column_numbers = true
 
-[tool.pylint.'MESSAGES CONTROL']
-disable = "duplicate-code, missing-module-docstring, missing-class-docstring, missing-function-docstring, logging-fstring-interpolation"