add unit tests, setup mocks, fix integration tests

Author: NouemanKHAL

teleport/datadog_checks/teleport/check.py

@@ -1,23 +1,26 @@
 # (C) Datadog, Inc. 2024-present
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
-import copy
 
 from datadog_checks.base import OpenMetricsBaseCheckV2
-from datadog_checks.base.errors import CheckException  # noqa: F401
 
-# from datadog_checks.base.utils.db import QueryManager
-# from requests.exceptions import ConnectionError, HTTPError, InvalidURL, Timeout
-# from json import JSONDecodeError
+METRIC_MAP = {
+    "process_state": "process_state",
+    # "certificate_mismatch_total": "certificate_mismatch_total",
+    "rx": "rx",
+    "server_interactive_sessions_total": "server_interactive_sessions_total",
+    # "teleport_build_info": "teleport_build_info",
+    "teleport_cache_events": "teleport_cache_events",
+    "teleport_cache_stale_events": "teleport_cache_stale_events",
+    "tx": "tx",
+}
 
 
 class TeleportCheck(OpenMetricsBaseCheckV2):
-    # This will be the prefix of every metric and service check the integration sends
     __NAMESPACE__ = 'teleport'
 
     def __init__(self, name, init_config, instances):
         super().__init__(name, init_config, instances)
-        self.diagnostic_url = self.instance.get("diagnostic_url")
         self.check_initializations.appendleft(self._parse_config)
 
     def check(self, _):
@@ -32,6 +35,7 @@ def check(self, _):
             pass
 
     def _parse_config(self):
+        self.diagnostic_url = self.instance.get("diagnostic_url")
         if self.diagnostic_url:
             self.instance.setdefault("openmetrics_endpoint", self.diagnostic_url + "/metrics")
-            self.instance.setdefault("metrics", ["process_state"])
+            self.instance.setdefault("metrics", [METRIC_MAP])

teleport/tests/conftest.py

@@ -12,7 +12,10 @@
 def dd_environment():
     compose_file = os.path.join(get_here(), 'docker', 'docker-compose.yaml')
 
-    with docker_run(compose_file, sleep=5):
+    def nothing():
+        pass
+
+    with docker_run(compose_file, sleep=5, down=nothing):
         instance = {"diagnostic_url": "http://127.0.0.1:3000"}
         yield instance
 

teleport/tests/fixtures/metrics.txt

@@ -4,7 +4,6 @@
 
 import pytest
 
-from datadog_checks.base import AgentCheck
 from datadog_checks.teleport import TeleportCheck
 
 pytestmark = [pytest.mark.integration, pytest.mark.usefixtures('dd_environment')]
@@ -14,25 +13,13 @@ def test_connect_ok(aggregator, dd_run_check):
     instance = {"diagnostic_url": "http://127.0.0.1:3000"}
     check = TeleportCheck('teleport', {}, [instance])
     dd_run_check(check)
-    aggregator.assert_service_check('teleport.health.up', status=AgentCheck.OK, count=1)
-    aggregator.assert_service_check('teleport.health.up', status=AgentCheck.CRITICAL, count=0)
+    aggregator.assert_service_check('teleport.health.up', status=TeleportCheck.OK, count=1)
+    aggregator.assert_service_check('teleport.health.up', status=TeleportCheck.CRITICAL, count=0)
 
 
 def test_check_collects_teleport_common_metrics(aggregator, dd_run_check):
     instance = {"diagnostic_url": "http://127.0.0.1:3000"}
     check = TeleportCheck('teleport', {}, [instance])
     dd_run_check(check)
 
-    common_metrics = [
-        "process_state",
-        "certificate_mismatch_total",
-        "rx",
-        "server_interactive_sessions_total",
-        "teleport_build_info",
-        "teleport_cache_events",
-        "teleport_cache_stale_events",
-        "tx",
-    ]
-
-    for metric in common_metrics:
-        aggregator.assert_metric(f"teleport.{metric}", tags=None, count=1)
+    aggregator.assert_metric("teleport.process_state")

teleport/tests/test_integration.py

@@ -2,8 +2,11 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
+import os
+
 import pytest
 
+from datadog_checks.dev import get_here
 from datadog_checks.teleport import TeleportCheck
 
 pytestmark = [pytest.mark.unit]
@@ -14,3 +17,11 @@ def test_connect_exception(dd_run_check):
     check = TeleportCheck('teleport', {}, [instance])
     with pytest.raises(Exception):
         dd_run_check(check)
+
+
+def test_common_teleport_metrics(dd_run_check, mock_http_response):
+    fixtures_path = os.path.join(get_here(), 'fixtures', 'metrics.txt')
+    mock_http_response(file_path=fixtures_path)
+    instance = {"diagnostic_url": "http://127.0.0.1:3000"}
+    check = TeleportCheck('teleport', {}, [instance])
+    dd_run_check(check)