opentelemetry-instrumentation-urllib: move from httpretty to mocker

Author: xrmx

instrumentation/opentelemetry-instrumentation-urllib/test-requirements.txt

@@ -1,6 +1,6 @@
 asgiref==3.8.1
 Deprecated==1.2.14
-httpretty==1.1.4
+mocket==3.14.1
 iniconfig==2.0.0
 packaging==24.0
 pluggy==1.6.0

instrumentation/opentelemetry-instrumentation-urllib/tests/test_metrics_instrumentation.py

@@ -8,7 +8,8 @@
 from urllib import request
 from urllib.parse import urlencode
 
-import httpretty
+from mocket import Mocketizer
+from mocket.mocks.mockhttp import Entry
 from pytest import mark
 
 from opentelemetry.instrumentation._semconv import (
@@ -56,16 +57,15 @@ def setUp(self):
         _OpenTelemetrySemanticConventionStability._initialized = False
         self.env_patch.start()
         URLLibInstrumentor().instrument()
-        httpretty.enable()
-        httpretty.register_uri(httpretty.GET, self.URL, body=b"Hello!")
-        httpretty.register_uri(
-            httpretty.POST, self.URL_POST, body=b"Hello World!"
-        )
+        self.mocketizer = Mocketizer(strict_mode=True)
+        self.mocketizer.enter()
+        Entry.single_register(Entry.GET, self.URL, body=b"Hello!")
+        Entry.single_register(Entry.POST, self.URL_POST, body=b"Hello World!")
 
     def tearDown(self):
         super().tearDown()
         URLLibInstrumentor().uninstrument()
-        httpretty.disable()
+        self.mocketizer.exit()
 
     # Return Sequence with one histogram
     def create_histogram_data_points(

instrumentation/opentelemetry-instrumentation-urllib/tests/test_urllib_integration.py

@@ -12,7 +12,8 @@
 from urllib.error import HTTPError
 from urllib.request import OpenerDirector
 
-import httpretty
+from mocket import Mocket, Mocketizer
+from mocket.mocks.mockhttp import Entry
 
 import opentelemetry.instrumentation.urllib  # pylint: disable=no-name-in-module,import-error
 from opentelemetry import trace
@@ -85,20 +86,21 @@ def setUp(self):
         self.exclude_patch.start()
 
         URLLibInstrumentor().instrument()
-        httpretty.enable()
-        httpretty.register_uri(httpretty.GET, self.URL, body=b"Hello!")
-        httpretty.register_uri(
-            httpretty.GET,
+        self.mocketizer = Mocketizer(strict_mode=True)
+        self.mocketizer.enter()
+        Entry.single_register(Entry.GET, self.URL, body=b"Hello!")
+        Entry.single_register(
+            Entry.GET,
             self.URL_TIMEOUT,
-            body=self.timeout_exception_callback,
+            exception=socket.timeout(),
         )
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             self.URL_EXCEPTION,
-            body=self.base_exception_callback,
+            exception=Exception("test"),  # pylint: disable=broad-exception-raised
         )
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             "http://mock/status/500",
             status=500,
         )
@@ -107,15 +109,7 @@ def setUp(self):
     def tearDown(self):
         super().tearDown()
         URLLibInstrumentor().uninstrument()
-        httpretty.disable()
-
-    @staticmethod
-    def timeout_exception_callback(*_, **__):
-        raise socket.timeout
-
-    @staticmethod
-    def base_exception_callback(*_, **__):
-        raise Exception("test")  # pylint: disable=broad-exception-raised
+        self.mocketizer.exit()
 
     def assert_span(self, exporter=None, num_spans=1):
         if exporter is None:
@@ -214,8 +208,8 @@ def test_basic_both_semconv(self):
 
     def test_excluded_urls_explicit(self):
         url_201 = "http://mock/status/201"
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             url_201,
             status=201,
         )
@@ -229,8 +223,8 @@ def test_excluded_urls_explicit(self):
 
     def test_excluded_urls_from_env(self):
         url = "http://localhost/env_excluded_arg/123"
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             url,
             status=200,
         )
@@ -244,8 +238,8 @@ def test_excluded_urls_from_env(self):
 
     def test_not_foundbasic(self):
         url_404 = "http://mock/status/404/"
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             url_404,
             status=404,
         )
@@ -268,8 +262,8 @@ def test_not_foundbasic(self):
 
     def test_not_foundbasic_new_semconv(self):
         url_404 = "http://mock/status/404/"
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             url_404,
             status=404,
         )
@@ -292,8 +286,8 @@ def test_not_foundbasic_new_semconv(self):
 
     def test_not_foundbasic_both_semconv(self):
         url_404 = "http://mock/status/404/"
-        httpretty.register_uri(
-            httpretty.GET,
+        Entry.single_register(
+            Entry.GET,
             url_404,
             status=404,
         )
@@ -410,7 +404,7 @@ def test_distributed_context(self):
 
             span = self.assert_span()
 
-            headers_ = dict(httpretty.last_request().headers)
+            headers_ = dict(Mocket.last_request().headers)
             headers = {}
             for k, v in headers_.items():
                 headers[k.lower()] = v
@@ -510,6 +504,8 @@ def test_requests_timeout_exception(self, *_, **__):
     def test_remove_sensitive_params(self):
         url = "http://username:password@mock/status/200"
 
+        Mocket.reset()
+        Entry.single_register(Entry.GET, url, exception=Exception("test"))
         with self.assertRaises(Exception):
             self.perform_request(url)
 
@@ -558,9 +554,12 @@ def test_custom_response_headers_captured(self):
             "X-Custom-Header": "custom-value",
             "X-Another-Header": "another-value",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(url)
 
@@ -613,9 +612,12 @@ def test_sensitive_headers_sanitized(self):
             "Set-Cookie": "session=abc123",
             "X-Secret": "secret",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(
             url,
@@ -656,9 +658,12 @@ def test_custom_headers_with_regex(self):
             "X-Custom-Response-B": "value-B",
             "X-Other-Response-Header": "other-value",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(
             url,
@@ -702,9 +707,12 @@ def test_custom_headers_case_insensitive(self):
         )
 
         response_headers = {"X-ReSPoNse-HeaDER": "custom-value"}
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(
             url,
@@ -733,9 +741,12 @@ def test_standard_http_headers_captured(self):
             "Content-Type": "text/plain",
             "Server": "TestServer/1.0",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(
             url,
@@ -801,9 +812,12 @@ def test_capture_all_response_headers(self):
             "X-Response-Two": "value2",
             "X-Response-Three": "value3",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(url)
 
@@ -863,9 +877,12 @@ def test_capture_and_sanitize_environment_variables(self):
             "X-Response-One": "value1",
             "X-Response-Two": "value2",
         }
-        url = "http://mock//capture_headers"
-        httpretty.register_uri(
-            httpretty.GET, url, body="Hello!", adding_headers=response_headers
+        url = "http://mock/capture_headers"
+        Entry.single_register(
+            Entry.GET,
+            url,
+            body="Hello!",
+            headers=response_headers,
         )
         self.perform_request(
             url, headers=[("x-request-one", "one"), ("x-request-two", "two")]