feat: add end-to-end tests for Quip API integration

Author: zxkane

.gitignore

@@ -22,7 +22,9 @@ wheels/
 .coverage
 
 # Environment
+!.env.example
 .env
+.env.*
 .venv
 env/
 venv/

README.md

@@ -128,7 +128,11 @@ quip-mcp-server/
 │   └── tools.py        # Tool definitions and handlers
 ├── tests/
 │   ├── __init__.py
-│   └── test_server.py  # Unit tests for the server
+│   ├── test_server.py  # Unit tests for the server
+│   └── e2e/            # End-to-end tests
+│       ├── __init__.py
+│       ├── conftest.py # Test fixtures for e2e tests
+│       └── test_quip_integration.py # Integration tests with Quip API
 ├── .uv/
 │   └── config.toml     # uv configuration settings
 ├── pyproject.toml      # Project metadata and dependencies (includes pytest config)
@@ -191,7 +195,6 @@ python -m src.server
 #### Running Tests
 
 The project uses pytest for testing. To run the tests:
-
 ```bash
 # Install development dependencies
 uv pip install -e ".[dev]"
@@ -201,6 +204,38 @@ pytest
 
 # Run tests with coverage
 pytest --cov=src
+
+# Run only e2e tests
+pytest tests/e2e
+
+# Run a specific e2e test
+pytest tests/e2e/test_quip_integration.py::test_connection
+```
+
+### End-to-End (e2e) Testing
+
+The project includes end-to-end tests that verify integration with the actual Quip API. To run these tests:
+
+1. Create a `.env.local` file in the project root with your test configuration:
+   ```
+   # Quip API token (required)
+   QUIP_TOKEN=your_actual_quip_token_here
+   
+   # Test configuration
+   TEST_THREAD_ID=your_test_spreadsheet_thread_id
+   TEST_SHEET_NAME=Sheet1  # Optional: specific sheet name to test
+   ```
+
+2. Run the e2e tests:
+   ```bash
+   # Run all e2e tests
+   pytest tests/e2e
+   
+   # Run with verbose output
+   pytest -v tests/e2e
+   ```
+
+Note: The e2e tests will be skipped automatically if `.env.local` is missing or if required environment variables are not set.
 ```
 
 #### Debugging

pyproject.toml

@@ -49,6 +49,9 @@ python_files = "test_*.py"
 python_classes = "Test*"
 python_functions = "test_*"
 addopts = "-v"
+markers = [
+    "e2e: marks tests as end-to-end tests that require external resources",
+]
 
 [tool.coverage.run]
 source = ["src"]

tests/e2e/__init__.py

@@ -0,0 +1 @@
+# Mark tests/e2e as a Python package

tests/e2e/conftest.py

@@ -0,0 +1,44 @@
+import os
+import pytest
+from dotenv import load_dotenv
+from src.quip_client import QuipClient
+@pytest.fixture(scope="session", autouse=True)
+def load_env():
+    """
+    Load test environment variables
+    
+    Priority:
+    1. System environment variables
+    2. Variables from .env.local file (if exists)
+    
+    This supports both local development and CI/CD environments
+    """
+    # Try to load .env.local file if it exists
+    local_env = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))), '.env.local')
+    if os.path.exists(local_env):
+        load_dotenv(local_env)
+        print(f"Loaded environment variables from {local_env}")
+    
+    # Check required environment variables (either from .env.local or system)
+    if not os.environ.get("QUIP_TOKEN"):
+        pytest.skip("QUIP_TOKEN environment variable is not set, skipping e2e tests")
+    if not os.environ.get("TEST_THREAD_ID"):
+        pytest.skip("TEST_THREAD_ID environment variable is not set, skipping e2e tests")
+        pytest.skip("TEST_THREAD_ID环境变量未设置，跳过e2e测试")
+
+@pytest.fixture
+def quip_client():
+    """Create a QuipClient instance"""
+    token = os.environ.get("QUIP_TOKEN")
+    base_url = os.environ.get("QUIP_BASE_URL", "https://platform.quip.com")
+    return QuipClient(access_token=token, base_url=base_url)
+
+@pytest.fixture
+def test_thread_id():
+    """Get the test thread ID"""
+    return os.environ.get("TEST_THREAD_ID")
+
+@pytest.fixture
+def test_sheet_name():
+    """Get the test sheet name"""
+    return os.environ.get("TEST_SHEET_NAME")

tests/e2e/test_quip_integration.py

@@ -0,0 +1,97 @@
+import os
+import tempfile
+import pytest
+import csv
+import io
+from src.quip_client import convert_xlsx_to_csv
+
+@pytest.mark.e2e
+def test_connection(quip_client, test_thread_id):
+    """Test connection to Quip API"""
+    thread = quip_client.get_thread(test_thread_id)
+    assert thread is not None
+    assert "thread" in thread
+    print(thread["thread"])
+    assert thread["thread"]["id"] == test_thread_id or \
+      ("secret_path" in thread["thread"] and thread["thread"]["secret_path"] == test_thread_id) or \
+      test_thread_id in thread["thread"]["link"]
+
+@pytest.mark.e2e
+def test_is_spreadsheet(quip_client, test_thread_id):
+    """Test if the thread is correctly identified as a spreadsheet"""
+    is_spreadsheet = quip_client.is_spreadsheet(test_thread_id)
+    assert is_spreadsheet is True
+
+@pytest.mark.e2e
+def test_export_to_xlsx(quip_client, test_thread_id):
+    """Test exporting to XLSX format"""
+    with tempfile.NamedTemporaryFile(suffix=".xlsx", delete=False) as temp_file:
+        xlsx_path = temp_file.name
+    
+    try:
+        # Export to XLSX
+        quip_client.export_thread_to_xlsx(test_thread_id, xlsx_path)
+        assert os.path.exists(xlsx_path)
+        assert os.path.getsize(xlsx_path) > 0
+    finally:
+        # Clean up temporary file
+        if os.path.exists(xlsx_path):
+            os.remove(xlsx_path)
+
+@pytest.mark.e2e
+def test_convert_xlsx_to_csv(quip_client, test_thread_id, test_sheet_name):
+    """Test converting XLSX to CSV and validate content"""
+    with tempfile.NamedTemporaryFile(suffix=".xlsx", delete=False) as temp_file:
+        xlsx_path = temp_file.name
+    
+    try:
+        # Export to XLSX
+        quip_client.export_thread_to_xlsx(test_thread_id, xlsx_path)
+        
+        # Convert to CSV
+        csv_data = convert_xlsx_to_csv(xlsx_path, test_sheet_name)
+        
+        # Validate CSV data
+        assert csv_data is not None
+        assert len(csv_data) > 0
+        
+        # Parse CSV data for more detailed validation
+        csv_reader = csv.reader(io.StringIO(csv_data))
+        rows = list(csv_reader)
+        assert len(rows) > 0  # At least one row of data
+        
+        # You can add more specific validations for your data
+    finally:
+        # Clean up temporary file
+        if os.path.exists(xlsx_path):
+            os.remove(xlsx_path)
+
+@pytest.mark.e2e
+def test_export_to_csv_fallback(quip_client, test_thread_id, test_sheet_name):
+    """Test exporting to CSV format using fallback method"""
+    csv_data = quip_client.export_thread_to_csv_fallback(test_thread_id, test_sheet_name)
+    assert csv_data is not None
+    assert len(csv_data) > 0
+    
+    # Parse CSV data for more detailed validation
+    csv_reader = csv.reader(io.StringIO(csv_data))
+    rows = list(csv_reader)
+    assert len(rows) > 0  # At least one row of data
+
+@pytest.mark.e2e
+def test_error_handling_invalid_thread(quip_client):
+    """Test handling of invalid threadId"""
+    invalid_thread_id = "invalid_thread_id_123456"
+    
+    # Test is_spreadsheet method
+    is_spreadsheet = quip_client.is_spreadsheet(invalid_thread_id)
+    assert is_spreadsheet is False
+    
+    # Test export_thread_to_xlsx method
+    with tempfile.NamedTemporaryFile(suffix=".xlsx") as temp_file:
+        with pytest.raises(Exception):
+            quip_client.export_thread_to_xlsx(invalid_thread_id, temp_file.name)
+    
+    # Test export_thread_to_csv_fallback method
+    with pytest.raises(Exception):
+        quip_client.export_thread_to_csv_fallback(invalid_thread_id)