Remove requests.Session test patches from conftest.py files

cilium/tests/conftest.py

@@ -3,10 +3,10 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 import os
 
-import mock
 import pytest
 
 from datadog_checks.base.utils.common import get_docker_hostname
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
 from datadog_checks.cilium import CiliumCheck
 from datadog_checks.dev import run_command
 from datadog_checks.dev.kind import kind_run
@@ -198,28 +198,18 @@ def operator_instance_use_openmetrics():
 
 
 @pytest.fixture()
-def mock_agent_data():
+def mock_agent_data(mock_openmetrics_http):
     f_name = os.path.join(os.path.dirname(__file__), "fixtures", "agent_metrics.txt")
     with open(f_name, "r") as f:
         text_data = f.read()
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split("\n"), headers={"Content-Type": "text/plain"}
-        ),
-    ):
-        yield
+    mock_openmetrics_http.get.return_value = MockHTTPResponse(content=text_data, headers={"Content-Type": "text/plain"})
+    yield
 
 
 @pytest.fixture()
-def mock_operator_data():
+def mock_operator_data(mock_openmetrics_http):
     f_name = os.path.join(os.path.dirname(__file__), "fixtures", "operator_metrics.txt")
     with open(f_name, "r") as f:
         text_data = f.read()
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split("\n"), headers={"Content-Type": "text/plain"}
-        ),
-    ):
-        yield
+    mock_openmetrics_http.get.return_value = MockHTTPResponse(content=text_data, headers={"Content-Type": "text/plain"})
+    yield

datadog_checks_dev/changelog.d/22676.added

@@ -1 +1 @@
-Add mock_http fixture for library-agnostic HTTP client mocking in integration tests.
+Add mock_http, mock_openmetrics_http, and mock_prometheus_http fixtures for library-agnostic HTTP client mocking in integration tests.

datadog_checks_dev/datadog_checks/dev/plugin/pytest.py

@@ -341,6 +341,32 @@ def _set_header(name, value):
     return client
 
 
+@pytest.fixture
+def mock_openmetrics_http(mock_http, mocker):
+    """OpenMetrics HTTP mock with dual interception:
+
+    - v1 checks (OpenMetricsBaseCheck): patches OpenMetricsScraperMixin.get_http_handler to return mock_http.
+    - v2 checks (OpenMetricsBaseCheckV2): inherited via mock_http's AgentCheck.http PropertyMock; the
+      get_http_handler patch is unused on this path because v2 calls self.http.get(...) directly.
+    """
+    mocker.patch(
+        'datadog_checks.base.checks.openmetrics.mixins.OpenMetricsScraperMixin.get_http_handler',
+        return_value=mock_http,
+    )
+    return mock_http
+
+
+@pytest.fixture
+def mock_prometheus_http(mock_http, mocker):
+    """mock_http with PrometheusScraperMixin.get_http_handler patched to return it."""
+    mock_http.ignore_tls_warning = False
+    mocker.patch(
+        'datadog_checks.base.checks.prometheus.mixins.PrometheusScraperMixin.get_http_handler',
+        return_value=mock_http,
+    )
+    return mock_http
+
+
 @pytest.fixture
 def mock_http_response_per_endpoint(mocker, mock_response):
     @overload

datadog_cluster_agent/tests/conftest.py

@@ -4,9 +4,10 @@
 import os
 from copy import deepcopy
 
-import mock
 import pytest
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
+
 INSTANCE = {'prometheus_url': 'http://localhost:5000/metrics'}
 
 
@@ -21,14 +22,9 @@ def instance():
 
 
 @pytest.fixture()
-def mock_metrics_endpoint():
+def mock_metrics_endpoint(mock_openmetrics_http):
     f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'metrics.txt')
     with open(f_name, 'r') as f:
         text_data = f.read()
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split("\n"), headers={'Content-Type': "text/plain"}
-        ),
-    ):
-        yield
+    mock_openmetrics_http.get.return_value = MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
+    yield

dcgm/tests/conftest.py

@@ -4,10 +4,10 @@
 
 import copy
 import os
-from unittest import mock
 
 import pytest
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
 from datadog_checks.dcgm import DcgmCheck
 from datadog_checks.dev import docker_run
 from datadog_checks.dev.conditions import CheckDockerLogs, CheckEndpoints
@@ -40,28 +40,18 @@ def check(instance):
 
 
 @pytest.fixture()
-def mock_metrics():
+def mock_metrics(mock_http):
     f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'metrics.txt')
     with open(f_name, 'r') as f:
         text_data = f.read()
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split("\n"), headers={'Content-Type': "text/plain"}
-        ),
-    ):
-        yield
+    mock_http.get.return_value = MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
+    yield
 
 
 @pytest.fixture()
-def mock_label_remap():
+def mock_label_remap(mock_http):
     f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'label_remap.txt')
     with open(f_name, 'r') as f:
         text_data = f.read()
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split("\n"), headers={'Content-Type': "text/plain"}
-        ),
-    ):
-        yield
+    mock_http.get.return_value = MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
+    yield

external_dns/tests/conftest.py

@@ -4,27 +4,23 @@
 import os
 from copy import deepcopy
 
-import mock
 import pytest
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
+
 from .common import FIXTURE_DIR
 
 INSTANCE = {'prometheus_url': 'http://localhost:7979/metrics', 'tags': ['custom:tag']}
 
 
 @pytest.fixture
-def mock_external_dns():
+def mock_external_dns(mock_openmetrics_http):
     f_name = os.path.join(FIXTURE_DIR, 'metrics.txt')
     with open(f_name, 'r') as f:
         text_data = f.read()
 
-    with mock.patch(
-        'requests.Session.get',
-        return_value=mock.MagicMock(
-            status_code=200, iter_lines=lambda **kwargs: text_data.split('\n'), headers={'Content-Type': 'text/plain'}
-        ),
-    ):
-        yield
+    mock_openmetrics_http.get.return_value = MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
+    yield
 
 
 @pytest.fixture(scope='session')

fluxcd/tests/conftest.py

@@ -3,10 +3,10 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 import os
 from contextlib import ExitStack
-from unittest import mock
 
 import pytest
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
 from datadog_checks.dev import get_here
 from datadog_checks.dev.kind import kind_run
 from datadog_checks.dev.kube_port_forward import port_forward
@@ -69,36 +69,22 @@ def check(instance):
 
 
 @pytest.fixture()
-def mock_metrics_v1():
+def mock_metrics_v1(mock_http):
     fixture_file = os.path.join(os.path.dirname(__file__), "fixtures", "metrics-v1.txt")
 
     with open(fixture_file, "r") as f:
         content = f.read()
 
-    with mock.patch(
-        "requests.Session.get",
-        return_value=mock.MagicMock(
-            status_code=200,
-            iter_lines=lambda **kwargs: content.split("\n"),
-            headers={"Content-Type": "text/plain"},
-        ),
-    ):
-        yield
+    mock_http.get.return_value = MockHTTPResponse(content=content, headers={"Content-Type": "text/plain"})
+    yield
 
 
 @pytest.fixture()
-def mock_metrics_v2():
+def mock_metrics_v2(mock_http):
     fixture_file = os.path.join(os.path.dirname(__file__), "fixtures", "metrics-v2.txt")
 
     with open(fixture_file, "r") as f:
         content = f.read()
 
-    with mock.patch(
-        "requests.Session.get",
-        return_value=mock.MagicMock(
-            status_code=200,
-            iter_lines=lambda **kwargs: content.split("\n"),
-            headers={"Content-Type": "text/plain"},
-        ),
-    ):
-        yield
+    mock_http.get.return_value = MockHTTPResponse(content=content, headers={"Content-Type": "text/plain"})
+    yield

gitlab/tests/conftest.py

@@ -7,10 +7,10 @@
 from contextlib import contextmanager
 from time import sleep
 
-import mock
 import pytest
 import requests
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
 from datadog_checks.dev import EnvVars, TempDir, docker_run
 from datadog_checks.dev._env import get_state, save_state
 from datadog_checks.dev.conditions import CheckEndpoints
@@ -102,12 +102,9 @@ def dd_environment():
 
 
 @pytest.fixture()
-def mock_data():
-    with mock.patch(
-        'requests.Session.get',
-        side_effect=mocked_requests_get,
-    ):
-        yield
+def mock_data(mock_openmetrics_http):
+    mock_openmetrics_http.get.side_effect = mocked_requests_get
+    yield
 
 
 def mocked_requests_get(*args, **kwargs):
@@ -117,45 +114,29 @@ def mocked_requests_get(*args, **kwargs):
         f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'readiness_check.json')
         with open(f_name, 'r') as f:
             text_data = f.read()
-            response = mock.MagicMock()
-            response.status_code = 200
-            response.json.return_value = json.loads(text_data)
-            return response
+            return MockHTTPResponse(json_data=json.loads(text_data))
 
     elif url == "http://{}:{}/-/liveness".format(HOST, GITLAB_LOCAL_PORT) or url == "http://{}:{}/-/health".format(
         HOST, GITLAB_LOCAL_PORT
     ):
-        response = mock.MagicMock()
-        response.status_code = 200
-        return response
+        return MockHTTPResponse()
     elif url == "http://{}:{}/-/metrics".format(HOST, GITLAB_LOCAL_PORT):
         f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'metrics.txt')
 
         with open(f_name, 'r') as f:
             text_data = f.read()
-            return mock.MagicMock(
-                status_code=200,
-                iter_lines=lambda **kwargs: text_data.split("\n"),
-                headers={'Content-Type': "text/plain"},
-            )
+            return MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
     elif url == "http://{}:{}/metrics".format(HOST, GITLAB_LOCAL_GITALY_PROMETHEUS_PORT):
         f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'gitaly.txt')
 
         with open(f_name, 'r') as f:
             text_data = f.read()
-            return mock.MagicMock(
-                status_code=200,
-                iter_lines=lambda **kwargs: text_data.split("\n"),
-                headers={'Content-Type': "text/plain"},
-            )
+            return MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
     elif url == "http://{}:{}/api/v4/version".format(HOST, GITLAB_LOCAL_PORT):
         f_name = os.path.join(os.path.dirname(__file__), 'fixtures', 'version.json')
         with open(f_name, 'r') as f:
             text_data = f.read()
-            response = mock.MagicMock()
-            response.status_code = 200
-            response.json.return_value = json.loads(text_data)
-            return response
+            return MockHTTPResponse(json_data=json.loads(text_data))
 
     pytest.fail("url `{}` not registered".format(args[0]))
 

gitlab_runner/tests/conftest.py

@@ -4,9 +4,9 @@
 
 import os
 
-import mock
 import pytest
 
+from datadog_checks.base.utils.http_testing import MockHTTPResponse
 from datadog_checks.dev import docker_run
 from datadog_checks.dev.conditions import CheckDockerLogs, CheckEndpoints
 
@@ -68,21 +68,14 @@ def _mocked_requests_get(*args, **kwargs):
         fixtures_path = os.path.join(os.path.dirname(__file__), 'fixtures', 'metrics.txt')
         with open(fixtures_path, 'r') as f:
             text_data = f.read()
-            return mock.MagicMock(
-                status_code=200,
-                iter_lines=lambda **kwargs: text_data.split("\n"),
-                headers={'Content-Type': "text/plain"},
-            )
+            return MockHTTPResponse(content=text_data, headers={'Content-Type': 'text/plain'})
     elif url == 'http://{}:{}/ci'.format(HOST, GITLAB_LOCAL_MASTER_PORT):
-        return mock.MagicMock(status_code=200)
+        return MockHTTPResponse()
 
-    return mock.MagicMock(status_code=404)
+    return MockHTTPResponse(status_code=404)
 
 
 @pytest.fixture()
-def mock_data():
-    with mock.patch(
-        'requests.Session.get',
-        side_effect=_mocked_requests_get,
-    ):
-        yield
+def mock_data(mock_openmetrics_http):
+    mock_openmetrics_http.get.side_effect = _mocked_requests_get
+    yield