httpdbg 0.29.2__tar.gz → 0.30.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.29.2
+Version: 0.30.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

{httpdbg-0.29.2 → httpdbg-0.30.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

{httpdbg-0.29.2 → httpdbg-0.30.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.30.0"
 
 __all__ = ["httprecord", "HTTPRecords"]

{httpdbg-0.29.2 → httpdbg-0.30.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.30.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.30.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.30.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.30.0}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.29.2
+Version: 0.30.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

{httpdbg-0.29.2 → httpdbg-0.30.0}/httpdbg.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ httpdbg/hooks/httpx.py
 httpdbg/hooks/pytest.py
 httpdbg/hooks/requests.py
 httpdbg/hooks/socket.py
+httpdbg/hooks/unittest.py
 httpdbg/hooks/urllib3.py
 httpdbg/hooks/utils.py
 httpdbg/webapp/__init__.py
@@ -64,7 +65,9 @@ tests/test_cli.py
 tests/test_context_manager.py
 tests/test_hook_aiohttp.py
 tests/test_hook_httpx.py
+tests/test_hook_pytest.py
 tests/test_hook_requests.py
+tests/test_hook_unittest.py
 tests/test_hook_urllib3.py
 tests/test_initiator.py
 tests/test_mode_console.py

{httpdbg-0.29.2 → httpdbg-0.30.0}/tests/test_api.py

@@ -6,8 +6,8 @@ import pytest
 from httpdbg.hooks.all import httprecord
 from httpdbg.server import httpdbg_srv
 
-from utils import get_request_content_up
-from utils import get_request_details
+from tests.utils import get_request_content_up
+from tests.utils import get_request_details
 
 
 @pytest.mark.api

httpdbg-0.30.0/tests/test_hook_pytest.py

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+import os
+
+import pytest
+
+from httpdbg.mode_module import run_module
+from httpdbg.hooks.all import httprecord
+
+
+@pytest.mark.pytest
+@pytest.mark.group
+@pytest.mark.tag
+def test_run_pytest_tag(httpbin):
+    with httprecord() as records:
+        os.environ["HTTPDBG_TEST_PYTEST_BASE_URL"] = httpbin.url
+        script_to_run = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "demo_run_pytest.py"
+        )
+        run_module(["pytest", f"{script_to_run}::test_demo_pytest_fixture_tag"])
+
+    assert len(records) == 2
+    groups = records.groups
+
+    assert records[0].url.endswith("/post")
+    assert groups[records[0].group_id].label == "test_demo_pytest_fixture_tag"
+    assert (
+        "demo_run_pytest.py::test_demo_pytest_fixture_tag"
+        in groups[records[0].group_id].full_label
+    )
+    assert records[0].tag == "my_fixture"
+
+    assert records[1].url.endswith("/get")
+    assert groups[records[1].group_id].label == "test_demo_pytest_fixture_tag"
+    assert (
+        "demo_run_pytest.py::test_demo_pytest_fixture_tag"
+        in groups[records[1].group_id].full_label
+    )
+    assert records[1].tag is None

httpdbg-0.30.0/tests/test_hook_unittest.py

@@ -0,0 +1,132 @@
+# -*- coding: utf-8 -*-
+import os
+
+import pytest
+
+from httpdbg.mode_module import run_module
+from httpdbg.mode_script import run_script
+from httpdbg.hooks.all import httprecord
+
+
+@pytest.mark.unittest
+@pytest.mark.group
+@pytest.mark.tag
+def test_run_module_unittest(httpbin):
+    with httprecord() as records:
+        os.environ["HTTPDBG_TEST_UNITTEST_BASE_URL"] = httpbin.url
+        script_to_run = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "demo_run_unittest.py"
+        )
+        run_module(["unittest", f"{script_to_run}"])
+
+    assert_unittest_records(records)
+
+
+@pytest.mark.unittest
+@pytest.mark.group
+@pytest.mark.tag
+def test_run_script_unittest(httpbin):
+    with httprecord() as records:
+        os.environ["HTTPDBG_TEST_UNITTEST_BASE_URL"] = httpbin.url
+        script_to_run = os.path.join(
+            os.path.dirname(os.path.realpath(__file__)), "demo_run_unittest.py"
+        )
+        run_script([f"{script_to_run}"])
+
+    assert_unittest_records(records)
+
+
+def assert_unittest_records(records):
+
+    assert len(records) == 10
+    groups = records.groups
+
+    i_req = 0
+    assert records[i_req].url.endswith("/setup_module")
+    assert groups[records[i_req].group_id].label == "setUpModule (demo_run_unittest)"
+    assert (
+        "demo_run_unittest.py::setUpModule"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None
+
+    i_req = 1
+    assert records[i_req].url.endswith("/setup_class")
+    assert groups[records[i_req].group_id].label == "TestUnittests::setUpClass"
+    assert (
+        "demo_run_unittest.py::TestUnittests::setUpClass"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None
+
+    i_req = 2
+    assert records[i_req].url.endswith("/setup")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case1"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case1"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag == "setUp"
+
+    i_req = 3
+    assert records[i_req].url.endswith("/testcase1")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case1"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case1"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None
+
+    i_req = 4
+    assert records[i_req].url.endswith("/teardown")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case1"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case1"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag == "tearDown"
+
+    i_req = 5
+    assert records[i_req].url.endswith("/setup")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case2"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case2"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag == "setUp"
+
+    i_req = 6
+    assert records[i_req].url.endswith("/testcase2")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case2"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case2"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None
+
+    i_req = 7
+    assert records[i_req].url.endswith("/teardown")
+    assert groups[records[i_req].group_id].label == "TestUnittests::test_case2"
+    assert (
+        "demo_run_unittest.py::TestUnittests::test_case2"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag == "tearDown"
+
+    i_req = 8
+    assert records[i_req].url.endswith("/teardown_class")
+    assert groups[records[i_req].group_id].label == "TestUnittests::tearDownClass"
+    assert (
+        "demo_run_unittest.py::TestUnittests::tearDownClass"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None
+
+    i_req = 9
+    assert records[i_req].url.endswith("/teardown_module")
+    assert groups[records[i_req].group_id].label == "tearDownModule (demo_run_unittest)"
+    assert (
+        "demo_run_unittest.py::tearDownModule"
+        in groups[records[i_req].group_id].full_label
+    )
+    assert records[i_req].tag is None

{httpdbg-0.29.2 → httpdbg-0.30.0}/tests/test_initiator.py

@@ -102,12 +102,12 @@ def test_initiator_pytest(httpbin):
 )
 def test_initiator_add_package_fnc(httpbin):
     # all cases must be tested in the same test
-    with httprecord(initiators=["initiator_pck"]) as records:
-        from initiator_pck.initiator2.mod2 import fnc_in_subpackage
-        from initiator_pck.mod1 import fnc_in_package
-        from initiator_pck import fnc_async
-        from initiator_pck.initiator2.initiator3 import fnc_in_init
-        from initiator_pck.initiator2.mod2 import FakeClient
+    with httprecord(initiators=["tests.initiator_pck"]) as records:
+        from tests.initiator_pck.initiator2.mod2 import fnc_in_subpackage
+        from tests.initiator_pck.mod1 import fnc_in_package
+        from tests.initiator_pck import fnc_async
+        from tests.initiator_pck.initiator2.initiator3 import fnc_in_init
+        from tests.initiator_pck.initiator2.mod2 import FakeClient
 
         fnc_in_package(f"{httpbin.url}/get")
         fnc_in_subpackage(f"{httpbin.url}/get")

{httpdbg-0.29.2 → httpdbg-0.30.0}/tests/test_mode_module_pytest.py

@@ -112,28 +112,3 @@ def test_run_pytest_group(httpbin, httpdbg_host, httpdbg_port):
 
     assert group["label"] == "test_demo_pytest"
     assert group["full_label"] == "tests/demo_run_pytest.py::test_demo_pytest"
-
-
-@pytest.mark.api
-@pytest.mark.pytest
-@pytest.mark.tag
-def test_run_pytest_tag(httpbin, httpdbg_host, httpdbg_port):
-    with httpdbg_srv(httpdbg_host, httpdbg_port) as records:
-        with httprecord(records):
-            os.environ["HTTPDBG_TEST_PYTEST_BASE_URL"] = httpbin.url
-            script_to_run = os.path.join(
-                os.path.dirname(os.path.realpath(__file__)), "demo_run_pytest.py"
-            )
-            run_module(["pytest", f"{script_to_run}::test_demo_pytest_fixture_tag"])
-
-        ret = requests.get(f"http://{httpdbg_host}:{httpdbg_port}/requests")
-
-    reqs = ret.json()["requests"]
-
-    assert len(reqs) == 2
-
-    assert reqs[list(reqs.keys())[0]]["url"] == httpbin.url + "/post"
-    assert reqs[list(reqs.keys())[0]]["tag"] == "my_fixture"
-
-    assert reqs[list(reqs.keys())[1]]["url"] == httpbin.url + "/get"
-    assert reqs[list(reqs.keys())[1]]["tag"] is None