Merge pull request apache#833 from datastax/python-810

aboudreault · web-flow · commit a549ca634776 · 2017-10-04T12:40:53.000-04:00
PYTHON-810: Revert Deprecation of WhiteListRoundRobinPolicy
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,10 @@ Bug Fixes
 * cqlengine: allow min_length=0 for Ascii and Text column types (PYTHON-735)
 * Rare exception when "sys.exit(0)" after query timeouts (PYTHON-752)
 
+Others
+------
+* Remove DeprecationWarning when using WhiteListRoundRobinPolicy (PYTHON-810)
+
 3.11.0
 ======
 July 24, 2017
diff --git a/cassandra/policies.py b/cassandra/policies.py
@@ -17,7 +17,6 @@
 from random import randint, shuffle
 from threading import Lock
 import socket
-from warnings import warn
 
 from cassandra import ConsistencyLevel, OperationTimedOut
 
@@ -397,10 +396,6 @@ def on_remove(self, *args, **kwargs):
 
 class WhiteListRoundRobinPolicy(RoundRobinPolicy):
     """
-    |wlrrp| **is deprecated. It will be removed in 4.0.** It can effectively be
-    reimplemented using :class:`.HostFilterPolicy`. For more information, see
-    PYTHON-758_.
-
     A subclass of :class:`.RoundRobinPolicy` which evenly
     distributes queries across all nodes in the cluster,
     regardless of what datacenter the nodes may be in, but
@@ -410,26 +405,13 @@ class WhiteListRoundRobinPolicy(RoundRobinPolicy):
     https://datastax-oss.atlassian.net/browse/JAVA-145
     Where connection errors occur when connection
     attempts are made to private IP addresses remotely
-
-    .. |wlrrp| raw:: html
-
-       <b><code>WhiteListRoundRobinPolicy</code></b>
-
-    .. _PYTHON-758: https://datastax-oss.atlassian.net/browse/PYTHON-758
-
     """
+
     def __init__(self, hosts):
         """
         The `hosts` parameter should be a sequence of hosts to permit
         connections to.
         """
-        msg = ('WhiteListRoundRobinPolicy is deprecated. '
-               'It will be removed in 4.0. '
-               'It can effectively be reimplemented using HostFilterPolicy.')
-        warn(msg, DeprecationWarning)
-        # DeprecationWarnings are silent by default so we also log the message
-        log.warning(msg)
-
         self._allowed_hosts = hosts
         self._allowed_hosts_resolved = [endpoint[4][0] for a in self._allowed_hosts
                                         for endpoint in socket.getaddrinfo(a, None, socket.AF_UNSPEC, socket.SOCK_STREAM)]
diff --git a/tests/integration/standard/test_policies.py b/tests/integration/standard/test_policies.py
@@ -19,19 +19,19 @@
 except ImportError:
     import unittest  # noqa
 
-from cassandra.cluster import Cluster
-from cassandra.policies import HostFilterPolicy, RoundRobinPolicy, \
-    SimpleConvictionPolicy
+from cassandra.cluster import Cluster, ExecutionProfile
+from cassandra.policies import HostFilterPolicy, RoundRobinPolicy,  SimpleConvictionPolicy, WhiteListRoundRobinPolicy
 from cassandra.pool import Host
 
-from tests.integration import PROTOCOL_VERSION
-
+from tests.integration import PROTOCOL_VERSION, local
 
 from concurrent.futures import wait as wait_futures
 
+
 def setup_module():
     use_singledc()
 
+
 class HostFilterPolicyTests(unittest.TestCase):
 
     def test_predicate_changes(self):
@@ -74,3 +74,20 @@ def test_predicate_changes(self):
             response = session.execute("SELECT * from system.local")
             queried_hosts.update(response.response_future.attempted_hosts)
         self.assertEqual(queried_hosts, all_hosts)
+
+
+class WhiteListRoundRobinPolicyTests(unittest.TestCase):
+
+    @local
+    def test_only_connects_to_subset(self):
+        only_connect_hosts = {"127.0.0.1", "127.0.0.2"}
+        white_list = ExecutionProfile(load_balancing_policy=WhiteListRoundRobinPolicy(only_connect_hosts))
+        cluster = Cluster(execution_profiles={"white_list": white_list})
+        #cluster = Cluster(load_balancing_policy=WhiteListRoundRobinPolicy(only_connect_hosts))
+        session = cluster.connect(wait_for_all_pools=True)
+        queried_hosts = set()
+        for _ in range(10):
+            response = session.execute('SELECT * from system.local', execution_profile="white_list")
+            queried_hosts.update(response.response_future.attempted_hosts)
+        queried_hosts = set(host.address for host in queried_hosts)
+        self.assertEqual(queried_hosts, only_connect_hosts)
diff --git a/tests/unit/test_policies.py b/tests/unit/test_policies.py
@@ -1232,22 +1232,6 @@ def test_hosts_with_hostname(self):
 
         self.assertEqual(policy.distance(host), HostDistance.LOCAL)
 
-    def test_deprecated(self):
-        import warnings
-
-        warnings.resetwarnings()  # in case we've instantiated one before
-
-        # set up warning filters to allow all, set up restore when this test is done
-        filters_backup, warnings.filters = warnings.filters, []
-        self.addCleanup(setattr, warnings, 'filters', filters_backup)
-
-        with warnings.catch_warnings(record=True) as caught_warnings:
-            WhiteListRoundRobinPolicy([])
-            self.assertEqual(len(caught_warnings), 1)
-            warning_message = caught_warnings[-1]
-            self.assertEqual(warning_message.category, DeprecationWarning)
-            self.assertIn('4.0', warning_message.message.args[0])
-
 
 class AddressTranslatorTest(unittest.TestCase):
 
