Integrated pytest-recording into conftest.py

Author: jamesbraza

.pre-commit-config.yaml

@@ -36,6 +36,7 @@ repos:
         args:
           - --word-list=.secrets.allowlist
           - --exclude-files=.secrets.baseline$
+        exclude: tests/cassettes
   - repo: https://github.com/jumanjihouse/pre-commit-hooks
     rev: 3.0.0
     hooks:

.secrets.allowlist

@@ -0,0 +1,2 @@
+authorization
+x-api-key

pyproject.toml

@@ -74,6 +74,7 @@ tests-root = "tests"
 check-filenames = true
 check-hidden = true
 ignore-words-list = "astroid,ser"
+skip = "tests/cassettes/*"
 
 [tool.mypy]
 # Type-checks the interior of functions without type annotations.

tests/__init__.py

@@ -1,3 +1,4 @@
+import pathlib
 from enum import StrEnum
 
 
@@ -6,3 +7,7 @@ class CILLMModelNames(StrEnum):
 
     ANTHROPIC = "claude-3-haiku-20240307"  # Cheap and not Anthropic's cutting edge
     OPENAI = "gpt-4o-mini-2024-07-18"  # Cheap and not OpenAI's cutting edge
+
+
+TESTS_DIR = pathlib.Path(__file__).parent
+CASSETTES_DIR = TESTS_DIR / "cassettes"

tests/conftest.py

@@ -1,5 +1,6 @@
 import os
 import random
+from typing import Any
 
 import numpy as np
 import pytest
@@ -8,6 +9,8 @@
 
 from ldp.utils import configure_log_levels
 
+from . import CASSETTES_DIR
+
 IN_GITHUB_ACTIONS: bool = os.getenv("GITHUB_ACTIONS") == "true"
 
 
@@ -35,3 +38,18 @@ def set_seed(seed: int | None) -> None:
 def fixture_seed_zero() -> None:
     """Set a 0 seed to minimize the chances of test flakiness."""
     set_seed(0)
+
+
+OPENAI_API_KEY_HEADER = "authorization"
+ANTHROPIC_API_KEY_HEADER = "x-api-key"
+
+
+@pytest.fixture(scope="session", name="vcr_config")
+def fixture_vcr_config() -> dict[str, Any]:
+    return {
+        "filter_headers": [OPENAI_API_KEY_HEADER, ANTHROPIC_API_KEY_HEADER, "cookie"],
+        "record_mode": "once",
+        "match_on": ["method", "host", "path", "query"],
+        "allow_playback_repeats": True,
+        "cassette_library_dir": str(CASSETTES_DIR),
+    }