Testing interaction with page token and extra params in iterator.

dhermes · dhermes · commit 062bba54a8ce · 2014-11-04T10:16:50.000-08:00
Also making sure tests pass by using the `upload_` prefix
instead of the `set_contents_` prefix.
diff --git a/gcloud/storage/bucket.py b/gcloud/storage/bucket.py
@@ -284,7 +284,7 @@ def upload_file(self, filename, key=None):
         if key is None:
             key = os.path.basename(filename)
         key = self.new_key(key)
-        return key.set_contents_from_filename(filename)
+        return key.upload_from_filename(filename)
 
     def upload_file_object(self, file_obj, key=None):
         """Shortcut method to upload a file object into this bucket.
@@ -324,7 +324,7 @@ def upload_file_object(self, file_obj, key=None):
             key = self.new_key(key)
         else:
             key = self.new_key(os.path.basename(file_obj.name))
-        return key.set_contents_from_file(file_obj)
+        return key.upload_from_file(file_obj)
 
     def has_metadata(self, field=None):
         """Check if metadata is available locally.
diff --git a/gcloud/storage/iterator.py b/gcloud/storage/iterator.py
@@ -38,12 +38,22 @@ class Iterator(object):
     :type path: string
     :param path: The path to query for the list of items.
     """
+
+    PAGE_TOKEN = 'pageToken'
+    RESERVED_PARAMS = frozenset([PAGE_TOKEN])
+
     def __init__(self, connection, path, extra_params=None):
         self.connection = connection
         self.path = path
         self.page_number = 0
         self.next_page_token = None
         self.extra_params = extra_params
+        if self.extra_params is not None:
+            reserved_in_use = self.RESERVED_PARAMS.intersection(
+                extra_params.keys())
+            if reserved_in_use:
+                raise ValueError(('Using a reserved parameter',
+                                  reserved_in_use))
 
     def __iter__(self):
         """Iterate through the list of items."""
@@ -72,7 +82,7 @@ def get_query_params(self):
         """
         result = None
         if self.next_page_token:
-            result = {'pageToken': self.next_page_token}
+            result = {self.PAGE_TOKEN: self.next_page_token}
         if self.extra_params is not None:
             result = result or {}
             result.update(self.extra_params)
diff --git a/gcloud/storage/test_bucket.py b/gcloud/storage/test_bucket.py
@@ -376,8 +376,9 @@ def __init__(self, bucket, name):
                 self._bucket = bucket
                 self._name = name
 
-            def set_contents_from_file(self, fh):
+            def upload_from_file(self, fh):
                 _uploaded.append((self._bucket, self._name, fh))
+
         bucket = self._makeOne()
         with _Monkey(MUT, Key=_Key):
             bucket.upload_file_object(FILEOBJECT)
@@ -397,8 +398,9 @@ def __init__(self, bucket, name):
                 self._bucket = bucket
                 self._name = name
 
-            def set_contents_from_file(self, fh):
+            def upload_from_file(self, fh):
                 _uploaded.append((self._bucket, self._name, fh))
+
         bucket = self._makeOne()
         with _Monkey(MUT, Key=_Key):
             bucket.upload_file_object(FILEOBJECT, KEY)
diff --git a/gcloud/storage/test_iterator.py b/gcloud/storage/test_iterator.py
@@ -82,6 +82,25 @@ def test_get_query_params_extra_params(self):
         iterator = self._makeOne(connection, PATH, extra_params=extra_params)
         self.assertEqual(iterator.get_query_params(), extra_params)
 
+    def test_get_query_params_w_token_and_extra_params(self):
+        connection = _Connection()
+        PATH = '/foo'
+        TOKEN = 'token'
+        extra_params = {'key': 'val'}
+        iterator = self._makeOne(connection, PATH, extra_params=extra_params)
+        iterator.next_page_token = TOKEN
+
+        expected_query = extra_params.copy()
+        expected_query.update({'pageToken': TOKEN})
+        self.assertEqual(iterator.get_query_params(), expected_query)
+
+    def test_get_query_params_w_token_collision(self):
+        connection = _Connection()
+        PATH = '/foo'
+        extra_params = {'pageToken': 'val'}
+        self.assertRaises(ValueError, self._makeOne, connection, PATH,
+                          extra_params=extra_params)
+
     def test_get_next_page_response_new_no_token_in_response(self):
         PATH = '/foo'
         TOKEN = 'token'
