Implemented ruff linting and format check in CI + basic sanity test using pytest to test the CI workflow

Author: nir1r7

.github/workflows/ci.yml

@@ -31,10 +31,20 @@ jobs:
                 python -m pip install --upgrade pip
                 pip install -r backend/requirements.txt
 
+            # Lint with Ruff
+            - name: Lint with Ruff
+              run: |
+                ruff check backend/app backend/tests
+
+            # Ruff formating check
+            - name: Ruff format check
+              run: |
+                ruff format --check backend/app backend/tests
+
             # Run tests
-            # - name: Run tests
-            #   run: |
-            #     pytest backend/tests/
+            - name: Run tests
+              run: |
+                pytest backend/tests/
 
             # Log in to Github Container Registry
             - name: Log in to GHCR

.gitignore

@@ -43,8 +43,18 @@ htmlcov/
 *.log
 logs/
 
+# Alembic
+alembic/__pycache__/
+alembic/versions/__pycache__/
+
+# Monitoring
+monitoring/grafana/data/
+monitoring/grafana/provisioning/
+*.rrd
+
 # Docker
 docker-compose.override.yml
+*.pid
 
 # OS
 Thumbs.db

backend/alembic/env.py

@@ -1,15 +1,9 @@
 from logging.config import fileConfig
 
-from sqlalchemy import engine_from_config
-from sqlalchemy import pool
+from alembic import context
 from app.core.config import DATABASE_URL
-from sqlalchemy import create_engine
-
-
 from app.db import Base
-from app.models import event
-
-from alembic import context
+from sqlalchemy import create_engine, pool
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
@@ -77,6 +71,7 @@ def run_migrations_offline() -> None:
 #         with context.begin_transaction():
 #             context.run_migrations()
 
+
 def run_migrations_online() -> None:
     sync_url = DATABASE_URL.replace("+asyncpg", "")
 
@@ -95,7 +90,6 @@ def run_migrations_online() -> None:
             context.run_migrations()
 
 
-
 if context.is_offline_mode():
     run_migrations_offline()
 else:

backend/app/api/routes/events.py

@@ -1,12 +1,14 @@
-from fastapi import APIRouter, status
-from app.models.event import EventIn
-from app.db import database
-from app.core.logging import get_logger
 import json
 
+from app.core.logging import get_logger
+from app.db import database
+from app.models.event import EventIn
+from fastapi import APIRouter, status
+
 router = APIRouter(prefix="/events", tags=["events"])
 logger = get_logger("eventrelay.events")
 
+
 @router.post("", status_code=status.HTTP_202_ACCEPTED)
 async def ingest_event(event: EventIn):
     query = """
@@ -16,9 +18,9 @@ async def ingest_event(event: EventIn):
     """
     # Convert payload dict to JSON string for JSONB column
     values = event.dict()
-    values['payload'] = json.dumps(values['payload'])
-    
-    event_id = await database.execute(query = query, values=values)
+    values["payload"] = json.dumps(values["payload"])
+
+    event_id = await database.execute(query=query, values=values)
 
     logger.info(f"Stored event id={event_id} source={event.source} type={event.type}")
 
@@ -27,12 +29,13 @@ async def ingest_event(event: EventIn):
         "id": event_id,
     }
 
+
 @router.get("")
 async def get_all_events():
     query = "SELECT * FROM events"
 
-    events = await database.fetch_all(query = query)
+    events = await database.fetch_all(query=query)
 
-    logger.info(f"Retrieved all events")
+    logger.info("Retrieved all events")
 
-    return events
+    return events

backend/app/core/config.py

@@ -1,4 +1,3 @@
-from dotenv import load_dotenv
 import os
 from pathlib import Path
 

backend/app/core/logging.py

@@ -1,20 +1,22 @@
-import logging
 import json
-from datetime import datetime, UTC
+import logging
+from datetime import UTC, datetime
+
 
 class JsonFormatter(logging.Formatter):
     def format(self, record):
         log = {
             "level": record.levelname,
             "message": record.getMessage(),
-            "time": datetime.now(UTC).isoformat()
+            "time": datetime.now(UTC).isoformat(),
         }
 
         if hasattr(record, "extra"):
             log.update(record.extra)
 
         return json.dumps(log)
-    
+
+
 def get_logger(name: str) -> logging.Logger:
     logger = logging.getLogger(name)
     logger.setLevel(logging.INFO)
@@ -25,4 +27,4 @@ def get_logger(name: str) -> logging.Logger:
     if not logger.handlers:
         logger.addHandler(handler)
 
-    return logger;
+    return logger

backend/app/db.py

@@ -1,7 +1,8 @@
-from sqlalchemy.orm import declarative_base
 from databases import Database
+from sqlalchemy.orm import declarative_base
+
 from app.core.config import DATABASE_URL
 
 database = Database(DATABASE_URL)
 
-Base = declarative_base()
+Base = declarative_base()

backend/app/main.py

@@ -1,20 +1,23 @@
 from fastapi import FastAPI
+
 from app.api.routes import events
 from app.db import database
 
-
 app = FastAPI(title="EventRelay")
 
 app.include_router(events.router)
 
+
 @app.get("/health")
 def health():
     return {"status": "ok"}
 
+
 @app.on_event("startup")
 async def startup():
     await database.connect()
 
+
 @app.on_event("shutdown")
 async def shutdown():
-    await database.disconnect()
+    await database.disconnect()

backend/app/models/event.py

@@ -1,14 +1,17 @@
-from sqlalchemy import Column, Integer, String, JSON, DateTime, func
-from pydantic import BaseModel, Field
 from typing import Dict
+
 from app.db import Base
+from pydantic import BaseModel, Field
+from sqlalchemy import JSON, Column, DateTime, Integer, String, func
+
 
 # pyndantic model (api inp)
 class EventIn(BaseModel):
     source: str = Field(..., example="auth-service")
     type: str = Field(..., example="user.login")
     payload: Dict = Field(..., example={"user_id": 123})
 
+
 # sqlalchemy  (db schema)
 class Event(Base):
     __tablename__ = "events"
@@ -17,4 +20,4 @@ class Event(Base):
     source = Column(String, nullable=False)
     type = Column(String, nullable=False)
     payload = Column(JSON, nullable=False)
-    created_at = Column(DateTime(timezone=True), server_default=func.now())
+    created_at = Column(DateTime(timezone=True), server_default=func.now())

backend/pyproject.toml

@@ -0,0 +1,28 @@
+[tool.ruff]
+# Where Ruff should look
+src = ["app"]
+
+# Python version you target
+target-version = "py311"
+
+# Keep output readable in CI
+line-length = 100
+
+# Only enable high-signal rules
+lint.select = [
+    "F",  # Pyflakes (real bugs)
+    "E",  # Basic syntax errors
+    "W",  # Warnings
+    "I",  # Import sorting
+]
+
+# Ignore noisy / non-critical rules
+lint.ignore = [
+    "E501",  # Line length (we'll format later)
+]
+
+# Never lint generated or external code
+exclude = [
+    "alembic/versions",
+    "venv",
+]