feat: replace pytest-vcr by pytest-recording

1. pytest-vcr does not support httpx - which LiteLLM uses for streaming responses.
2. pytest-vcr is no longer maintained, last commit 6 years ago :fist::skin-tone-4:
3. pytest-recording supports modern request libraries (including httpx) and actively maintained

tests/conftest.py

@@ -8,6 +8,7 @@ from dotenv import load_dotenv
 
 load_result = load_dotenv(override=True)
 
+
 @pytest.fixture(autouse=True)
 def setup_test_environment():
     """Set up test environment with a temporary directory for SQLite storage."""
@@ -15,11 +16,13 @@ def setup_test_environment():
         # Create the directory with proper permissions
         storage_dir = Path(temp_dir) / "crewai_test_storage"
         storage_dir.mkdir(parents=True, exist_ok=True)
-        
+
         # Validate that the directory was created successfully
         if not storage_dir.exists() or not storage_dir.is_dir():
-            raise RuntimeError(f"Failed to create test storage directory: {storage_dir}")
-        
+            raise RuntimeError(
+                f"Failed to create test storage directory: {storage_dir}"
+            )
+
         # Verify directory permissions
         try:
             # Try to create a test file to verify write permissions
@@ -27,11 +30,20 @@ def setup_test_environment():
             test_file.touch()
             test_file.unlink()
         except (OSError, IOError) as e:
-            raise RuntimeError(f"Test storage directory {storage_dir} is not writable: {e}")
-        
+            raise RuntimeError(
+                f"Test storage directory {storage_dir} is not writable: {e}"
+            )
+
         # Set environment variable to point to the test storage directory
         os.environ["CREWAI_STORAGE_DIR"] = str(storage_dir)
-        
+
         yield
-        
+
         # Cleanup is handled automatically when tempfile context exits
+
+
+@pytest.fixture(scope="module")
+def vcr_config(request) -> dict:
+    return {
+        "cassette_library_dir": "tests/cassettes",
+    }

tests/llm_test.py

@@ -2,6 +2,7 @@ import os
 from time import sleep
 from unittest.mock import MagicMock, patch
 
+import litellm
 import pytest
 from pydantic import BaseModel
 

tests/memory/cassettes/test_save_and_search_with_provider.yaml

@@ -1,270 +0,0 @@
-interactions:
-- request:
-    body: ''
-    headers:
-      accept:
-      - '*/*'
-      accept-encoding:
-      - gzip, deflate
-      connection:
-      - keep-alive
-      host:
-      - api.mem0.ai
-      user-agent:
-      - python-httpx/0.27.0
-    method: GET
-    uri: https://api.mem0.ai/v1/memories/?user_id=test
-  response:
-    body:
-      string: '[]'
-    headers:
-      CF-Cache-Status:
-      - DYNAMIC
-      CF-RAY:
-      - 8b477138bad847b9-BOM
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '2'
-      Content-Type:
-      - application/json
-      Date:
-      - Sat, 17 Aug 2024 06:00:11 GMT
-      NEL:
-      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
-      Report-To:
-      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=uuyH2foMJVDpV%2FH52g1q%2FnvXKe3dBKVzvsK0mqmSNezkiszNR9OgrEJfVqmkX%2FlPFRP2sH4zrOuzGo6k%2FjzsjYJczqSWJUZHN2pPujiwnr1E9W%2BdLGKmG6%2FqPrGYAy2SBRWkkJVWsTO3OQ%3D%3D"}],"group":"cf-nel","max_age":604800}'
-      Server:
-      - cloudflare
-      allow:
-      - GET, POST, DELETE, OPTIONS
-      alt-svc:
-      - h3=":443"; ma=86400
-      cross-origin-opener-policy:
-      - same-origin
-      referrer-policy:
-      - same-origin
-      vary:
-      - Accept, origin, Cookie
-      x-content-type-options:
-      - nosniff
-      x-frame-options:
-      - DENY
-    status:
-      code: 200
-      message: OK
-- request:
-    body: '{"batch": [{"properties": {"python_version": "3.12.4 (v3.12.4:8e8a4baf65,
-      Jun  6 2024, 17:33:18) [Clang 13.0.0 (clang-1300.0.29.30)]", "os": "darwin",
-      "os_version": "Darwin Kernel Version 23.4.0: Wed Feb 21 21:44:54 PST 2024; root:xnu-10063.101.15~2/RELEASE_ARM64_T6030",
-      "os_release": "23.4.0", "processor": "arm", "machine": "arm64", "function":
-      "mem0.client.main.MemoryClient", "$lib": "posthog-python", "$lib_version": "3.5.0",
-      "$geoip_disable": true}, "timestamp": "2024-08-17T06:00:11.526640+00:00", "context":
-      {}, "distinct_id": "fd411bd3-99a2-42d6-acd7-9fca8ad09580", "event": "client.init"}],
-      "historical_migration": false, "sentAt": "2024-08-17T06:00:11.701621+00:00",
-      "api_key": "phc_hgJkUVJFYtmaJqrvf6CYN67TIQ8yhXAkWzUn9AMU4yX"}'
-    headers:
-      Accept:
-      - '*/*'
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '740'
-      Content-Type:
-      - application/json
-      User-Agent:
-      - posthog-python/3.5.0
-    method: POST
-    uri: https://us.i.posthog.com/batch/
-  response:
-    body:
-      string: '{"status":"Ok"}'
-    headers:
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '15'
-      Content-Type:
-      - application/json
-      Date:
-      - Sat, 17 Aug 2024 06:00:12 GMT
-      access-control-allow-credentials:
-      - 'true'
-      server:
-      - envoy
-      vary:
-      - origin, access-control-request-method, access-control-request-headers
-      x-envoy-upstream-service-time:
-      - '69'
-    status:
-      code: 200
-      message: OK
-- request:
-    body: '{"messages": [{"role": "user", "content": "Remember the following insights
-      from Agent run: test value with provider"}], "metadata": {"task": "test_task_provider",
-      "agent": "test_agent_provider"}, "app_id": "Researcher"}'
-    headers:
-      accept:
-      - '*/*'
-      accept-encoding:
-      - gzip, deflate
-      connection:
-      - keep-alive
-      content-length:
-      - '219'
-      content-type:
-      - application/json
-      host:
-      - api.mem0.ai
-      user-agent:
-      - python-httpx/0.27.0
-    method: POST
-    uri: https://api.mem0.ai/v1/memories/
-  response:
-    body:
-      string: '{"message":"ok"}'
-    headers:
-      CF-Cache-Status:
-      - DYNAMIC
-      CF-RAY:
-      - 8b477140282547b9-BOM
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '16'
-      Content-Type:
-      - application/json
-      Date:
-      - Sat, 17 Aug 2024 06:00:13 GMT
-      NEL:
-      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
-      Report-To:
-      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=FRjJKSk3YxVj03wA7S05H8ts35KnWfqS3wb6Rfy4kVZ4BgXfw7nJbm92wI6vEv5fWcAcHVnOlkJDggs11B01BMuB2k3a9RqlBi0dJNiMuk%2Bgm5xE%2BODMPWJctYNRwQMjNVbteUpS%2Fad8YA%3D%3D"}],"group":"cf-nel","max_age":604800}'
-      Server:
-      - cloudflare
-      allow:
-      - GET, POST, DELETE, OPTIONS
-      alt-svc:
-      - h3=":443"; ma=86400
-      cross-origin-opener-policy:
-      - same-origin
-      referrer-policy:
-      - same-origin
-      vary:
-      - Accept, origin, Cookie
-      x-content-type-options:
-      - nosniff
-      x-frame-options:
-      - DENY
-    status:
-      code: 200
-      message: OK
-- request:
-    body: '{"query": "test value with provider", "limit": 3, "app_id": "Researcher"}'
-    headers:
-      accept:
-      - '*/*'
-      accept-encoding:
-      - gzip, deflate
-      connection:
-      - keep-alive
-      content-length:
-      - '73'
-      content-type:
-      - application/json
-      host:
-      - api.mem0.ai
-      user-agent:
-      - python-httpx/0.27.0
-    method: POST
-    uri: https://api.mem0.ai/v1/memories/search/
-  response:
-    body:
-      string: '[]'
-    headers:
-      CF-Cache-Status:
-      - DYNAMIC
-      CF-RAY:
-      - 8b47714d083b47b9-BOM
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '2'
-      Content-Type:
-      - application/json
-      Date:
-      - Sat, 17 Aug 2024 06:00:14 GMT
-      NEL:
-      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
-      Report-To:
-      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v4?s=2DRWL1cdKdMvnE8vx1fPUGeTITOgSGl3N5g84PS6w30GRqpfz79BtSx6REhpnOiFV8kM6KGqln0iCZ5yoHc2jBVVJXhPJhQ5t0uerD9JFnkphjISrJOU1MJjZWneT9PlNABddxvVNCmluA%3D%3D"}],"group":"cf-nel","max_age":604800}'
-      Server:
-      - cloudflare
-      allow:
-      - POST, OPTIONS
-      alt-svc:
-      - h3=":443"; ma=86400
-      cross-origin-opener-policy:
-      - same-origin
-      referrer-policy:
-      - same-origin
-      vary:
-      - Accept, origin, Cookie
-      x-content-type-options:
-      - nosniff
-      x-frame-options:
-      - DENY
-    status:
-      code: 200
-      message: OK
-- request:
-    body: '{"batch": [{"properties": {"python_version": "3.12.4 (v3.12.4:8e8a4baf65,
-      Jun  6 2024, 17:33:18) [Clang 13.0.0 (clang-1300.0.29.30)]", "os": "darwin",
-      "os_version": "Darwin Kernel Version 23.4.0: Wed Feb 21 21:44:54 PST 2024; root:xnu-10063.101.15~2/RELEASE_ARM64_T6030",
-      "os_release": "23.4.0", "processor": "arm", "machine": "arm64", "function":
-      "mem0.client.main.MemoryClient", "$lib": "posthog-python", "$lib_version": "3.5.0",
-      "$geoip_disable": true}, "timestamp": "2024-08-17T06:00:13.593952+00:00", "context":
-      {}, "distinct_id": "fd411bd3-99a2-42d6-acd7-9fca8ad09580", "event": "client.add"}],
-      "historical_migration": false, "sentAt": "2024-08-17T06:00:13.858277+00:00",
-      "api_key": "phc_hgJkUVJFYtmaJqrvf6CYN67TIQ8yhXAkWzUn9AMU4yX"}'
-    headers:
-      Accept:
-      - '*/*'
-      Accept-Encoding:
-      - gzip, deflate
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '739'
-      Content-Type:
-      - application/json
-      User-Agent:
-      - posthog-python/3.5.0
-    method: POST
-    uri: https://us.i.posthog.com/batch/
-  response:
-    body:
-      string: '{"status":"Ok"}'
-    headers:
-      Connection:
-      - keep-alive
-      Content-Length:
-      - '15'
-      Content-Type:
-      - application/json
-      Date:
-      - Sat, 17 Aug 2024 06:00:13 GMT
-      access-control-allow-credentials:
-      - 'true'
-      server:
-      - envoy
-      vary:
-      - origin, access-control-request-method, access-control-request-headers
-      x-envoy-upstream-service-time:
-      - '33'
-    status:
-      code: 200
-      message: OK
-version: 1

tests/tools/agent_tools/agent_tools_test.py

@@ -16,6 +16,13 @@ delegate_tool = tools[0]
 ask_tool = tools[1]
 
 
+@pytest.fixture(scope="module")
+def vcr_config(request) -> dict:
+    return {
+        "cassette_library_dir": "tests/tools/agent_tools/cassettes",
+    }
+
+
 @pytest.mark.vcr(filter_headers=["authorization"])
 def test_delegate_work():
     result = delegate_tool.run(

tests/utilities/test_converter.py

@@ -21,6 +21,13 @@ from crewai.utilities.converter import (
 from crewai.utilities.pydantic_schema_parser import PydanticSchemaParser
 
 
+@pytest.fixture(scope="module")
+def vcr_config(request) -> dict:
+    return {
+        "cassette_library_dir": "tests/utilities/cassettes",
+    }
+
+
 # Sample Pydantic models for testing
 class EmailResponse(BaseModel):
     previous_message_content: str

tests/utilities/test_events.py

@@ -50,6 +50,14 @@ from crewai.utilities.events.tool_usage_events import (
     ToolUsageErrorEvent,
 )
 
+
+@pytest.fixture(scope="module")
+def vcr_config(request) -> dict:
+    return {
+        "cassette_library_dir": "tests/utilities/cassettes",
+    }
+
+
 # Skip streaming tests when running in CI/CD environments
 skip_streaming_in_ci = pytest.mark.skipif(
     os.getenv("CI") is not None, reason="Skipping streaming tests in CI/CD environments"