ddapm-test-agent 1.33.1__tar.gz → 1.34.0__tar.gz

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddapm-test-agent
-Version: 1.33.1
+Version: 1.34.0
 Summary: Test agent for Datadog APM client libraries
 Home-page: https://github.com/Datadog/dd-apm-test-agent
 Author: Kyle Verhoog
@@ -240,6 +240,10 @@ And pass in a valid API key (if needed) in the way that provider expects.
 
 To redact api keys, modify the `filter_headers` list in the `get_vcr` function in `ddapm_test_agent/vcr_proxy.py`. This can be confirmed by viewing cassettes in the `vcr-cassettes` directory (or the otherwise specified directory), and verifying that any new cassettes do not contain the api key.
 
+#### Running in CI
+
+To have the vcr proxy throw a 404 error if a cassette is not found in CI mode to ensure that all cassettes are generated locally and committed, set the `VCR_CI_MODE` environment variable or the `--vcr-ci-mode` flag in the cli tool to `true` (this value defaults to `false`).
+
 ## Configuration
 
 The test agent can be configured via command-line options or via environment variables.

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/README.md

@@ -196,6 +196,10 @@ And pass in a valid API key (if needed) in the way that provider expects.
 
 To redact api keys, modify the `filter_headers` list in the `get_vcr` function in `ddapm_test_agent/vcr_proxy.py`. This can be confirmed by viewing cassettes in the `vcr-cassettes` directory (or the otherwise specified directory), and verifying that any new cassettes do not contain the api key.
 
+#### Running in CI
+
+To have the vcr proxy throw a 404 error if a cassette is not found in CI mode to ensure that all cassettes are generated locally and committed, set the `VCR_CI_MODE` environment variable or the `--vcr-ci-mode` flag in the cli tool to `true` (this value defaults to `false`).
+
 ## Configuration
 
 The test agent can be configured via command-line options or via environment variables.

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/ddapm_test_agent/agent.py

@@ -831,7 +831,6 @@ class Agent:
                 "peer_tags": ["db.name", "mongodb.db", "messaging.system"],
                 "span_events": True,  # Advertise support for the top-level Span field for Span Events
             },
-            headers={"Datadog-Agent-State": "03e868b3ecdd62a91423cc4c3917d0d151fb9fa486736911ab7f5a0750c63824"},
         )
 
     async def _handle_traces(self, request: Request, version: Literal["v0.4", "v0.5", "v0.7", "v1"]) -> web.Response:
@@ -1356,6 +1355,7 @@ def make_app(
     snapshot_removed_attrs: List[str],
     snapshot_regex_placeholders: Dict[str, str],
     vcr_cassettes_directory: str,
+    vcr_ci_mode: bool,
 ) -> web.Application:
     agent = Agent()
     app = web.Application(
@@ -1417,7 +1417,7 @@ def make_app(
             web.route(
                 "*",
                 "/vcr/{path:.*}",
-                lambda request: proxy_request(request, vcr_cassettes_directory),
+                lambda request: proxy_request(request, vcr_cassettes_directory, vcr_ci_mode),
             ),
         ]
     )
@@ -1582,6 +1582,12 @@ def main(args: Optional[List[str]] = None) -> None:
         default=os.environ.get("VCR_CASSETTES_DIRECTORY", os.path.join(os.getcwd(), "vcr-cassettes")),
         help="Directory to read and store third party API cassettes.",
     )
+    parser.add_argument(
+        "--vcr-ci-mode",
+        type=bool,
+        default=os.environ.get("VCR_CI_MODE", False),
+        help="Will change the test agent to record VCR cassettes in CI mode, throwing an error if a cassette is not found on /vcr/{provider}",
+    )
     parsed_args = parser.parse_args(args=args)
     logging.basicConfig(level=parsed_args.log_level)
 
@@ -1625,6 +1631,7 @@ def main(args: Optional[List[str]] = None) -> None:
         snapshot_removed_attrs=parsed_args.snapshot_removed_attrs,
         snapshot_regex_placeholders=parsed_args.snapshot_regex_placeholders,
         vcr_cassettes_directory=parsed_args.vcr_cassettes_directory,
+        vcr_ci_mode=parsed_args.vcr_ci_mode,
     )
 
     # Validate port configuration

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/ddapm_test_agent/vcr_proxy.py

@@ -146,7 +146,7 @@ def generate_cassette_name(path: str, method: str, body: bytes, vcr_cassette_pre
     )
 
 
-async def proxy_request(request: Request, vcr_cassettes_directory: str) -> Response:
+async def proxy_request(request: Request, vcr_cassettes_directory: str, vcr_ci_mode: bool) -> Response:
     path = request.match_info["path"]
     if request.query_string:
         path = path + "?" + request.query_string
@@ -159,15 +159,22 @@ async def proxy_request(request: Request, vcr_cassettes_directory: str) -> Respo
     if provider not in PROVIDER_BASE_URLS:
         return Response(body=f"Unsupported provider: {provider}", status=400)
 
-    target_url = url_path_join(PROVIDER_BASE_URLS[provider], remaining_path)
-
-    headers = {key: value for key, value in request.headers.items() if key != "Host"}
-
     body_bytes = await request.read()
 
     vcr_cassette_prefix = request.pop("vcr_cassette_prefix", None)
     cassette_name = generate_cassette_name(path, request.method, body_bytes, vcr_cassette_prefix)
     cassette_file_name = f"{cassette_name}.yaml"
+    cassette_file_path = os.path.join(vcr_cassettes_directory, provider, cassette_file_name)
+    cassette_exists = os.path.exists(cassette_file_path)
+
+    if vcr_ci_mode and not cassette_exists:
+        return Response(
+            body=f"Cassette {cassette_file_name} not found while running in CI mode. Please generate the cassette locally and commit it.",
+            status=500,
+        )
+
+    target_url = url_path_join(PROVIDER_BASE_URLS[provider], remaining_path)
+    headers = {key: value for key, value in request.headers.items() if key != "Host"}
 
     request_kwargs: Dict[str, Any] = {
         "method": request.method,
@@ -179,9 +186,7 @@ async def proxy_request(request: Request, vcr_cassettes_directory: str) -> Respo
         "stream": True,
     }
 
-    if provider in AWS_SERVICES and not os.path.exists(
-        os.path.join(vcr_cassettes_directory, provider, cassette_file_name)
-    ):
+    if provider in AWS_SERVICES and not cassette_exists:
         if not AWS_SECRET_ACCESS_KEY:
             return Response(
                 body="AWS_SECRET_ACCESS_KEY environment variable not set for aws signature recalculation",

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/ddapm_test_agent.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddapm-test-agent
-Version: 1.33.1
+Version: 1.34.0
 Summary: Test agent for Datadog APM client libraries
 Home-page: https://github.com/Datadog/dd-apm-test-agent
 Author: Kyle Verhoog
@@ -240,6 +240,10 @@ And pass in a valid API key (if needed) in the way that provider expects.
 
 To redact api keys, modify the `filter_headers` list in the `get_vcr` function in `ddapm_test_agent/vcr_proxy.py`. This can be confirmed by viewing cassettes in the `vcr-cassettes` directory (or the otherwise specified directory), and verifying that any new cassettes do not contain the api key.
 
+#### Running in CI
+
+To have the vcr proxy throw a 404 error if a cassette is not found in CI mode to ensure that all cassettes are generated locally and committed, set the `VCR_CI_MODE` environment variable or the `--vcr-ci-mode` flag in the cli tool to `true` (this value defaults to `false`).
+
 ## Configuration
 
 The test agent can be configured via command-line options or via environment variables.

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/ddapm_test_agent.egg-info/SOURCES.txt

@@ -115,6 +115,7 @@ releasenotes/notes/python310-docker-image-d4e329cfecf6510e.yaml
 releasenotes/notes/rc-encoding-length-fix-cc011edea7f8f5b2.yaml
 releasenotes/notes/rc-get-endpoint-e502f55b7df544e2.yaml
 releasenotes/notes/remoteconfig-requests-1af7abb99c61c069.yaml
+releasenotes/notes/remove-agent-state-header-from-info-87f920bf4ce5785c.yaml
 releasenotes/notes/remove-nix-ec1c4aca7dc002c4.yaml
 releasenotes/notes/remove-old-pythons-4667b182aacf0ce6.yaml
 releasenotes/notes/reuse-session-1670aa569907cf68.yaml
@@ -149,6 +150,7 @@ releasenotes/notes/vcr-aws-bedrock-proxy-3bf018b1712d5105.yaml
 releasenotes/notes/vcr-cassette-name-middleware-fix-9e47c395892a9fe7.yaml
 releasenotes/notes/vcr-cassettes-for-openai-v5-6e9d78091de1f0c2.yaml
 releasenotes/notes/vcr-cassettes-for-vercel-ai-7a8275f9c2b48bc7.yaml
+releasenotes/notes/vcr-ci-mode-99dbd2940fff8d7a.yaml
 releasenotes/notes/vcr-prefix-instead-of-suffix-4c56dcb5038d222e.yaml
 releasenotes/notes/vcr-proxy-aws-recalculation-fix-2184c10270a7bca5.yaml
 releasenotes/notes/vcr-proxy-use-test-name-bugfix-be758294ba30ac78.yaml

ddapm_test_agent-1.34.0/releasenotes/notes/remove-agent-state-header-from-info-87f920bf4ce5785c.yaml

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Remove `Datadog-Agent-State` header from `/info` endpoint response to match actual Datadog agent behavior.

ddapm_test_agent-1.34.0/releasenotes/notes/vcr-ci-mode-99dbd2940fff8d7a.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    vcr: adds a new ``--vcr-ci-mode`` flag and accompanying ``VCR_CI_MODE`` environment variable that, when set to ``true`` (defaults to ``false``), will throw a 404 error if a cassette is not found in CI mode to ensure that all cassettes are generated locally and committed.

{ddapm_test_agent-1.33.1 → ddapm_test_agent-1.34.0}/tests/conftest.py

@@ -110,6 +110,11 @@ def snapshot_server_cassettes_directory() -> Generator[str, None, None]:
     yield "/snapshot-server-cassettes"
 
 
+@pytest.fixture
+def vcr_ci_mode() -> Generator[bool, None, None]:
+    yield False
+
+
 @pytest.fixture
 async def agent_app(
     aiohttp_server,
@@ -126,6 +131,7 @@ async def agent_app(
     snapshot_removed_attrs,
     snapshot_regex_placeholders,
     snapshot_server_cassettes_directory,
+    vcr_ci_mode,
 ):
     app = await aiohttp_server(
         make_app(
@@ -142,6 +148,7 @@ async def agent_app(
             snapshot_removed_attrs,
             snapshot_regex_placeholders,
             snapshot_server_cassettes_directory,
+            vcr_ci_mode,
         )
     )
     yield app