|
| 1 | +""" |
| 2 | +Unit tests verifying that RLock -> Lock conversion is safe. |
| 3 | +
|
| 4 | +Tests that the lock objects are of the correct type and that basic |
| 5 | +operations (connect, metadata, pool) still work correctly. |
| 6 | +""" |
| 7 | +import threading |
| 8 | +import unittest |
| 9 | +from unittest.mock import Mock, patch |
| 10 | + |
| 11 | +from cassandra.cluster import Cluster |
| 12 | +from cassandra.metadata import Metadata, TokenMap |
| 13 | +from cassandra.pool import Host |
| 14 | + |
| 15 | + |
| 16 | +class TestLockTypes(unittest.TestCase): |
| 17 | + """Verify each converted lock is a plain Lock, not RLock.""" |
| 18 | + |
| 19 | + def _assert_is_lock_not_rlock(self, lock_obj): |
| 20 | + """Assert the given object is a plain Lock, not an RLock.""" |
| 21 | + # In CPython, Lock() creates _thread.lock, RLock() creates _thread.RLock |
| 22 | + lock_type_name = type(lock_obj).__name__ |
| 23 | + self.assertNotIn('RLock', lock_type_name, |
| 24 | + f"Expected plain Lock but got {type(lock_obj)}") |
| 25 | + |
| 26 | + def test_metadata_hosts_lock_is_plain_lock(self): |
| 27 | + """Metadata._hosts_lock should be a plain Lock.""" |
| 28 | + m = Metadata() |
| 29 | + self._assert_is_lock_not_rlock(m._hosts_lock) |
| 30 | + |
| 31 | + def test_metadata_rebuild_lock_is_plain_lock(self): |
| 32 | + """TokenMap._rebuild_lock should be a plain Lock.""" |
| 33 | + tm = TokenMap( |
| 34 | + token_class=Mock(), |
| 35 | + token_to_host_owner={}, |
| 36 | + all_tokens=[], |
| 37 | + metadata=Mock() |
| 38 | + ) |
| 39 | + self._assert_is_lock_not_rlock(tm._rebuild_lock) |
| 40 | + |
| 41 | + def test_host_lock_is_plain_lock(self): |
| 42 | + """Host.lock should be a plain Lock.""" |
| 43 | + import uuid |
| 44 | + h = Host( |
| 45 | + endpoint=Mock(), |
| 46 | + conviction_policy_factory=Mock(), |
| 47 | + host_id=uuid.uuid4() |
| 48 | + ) |
| 49 | + self._assert_is_lock_not_rlock(h.lock) |
| 50 | + |
| 51 | + def test_cqlengine_connection_lock_is_plain_lock(self): |
| 52 | + """CQLEngine Connection.lazy_connect_lock should be a plain Lock.""" |
| 53 | + from cassandra.cqlengine.connection import Connection as CQLConn |
| 54 | + c = CQLConn.__new__(CQLConn) |
| 55 | + c.lazy_connect_lock = threading.Lock() |
| 56 | + self._assert_is_lock_not_rlock(c.lazy_connect_lock) |
| 57 | + |
| 58 | + |
| 59 | +class TestMetadataOperationsWithLock(unittest.TestCase): |
| 60 | + """Verify metadata operations work correctly with plain Lock.""" |
| 61 | + |
| 62 | + def test_add_and_get_host(self): |
| 63 | + """add_or_return_host + get_host should work with plain Lock.""" |
| 64 | + import uuid |
| 65 | + m = Metadata() |
| 66 | + endpoint = Mock() |
| 67 | + host = Host(endpoint=endpoint, conviction_policy_factory=Mock(), |
| 68 | + host_id=uuid.uuid4()) |
| 69 | + returned, new = m.add_or_return_host(host) |
| 70 | + self.assertTrue(new) |
| 71 | + self.assertIs(returned, host) |
| 72 | + |
| 73 | + # Second add should return same host |
| 74 | + returned2, new2 = m.add_or_return_host(host) |
| 75 | + self.assertFalse(new2) |
| 76 | + self.assertIs(returned2, host) |
| 77 | + |
| 78 | + def test_update_host_sequential_lock(self): |
| 79 | + """update_host acquires lock twice sequentially — must not deadlock.""" |
| 80 | + import uuid |
| 81 | + m = Metadata() |
| 82 | + old_endpoint = Mock() |
| 83 | + new_endpoint = Mock() |
| 84 | + host = Host(endpoint=new_endpoint, conviction_policy_factory=Mock(), |
| 85 | + host_id=uuid.uuid4()) |
| 86 | + # update_host calls add_or_return_host (acquires lock, releases), |
| 87 | + # then acquires lock again for endpoint update. |
| 88 | + # With plain Lock, this must NOT deadlock. |
| 89 | + m.update_host(host, old_endpoint) |
| 90 | + # Host should be retrievable by host_id |
| 91 | + result = m.get_host_by_host_id(host.host_id) |
| 92 | + self.assertIs(result, host) |
| 93 | + |
| 94 | + def test_remove_host(self): |
| 95 | + """remove_host should work with plain Lock.""" |
| 96 | + import uuid |
| 97 | + m = Metadata() |
| 98 | + endpoint = Mock() |
| 99 | + host = Host(endpoint=endpoint, conviction_policy_factory=Mock(), |
| 100 | + host_id=uuid.uuid4()) |
| 101 | + m.add_or_return_host(host) |
| 102 | + removed = m.remove_host(host) |
| 103 | + self.assertTrue(removed) |
| 104 | + |
| 105 | + def test_all_hosts(self): |
| 106 | + """all_hosts should work under plain Lock.""" |
| 107 | + import uuid |
| 108 | + m = Metadata() |
| 109 | + hosts = [] |
| 110 | + for _ in range(3): |
| 111 | + h = Host(endpoint=Mock(), conviction_policy_factory=Mock(), |
| 112 | + host_id=uuid.uuid4()) |
| 113 | + m.add_or_return_host(h) |
| 114 | + hosts.append(h) |
| 115 | + all_h = m.all_hosts() |
| 116 | + self.assertEqual(len(all_h), 3) |
| 117 | + |
| 118 | + |
| 119 | +class TestHostLockOperations(unittest.TestCase): |
| 120 | + """Verify Host lock operations work with plain Lock.""" |
| 121 | + |
| 122 | + def test_get_and_set_reconnection_handler(self): |
| 123 | + """get_and_set_reconnection_handler should work with plain Lock.""" |
| 124 | + import uuid |
| 125 | + h = Host(endpoint=Mock(), conviction_policy_factory=Mock(), |
| 126 | + host_id=uuid.uuid4()) |
| 127 | + handler = Mock() |
| 128 | + old = h.get_and_set_reconnection_handler(handler) |
| 129 | + self.assertIsNone(old) |
| 130 | + old2 = h.get_and_set_reconnection_handler(Mock()) |
| 131 | + self.assertIs(old2, handler) |
| 132 | + |
| 133 | + |
| 134 | +class TestClusterConnectFailureNoDeadlock(unittest.TestCase): |
| 135 | + """Verify Cluster.connect() failure path doesn't deadlock with plain Lock. |
| 136 | +
|
| 137 | + Cluster._lock is a plain Lock. connect() acquires it, and on failure |
| 138 | + calls shutdown() which also acquires it. The shutdown() call must happen |
| 139 | + after releasing the lock to avoid deadlock. |
| 140 | + """ |
| 141 | + |
| 142 | + def test_connect_failure_calls_shutdown_without_deadlock(self): |
| 143 | + """connect() should call shutdown() and re-raise on control connection failure.""" |
| 144 | + cluster = Cluster(contact_points=[]) |
| 145 | + # Ensure Cluster._lock is a plain Lock (not RLock) |
| 146 | + lock_type_name = type(cluster._lock).__name__ |
| 147 | + self.assertNotIn('RLock', lock_type_name) |
| 148 | + |
| 149 | + with patch.object(cluster.connection_class, 'initialize_reactor'): |
| 150 | + with patch.object(cluster.control_connection, 'connect', |
| 151 | + side_effect=Exception("test connection failure")): |
| 152 | + with patch.object(cluster, 'shutdown') as mock_shutdown: |
| 153 | + with self.assertRaises(Exception) as ctx: |
| 154 | + cluster.connect() |
| 155 | + self.assertIn("test connection failure", str(ctx.exception)) |
| 156 | + mock_shutdown.assert_called_once() |
| 157 | + |
| 158 | + |
| 159 | +if __name__ == '__main__': |
| 160 | + unittest.main() |
0 commit comments