datadog-checks-base 37.8.0__tar.gz → 37.9.0__tar.gz

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datadog-checks-base
-Version: 37.8.0
+Version: 37.9.0
 Summary: The Datadog Check Toolkit
 Project-URL: Source, https://github.com/DataDog/integrations-core
 Author-email: Datadog <packages@datadoghq.com>

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/datadog_checks/base/__about__.py

@@ -1,4 +1,4 @@
 # (C) Datadog, Inc. 2018-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-__version__ = "37.8.0"
+__version__ = "37.9.0"

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/datadog_checks/base/checks/base.py

@@ -57,11 +57,6 @@ else:
 
 init_logging()
 
-if datadog_agent.get_config('disable_unsafe_yaml'):
-    from ..ddyaml import monkey_patch_pyyaml
-
-    monkey_patch_pyyaml()
-
 if datadog_agent.get_config('integration_tracing'):
     from ddtrace import patch
 
@@ -386,17 +381,6 @@ class AgentCheck(object):
 
         return limit
 
-    @staticmethod
-    def load_config(yaml_str):
-        # type: (str) -> Any
-        """
-        Convenience wrapper to ease programmatic use of this class from the C API.
-        """
-        # See Performance Optimizations in this package's README.md.
-        import yaml
-
-        return yaml.safe_load(yaml_str)
-
     @property
     def http(self) -> RequestsWrapper:
         """
@@ -1485,3 +1469,28 @@ class AgentCheck(object):
 
         for m in metrics:
             self.gauge(m.name, m.value, tags=tags, raw=True)
+
+    @staticmethod
+    def load_config(yaml_str: str) -> Any:
+        """
+        Convenience wrapper to ease programmatic use of this class from the C API.
+        """
+        import subprocess
+        import sys
+
+        process = subprocess.Popen(
+            [sys.executable, '-c', 'import sys, yaml; print(yaml.safe_load(sys.stdin.read()))'],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+        stdout, stderr = process.communicate(yaml_str.encode())
+        if process.returncode != 0:
+            raise ValueError(f'Failed to load config: {stderr.decode()}')
+
+        decoded = stdout.strip().decode()
+        try:
+            return eval(decoded)
+        # a single, literal unquoted string
+        except Exception:
+            return decoded

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/datadog_checks/base/stubs/aggregator.py

@@ -341,6 +341,8 @@ class AggregatorStub(object):
             if expected_tags and expected_tags != sorted(metric.tags):
                 continue
 
+            # to assert hostname is None, pass in hostname as '':
+            # https://github.com/DataDog/integrations-core/blob/7.65.x/datadog_checks_base/datadog_checks/base/checks/base.py#L760
             if hostname is not None and hostname != metric.hostname:
                 continue
 

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/datadog_checks/base/stubs/datadog_agent.py

@@ -29,7 +29,7 @@ class DatadogAgentStub(object):
         self._sent_telemetry = defaultdict(list)
 
     def get_default_config(self):
-        return {'enable_metadata_collection': True, 'disable_unsafe_yaml': True}
+        return {'enable_metadata_collection': True}
 
     def reset(self):
         self._sent_logs.clear()

{datadog_checks_base-37.8.0 → datadog_checks_base-37.9.0}/tests/base/checks/test_agent_check.py

@@ -42,7 +42,12 @@ def test_check_version():
 
 
 def test_load_config():
-    assert AgentCheck.load_config("raw_foo: bar") == {'raw_foo': 'bar'}
+    assert AgentCheck.load_config('raw_foo: bar') == {'raw_foo': 'bar'}
+    assert AgentCheck.load_config('invalid:mapping') == 'invalid:mapping'
+    assert AgentCheck.load_config('') is None
+
+    with pytest.raises(ValueError, match='Failed to load config: '):
+        AgentCheck.load_config(':')
 
 
 def test_persistent_cache(datadog_agent):

datadog_checks_base-37.9.0/tests/stubs/test_assert_metric.py

@@ -0,0 +1,17 @@
+# (C) Datadog, Inc. 2025-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+from datadog_checks.base import AgentCheck
+
+
+class TestAssertMetric:
+
+    def test_assert_metric_hostname(self, aggregator):
+        check = AgentCheck()
+
+        check.gauge('test.metric', 1, hostname=None)
+        check.gauge('test.metric_host', 1, hostname='hello')
+
+        aggregator.assert_metric('test.metric', 1, hostname='')
+        aggregator.assert_metric('test.metric_host', 1, hostname='hello')

datadog_checks_base-37.8.0/datadog_checks/base/ddyaml.py

@@ -1,171 +0,0 @@
-# (C) Datadog, Inc. 2011-present
-# All rights reserved
-# Licensed under Simplified BSD License (see LICENSE)
-import logging
-from os.path import realpath
-
-import yaml
-
-try:
-    from yaml import CSafeDumper as yDumper
-    from yaml import CSafeLoader as yLoader
-except ImportError:
-    # On source install C Extensions might have not been built
-    from yaml import SafeDumper as yDumper  # noqa, imported from here elsewhere
-    from yaml import SafeLoader as yLoader  # noqa, imported from here elsewhere
-
-log = logging.getLogger(__name__)
-
-pyyaml_load = None
-pyyaml_load_all = None
-pyyaml_dump_all = None
-
-
-def safe_yaml_dump_all(
-    documents,
-    stream=None,
-    Dumper=yDumper,
-    default_style=None,
-    default_flow_style=None,
-    canonical=None,
-    indent=None,
-    width=None,
-    allow_unicode=None,
-    line_break=None,
-    encoding='utf-8',
-    explicit_start=None,
-    explicit_end=None,
-    version=None,
-    tags=None,
-):
-    if Dumper != yDumper:
-        stream_name = get_stream_name(stream)
-        log.debug("Unsafe dumping of YAML has been disabled - using safe dumper instead in %s", stream_name)
-
-    if pyyaml_dump_all:
-        return pyyaml_dump_all(
-            documents,
-            stream,
-            yDumper,
-            default_style,
-            default_flow_style,
-            canonical,
-            indent,
-            width,
-            allow_unicode,
-            line_break,
-            encoding,
-            explicit_start,
-            explicit_end,
-            version,
-            tags,
-        )
-
-    return yaml.dump_all(
-        documents,
-        stream,
-        yDumper,
-        default_style,
-        default_flow_style,
-        canonical,
-        indent,
-        width,
-        allow_unicode,
-        line_break,
-        encoding,
-        explicit_start,
-        explicit_end,
-        version,
-        tags,
-    )
-
-
-def safe_yaml_load(stream, Loader=yLoader):
-    if Loader != yLoader:
-        stream_name = get_stream_name(stream)
-        log.debug("Unsafe loading of YAML has been disabled - using safe loader instead in %s", stream_name)
-
-    if pyyaml_load:
-        return pyyaml_load(stream, Loader=yLoader)
-
-    return yaml.load(stream, Loader=yLoader)
-
-
-def safe_yaml_load_all(stream, Loader=yLoader):
-    if Loader != yLoader:
-        stream_name = get_stream_name(stream)
-        log.debug("Unsafe loading of YAML has been disabled - using safe loader instead in %s", stream_name)
-
-    if pyyaml_load_all:
-        return pyyaml_load_all(stream, Loader=yLoader)
-
-    return yaml.load_all(stream, Loader=yLoader)
-
-
-def get_stream_name(stream):
-    """Using the same logic as pyyaml to handle both string types and file types. All file objects do not necessarily
-    have a `name` attribute, in that case we can only say the stream is a file."""
-    if isinstance(stream, str):
-        return "<string>"
-    elif hasattr(stream, 'name'):
-        return realpath(stream.name)
-    else:
-        return "<file>"
-
-
-def yaml_load_force_loader(stream, Loader):
-    """Override the default monkey patch for this call"""
-    log.debug(
-        "`%s` YAML loader is used instead of the default one, please make sure it is safe to do so", Loader.__name__
-    )
-    if pyyaml_load is None:
-        return yaml.load(stream, Loader)
-    return pyyaml_load(stream, Loader)
-
-
-def yaml_load_all_force_loader(stream, Loader):
-    """Override the default monkey patch for this call"""
-    log.debug(
-        "`%s` YAML loader is used instead of the default one, please make sure it is safe to do so", Loader.__name__
-    )
-    if pyyaml_load_all is None:
-        return yaml.load_all(stream, Loader)
-    return pyyaml_load_all(stream, Loader)
-
-
-def monkey_patch_pyyaml():
-    global pyyaml_load
-    global pyyaml_load_all
-    global pyyaml_dump_all
-
-    if not pyyaml_load:
-        log.info("monkey patching yaml.load...")
-        pyyaml_load = yaml.load
-        yaml.load = safe_yaml_load
-    if not pyyaml_load_all:
-        log.info("monkey patching yaml.load_all...")
-        pyyaml_load_all = yaml.load_all
-        yaml.load_all = safe_yaml_load_all
-    if not pyyaml_dump_all:
-        log.info("monkey patching yaml.dump_all... (affects all yaml dump operations)")
-        pyyaml_dump_all = yaml.dump_all
-        yaml.dump_all = safe_yaml_dump_all
-
-
-def monkey_patch_pyyaml_reverse():
-    global pyyaml_load
-    global pyyaml_load_all
-    global pyyaml_dump_all
-
-    if pyyaml_load:
-        log.info("reversing monkey patch for yaml.load...")
-        yaml.load = pyyaml_load
-        pyyaml_load = None
-    if pyyaml_load_all:
-        log.info("reversing monkey patch for yaml.load_all...")
-        yaml.load_all = pyyaml_load_all
-        pyyaml_load_all = None
-    if pyyaml_dump_all:
-        log.info("reversing monkey patch for yaml.dump_all... (affects all yaml dump operations)")
-        yaml.dump_all = pyyaml_dump_all
-        pyyaml_dump_all = None

datadog_checks_base-37.8.0/tests/base/test_ddyaml.py

@@ -1,103 +0,0 @@
-import os
-import tempfile
-
-import pytest
-import yaml
-
-from datadog_checks.base.ddyaml import (
-    monkey_patch_pyyaml,
-    monkey_patch_pyyaml_reverse,
-    safe_yaml_dump_all,
-    safe_yaml_load,
-    safe_yaml_load_all,
-    yaml_load_force_loader,
-    yDumper,
-)
-
-FIXTURE_PATH = os.path.join(os.path.dirname(os.path.realpath(__file__)), '..', 'fixtures', 'ddyaml')
-
-
-class Dummy(object):
-    def __init__(self):
-        self.foo = 1
-        self.bar = 'a'
-        self.qux = {self.foo: self.bar}
-
-    def get_foo(self):
-        return self.foo
-
-    def get_bar(self):
-        return self.bar
-
-    def get_qux(self):
-        return self.qux
-
-
-@pytest.fixture(scope="module", autouse=True)
-def patch_yaml():
-    monkey_patch_pyyaml()
-    yield
-    monkey_patch_pyyaml_reverse()
-
-
-def test_monkey_patch():
-    assert yaml.dump_all == safe_yaml_dump_all
-    assert yaml.load_all == safe_yaml_load_all
-    assert yaml.load == safe_yaml_load
-
-
-def test_load():
-    conf = os.path.join(FIXTURE_PATH, "valid_conf.yaml")
-    with open(conf) as f:
-        stream = f.read()
-
-        yaml_config_safe = safe_yaml_load(stream)
-        yaml_config_native = yaml.load(stream)
-        assert yaml_config_safe is not None
-        assert yaml_config_native is not None
-        assert yaml_config_native == yaml_config_safe
-
-        yaml_config_safe = list(safe_yaml_load_all(stream))
-        yaml_config_native = list(yaml.load_all(stream))
-        assert yaml_config_safe != []
-        assert yaml_config_native != []
-        assert len(yaml_config_safe) == len(yaml_config_native)
-        for safe, native in zip(yaml_config_safe, yaml_config_native):
-            assert safe == native
-
-
-def test_unsafe():
-    dummy = Dummy()
-
-    with pytest.raises(yaml.representer.RepresenterError):
-        yaml.dump_all([dummy])
-
-    with pytest.raises(yaml.representer.RepresenterError):
-        yaml.dump(dummy, Dumper=yDumper)
-
-    # reverse monkey patch and try again
-    monkey_patch_pyyaml_reverse()
-
-    with tempfile.TemporaryFile(suffix='.yaml', mode='w+t') as f:
-        yaml.dump_all([dummy], stream=f)
-        f.seek(0)  # rewind
-
-        doc_unsafe = yaml.load(f, Loader=yaml.Loader)
-        assert type(doc_unsafe) is Dummy
-
-        monkey_patch_pyyaml()
-        with pytest.raises(yaml.constructor.ConstructorError):
-            f.seek(0)  # rewind
-            safe_yaml_load(f)
-
-        with pytest.raises(yaml.constructor.ConstructorError):
-            f.seek(0)  # rewind
-            yaml.load(f)
-
-
-def test_force_loader():
-    conf = os.path.join(FIXTURE_PATH, "valid_conf.yaml")
-    with open(conf) as f:
-        stream = f.read()
-        yaml_config = yaml_load_force_loader(stream, yaml.SafeLoader)
-        assert yaml_config is not None

datadog_checks_base-37.8.0/tests/fixtures/ddyaml/valid_conf.yaml

@@ -1,4 +0,0 @@
-init_config:
-
-instances:
-  - host: localhost