Add CI to run checks and tests; reformat everything so those tests pass (#10)

Author: gvanrossum-ms

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+# .github/workflows/ci.yml
+name: CI
+on: [push, pull_request]
+
+jobs:
+  run-make:
+    name: ${{ matrix.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { name: "make check", cmd: "make check" }
+          - { name: "make test",  cmd: "make test" }
+          - { name: "make format --check", cmd: "make format FLAGS=--check" }
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Cache uv
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/uv
+            .venv
+          key: ${{ runner.os }}-uv-${{ hashFiles('**/uv.lock', '**/pyproject.toml') }}
+          restore-keys: ${{ runner.os }}-uv-
+
+      - name: Install uv
+        run: |
+          set -euxo pipefail
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - run: ${{ matrix.cmd }}

.gitignore

@@ -8,7 +8,7 @@ __pycache__
 /evals
 /gmail/client_secret.json
 /gmail/token.json
-/gmail/mail_dump/
+/gmail/*_dump/
 /testdata/Episode_53_Answer_results.json
 /testdata/Episode_53_Search_results.json
 /testdata/MP/

Makefile

@@ -8,7 +8,7 @@ all: venv format check test build
 
 .PHONY: format
 format: venv
-	.venv/bin/black typeagent test tools
+	.venv/bin/black typeagent test tools $(FLAGS)
 
 .PHONY: check
 check: venv

pyproject.toml

@@ -47,6 +47,7 @@ Homepage = "https://github.com/microsoft/TypeAgent/tree/main"
 packages = [
     "typeagent",
     "typeagent.aitools",
+    "typeagent.emails",
     "typeagent.knowpro",
     "typeagent.mcp",
     "typeagent.podcasts",
@@ -58,6 +59,7 @@ packages = [
 
 [tool.setuptools.package-data]
 "typeagent.podcasts" = ["*.json"]
+"typeagent.emails" = ["*.json"]
 
 [tool.pytest.ini_options]
 asyncio_default_fixture_loop_scope = "function"

test/fixtures.py

@@ -45,6 +45,14 @@ def needs_auth() -> None:
     utils.load_dotenv()
 
 
+@pytest.fixture(scope="session")
+def really_needs_auth() -> None:
+    utils.load_dotenv()
+    # Check if any of the supported API keys is set
+    if not (os.getenv("OPENAI_API_KEY") or os.getenv("AZURE_OPENAI_API_KEY")):
+        pytest.skip("No API key found")
+
+
 @pytest.fixture(scope="session")
 def embedding_model() -> AsyncEmbeddingModel:
     """Fixture to create a test embedding model with small embedding size for faster tests."""

test/test_demo.py

@@ -12,7 +12,7 @@
 from typeagent.knowpro.interfaces import ScoredSemanticRefOrdinal
 from typeagent.podcasts import podcast
 
-from fixtures import needs_auth
+from fixtures import really_needs_auth
 
 tests_dir = os.path.dirname(__file__)
 root_dir = os.path.dirname(tests_dir)
@@ -27,7 +27,7 @@
 )
 
 
-def test_main(needs_auth: None):
+def test_main(really_needs_auth: None):
     # auth is needed because we use embeddings.
     # TODO: Only use the embeddings loaded from the file and cached.
     asyncio.run(main(DEFAULT_FILE))

test/test_knowledge.py

@@ -14,7 +14,7 @@
 )
 from typeagent.knowpro import convknowledge, kplib
 
-from fixtures import needs_auth  # type: ignore  # Used!
+from fixtures import really_needs_auth
 
 
 class MockKnowledgeExtractor:
@@ -34,7 +34,7 @@ def mock_knowledge_extractor() -> convknowledge.KnowledgeExtractor:
     return MockKnowledgeExtractor()  # type: ignore
 
 
-def test_create_knowledge_extractor(needs_auth: None):
+def test_create_knowledge_extractor(really_needs_auth: None):
     """Test creating a knowledge extractor."""
     extractor = create_knowledge_extractor()
     assert isinstance(extractor, convknowledge.KnowledgeExtractor)

test/test_property_index_population.py

@@ -21,6 +21,8 @@
 from typeagent.podcasts.podcast import PodcastMessage
 from typeagent.storage import SqliteStorageProvider
 
+from fixtures import really_needs_auth
+
 
 class MockEmbeddingModel(AsyncEmbeddingModel):
     def __init__(self):
@@ -33,7 +35,7 @@ async def get_embeddings(self, keys: list[str]) -> np.ndarray:
 
 
 @pytest.mark.asyncio
-async def test_property_index_population_from_database():
+async def test_property_index_population_from_database(really_needs_auth):
     """Test that property index is correctly populated when reopening a database."""
     load_dotenv()
     temp_db_path = tempfile.mktemp(suffix=".sqlite")

test/test_query_method.py

@@ -11,15 +11,11 @@
 from typeagent.knowpro.convsettings import ConversationSettings
 from typeagent.transcripts.transcript import TranscriptMessage, TranscriptMessageMeta
 
-
-@pytest.fixture(scope="session")
-def needs_auth() -> None:
-    """Load environment variables for authentication."""
-    load_dotenv()
+from fixtures import really_needs_auth
 
 
 @pytest.mark.asyncio
-async def test_query_method_basic(needs_auth: None):
+async def test_query_method_basic(really_needs_auth: None):
     """Test the basic query method workflow."""
     # Create a conversation with some test data
     test_model = AsyncEmbeddingModel(model_name=TEST_MODEL_NAME)
@@ -65,7 +61,7 @@ async def test_query_method_basic(needs_auth: None):
 
 
 @pytest.mark.asyncio
-async def test_query_method_empty_conversation(needs_auth: None):
+async def test_query_method_empty_conversation(really_needs_auth: None):
     """Test query method on an empty conversation."""
     test_model = AsyncEmbeddingModel(model_name=TEST_MODEL_NAME)
     settings = ConversationSettings(model=test_model)

test/test_related_terms_index_population.py

@@ -4,7 +4,6 @@
 
 """Test to verify related terms index population in storage providers."""
 
-import asyncio
 import tempfile
 import os
 import pytest
@@ -18,13 +17,14 @@
     MessageTextIndexSettings,
     RelatedTermIndexSettings,
 )
-from typeagent.storage.memory.reltermsindex import RelatedTermsIndex
 from typeagent.podcasts.podcast import PodcastMessage, PodcastMessageMeta
 from typeagent.storage import SqliteStorageProvider
 
+from fixtures import really_needs_auth
+
 
 @pytest.mark.asyncio
-async def test_related_terms_index_population_from_database():
+async def test_related_terms_index_population_from_database(really_needs_auth):
     """Test that related terms index is correctly populated when reopening a database."""
     load_dotenv()
     temp_db_path = tempfile.mktemp(suffix=".sqlite")