ddapm-test-agent 1.33.0__py3-none-any.whl → 1.34.0__py3-none-any.whl

ddapm_test_agent/__init__.py

@@ -1,4 +1,4 @@
 def _get_version():
-    import pkg_resources  # type: ignore[import-untyped]
+    import pkg_resources
 
     return pkg_resources.get_distribution(__name__).version

ddapm_test_agent/agent.py

@@ -133,7 +133,7 @@ def _session_token(request: Request) -> Optional[str]:
 
 async def _vcr_proxy_cassette_prefix(request: Request) -> Optional[str]:
     try:
-        request_body: dict[str, str] = await request.json()
+        request_body: Dict[str, str] = await request.json()
         requested_test_name = request_body.get("test_name")
         return requested_test_name
     except (json.JSONDecodeError, UnicodeDecodeError):
@@ -165,7 +165,7 @@ async def handle_exception_middleware(request: Request, handler: _Handler) -> we
 
 async def _forward_request(
     request_data: bytes, headers: Mapping[str, str], full_agent_url: str
-) -> tuple[ClientResponse, str]:
+) -> Tuple[ClientResponse, str]:
     async with ClientSession() as session:
         async with session.post(
             full_agent_url,
@@ -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:
@@ -929,10 +928,9 @@ class Agent:
         # Get the span attributes that are to be removed for this snapshot.
         default_attribute_regex_replaces: Dict[str, str] = request.app["snapshot_regex_placeholders"]
         regex_overrides = _parse_map(request.url.query.get("regex_placeholders", ""))
-        attribute_regex_replaces = dict(
-            (f"{{{key}}}", re.compile(regex))
-            for (key, regex) in (default_attribute_regex_replaces | regex_overrides).items()
-        )
+        regex_replaces = default_attribute_regex_replaces.copy()
+        regex_replaces.update(regex_overrides)
+        attribute_regex_replaces = dict((f"{{{key}}}", re.compile(regex)) for (key, regex) in regex_replaces.items())
         log.info("using regex placeholders %r", attribute_regex_replaces)
 
         if "span_id" in span_removes:
@@ -1357,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(
@@ -1418,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),
             ),
         ]
     )
@@ -1583,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)
 
@@ -1626,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/trace_snapshot.py

@@ -3,13 +3,13 @@ import json
 import logging
 import operator
 import pprint
-from re import Pattern
 import textwrap
 from typing import Any
 from typing import Dict
 from typing import List
 from typing import Optional
 from typing import OrderedDict as OrderedDictType
+from typing import Pattern
 from typing import Set
 from typing import Tuple
 from typing import cast
@@ -188,9 +188,13 @@ def _match_traces(t1s: List[Trace], t2s: List[Trace]) -> List[Tuple[Trace, Trace
     return matches
 
 
-def _diff_spans(
-    s1: Span, s2: Span, ignored: Set[str]
-) -> Tuple[List[str], List[str], List[str], List[Tuple[List[str], List[str]]], List[Tuple[List[str], List[str]]]]:
+def _diff_spans(s1: Span, s2: Span, ignored: Set[str]) -> Tuple[
+    List[str],
+    List[str],
+    List[str],
+    List[Tuple[List[str], List[str]]],
+    List[Tuple[List[str], List[str]]],
+]:
     """Return differing attributes between two spans and their meta/metrics maps.
 
     It is assumed that the spans have passed through preliminary validation
@@ -255,7 +259,11 @@ def _diff_spans(
             )
             link_diff = []
             for d1, d2, ign in [
-                (l1_no_tags, l2_no_tags, set(i[11:] for i in ignored if i.startswith("span_links."))),
+                (
+                    l1_no_tags,
+                    l2_no_tags,
+                    set(i[11:] for i in ignored if i.startswith("span_links.")),
+                ),
                 (
                     l1.get("attributes") or {},
                     l2.get("attributes") or {},
@@ -288,7 +296,11 @@ def _diff_spans(
             )
             event_diff = []
             for d1, d2, ign in [
-                (l1_no_tags, l2_no_tags, set(i[12:] for i in ignored if i.startswith("span_events."))),
+                (
+                    l1_no_tags,
+                    l2_no_tags,
+                    set(i[12:] for i in ignored if i.startswith("span_events.")),
+                ),
                 (
                     e1.get("attributes") or {},
                     e2.get("attributes") or {},
@@ -307,7 +319,13 @@ def _diff_spans(
     results.append(event_diffs)  # type: ignore
 
     return cast(
-        Tuple[List[str], List[str], List[str], List[Tuple[List[str], List[str]]], List[Tuple[List[str], List[str]]]],
+        Tuple[
+            List[str],
+            List[str],
+            List[str],
+            List[Tuple[List[str], List[str]]],
+            List[Tuple[List[str], List[str]]],
+        ],
         tuple(results),
     )
 
@@ -334,9 +352,13 @@ def _compare_traces(expected: Trace, received: Trace, ignored: Set[str]) -> None
         ) as frame:
             frame.add_item(f"Expected span:\n{pprint.pformat(s_exp)}")
             frame.add_item(f"Received span:\n{pprint.pformat(s_rec)}")
-            top_level_diffs, meta_diffs, metrics_diffs, span_link_diffs, span_event_diffs = _diff_spans(
-                s_exp, s_rec, ignored
-            )
+            (
+                top_level_diffs,
+                meta_diffs,
+                metrics_diffs,
+                span_link_diffs,
+                span_event_diffs,
+            ) = _diff_spans(s_exp, s_rec, ignored)
 
             for diffs, diff_type, d_exp, d_rec in [
                 (top_level_diffs, "span", s_exp, s_rec),
@@ -363,7 +385,12 @@ def _compare_traces(expected: Trace, received: Trace, ignored: Set[str]) -> None
 
             for i, (link_level_diffs, attribute_diffs) in enumerate(span_link_diffs):
                 for diffs, diff_type, d_exp, d_rec in [
-                    (link_level_diffs, f"{i}", s_exp["span_links"][i], s_rec["span_links"][i]),
+                    (
+                        link_level_diffs,
+                        f"{i}",
+                        s_exp["span_links"][i],
+                        s_rec["span_links"][i],
+                    ),
                     (
                         attribute_diffs,
                         f"{i} attributes",
@@ -387,7 +414,12 @@ def _compare_traces(expected: Trace, received: Trace, ignored: Set[str]) -> None
 
             for i, (event_level_diffs, attribute_diffs) in enumerate(span_event_diffs):
                 for diffs, diff_type, d_exp, d_rec in [
-                    (event_level_diffs, f"{i}", s_exp["span_events"][i], s_rec["span_events"][i]),
+                    (
+                        event_level_diffs,
+                        f"{i}",
+                        s_exp["span_events"][i],
+                        s_rec["span_events"][i],
+                    ),
                     (
                         attribute_diffs,
                         f"{i} attributes",
@@ -545,4 +577,7 @@ def generate_snapshot(
     removed: Optional[List[str]] = None,
     attribute_regex_replaces: Optional[Dict[str, Pattern[str]]] = None,
 ) -> str:
-    return _snapshot_json(_normalize_traces(received_traces, attribute_regex_replaces or {}), removed or [])
+    return _snapshot_json(
+        _normalize_traces(received_traces, attribute_regex_replaces or {}),
+        removed or [],
+    )

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,14 +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,
@@ -178,7 +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_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",
@@ -192,7 +200,7 @@ async def proxy_request(request: Request, vcr_cassettes_directory: str) -> Respo
         auth = AWS4Auth(aws_access_key, AWS_SECRET_ACCESS_KEY, AWS_REGION, AWS_SERVICES[provider])
         request_kwargs["auth"] = auth
 
-    with get_vcr(provider, vcr_cassettes_directory).use_cassette(f"{cassette_name}.yaml"):
+    with get_vcr(provider, vcr_cassettes_directory).use_cassette(cassette_file_name):
         provider_response = requests.request(**request_kwargs)
 
     # Extract content type without charset

{ddapm_test_agent-1.33.0.dist-info → ddapm_test_agent-1.34.0.dist-info}/METADATA

@@ -1,15 +1,12 @@
 Metadata-Version: 2.4
 Name: ddapm-test-agent
-Version: 1.33.0
+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
 Author-email: kyle@verhoog.ca
 License: BSD 3
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -64,11 +61,6 @@ See the [Development](#development) section for how to get the test agent runnin
 
 ## Installation
 
-The test agent can be installed using [nix](https://docs.determinate.systems/getting-started/):
-
-    nix profile install github:datadog/dd-apm-test-agent#ddapm-test-agent
-    # nix profile upgrade ddapm-test-agent # to upgrade
-
 The test agent can be installed from PyPI:
 
     pip install ddapm-test-agent
@@ -248,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.0.dist-info → ddapm_test_agent-1.34.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-ddapm_test_agent/__init__.py,sha256=hJBQduemued6MAWH6Uk2gqJx2vb0_dd0UO52pJ83nLM,138
-ddapm_test_agent/agent.py,sha256=S5VzW5yvBQKqsGj50Xqb_u8gXvRnZguwWTZXn6BcX-M,73960
+ddapm_test_agent/__init__.py,sha256=IEYMDM-xI0IoHYSYw4Eva5263puB_crrrbLstOCScRw,106
+ddapm_test_agent/agent.py,sha256=Wt1L-z9g8pSc22FWa6rGfUaTpGIk7_GBwLl3c94RD6o,74240
 ddapm_test_agent/apmtelemetry.py,sha256=w_9-yUDh1dgox-FfLqeOHU2C14GcjOjen-_SVagiZrc,861
 ddapm_test_agent/checks.py,sha256=pBa4YKZQVA8qaTVJ_XgMA6TmlUZNh99YOrCFJA7fwo0,6865
 ddapm_test_agent/client.py,sha256=ViEmiRX9Y3SQ-KBhSc-FdzBmIVIe8Ij9jj-Q6VGyzLY,7359
@@ -12,15 +12,15 @@ ddapm_test_agent/metrics.py,sha256=EZo7lSec2oAiH7tUqavKZ2MJM7TwbuFGE3AT3cXwmSM,3
 ddapm_test_agent/remoteconfig.py,sha256=_QjYUKc3JF31DxdvISDXgslm5WVnYWAw0hyckWuLc1c,3606
 ddapm_test_agent/trace.py,sha256=t0OR8w3NcZK-EOOoadgPITiZqS5tAJGtxqLVGLEw7Kg,45816
 ddapm_test_agent/trace_checks.py,sha256=bRg2eLKoHROXIFJRbujMUn0T3x1X8pZso-j8wXNomec,9972
-ddapm_test_agent/trace_snapshot.py,sha256=g2MhKi8UE-Wsf6PtuzPoXymcW-cYRUnvj63SP9FETJs,22354
+ddapm_test_agent/trace_snapshot.py,sha256=ayOUcCFo6xyotFRm0fSNdeA91_T447W5ShlkRvi0nZE,22932
 ddapm_test_agent/tracerflare.py,sha256=uoSjhPCOKZflgJn5JLv1Unh4gUdAR1-YbC9_1n1iH9w,954
 ddapm_test_agent/tracestats.py,sha256=q_WQZnh2kXSSN3fRIBe_0jMYCBQHcaS3fZmJTge4lWc,2073
 ddapm_test_agent/tracestats_snapshot.py,sha256=VsB6MVnHPjPWHVWnnDdCXJcVKL_izKXEf9lvJ0qbjNQ,3609
-ddapm_test_agent/vcr_proxy.py,sha256=qnzLD5f1LcKIcLFmqU0n5fzcfWTIt0m173pbpBfeXK4,6745
-ddapm_test_agent-1.33.0.dist-info/licenses/LICENSE.BSD3,sha256=J9S_Tq-hhvteDV2W8R0rqht5DZHkmvgdx3gnLZg4j6Q,1493
-ddapm_test_agent-1.33.0.dist-info/licenses/LICENSE.apache2,sha256=5V2RruBHZQIcPyceiv51DjjvdvhgsgS4pnXAOHDuZkQ,11342
-ddapm_test_agent-1.33.0.dist-info/METADATA,sha256=hxIxnr5yrlh06q1YfaKgeX7RcQUx0XzC7nM2pgHQQQ4,28483
-ddapm_test_agent-1.33.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ddapm_test_agent-1.33.0.dist-info/entry_points.txt,sha256=ulayVs6YJ-0Ej2kxbwn39wOHDVXbyQgFgsbRQmXydcs,250
-ddapm_test_agent-1.33.0.dist-info/top_level.txt,sha256=A9jiKOrrg6VjFAk-mtlSVYN4wr0VsZe58ehGR6IW47U,17
-ddapm_test_agent-1.33.0.dist-info/RECORD,,
+ddapm_test_agent/vcr_proxy.py,sha256=2OmwCxd9kGBxRGoM7wYQx2H8XiRM3ADsrFlpMsBNfTs,7137
+ddapm_test_agent-1.34.0.dist-info/licenses/LICENSE.BSD3,sha256=J9S_Tq-hhvteDV2W8R0rqht5DZHkmvgdx3gnLZg4j6Q,1493
+ddapm_test_agent-1.34.0.dist-info/licenses/LICENSE.apache2,sha256=5V2RruBHZQIcPyceiv51DjjvdvhgsgS4pnXAOHDuZkQ,11342
+ddapm_test_agent-1.34.0.dist-info/METADATA,sha256=XRVBSQse9hAtcu0cWS8ccFXErpUfXc_B2M9bYPAp5rM,28400
+ddapm_test_agent-1.34.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ddapm_test_agent-1.34.0.dist-info/entry_points.txt,sha256=ulayVs6YJ-0Ej2kxbwn39wOHDVXbyQgFgsbRQmXydcs,250
+ddapm_test_agent-1.34.0.dist-info/top_level.txt,sha256=A9jiKOrrg6VjFAk-mtlSVYN4wr0VsZe58ehGR6IW47U,17
+ddapm_test_agent-1.34.0.dist-info/RECORD,,