From edfeae372312b3370dc12deea8cd8028ecba6bd6 Mon Sep 17 00:00:00 2001
From: Timur Alperovich <timur@timuralp.com>
Date: Fri, 23 Nov 2018 22:47:15 -0800
Subject: [PATCH] Add delimiter to get_account().

Exposes the delimiter parameter, which the Swift API supports for
container listings.

Change-Id: Id8dfce01a9b64de9d1222aab9a4a682ce9e0f2b7
---
 swiftclient/client.py                | 19 ++++++++++++-------
 tests/functional/test_swiftclient.py | 12 ++++++++++++
 tests/unit/test_swiftclient.py       | 12 ++++++++++++
 3 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/swiftclient/client.py b/swiftclient/client.py
index 049b4afc..c9efc79b 100644
--- a/swiftclient/client.py
+++ b/swiftclient/client.py
@@ -757,7 +757,7 @@ def store_response(resp, response_dict):
 
 def get_account(url, token, marker=None, limit=None, prefix=None,
                 end_marker=None, http_conn=None, full_listing=False,
-                service_token=None, headers=None):
+                service_token=None, headers=None, delimiter=None):
     """
     Get a listing of containers for the account.
 
@@ -773,6 +773,7 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
                          of 10000 listings
     :param service_token: service auth token
     :param headers: additional headers to include in the request
+    :param delimiter: delimiter query
     :returns: a tuple of (response headers, a list of containers) The response
               headers will be a dict and all header names will be lowercase.
     :raises ClientException: HTTP GET request failed
@@ -786,14 +787,14 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
     if not http_conn:
         http_conn = http_connection(url)
     if full_listing:
-        rv = get_account(url, token, marker, limit, prefix,
-                         end_marker, http_conn, headers=req_headers)
+        rv = get_account(url, token, marker, limit, prefix, end_marker,
+                         http_conn, headers=req_headers, delimiter=delimiter)
         listing = rv[1]
         while listing:
             marker = listing[-1]['name']
             listing = get_account(url, token, marker, limit, prefix,
-                                  end_marker, http_conn,
-                                  headers=req_headers)[1]
+                                  end_marker, http_conn, headers=req_headers,
+                                  delimiter=delimiter)[1]
             if listing:
                 rv[1].extend(listing)
         return rv
@@ -805,6 +806,8 @@ def get_account(url, token, marker=None, limit=None, prefix=None,
         qs += '&limit=%d' % limit
     if prefix:
         qs += '&prefix=%s' % quote(prefix)
+    if delimiter:
+        qs += '&delimiter=%s' % quote(delimiter)
     if end_marker:
         qs += '&end_marker=%s' % quote(end_marker)
     full_path = '%s?%s' % (parsed.path, qs)
@@ -1779,14 +1782,16 @@ class Connection(object):
         return self._retry(None, head_account, headers=headers)
 
     def get_account(self, marker=None, limit=None, prefix=None,
-                    end_marker=None, full_listing=False, headers=None):
+                    end_marker=None, full_listing=False, headers=None,
+                    delimiter=None):
         """Wrapper for :func:`get_account`"""
         # TODO(unknown): With full_listing=True this will restart the entire
         # listing with each retry. Need to make a better version that just
         # retries where it left off.
         return self._retry(None, get_account, marker=marker, limit=limit,
                            prefix=prefix, end_marker=end_marker,
-                           full_listing=full_listing, headers=headers)
+                           full_listing=full_listing, headers=headers,
+                           delimiter=delimiter)
 
     def post_account(self, headers, response_dict=None,
                      query_string=None, data=None):
diff --git a/tests/functional/test_swiftclient.py b/tests/functional/test_swiftclient.py
index 1d76a8d1..b4f275b2 100644
--- a/tests/functional/test_swiftclient.py
+++ b/tests/functional/test_swiftclient.py
@@ -154,6 +154,18 @@ class TestFunctional(unittest.TestCase):
         self.assertTrue(len(containers) >= 1)
         self.assertEqual(self.containername_2, containers[0].get('name'))
 
+        # Test prefix
+        _, containers = self.conn.get_account(prefix='dne')
+        self.assertEqual(0, len(containers))
+
+        # Test delimiter
+        _, containers = self.conn.get_account(
+            prefix=self.containername, delimiter='_')
+        self.assertEqual(2, len(containers))
+        self.assertEqual(self.containername, containers[0].get('name'))
+        self.assertTrue(
+            self.containername_2.startswith(containers[1].get('subdir')))
+
     def _check_container_headers(self, headers):
         self.assertTrue(headers.get('content-length'))
         self.assertTrue(headers.get('x-container-object-count'))
diff --git a/tests/unit/test_swiftclient.py b/tests/unit/test_swiftclient.py
index 62875a5d..2d45deb8 100644
--- a/tests/unit/test_swiftclient.py
+++ b/tests/unit/test_swiftclient.py
@@ -704,6 +704,18 @@ class TestGetAccount(MockHttpTest):
                 'x-auth-token': 'asdf'}),
         ])
 
+    def test_param_delimiter(self):
+        c.http_connection = self.fake_http_connection(
+            204,
+            query_string="format=json&delimiter=-")
+        c.get_account('http://www.test.com/v1/acct', 'asdf',
+                      delimiter='-')
+        self.assertRequests([
+            ('GET', '/v1/acct?format=json&delimiter=-', '', {
+                'accept-encoding': 'gzip',
+                'x-auth-token': 'asdf'}),
+        ])
+
 
 class TestHeadAccount(MockHttpTest):