caddis-plugin: Instructions file for GitHub Copilot

Testing Guidelines

Standards for writing tests for Streamlit, FastAPI, and Python applications.

Test Structure

project/
├── src/
│   └── app/
│       ├── services/
│       └── repositories/
└── tests/
    ├── conftest.py          # Shared fixtures
    ├── unit/
    │   ├── test_services.py
    │   └── test_utils.py
    ├── integration/
    │   ├── test_api.py
    │   └── test_database.py
    └── e2e/
        └── test_workflows.py

---

Naming Conventions

# Test files: test_<module>.py
# test_complaint_service.py

# Test functions: test_<action>_<scenario>_<expected_outcome>
def test_create_complaint_with_valid_data_returns_complaint_id():
    ...

def test_create_complaint_with_missing_description_raises_validation_error():
    ...

# Test classes: Test<ClassName>
class TestComplaintService:
    def test_create_returns_id(self):
        ...

---

Fixtures

conftest.py

# tests/conftest.py
import pytest
from unittest.mock import MagicMock, AsyncMock
from datetime import datetime
from uuid import uuid4

from app.models.complaint import Complaint, ComplaintCreate

@pytest.fixture
def sample_complaint() -> Complaint:
    """Create a sample complaint for testing."""
    return Complaint(
        id=uuid4(),
        customer_id="CUST001",
        complaint_type="billing",
        description="Test complaint description",
        priority=3,
        status="open",
        created_at=datetime.now()
    )

@pytest.fixture
def sample_complaint_create() -> ComplaintCreate:
    """Create sample complaint creation data."""
    return ComplaintCreate(
        customer_id="CUST001",
        complaint_type="billing",
        description="Test complaint description for creation",
        priority=3
    )

@pytest.fixture
def mock_db_adapter():
    """Create a mock database adapter."""
    adapter = MagicMock()
    adapter.fetch_dataframe = MagicMock(return_value=pd.DataFrame())
    adapter.execute = MagicMock(return_value=True)
    return adapter

@pytest.fixture
def mock_async_db():
    """Create a mock async database adapter."""
    adapter = AsyncMock()
    adapter.fetch = AsyncMock(return_value=[])
    adapter.execute = AsyncMock(return_value=True)
    return adapter