forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_iterator.py
More file actions
372 lines (303 loc) · 12.5 KB
/
Copy pathtest_iterator.py
File metadata and controls
372 lines (303 loc) · 12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import unittest
class Test__do_nothing_page_start(unittest.TestCase):
def _callFUT(self, iterator, page, response):
from google.cloud.iterator import _do_nothing_page_start
return _do_nothing_page_start(iterator, page, response)
def test_do_nothing(self):
result = self._callFUT(None, None, None)
self.assertIsNone(result)
class TestPage(unittest.TestCase):
def _getTargetClass(self):
from google.cloud.iterator import Page
return Page
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_constructor(self):
parent = object()
items_key = 'potatoes'
response = {items_key: (1, 2, 3)}
page = self._makeOne(parent, response, items_key, None)
self.assertIs(page._parent, parent)
self.assertEqual(page._num_items, 3)
self.assertEqual(page._remaining, 3)
def test_num_items_property(self):
page = self._makeOne(None, {}, '', None)
num_items = 42
page._num_items = num_items
self.assertEqual(page.num_items, num_items)
def test_remaining_property(self):
page = self._makeOne(None, {}, '', None)
remaining = 1337
page._remaining = remaining
self.assertEqual(page.remaining, remaining)
def test___iter__(self):
page = self._makeOne(None, {}, '', None)
self.assertIs(iter(page), page)
def test_iterator_calls__item_to_value(self):
import six
class Parent(object):
calls = 0
def item_to_value(self, item):
self.calls += 1
return item
items_key = 'turkeys'
response = {items_key: [10, 11, 12]}
parent = Parent()
page = self._makeOne(parent, response, items_key,
Parent.item_to_value)
page._remaining = 100
self.assertEqual(parent.calls, 0)
self.assertEqual(page.remaining, 100)
self.assertEqual(six.next(page), 10)
self.assertEqual(parent.calls, 1)
self.assertEqual(page.remaining, 99)
self.assertEqual(six.next(page), 11)
self.assertEqual(parent.calls, 2)
self.assertEqual(page.remaining, 98)
self.assertEqual(six.next(page), 12)
self.assertEqual(parent.calls, 3)
self.assertEqual(page.remaining, 97)
class TestIterator(unittest.TestCase):
def _getTargetClass(self):
from google.cloud.iterator import Iterator
return Iterator
def _makeOne(self, *args, **kw):
return self._getTargetClass()(*args, **kw)
def test_constructor(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
iterator = self._makeOne(client, path, None)
self.assertIs(iterator.client, client)
self.assertEqual(iterator.path, path)
self.assertEqual(iterator.page_number, 0)
self.assertIsNone(iterator.next_page_token)
def test_constructor_w_extra_param_collision(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
extra_params = {'pageToken': 'val'}
with self.assertRaises(ValueError):
self._makeOne(client, path, None, extra_params=extra_params)
def test_page_property(self):
iterator = self._makeOne(None, None, None)
page = object()
iterator._page = page
self.assertIs(iterator.page, page)
def test_page_property_unset(self):
from google.cloud.iterator import _UNSET
iterator = self._makeOne(None, None, None)
self.assertIs(iterator._page, _UNSET)
with self.assertRaises(AttributeError):
getattr(iterator, 'page')
def test_update_page_no_more(self):
iterator = self._makeOne(None, None, None)
iterator._page = None
with self.assertRaises(ValueError):
iterator.update_page()
def test_update_page_not_empty_success(self):
from google.cloud.iterator import Page
iterator = self._makeOne(None, None, None)
page = Page(None, {}, '', None)
iterator._page = page
iterator._page._remaining = 1
iterator.update_page(require_empty=False)
self.assertIs(iterator._page, page)
def test_update_page_not_empty_fail(self):
from google.cloud.iterator import Page
iterator = self._makeOne(None, None, None)
iterator._page = Page(None, {}, '', None)
iterator._page._remaining = 1
with self.assertRaises(ValueError):
iterator.update_page(require_empty=True)
def test_update_page_empty_then_no_more(self):
iterator = self._makeOne(None, None, None)
# Fake that there are no more pages.
iterator.page_number = 1
iterator.next_page_token = None
iterator.update_page()
self.assertIsNone(iterator.page)
def test_update_page_empty_then_another(self):
from google.cloud._testing import _Monkey
from google.cloud import iterator as MUT
items_key = 'its-key'
iterator = self._makeOne(None, None, None, items_key=items_key)
# Fake the next page class.
fake_page = object()
page_args = []
def dummy_response():
return {}
def dummy_page_class(*args):
page_args.append(args)
return fake_page
iterator._get_next_page_response = dummy_response
with _Monkey(MUT, Page=dummy_page_class):
iterator.update_page()
self.assertIs(iterator.page, fake_page)
self.assertEqual(
page_args, [(iterator, {}, items_key, iterator._item_to_value)])
def test___iter__(self):
iterator = self._makeOne(None, None, None)
self.assertIs(iter(iterator), iterator)
def test_iterate(self):
import six
path = '/foo'
key1 = 'key1'
key2 = 'key2'
item1, item2 = object(), object()
ITEMS = {key1: item1, key2: item2}
def item_to_value(iterator, item): # pylint: disable=unused-argument
return ITEMS[item['name']]
connection = _Connection(
{'items': [{'name': key1}, {'name': key2}]})
client = _Client(connection)
iterator = self._makeOne(client, path=path,
item_to_value=item_to_value)
self.assertEqual(iterator.num_results, 0)
val1 = six.next(iterator)
self.assertEqual(val1, item1)
self.assertEqual(iterator.num_results, 1)
val2 = six.next(iterator)
self.assertEqual(val2, item2)
self.assertEqual(iterator.num_results, 2)
with self.assertRaises(StopIteration):
six.next(iterator)
kw, = connection._requested
self.assertEqual(kw['method'], 'GET')
self.assertEqual(kw['path'], path)
self.assertEqual(kw['query_params'], {})
def test__has_next_page_new(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
iterator = self._makeOne(client, path, None)
self.assertTrue(iterator._has_next_page())
def test__has_next_page_w_number_no_token(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
iterator = self._makeOne(client, path, None)
iterator.page_number = 1
self.assertFalse(iterator._has_next_page())
def test__has_next_page_w_number_w_token(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
token = 'token'
iterator = self._makeOne(client, path, None)
iterator.page_number = 1
iterator.next_page_token = token
self.assertTrue(iterator._has_next_page())
def test__has_next_page_w_max_results_not_done(self):
iterator = self._makeOne(None, None, None, max_results=3,
page_token='definitely-not-none')
iterator.page_number = 1
self.assertLess(iterator.num_results, iterator.max_results)
self.assertTrue(iterator._has_next_page())
def test__has_next_page_w_max_results_done(self):
iterator = self._makeOne(None, None, None, max_results=3)
iterator.page_number = 1
iterator.num_results = iterator.max_results
self.assertFalse(iterator._has_next_page())
def test__get_query_params_no_token(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
iterator = self._makeOne(client, path, None)
self.assertEqual(iterator._get_query_params(), {})
def test__get_query_params_w_token(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
token = 'token'
iterator = self._makeOne(client, path, None)
iterator.next_page_token = token
self.assertEqual(iterator._get_query_params(),
{'pageToken': token})
def test__get_query_params_w_max_results(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
max_results = 3
iterator = self._makeOne(client, path, None,
max_results=max_results)
iterator.num_results = 1
local_max = max_results - iterator.num_results
self.assertEqual(iterator._get_query_params(),
{'maxResults': local_max})
def test__get_query_params_extra_params(self):
connection = _Connection()
client = _Client(connection)
path = '/foo'
extra_params = {'key': 'val'}
iterator = self._makeOne(client, path, None,
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()
client = _Client(connection)
path = '/foo'
token = 'token'
extra_params = {'key': 'val'}
iterator = self._makeOne(client, path, None,
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_next_page_response_new_no_token_in_response(self):
path = '/foo'
token = 'token'
key1 = 'key1'
key2 = 'key2'
connection = _Connection({'items': [{'name': key1}, {'name': key2}],
'nextPageToken': token})
client = _Client(connection)
iterator = self._makeOne(client, path, None)
response = iterator._get_next_page_response()
self.assertEqual(response['items'], [{'name': key1}, {'name': key2}])
self.assertEqual(iterator.page_number, 1)
self.assertEqual(iterator.next_page_token, token)
kw, = connection._requested
self.assertEqual(kw['method'], 'GET')
self.assertEqual(kw['path'], path)
self.assertEqual(kw['query_params'], {})
def test_reset(self):
from google.cloud.iterator import _UNSET
connection = _Connection()
client = _Client(connection)
path = '/foo'
token = 'token'
iterator = self._makeOne(client, path, None)
iterator.page_number = 1
iterator.next_page_token = token
iterator._page = object()
iterator.reset()
self.assertEqual(iterator.page_number, 0)
self.assertEqual(iterator.num_results, 0)
self.assertIsNone(iterator.next_page_token)
self.assertIs(iterator._page, _UNSET)
class _Connection(object):
def __init__(self, *responses):
self._responses = responses
self._requested = []
def api_request(self, **kw):
self._requested.append(kw)
response, self._responses = self._responses[0], self._responses[1:]
return response
class _Client(object):
def __init__(self, connection):
self.connection = connection