e2e: add DPS leak checks

Run strict SDK and Paho leak tracking after every DPS registration test. Share tracker construction with the IoT Hub suite while preserving its existing false-positive filter.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: cartertinney

dev_utils/dev_utils/sdk_leak_tracker.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE file in the project root for
+# full license information.
+
+from .leak_tracker import LeakTracker
+
+TRACKED_MODULES = ("azure.iot.device", "paho")
+
+
+def create_tracker(filter_callback=None):
+    tracker = LeakTracker()
+    for module_name in TRACKED_MODULES:
+        tracker.track_module(module_name)
+    tracker.filter_callback = filter_callback
+    return tracker

tests/e2e/iothub_e2e/conftest.py

@@ -8,8 +8,7 @@
 import test_config
 import device_identity_helper
 import const
-import dev_utils.leak_tracker as leak_tracker_module
-from dev_utils import test_env, get_random_message, get_random_dict, iptables
+from dev_utils import test_env, get_random_message, get_random_dict, iptables, sdk_leak_tracker
 from utils import is_windows
 
 from drop_fixtures import dropper  # noqa: F401
@@ -122,11 +121,7 @@ def leak_tracker_filter(leaks):
 @pytest.fixture(scope="function")
 def leak_tracker():
     """Opt the requesting test into a leak check before fixture teardown."""
-    tracker = leak_tracker_module.LeakTracker()
-    tracker.track_module("azure.iot.device")
-    tracker.track_module("paho")
-    tracker.filter_callback = leak_tracker_filter
-    return tracker
+    return sdk_leak_tracker.create_tracker(filter_callback=leak_tracker_filter)
 
 
 @pytest.fixture(scope="session")
@@ -232,10 +227,7 @@ def pytest_runtest_setup(item):
     #
     # Of these 2, the `leak_tracker` fixture is more useful.
     #
-    item.outer_leak_tracker = leak_tracker_module.LeakTracker()
-    item.outer_leak_tracker.track_module("azure.iot.device")
-    item.outer_leak_tracker.track_module("paho")
-    item.outer_leak_tracker.filter_callback = leak_tracker_filter
+    item.outer_leak_tracker = sdk_leak_tracker.create_tracker(filter_callback=leak_tracker_filter)
     item.outer_leak_tracker.set_initial_object_list()
 
 

tests/e2e/provisioning_e2e/conftest.py

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+
+import pytest
+
+from dev_utils import sdk_leak_tracker
+
+
+@pytest.hookimpl(wrapper=True)
+def pytest_runtest_call():
+    """
+    Check that DPS client objects are released after each registration test.
+
+    Successful registration shuts down the provisioning pipeline before returning. The leak check
+    runs after the test frame is released so test-local clients and results do not cause false
+    positives.
+    """
+    # DPS clients are created after this baseline, so allowing a "replacement" object would hide
+    # a real leak rather than suppress a false positive.
+    tracker = sdk_leak_tracker.create_tracker()
+    tracker.set_initial_object_list()
+
+    result = yield
+
+    tracker.check_for_leaks()
+    return result