Fix: CI/CD Quality Checks (Linting & Formatting)

parvenuprompting · parvenuprompting · commit e277c533a2e3 · 2026-01-04T20:10:26.000+01:00
- Black: Auto-formatted 3 files (search.py, ingestion.py, test_search.py).
- Ruff: Fixed 86 linting errors (55 auto, 31 manual).
  - Added missing imports (select, AsyncGenerator).
  - Fixed exception handling (raise from err).
  - Fixed None comparisons (is_(None)).
  - Removed commented code.
  - Simplified return statements and nested if.
  - Fixed test file import ordering.
- CI: Added Black format check to workflow.
- Tests: 30/30 passed, 80% coverage maintained.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,6 +41,10 @@ jobs:
               run: |
                   poetry install
 
+            - name: Check code formatting with Black
+              run: |
+                  poetry run black --check app tests
+
             - name: Lint with Ruff
               run: |
                   poetry run ruff check .
diff --git a/app/api/deps.py b/app/api/deps.py
@@ -1,21 +1,21 @@
 """API dependencies."""
-from typing import Annotated, AsyncGenerator
+from collections.abc import AsyncGenerator
+from typing import Annotated
 
-from fastapi import Depends, HTTPException, status, Security
-from fastapi.security import OAuth2PasswordBearer, APIKeyHeader
+from fastapi import Depends, HTTPException, Security, status
+from fastapi.security import APIKeyHeader, OAuth2PasswordBearer
 from jose import JWTError
 from pydantic import ValidationError
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from app.core import security, auth_client
+from app.core import auth_client, security
 from app.core.config import settings
 from app.db.session import SessionLocal
-from app.models.user import User
 from app.models.client import Client
-from app.repositories.user import user_repo
+from app.models.user import User
 from app.repositories.api_key import api_key_repo
+from app.repositories.user import user_repo
 from app.schemas.token import TokenPayload
-from app.schemas.user import UserResponse
 
 # OAuth2 scheme for JWT token in Authorization header
 reusable_oauth2 = OAuth2PasswordBearer(tokenUrl=f"{settings.api_v1_str}/admin/auth/login")
@@ -52,11 +52,11 @@ async def get_current_user(session: SessionDep, token: TokenDep) -> User:
                 headers={"WWW-Authenticate": "Bearer"},
             )
         token_data = TokenPayload(**payload)
-    except (JWTError, ValidationError):
+    except (JWTError, ValidationError) as err:
         raise HTTPException(
             status_code=status.HTTP_403_FORBIDDEN,
             detail="Could not validate credentials",
-        )
+        ) from err
 
     user = await user_repo.get(session, token_data.sub)  # type: ignore # sub is UUID in string
     if not user:
@@ -91,10 +91,6 @@ async def get_current_client(
             detail="Invalid or expired API Key",
         )
 
-    # Update last used (fire and forget / async task in real app)
-    # db_key.last_used_at = datetime.utcnow()
-    # await session.commit()
-
     if not db_key.client.is_license_valid:
         raise HTTPException(
             status_code=status.HTTP_403_FORBIDDEN,
@@ -109,7 +105,7 @@ def get_content_service() -> "ContentService":
     Dependency to get content service instance.
     In a real app with more complex deps, this could initialize the service.
     """
-    from app.services.content import ContentService, content_service as _content_service
+    from app.services.content import content_service as _content_service
 
     return _content_service
 
diff --git a/app/api/v1/admin/auth.py b/app/api/v1/admin/auth.py
@@ -4,7 +4,6 @@
 
 from fastapi import APIRouter, Depends, HTTPException, status
 from fastapi.security import OAuth2PasswordRequestForm
-from sqlalchemy.ext.asyncio import AsyncSession
 
 from app.api.deps import SessionDep
 from app.core import security
diff --git a/app/api/v1/content/search.py b/app/api/v1/content/search.py
@@ -21,11 +21,10 @@ async def search_content(
 ) -> Any:
     """
     Search for content using semantic similarity (RAG).
-    
+
     Returns the most relevant snippets for the given query.
     Access is restricted to the authenticated client's private data + shared data.
     """
-    results = await search_service.search_content(
+    return await search_service.search_content(
         session=db, query=query, client=current_client, limit=limit
     )
-    return results
diff --git a/app/api/v1/router.py b/app/api/v1/router.py
@@ -2,7 +2,7 @@
 from fastapi import APIRouter
 
 from app.api.v1.admin import auth
-from app.api.v1.content import guides, topics, search
+from app.api.v1.content import guides, search, topics
 
 api_router = APIRouter()
 
diff --git a/app/core/config.py b/app/core/config.py
@@ -78,13 +78,12 @@ def parse_cors_origins(cls, v: str) -> list[str]:
     @classmethod
     def validate_production_secrets(cls, v: str, info: ValidationInfo) -> str:
         """Ensure default secrets are not used in production."""
-        if info.data.get("environment") == "production":
-            # Check if value contains default insecure strings
-            if "insecure" in v:
-                name = info.field_name
-                raise ValueError(
-                    f"Production configuration error: {name} must be changed from default insecure value."
-                )
+        if info.data.get("environment") == "production" and "insecure" in v:
+            name = info.field_name
+            raise ValueError(
+                f"Production configuration error: {name} must be changed "
+                f"from default insecure value."
+            )
         return v
 
     @property
diff --git a/app/models/api_key.py b/app/models/api_key.py
@@ -1,6 +1,6 @@
 """API Key model for B2B authentication."""
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING
 from uuid import UUID
 
@@ -39,7 +39,7 @@ class APIKey(Base):
     is_active: Mapped[bool] = mapped_column(Boolean, default=True, nullable=False, index=True)
     last_used_at: Mapped[datetime | None] = mapped_column(DateTime, nullable=True)
     created_at: Mapped[datetime] = mapped_column(
-        DateTime, default=lambda: datetime.now(timezone.utc)
+        DateTime, default=lambda: datetime.now(UTC)
     )
     expires_at: Mapped[datetime | None] = mapped_column(
         DateTime, nullable=True
diff --git a/app/models/client.py b/app/models/client.py
@@ -1,7 +1,7 @@
 """Client model for B2B licensing."""
 import enum
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING
 
 from sqlalchemy import Boolean, Column, DateTime, String, text
@@ -41,11 +41,11 @@ class Client(Base):
     )
     is_active = Column(Boolean, default=True, nullable=False, index=True)
     license_expires_at = Column(DateTime, nullable=True)  # None = permanent
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
     updated_at = Column(
         DateTime,
-        default=lambda: datetime.now(timezone.utc),
-        onupdate=lambda: datetime.now(timezone.utc),
+        default=lambda: datetime.now(UTC),
+        onupdate=lambda: datetime.now(UTC),
         nullable=False,
     )
 
diff --git a/app/models/guide.py b/app/models/guide.py
@@ -1,7 +1,7 @@
 """Guide model - main documentation files."""
 import enum
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING
 
 from sqlalchemy import Column, DateTime, ForeignKey, Index, Integer, String, Text, text
@@ -58,11 +58,11 @@ class Guide(Base):
         SQLEnum(ComplexityLevel), nullable=False, index=True
     )
     estimated_read_time = Column(Integer, default=0)  # minutes
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
     updated_at = Column(
         DateTime,
-        default=lambda: datetime.now(timezone.utc),
-        onupdate=lambda: datetime.now(timezone.utc),
+        default=lambda: datetime.now(UTC),
+        onupdate=lambda: datetime.now(UTC),
         nullable=False,
     )
     # Relationships
diff --git a/app/models/section.py b/app/models/section.py
@@ -1,7 +1,7 @@
 """Section model - logical blocks within guides."""
 import enum
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING
 
 from sqlalchemy import Column, DateTime, ForeignKey, Integer, String, Text, text
@@ -47,11 +47,11 @@ class Section(Base):
     content = Column(Text, nullable=False)  # Markdown content
     order = Column(Integer, nullable=False, index=True)  # For sequencing
     section_type: Mapped[SectionType] = mapped_column(SQLEnum(SectionType), nullable=False)
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
     updated_at = Column(
         DateTime,
-        default=lambda: datetime.now(timezone.utc),
-        onupdate=lambda: datetime.now(timezone.utc),
+        default=lambda: datetime.now(UTC),
+        onupdate=lambda: datetime.now(UTC),
         nullable=False,
     )
     # Relationships
diff --git a/app/models/snippet.py b/app/models/snippet.py
@@ -1,14 +1,14 @@
 """Snippet model - reusable prompts, rules, and code examples."""
 import enum
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING, Optional
 
+from pgvector.sqlalchemy import Vector
 from sqlalchemy import Boolean, Column, DateTime, ForeignKey, String, Text, text
 from sqlalchemy import Enum as SQLEnum
 from sqlalchemy.dialects.postgresql import UUID as PGUUID
 from sqlalchemy.orm import Mapped, mapped_column, relationship
-from pgvector.sqlalchemy import Vector
 
 from app.db.session import Base
 
@@ -58,7 +58,7 @@ class Snippet(Base):
     language = Column(String(50), nullable=True)  # For code snippets: "python", "bash", etc.
     is_featured = Column(Boolean, default=False, nullable=False, index=True)
     embedding = Column(Vector(1536))  # OpenAI embeddings dimensionality
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
 
     # Relationships
     section: Mapped[Optional["Section"]] = relationship("Section", back_populates="snippets")
diff --git a/app/models/topic.py b/app/models/topic.py
@@ -1,10 +1,9 @@
 """Topic model - high-level content categories."""
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING
 
-from sqlalchemy import Column, DateTime, String, Text, text
-from sqlalchemy import Column, DateTime, String, Text, text, ForeignKey
+from sqlalchemy import Column, DateTime, ForeignKey, String, Text, text
 from sqlalchemy.dialects.postgresql import UUID as PGUUID
 from sqlalchemy.orm import Mapped, relationship
 
@@ -35,11 +34,11 @@ class Topic(Base):
         nullable=True,
         index=True,
     )
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
     updated_at = Column(
         DateTime,
-        default=lambda: datetime.now(timezone.utc),
-        onupdate=lambda: datetime.now(timezone.utc),
+        default=lambda: datetime.now(UTC),
+        onupdate=lambda: datetime.now(UTC),
         nullable=False,
     )
     # Relationships
diff --git a/app/models/user.py b/app/models/user.py
@@ -1,6 +1,6 @@
 """User model for admin authentication."""
 import uuid
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 
 from sqlalchemy import Boolean, Column, DateTime, String, text
 from sqlalchemy.dialects.postgresql import UUID as PGUUID
@@ -23,7 +23,7 @@ class User(Base):
     hashed_password = Column(String(255), nullable=False)
     is_active = Column(Boolean, default=True, nullable=False)
     is_superuser = Column(Boolean, default=False, nullable=False)
-    created_at = Column(DateTime, default=lambda: datetime.now(timezone.utc), nullable=False)
+    created_at = Column(DateTime, default=lambda: datetime.now(UTC), nullable=False)
 
     def __repr__(self) -> str:
         return f"<User {self.email}>"
diff --git a/app/repositories/snippet.py b/app/repositories/snippet.py
@@ -1,6 +1,7 @@
 """Snippet repository for reusable content."""
 import uuid
-from sqlalchemy import select, or_
+
+from sqlalchemy import or_, select
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from app.models.snippet import Snippet
diff --git a/app/services/content.py b/app/services/content.py
@@ -2,19 +2,18 @@
 from uuid import UUID
 
 from fastapi import HTTPException, status
+from sqlalchemy import or_, select
 from sqlalchemy.ext.asyncio import AsyncSession
 
-from sqlalchemy import or_
-
+from app.models.client import Client
 from app.models.guide import Guide
 from app.models.snippet import Snippet
 from app.models.topic import Topic
-from app.models.client import Client
 from app.repositories.guide import guide_repo
 from app.repositories.snippet import snippet_repo
 from app.repositories.topic import topic_repo
 from app.schemas.guide import GuideCreate, GuideUpdate
-from app.schemas.snippet import SnippetCreate, SnippetUpdate
+from app.schemas.snippet import SnippetCreate
 from app.schemas.topic import TopicCreate, TopicUpdate
 from app.services.ingestion import ingestion_service
 
@@ -26,10 +25,9 @@ class ContentService:
     async def get_topics(
         self, session: AsyncSession, current_client: Client, skip: int = 0, limit: int = 100
     ) -> list[Topic]:
-        # Filter: Global (None) or Owned (client.id)
         query = (
             select(Topic)
-            .where(or_(Topic.client_id == None, Topic.client_id == current_client.id))
+            .where(or_(Topic.client_id.is_(None), Topic.client_id == current_client.id))
             .offset(skip)
             .limit(limit)
         )
@@ -95,7 +93,7 @@ async def get_guides(
             select(Guide)
             .where(
                 Guide.topic_id == topic_id,
-                or_(Guide.client_id == None, Guide.client_id == current_client.id),
+                or_(Guide.client_id.is_(None), Guide.client_id == current_client.id),
             )
             .offset(skip)
             .limit(limit)
diff --git a/app/services/ingestion.py b/app/services/ingestion.py
@@ -1,5 +1,4 @@
 """Ingestion service for generating embeddings."""
-from typing import List
 
 from loguru import logger
 from openai import AsyncOpenAI
@@ -16,14 +15,12 @@ def __init__(self) -> None:
         if settings.OPENAI_API_KEY:
             self.client = AsyncOpenAI(api_key=settings.OPENAI_API_KEY)
 
-    async def generate_embedding(self, text: str) -> List[float]:
+    async def generate_embedding(self, text: str) -> list[float]:
         """
         Generate embedding for the given text using OpenAI.
         """
         if not self.client:
-            logger.warning(
-                "OPENAI_API_KEY not set. Returning dummy embedding."
-            )
+            logger.warning("OPENAI_API_KEY not set. Returning dummy embedding.")
             return [0.0] * self.vector_dim
 
         try:
diff --git a/app/services/search.py b/app/services/search.py
@@ -28,10 +28,9 @@ async def search_content(
         embedding = await ingestion_service.generate_embedding(query)
 
         # 2. Find Similar (pgvector)
-        snippets = await snippet_repo.find_similar(
+        return await snippet_repo.find_similar(
             session, embedding=embedding, client_id=client.id, limit=limit
         )
-        return snippets
 
 
 search_service = SearchService()
diff --git a/gunicorn_conf.py b/gunicorn_conf.py
@@ -1,5 +1,4 @@
 import multiprocessing
-import os
 
 # Server socket
 bind = "0.0.0.0:8000"
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/unit/test_content_service.py b/tests/unit/test_content_service.py
diff --git a/tests/unit/test_core_api_key.py b/tests/unit/test_core_api_key.py
diff --git a/tests/unit/test_search.py b/tests/unit/test_search.py
