Merge pull request kragniz#1569 from mtraynham/bug/get_params

Add missing assignments for some of the get parameters

Author: kragniz

etcd3/client.py

@@ -208,50 +208,64 @@ def _build_get_range_request(self, key,
                                  sort_target='key',
                                  serializable=False,
                                  keys_only=False,
-                                 count_only=None,
+                                 count_only=False,
                                  min_mod_revision=None,
                                  max_mod_revision=None,
                                  min_create_revision=None,
                                  max_create_revision=None):
         range_request = etcdrpc.RangeRequest()
         range_request.key = utils.to_bytes(key)
         range_request.keys_only = keys_only
+        range_request.count_only = count_only
+        range_request.serializable = serializable
+
         if range_end is not None:
             range_request.range_end = utils.to_bytes(range_end)
-
-        if sort_order is None:
-            range_request.sort_order = etcdrpc.RangeRequest.NONE
-        elif sort_order == 'ascend':
-            range_request.sort_order = etcdrpc.RangeRequest.ASCEND
-        elif sort_order == 'descend':
-            range_request.sort_order = etcdrpc.RangeRequest.DESCEND
-        else:
+        if limit is not None:
+            range_request.limit = limit
+        if revision is not None:
+            range_request.revision = revision
+        if min_mod_revision is not None:
+            range_request.min_mod_revision = min_mod_revision
+        if max_mod_revision is not None:
+            range_request.max_mod_revision = max_mod_revision
+        if min_create_revision is not None:
+            range_request.min_mod_revision = min_create_revision
+        if max_create_revision is not None:
+            range_request.min_mod_revision = max_create_revision
+
+        sort_orders = {
+            None: etcdrpc.RangeRequest.NONE,
+            'ascend': etcdrpc.RangeRequest.ASCEND,
+            'descend': etcdrpc.RangeRequest.DESCEND,
+        }
+        request_sort_order = sort_orders.get(sort_order)
+        if request_sort_order is None:
             raise ValueError('unknown sort order: "{}"'.format(sort_order))
-
-        if sort_target is None or sort_target == 'key':
-            range_request.sort_target = etcdrpc.RangeRequest.KEY
-        elif sort_target == 'version':
-            range_request.sort_target = etcdrpc.RangeRequest.VERSION
-        elif sort_target == 'create':
-            range_request.sort_target = etcdrpc.RangeRequest.CREATE
-        elif sort_target == 'mod':
-            range_request.sort_target = etcdrpc.RangeRequest.MOD
-        elif sort_target == 'value':
-            range_request.sort_target = etcdrpc.RangeRequest.VALUE
-        else:
+        range_request.sort_order = request_sort_order
+
+        sort_targets = {
+            None: etcdrpc.RangeRequest.KEY,
+            'key': etcdrpc.RangeRequest.KEY,
+            'version': etcdrpc.RangeRequest.VERSION,
+            'create': etcdrpc.RangeRequest.CREATE,
+            'mod': etcdrpc.RangeRequest.MOD,
+            'value': etcdrpc.RangeRequest.VALUE,
+        }
+        request_sort_target = sort_targets.get(sort_target)
+        if request_sort_target is None:
             raise ValueError('sort_target must be one of "key", '
                              '"version", "create", "mod" or "value"')
-
-        range_request.serializable = serializable
+        range_request.sort_target = request_sort_target
 
         return range_request
 
     @_handle_errors
-    def get_response(self, key, serializable=False):
+    def get_response(self, key, **kwargs):
         """Get the value of a key from etcd."""
         range_request = self._build_get_range_request(
             key,
-            serializable=serializable
+            **kwargs
         )
 
         return self.kvstub.Range(
@@ -275,8 +289,6 @@ def get(self, key, **kwargs):
             'hello world'
 
         :param key: key in etcd to get
-        :param serializable: whether to allow serializable reads. This can
-            result in stale reads
         :returns: value of key and metadata
         :rtype: bytes, ``KVMetadata``
         """

tests/test_etcd3.py

@@ -704,6 +704,68 @@ def test_get_all_keys_only(self, etcd):
             assert meta.key.startswith(b"/doot/")
             assert not value
 
+    def test_get_count_only(self, etcd):
+        for i in range(20):
+            etcdctl('put', '/doot/count{}'.format(i), 'i am in all')
+        resp = etcd.get_prefix_response(
+            key_prefix='/doot/count',
+            count_only=True
+        )
+        assert len(resp.kvs) == 0
+        assert resp.count == 20
+
+    def test_get_limit(self, etcd):
+        for i in range(20):
+            etcdctl('put', '/doot/limit{}'.format(i), 'i am in all')
+        for i in range(20):
+            resp = etcd.get_prefix_response(key_prefix='/doot/limit', limit=i)
+            assert resp.count == 20
+            if i == 0 or i == 20:
+                assert len(resp.kvs) == 20
+                assert resp.more is False
+            else:
+                assert len(resp.kvs) == i
+                assert resp.more is True
+
+    def test_get_revision(self, etcd):
+        revisions = []
+        for i in range(20):
+            resp = etcdctl('put', '/doot/revision{}'.format(i), 'i am in all')
+            revisions.append(resp['header']['revision'])
+        for i, revision in enumerate(revisions):
+            resp = etcd.get_prefix_response(
+                key_prefix='/doot/revision',
+                revision=revision
+            )
+            assert resp.count == min(len(revisions), i + 1)
+
+    def test_get_min_mod_revision(self, etcd):
+        revisions = []
+        for i in range(5):
+            resp = etcdctl('put', '/doot/revision', str(i))
+            revisions.append(resp['header']['revision'])
+        for revision in revisions:
+            resp = etcd.get_response(
+                key='/doot/revision',
+                min_mod_revision=revision
+            )
+            assert len(resp.kvs) == 1
+
+    def test_get_max_mod_revision(self, etcd):
+        revisions = []
+        for i in range(5):
+            resp = etcdctl('put', '/doot/revision', str(i))
+            revisions.append(resp['header']['revision'])
+        for revision in revisions:
+            resp = etcd.get_response(
+                key='/doot/revision',
+                max_mod_revision=revision
+            )
+            if revision == revisions[-1]:
+                assert len(resp.kvs) == 1
+            else:
+                assert len(resp.kvs) == 0
+
     def test_sort_order(self, etcd):
         def remove_prefix(string, prefix):
             return string[len(prefix):]