setup test client for database and without database with test coverage 100% for frontend routes

Author: john0isaac

tests/conftest.py

@@ -0,0 +1,67 @@
+import pytest
+from fastapi.testclient import TestClient
+from sqlalchemy import create_engine
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy.pool import StaticPool
+
+from fastapi_app import create_app
+from fastapi_app.postgres_models import Base
+
+POSTGRESQL_DATABASE_URL = "postgresql://admin:postgres@localhost:5432/postgres"
+
+
+# Create a SQLAlchemy engine
+engine = create_engine(
+    POSTGRESQL_DATABASE_URL,
+    poolclass=StaticPool,
+)
+
+# Create a sessionmaker to manage sessions
+TestingSessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
+
+
+@pytest.fixture(scope="session")
+def setup_database():
+    """Create tables in the database for all tests."""
+    try:
+        Base.metadata.create_all(bind=engine)
+        yield
+        Base.metadata.drop_all(bind=engine)
+    except Exception as e:
+        pytest.skip(f"Unable to connect to the database: {e}")
+
+
+@pytest.fixture(scope="function")
+def db_session(setup_database):
+    """Create a new database session with a rollback at the end of the test."""
+    connection = engine.connect()
+    transaction = connection.begin()
+    session = TestingSessionLocal(bind=connection)
+    yield session
+    session.close()
+    transaction.rollback()
+    connection.close()
+
+
+@pytest.fixture(scope="function")
+def test_db_client(db_session):
+    """Create a test client that uses the override_get_db fixture to return a session."""
+
+    def override_db_session():
+        try:
+            yield db_session
+        finally:
+            db_session.close()
+
+    app = create_app()
+    app.router.lifespan = override_db_session
+    with TestClient(app) as test_client:
+        yield test_client
+
+
+@pytest.fixture(scope="function")
+def test_client():
+    """Create a test client."""
+    app = create_app()
+    with TestClient(app) as test_client:
+        yield test_client

tests/test_endpoints.py

@@ -0,0 +1,71 @@
+import os
+
+import pytest
+
+
+@pytest.mark.asyncio
+async def test_index(test_client):
+    """test the index route"""
+    response = test_client.get("/")
+
+    html_index_file_path = "src/static/index.html"
+    with open(html_index_file_path, "rb") as f:
+        html_index_file = f.read()
+
+    assert response.status_code == 200
+    assert response.headers["Content-Type"] == "text/html; charset=utf-8"
+    assert response.headers["Content-Length"] == str(len(html_index_file))
+    assert html_index_file == response.content
+
+
+@pytest.mark.asyncio
+async def test_favicon(test_client):
+    """test the favicon route"""
+    response = test_client.get("/favicon.ico")
+
+    favicon_file_path = "src/static/favicon.ico"
+    with open(favicon_file_path, "rb") as f:
+        favicon_file = f.read()
+
+    assert response.status_code == 200
+    assert response.headers["Content-Type"] == "image/vnd.microsoft.icon"
+    assert response.headers["Content-Length"] == str(len(favicon_file))
+    assert favicon_file == response.content
+
+
+@pytest.mark.asyncio
+async def test_assets_non_existent_404(test_client):
+    """test the assets route with a non-existent file"""
+    response = test_client.get("/assets/manifest.json")
+
+    assert response.status_code == 404
+    assert response.headers["Content-Type"] == "application/json"
+    assert response.headers["Content-Length"] == "22"
+    assert b'{"detail":"Not Found"}' in response.content
+
+
+@pytest.mark.asyncio
+async def test_assets(test_client):
+    """test the assets route with an existing file"""
+    assets_dir_path = "src/static/assets"
+    assets_file_path = os.listdir(assets_dir_path)[0]
+
+    with open(os.path.join(assets_dir_path, assets_file_path), "rb") as f:
+        assets_file = f.read()
+
+    response = test_client.get(f"/assets/{assets_file_path}")
+
+    assert response.status_code == 200
+    assert response.headers["Content-Length"] == str(len(assets_file))
+    assert assets_file == response.content
+
+
+@pytest.mark.asyncio
+async def test_chat_non_json_415(test_client):
+    """test the chat route with a non-json request"""
+    response = test_client.post("/chat")
+
+    assert response.status_code == 422
+    assert response.headers["Content-Type"] == "application/json"
+    assert response.headers["Content-Length"] == "82"
+    assert b'{"detail":[{"type":"missing"' in response.content