httpdbg 0.29.2__tar.gz → 0.31.0__tar.gz

{httpdbg-0.29.2 → httpdbg-0.31.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.29.2
+Version: 0.31.0
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -116,6 +116,7 @@ You can use any package as an initiator, this is not limited to HTTP requests.
 | httpx          | supported                           |
 | aiohttp        | supported                           |
 | pytest         | supported                           |
+| unittest       | supported                           |
 | _your_package_ | yes, with the arg _-i your_package_ |
 
 ## configuration
@@ -147,16 +148,19 @@ options:
 
 ### web interace 
 
-Clic on the **&#9881;** button on the top right of the page.
+Some options are available to customize the UI:
 
-Some options are available:
-  * Hide the netloc in the url
-  * Hide the initiator rows
-  * Hide the tags
+  * Change the strategy to group the requests.
+  * Hide the scheme and the network location in the url.
+  * Hide the group rows.
+  * Hide the tags.
+  * ...
+
+You can also pin a request or delete all unpinned requests.
 
 To keep your configuration, bookmark the page with the full search query.
 
-Fox example, if you want to hide the initiator rows by default, the url will be:
+Fox example, if you want to hide the group rows by default, the url will be:
 ```
 http://localhost:4909/?hi=on
 ```

{httpdbg-0.29.2 → httpdbg-0.31.0}/README.md

@@ -88,6 +88,7 @@ You can use any package as an initiator, this is not limited to HTTP requests.
 | httpx          | supported                           |
 | aiohttp        | supported                           |
 | pytest         | supported                           |
+| unittest       | supported                           |
 | _your_package_ | yes, with the arg _-i your_package_ |
 
 ## configuration
@@ -119,16 +120,19 @@ options:
 
 ### web interace 
 
-Clic on the **⚙** button on the top right of the page.
+Some options are available to customize the UI:
 
-Some options are available:
-  * Hide the netloc in the url
-  * Hide the initiator rows
-  * Hide the tags
+  * Change the strategy to group the requests.
+  * Hide the scheme and the network location in the url.
+  * Hide the group rows.
+  * Hide the tags.
+  * ...
+
+You can also pin a request or delete all unpinned requests.
 
 To keep your configuration, bookmark the page with the full search query.
 
-Fox example, if you want to hide the initiator rows by default, the url will be:
+Fox example, if you want to hide the group rows by default, the url will be:
 ```
 http://localhost:4909/?hi=on
 ```

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/__init__.py

@@ -3,6 +3,6 @@ from httpdbg.hooks.all import httprecord
 from httpdbg.records import HTTPRecords
 
 
-__version__ = "0.29.2"
+__version__ = "0.31.0"
 
 __all__ = ["httprecord", "HTTPRecords"]

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/hooks/all.py

@@ -11,6 +11,7 @@ from httpdbg.hooks.httpx import hook_httpx
 from httpdbg.hooks.pytest import hook_pytest
 from httpdbg.hooks.requests import hook_requests
 from httpdbg.hooks.socket import hook_socket
+from httpdbg.hooks.unittest import hook_unittest
 from httpdbg.hooks.urllib3 import hook_urllib3
 from httpdbg.records import HTTPRecords
 
@@ -29,5 +30,6 @@ def httprecord(
                     with hook_urllib3(records):
                         with hook_aiohttp(records):
                             with hook_pytest(records):
-                                with hook_generic(records, initiators):
-                                    yield records
+                                with hook_unittest(records):
+                                    with hook_generic(records, initiators):
+                                        yield records

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/hooks/external.py

@@ -15,6 +15,7 @@ from httpdbg.records import HTTPRecords
 @contextmanager
 def watcher_external(records: HTTPRecords) -> Generator[HTTPRecords, None, None]:
     try:
+        watcher = None
         if HTTPDBG_SUBPROCESS_DIR not in os.environ:
             with tempfile.TemporaryDirectory(
                 prefix="httpdbg"

httpdbg-0.31.0/httpdbg/hooks/unittest.py

@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+from collections.abc import Callable
+from contextlib import contextmanager
+import inspect
+import os
+import typing
+from typing import Generator
+
+from httpdbg.initiator import httpdbg_group
+from httpdbg.initiator import httpdbg_tag
+from httpdbg.hooks.utils import decorate
+from httpdbg.hooks.utils import getcallargs
+from httpdbg.hooks.utils import undecorate
+from httpdbg.records import HTTPRecords
+
+
+def set_hook_for_unittest_run(records: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+
+        if "self" in callargs:
+            test_case = callargs["self"]
+
+            label = "unknown test"
+            full_label = "unknown test"
+
+            method_name = getattr(test_case, "_testMethodName")
+            if method_name:
+                test_class_name = test_case.__class__.__name__
+                label = f"{test_class_name}::{method_name}"
+                full_label = label
+                test_module = inspect.getmodule(test_case.__class__)
+                test_module_path = getattr(test_module, "__file__")
+                if test_module_path:
+                    test_module_path = os.path.relpath(test_module_path)
+                    full_label = f"{test_module_path}::{full_label}"
+
+            with httpdbg_group(records, label, full_label):
+                ret = method(*args, **kwargs)
+        else:
+            ret = method(*args, **kwargs)
+        return ret
+
+    return hook
+
+
+def set_hook_for_unittest_fixture(_: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+
+        if getattr(method, "__name__") == "_callSetUp":
+            with httpdbg_tag("setUp"):
+                return method(*args, **kwargs)
+        elif getattr(method, "__name__") == "_callTearDown":
+            with httpdbg_tag("tearDown"):
+                return method(*args, **kwargs)
+        else:
+            return method(*args, **kwargs)
+
+    return hook
+
+
+def set_hook_for_unittest_class_setup(records: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+
+        if "test" in callargs:
+            test_case = callargs["test"]
+
+            test_class_name = test_case.__class__.__name__
+            label = f"{test_class_name}::setUpClass"
+            full_label = label
+
+            test_module = inspect.getmodule(test_case.__class__)
+            test_module_path = getattr(test_module, "__file__")
+            if test_module_path:
+                test_module_path = os.path.relpath(test_module_path)
+                full_label = f"{test_module_path}::{full_label}"
+
+            with httpdbg_group(records, label, full_label):
+                return method(*args, **kwargs)
+        else:
+            return method(*args, **kwargs)
+
+    return hook
+
+
+def set_hook_for_unittest_class_teardown(records: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+
+        test_result = None
+        if "result" in callargs:
+            result = callargs["result"]
+
+            if result.testsRun > 0:
+                test_result = result
+
+        if test_result:
+
+            label = "tearDownClass (unknown class)"
+            full_label = label
+
+            test_class = getattr(test_result, "_previousTestClass")
+            if test_class:
+                test_class_name = test_class.__name__
+                label = f"{test_class_name}::tearDownClass"
+                full_label = label
+
+                test_module = inspect.getmodule(test_class)
+                test_module_path = getattr(test_module, "__file__")
+                if test_module_path:
+                    test_module_path = os.path.relpath(test_module_path)
+                    full_label = f"{test_module_path}::{full_label}"
+
+            with httpdbg_group(records, label, full_label):
+                return method(*args, **kwargs)
+        else:
+            return method(*args, **kwargs)
+
+    return hook
+
+
+def set_hook_for_unittest_module_setup(records: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+
+        if "test" in callargs:
+            test_suite = callargs["test"]
+
+            test_module = inspect.getmodule(test_suite)
+
+            label = f"setUpModule ({test_module.__name__})"  # may be __main__
+            full_label = label
+
+            test_module_path = getattr(test_module, "__file__")
+            if test_module_path:
+                # if we execute the tests using the script mode, the module name is __main__
+                # this is why we retrieve the module name from the path
+                module_name = os.path.splitext(os.path.basename(test_module_path))[0]
+                label = f"setUpModule ({module_name})"
+
+                test_module_path = os.path.relpath(test_module_path)
+                full_label = f"{test_module_path}::setUpModule"
+
+            with httpdbg_group(records, label, full_label):
+                return method(*args, **kwargs)
+        else:
+            return method(*args, **kwargs)
+
+    return hook
+
+
+def set_hook_for_unittest_module_teardown(records: HTTPRecords, method: Callable):
+
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+
+        test_result = None
+        if "result" in callargs:
+            result = callargs["result"]
+
+            if result.testsRun > 0:
+                test_result = result
+
+        if test_result:
+
+            label = "tearDownModule (unknown module)"
+            full_label = label
+
+            test_class = getattr(test_result, "_previousTestClass")
+            if test_class:
+
+                test_module = inspect.getmodule(test_class)
+
+                label = f"tearDownModule ({test_module.__name__})"  # may be __main__
+
+                test_module_path = getattr(test_module, "__file__")
+                if test_module_path:
+                    # if we execute the tests using the script mode, the module name is __main__
+                    # this is why we retrieve the module name from the path
+                    module_name = os.path.splitext(os.path.basename(test_module_path))[
+                        0
+                    ]
+                    label = f"tearDownModule ({module_name})"
+
+                    test_module_path = os.path.relpath(test_module_path)
+                    full_label = f"{test_module_path}::tearDownModule"
+
+            with httpdbg_group(records, label, full_label):
+                return method(*args, **kwargs)
+        else:
+            return method(*args, **kwargs)
+
+    return hook
+
+
+@typing.no_type_check
+@contextmanager
+def hook_unittest(records: HTTPRecords) -> Generator[None, None, None]:
+    hooks = False
+    try:
+        import unittest
+
+        unittest.case.TestCase.run = decorate(
+            records, unittest.case.TestCase.run, set_hook_for_unittest_run
+        )
+        unittest.case.TestCase._callSetUp = decorate(
+            records, unittest.case.TestCase._callSetUp, set_hook_for_unittest_fixture
+        )
+        unittest.case.TestCase._callTearDown = decorate(
+            records, unittest.case.TestCase._callTearDown, set_hook_for_unittest_fixture
+        )
+        unittest.suite.TestSuite._handleClassSetUp = decorate(
+            records,
+            unittest.suite.TestSuite._handleClassSetUp,
+            set_hook_for_unittest_class_setup,
+        )
+        unittest.suite.TestSuite._tearDownPreviousClass = decorate(
+            records,
+            unittest.suite.TestSuite._tearDownPreviousClass,
+            set_hook_for_unittest_class_teardown,
+        )
+        unittest.suite.TestSuite._handleModuleFixture = decorate(
+            records,
+            unittest.suite.TestSuite._handleModuleFixture,
+            set_hook_for_unittest_module_setup,
+        )
+        unittest.suite.TestSuite._handleModuleTearDown = decorate(
+            records,
+            unittest.suite.TestSuite._handleModuleTearDown,
+            set_hook_for_unittest_module_teardown,
+        )
+        hooks = True
+    except ImportError:
+        pass
+
+    yield
+
+    if hooks:
+        unittest.case.TestCase.run = undecorate(unittest.case.TestCase.run)
+        unittest.case.TestCase._callSetUp = undecorate(
+            unittest.case.TestCase._callSetUp
+        )
+        unittest.case.TestCase._callTearDown = undecorate(
+            unittest.case.TestCase._callTearDown
+        )
+        unittest.suite.TestSuite._handleClassSetUp = undecorate(
+            unittest.suite.TestSuite._handleClassSetUp
+        )
+        unittest.suite.TestSuite._tearDownPreviousClass = undecorate(
+            unittest.suite.TestSuite._tearDownPreviousClass
+        )
+        unittest.suite.TestSuite._handleModuleFixture = undecorate(
+            unittest.suite.TestSuite._handleModuleFixture
+        )
+        unittest.suite.TestSuite._handleModuleTearDown = undecorate(
+            unittest.suite.TestSuite._handleModuleTearDown
+        )

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/initiator.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 from contextlib import contextmanager
+import datetime
 import os
 import platform
 import traceback
@@ -31,6 +33,7 @@ class Initiator:
         self.label = label
         self.short_stack = short_stack
         self.stack = stack
+        self.tbegin: datetime.datetime = datetime.datetime.now(datetime.timezone.utc)
 
     def __eq__(self, other) -> bool:
         if type(other) is Initiator:
@@ -49,12 +52,14 @@ class Initiator:
                 "label": self.label,
                 "short_stack": self.short_stack,
                 "stack": "\n".join(self.stack),
+                "tbegin": self.tbegin.isoformat(),
             }
         else:
             json = {
                 "id": self.id,
                 "label": self.label,
                 "short_stack": self.short_stack,
+                "tbegin": self.tbegin.isoformat(),
             }
         return json
 
@@ -64,9 +69,15 @@ class Group:
         self.id: str = get_new_uuid()
         self.label: str = label
         self.full_label: str = full_label
+        self.tbegin: datetime.datetime = datetime.datetime.now(datetime.timezone.utc)
 
     def to_json(self) -> dict:
-        return {"id": self.id, "label": self.label, "full_label": self.full_label}
+        return {
+            "id": self.id,
+            "label": self.label,
+            "full_label": self.full_label,
+            "tbegin": self.tbegin.isoformat(),
+        }
 
 
 def compatible_path(path: str) -> str:
@@ -193,9 +204,13 @@ def extract_short_stack_from_file(
 
 @contextmanager
 def httpdbg_initiator(
-    records, extracted_stack: traceback.StackSummary, original_method, *args, **kwargs
+    records: "HTTPRecords",
+    extracted_stack: traceback.StackSummary,
+    original_method: Callable,
+    *args,
+    **kwargs,
 ) -> Generator[Union[Tuple[Initiator, Group], None], None, None]:
-    envname = f"{HTTPDBG_CURRENT_INITIATOR}_{records.id}"
+    envname = f"{HTTPDBG_CURRENT_INITIATOR}_{records.session.id}"
 
     if not os.environ.get(envname):
         # temporary set a fake initiator env variable to avoid a recursion error

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/mode_script.py

@@ -4,6 +4,8 @@ import sys
 import traceback
 from typing import List
 
+from httpdbg.log import logger
+
 
 def run_script(argv: List[str]) -> None:
     sys.argv = argv
@@ -15,6 +17,15 @@ def run_script(argv: List[str]) -> None:
     except AttributeError:
         exit("script mode - error - the first argument shall be a python file")
     try:
+        original__main___module = sys.modules["__main__"]
+        sys.modules["__main__"] = module  # mandatory to execute a unittest test file.
         spec.loader.exec_module(module)  # type: ignore
     except Exception:
         traceback.print_exc()
+    except SystemExit as ex:
+        # in some case, for example when executing unittest tests from a script,
+        # the SystemExit exception is raised by the script itself so we catch it.
+        # TODO propagate the SystemExit value when httpdbg terminates.
+        logger().info(f"run_script - exception SystemExit - {str(ex)}")
+    finally:
+        sys.modules["__main__"] = original__main___module

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/records.py

@@ -5,6 +5,7 @@ import datetime
 import os
 import socket
 import ssl
+import sys
 import traceback
 from urllib.parse import urlparse
 from typing import Dict, List, Tuple, Union
@@ -293,13 +294,21 @@ class HTTPRecord:
         return max(self.request.last_update, self.response.last_update)
 
 
+class HTTPRecordsSessionInfo:
+
+    def __init__(self):
+        self.id: str = get_new_uuid()
+        self.command_line: str = " ".join(sys.argv[1:]) if sys.argv[1:] else "console"
+        self.tbegin: datetime.datetime = datetime.datetime.now(datetime.timezone.utc)
+
+
 class HTTPRecords:
     def __init__(self) -> None:
         self.reset()
 
     def reset(self) -> None:
         logger().info("HTTPRecords.reset")
-        self.id = get_new_uuid()
+        self.session: HTTPRecordsSessionInfo = HTTPRecordsSessionInfo()
         self.requests: Dict[str, HTTPRecord] = {}
         self.requests_already_loaded = 0
         self.initiators: Dict[str, Initiator] = {}
@@ -317,7 +326,7 @@ class HTTPRecords:
         return len(self.requests)
 
     def get_initiator(self) -> str:
-        envname = f"{HTTPDBG_CURRENT_INITIATOR}_{self.id}"
+        envname = f"{HTTPDBG_CURRENT_INITIATOR}_{self.session.id}"
 
         if envname in os.environ:
             initiator = self.initiators[os.environ[envname]]

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/webapp/api.py

@@ -3,6 +3,7 @@ from json import JSONEncoder
 import traceback
 from typing import Any
 from typing import Dict
+from typing import Union
 
 from httpdbg.records import HTTPRecords
 from httpdbg.records import HTTPRecord
@@ -65,13 +66,17 @@ class RequestPayload(JSONEncoder):
 
 
 class RequestListPayload(JSONEncoder):
-    def default(self, records):
+    def default(self, records: HTTPRecords):
         assert isinstance(
             records, HTTPRecords
         ), "This encoder works only for HTTPRecords object."
 
-        payload = {
-            "id": records.id,
+        payload: Dict[str, Dict[str, Union[str, dict]]] = {
+            "session": {
+                "id": records.session.id,
+                "command_line": records.session.command_line,
+                "tbegin": records.session.tbegin.isoformat(),
+            },
             "requests": {},
             "initiators": {},
             "groups": {},

{httpdbg-0.29.2 → httpdbg-0.31.0}/httpdbg/webapp/app.py

@@ -11,6 +11,7 @@ from urllib.parse import urlparse, parse_qs
 from httpdbg import __version__
 from httpdbg.log import logger
 from httpdbg.webapp.api import RequestListPayload, RequestPayload
+from httpdbg.records import HTTPRecords
 
 
 @contextmanager
@@ -22,7 +23,10 @@ def silently_catch_error():
 
 
 class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
-    def __init__(self, records, *args, **kwargs):
+
+    def __init__(
+        self: "HttpbgHTTPRequestHandler", records: HTTPRecords, *args, **kwargs
+    ):
         self.records = records
         super().__init__(*args, **kwargs)
 
@@ -42,7 +46,7 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
             if serve(url):
                 break
 
-    def serve_static(self, url):
+    def serve_static(self: "HttpbgHTTPRequestHandler", url):
         base_path = os.path.dirname(os.path.realpath(__file__))
 
         if not (
@@ -99,13 +103,13 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
 
         return True
 
-    def serve_requests(self, url):
+    def serve_requests(self: "HttpbgHTTPRequestHandler", url):
         if not (url.path.lower() == "/requests"):
             return False
 
         query = parse_qs(url.query)
 
-        if query.get("id", [""])[0] == self.records.id:
+        if query.get("id", [""])[0] == self.records.session.id:
             self.records.requests_already_loaded = int(
                 query.get("requests_already_loaded", [0])[0]
             )
@@ -122,7 +126,7 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
 
         return True
 
-    def serve_request(self, url):
+    def serve_request(self: "HttpbgHTTPRequestHandler", url):
         regexp = r"/request/([\w\-]+)"
 
         if re.fullmatch(regexp, url.path) is None:
@@ -145,7 +149,7 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
 
         return True
 
-    def serve_request_content_up(self, url):
+    def serve_request_content_up(self: "HttpbgHTTPRequestHandler", url):
         regexp = r"/request/([\w\-]+)/up"
 
         if re.fullmatch(regexp, url.path) is None:
@@ -162,15 +166,11 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
         self.send_header("Content-type", "application/octet-stream")
         self.send_header_no_cache()
         self.end_headers()
-        self.wfile.write(
-            req.request.content.encode("utf-8")
-            if isinstance(req.request.content, str)
-            else req.request.content
-        )
+        self.wfile.write(req.request.content)
 
         return True
 
-    def serve_request_content_down(self, url):
+    def serve_request_content_down(self: "HttpbgHTTPRequestHandler", url):
         regexp = r"/request/([\w\-]+)/down"
 
         if re.fullmatch(regexp, url.path) is None:
@@ -191,7 +191,7 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
 
         return True
 
-    def serve_not_found(self, *kwargs):
+    def serve_not_found(self: "HttpbgHTTPRequestHandler", *kwargs):
         self.send_response(404)
         self.send_header_no_cache()
         self.end_headers()
@@ -199,11 +199,11 @@ class HttpbgHTTPRequestHandler(BaseHTTPRequestHandler):
 
         return True
 
-    def log_message(self, format, *args):
+    def log_message(self: "HttpbgHTTPRequestHandler", format, *args):
         pass
 
     def send_header_no_cache(self):
         self.send_header("Cache-Control", "max-age=0, no-cache, no-store, private")
 
-    def send_header_with_cache(self, seconds):
+    def send_header_with_cache(self: "HttpbgHTTPRequestHandler", seconds):
         self.send_header("Cache-Control", f"max-age={seconds}")