Add release_references

Author: justmobilize

adafruit_connection_manager.py

@@ -320,21 +320,38 @@ def get_socket(
 
 
 def connection_manager_close_all(
-    socket_pool: Optional[SocketpoolModuleType] = None,
+    socket_pool: Optional[SocketpoolModuleType] = None, release_references: bool = False
 ) -> None:
     """Close all open sockets for pool"""
     if socket_pool:
-        keys = [socket_pool]
+        socket_pools = [socket_pool]
     else:
-        keys = _global_connection_managers.keys()
+        socket_pools = _global_connection_managers.keys()
 
-    for key in keys:
-        connection_manager = _global_connection_managers.get(key, None)
+    for pool in socket_pools:
+        connection_manager = _global_connection_managers.get(pool, None)
         if connection_manager is None:
             raise RuntimeError("SocketPool not managed")
 
         connection_manager._free_sockets(force=True)  # pylint: disable=protected-access
 
+        if release_references:
+            radio_key = None
+            for radio_check, pool_check in _global_socketpools.items():
+                if pool == pool_check:
+                    radio_key = radio_check
+                    break
+
+            if radio_key:
+                if radio_key in _global_socketpools:
+                    del _global_socketpools[radio_key]
+
+                if radio_key in _global_ssl_contexts:
+                    del _global_ssl_contexts[radio_key]
+
+            if pool in _global_connection_managers:
+                del _global_connection_managers[pool]
+
 
 def get_connection_manager(socket_pool: SocketpoolModuleType) -> ConnectionManager:
     """Get the ConnectionManager singleton for the given pool"""

tests/connection_manager_close_all_test.py

@@ -85,3 +85,94 @@ def test_connection_manager_close_all_untracked():
     with pytest.raises(RuntimeError) as context:
         adafruit_connection_manager.connection_manager_close_all(mock_pool_1)
     assert "SocketPool not managed" in str(context)
+
+
+def test_connection_manager_close_all_single_release_references_false(  # pylint: disable=unused-argument
+    circuitpython_socketpool_module, adafruit_esp32spi_socket_module
+):
+    radio_wifi = mocket.MockRadio.Radio()
+    radio_esp = mocket.MockRadio.ESP_SPIcontrol()
+
+    socket_pool_wifi = adafruit_connection_manager.get_radio_socketpool(radio_wifi)
+    socket_pool_esp = adafruit_connection_manager.get_radio_socketpool(radio_esp)
+
+    ssl_context_wifi = adafruit_connection_manager.get_radio_ssl_context(radio_wifi)
+    ssl_context_esp = adafruit_connection_manager.get_radio_ssl_context(radio_esp)
+
+    connection_manager_wifi = adafruit_connection_manager.get_connection_manager(
+        socket_pool_wifi
+    )
+    connection_manager_esp = adafruit_connection_manager.get_connection_manager(
+        socket_pool_esp
+    )
+
+    assert socket_pool_wifi != socket_pool_esp
+    assert ssl_context_wifi != ssl_context_esp
+    assert connection_manager_wifi != connection_manager_esp
+
+    adafruit_connection_manager.connection_manager_close_all(
+        socket_pool_wifi, release_references=False
+    )
+
+    assert socket_pool_wifi in adafruit_connection_manager._global_socketpools.values()
+    assert socket_pool_esp in adafruit_connection_manager._global_socketpools.values()
+
+    assert ssl_context_wifi in adafruit_connection_manager._global_ssl_contexts.values()
+    assert ssl_context_esp in adafruit_connection_manager._global_ssl_contexts.values()
+
+    assert (
+        socket_pool_wifi
+        in adafruit_connection_manager._global_connection_managers.keys()
+    )
+    assert (
+        socket_pool_esp
+        in adafruit_connection_manager._global_connection_managers.keys()
+    )
+
+
+def test_connection_manager_close_all_single_release_references_true(  # pylint: disable=unused-argument
+    circuitpython_socketpool_module, adafruit_esp32spi_socket_module
+):
+    radio_wifi = mocket.MockRadio.Radio()
+    radio_esp = mocket.MockRadio.ESP_SPIcontrol()
+
+    socket_pool_wifi = adafruit_connection_manager.get_radio_socketpool(radio_wifi)
+    socket_pool_esp = adafruit_connection_manager.get_radio_socketpool(radio_esp)
+
+    ssl_context_wifi = adafruit_connection_manager.get_radio_ssl_context(radio_wifi)
+    ssl_context_esp = adafruit_connection_manager.get_radio_ssl_context(radio_esp)
+
+    connection_manager_wifi = adafruit_connection_manager.get_connection_manager(
+        socket_pool_wifi
+    )
+    connection_manager_esp = adafruit_connection_manager.get_connection_manager(
+        socket_pool_esp
+    )
+
+    assert socket_pool_wifi != socket_pool_esp
+    assert ssl_context_wifi != ssl_context_esp
+    assert connection_manager_wifi != connection_manager_esp
+
+    adafruit_connection_manager.connection_manager_close_all(
+        socket_pool_wifi, release_references=True
+    )
+
+    assert (
+        socket_pool_wifi not in adafruit_connection_manager._global_socketpools.values()
+    )
+    assert socket_pool_esp in adafruit_connection_manager._global_socketpools.values()
+
+    assert (
+        ssl_context_wifi
+        not in adafruit_connection_manager._global_ssl_contexts.values()
+    )
+    assert ssl_context_esp in adafruit_connection_manager._global_ssl_contexts.values()
+
+    assert (
+        socket_pool_wifi
+        not in adafruit_connection_manager._global_connection_managers.keys()
+    )
+    assert (
+        socket_pool_esp
+        in adafruit_connection_manager._global_connection_managers.keys()
+    )

tests/get_radio_test.py

@@ -19,6 +19,7 @@ def test_get_radio_socketpool_wifi(  # pylint: disable=unused-argument
     radio = mocket.MockRadio.Radio()
     socket_pool = adafruit_connection_manager.get_radio_socketpool(radio)
     assert isinstance(socket_pool, mocket.MocketPool)
+    assert socket_pool in adafruit_connection_manager._global_socketpools.values()
 
 
 def test_get_radio_socketpool_esp32spi(  # pylint: disable=unused-argument
@@ -27,6 +28,7 @@ def test_get_radio_socketpool_esp32spi(  # pylint: disable=unused-argument
     radio = mocket.MockRadio.ESP_SPIcontrol()
     socket_pool = adafruit_connection_manager.get_radio_socketpool(radio)
     assert socket_pool.__name__ == "adafruit_esp32spi_socket"
+    assert socket_pool in adafruit_connection_manager._global_socketpools.values()
 
 
 def test_get_radio_socketpool_wiznet5k(  # pylint: disable=unused-argument
@@ -36,6 +38,7 @@ def test_get_radio_socketpool_wiznet5k(  # pylint: disable=unused-argument
     with mock.patch("sys.implementation", return_value=[9, 0, 0]):
         socket_pool = adafruit_connection_manager.get_radio_socketpool(radio)
     assert socket_pool.__name__ == "adafruit_wiznet5k_socket"
+    assert socket_pool in adafruit_connection_manager._global_socketpools.values()
 
 
 def test_get_radio_socketpool_unsupported():
@@ -52,31 +55,35 @@ def test_get_radio_socketpool_returns_same_one(  # pylint: disable=unused-argume
     socket_pool_1 = adafruit_connection_manager.get_radio_socketpool(radio)
     socket_pool_2 = adafruit_connection_manager.get_radio_socketpool(radio)
     assert socket_pool_1 == socket_pool_2
+    assert socket_pool_1 in adafruit_connection_manager._global_socketpools.values()
 
 
 def test_get_radio_ssl_context_wifi(  # pylint: disable=unused-argument
     circuitpython_socketpool_module,
 ):
     radio = mocket.MockRadio.Radio()
-    ssl_contexts = adafruit_connection_manager.get_radio_ssl_context(radio)
-    assert isinstance(ssl_contexts, ssl.SSLContext)
+    ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio)
+    assert isinstance(ssl_context, ssl.SSLContext)
+    assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values()
 
 
 def test_get_radio_ssl_context_esp32spi(  # pylint: disable=unused-argument
     adafruit_esp32spi_socket_module,
 ):
     radio = mocket.MockRadio.ESP_SPIcontrol()
-    ssl_contexts = adafruit_connection_manager.get_radio_ssl_context(radio)
-    assert isinstance(ssl_contexts, adafruit_connection_manager._FakeSSLContext)
+    ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio)
+    assert isinstance(ssl_context, adafruit_connection_manager._FakeSSLContext)
+    assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values()
 
 
 def test_get_radio_ssl_context_wiznet5k(  # pylint: disable=unused-argument
     adafruit_wiznet5k_socket_module,
 ):
     radio = mocket.MockRadio.WIZNET5K()
     with mock.patch("sys.implementation", return_value=[9, 0, 0]):
-        ssl_contexts = adafruit_connection_manager.get_radio_ssl_context(radio)
-    assert isinstance(ssl_contexts, adafruit_connection_manager._FakeSSLContext)
+        ssl_context = adafruit_connection_manager.get_radio_ssl_context(radio)
+    assert isinstance(ssl_context, adafruit_connection_manager._FakeSSLContext)
+    assert ssl_context in adafruit_connection_manager._global_ssl_contexts.values()
 
 
 def test_get_radio_ssl_context_unsupported():
@@ -90,6 +97,7 @@ def test_get_radio_ssl_context_returns_same_one(  # pylint: disable=unused-argum
     circuitpython_socketpool_module,
 ):
     radio = mocket.MockRadio.Radio()
-    ssl_contexts_1 = adafruit_connection_manager.get_radio_ssl_context(radio)
-    ssl_contexts_2 = adafruit_connection_manager.get_radio_ssl_context(radio)
-    assert ssl_contexts_1 == ssl_contexts_2
+    ssl_context_1 = adafruit_connection_manager.get_radio_ssl_context(radio)
+    ssl_context_2 = adafruit_connection_manager.get_radio_ssl_context(radio)
+    assert ssl_context_1 == ssl_context_2
+    assert ssl_context_1 in adafruit_connection_manager._global_ssl_contexts.values()