add unsubscribe test

Merge pull request #579 from jmdietrich-gcx/unsubscribe_characteristic_in_gatt_client
Remove characteristic in GATT Client unsubscribe() if it's the last subscriber
2024-11-03 19:08:27 -08:00 · 2024-10-31 04:07:02 -07:00 · 2024-10-31 11:04:25 +00:00 · 2024-10-31 03:44:01 -07:00 · 2024-10-31 18:11:40 +08:00 · 2024-10-30 07:34:22 +01:00
3 changed files with 20 additions and 2 deletions
@@ -898,6 +898,12 @@ class Client:
                ) and subscriber in subscribers:
                    subscribers.remove(subscriber)

+                    # The characteristic itself is added as subscriber. If it is the
+                    # last remaining subscriber, we remove it, such that the clean up
+                    # works correctly. Otherwise the CCCD never is set back to 0.
+                    if len(subscribers) == 1 and characteristic in subscribers:
+                        subscribers.remove(characteristic)
+
                    # Cleanup if we removed the last one
                    if not subscribers:
                        del subscriber_set[characteristic.handle]
@@ -102,6 +102,7 @@ class ContextType(enum.IntFlag):

    # fmt: off
    PROHIBITED       = 0x0000
+    UNSPECIFIED      = 0x0001
    CONVERSATIONAL   = 0x0002
    MEDIA            = 0x0004
    GAME             = 0x0008
@@ -851,7 +851,12 @@ async def test_unsubscribe():
    await async_barrier()
    mock1.assert_called_once_with(ANY, True, False)

-    await c2.subscribe()
+    assert len(server.gatt_server.subscribers) == 1
+
+    def callback(_):
+        pass
+
+    await c2.subscribe(callback)
    await async_barrier()
    mock2.assert_called_once_with(ANY, True, False)

@@ -861,10 +866,16 @@ async def test_unsubscribe():
    mock1.assert_called_once_with(ANY, False, False)

    mock2.reset_mock()
-    await c2.unsubscribe()
+    await c2.unsubscribe(callback)
    await async_barrier()
    mock2.assert_called_once_with(ANY, False, False)

+    # All CCCDs should be zeros now
+    assert list(server.gatt_server.subscribers.values())[0] == {
+        c1.handle: bytes([0, 0]),
+        c2.handle: bytes([0, 0]),
+    }
+
    mock1.reset_mock()
    await c1.unsubscribe()
    await async_barrier()
Author	SHA1	Message	Date
Gilles Boccon-Gibod	a1414c2b5b	add unsubscribe test	2024-11-03 19:08:27 -08:00
Gilles Boccon-Gibod	b78f895143	Merge pull request #579 from jmdietrich-gcx/unsubscribe_characteristic_in_gatt_client Remove characteristic in GATT Client unsubscribe() if it's the last subscriber	2024-10-31 04:07:02 -07:00
zxzxwu	c4e9726828	Merge pull request #581 from zxzxwu/context [BAP] Add missing Unspecified context type	2024-10-31 11:04:25 +00:00
Gilles Boccon-Gibod	d4b8e8348a	Merge pull request #574 from google/gbg/update-python-versions remove test for deprecated Python 3.8 and add 3.13	2024-10-31 03:44:01 -07:00
Josh Wu	19debaa52e	[BAP] Add missing Unspecified context type	2024-10-31 18:11:40 +08:00
Jan-Marcel Dietrich	73fe564321	Remove characteristic in GATT Client unsubscribe() if it's the last subscriber GATT Client's subscribe() adds the characteristic itself as subscriber. Therefore the characteristic has to be removed in unsubscribe(), if it's the last subscriber. Otherwise the clean up does not work correctly and the CCCD never is set back to 0 in the remote device.	2024-10-30 07:34:22 +01:00