blob: 3070c60160f0373c32be6e4eb9923215d776a024 [file] [log] [blame]
Joe Gregorioba9ea7f2010-08-19 15:49:04 -04001#!/usr/bin/python2.4
Joe Gregoriof863f7a2011-02-24 03:24:44 -05002# -*- coding: utf-8 -*-
Joe Gregorioba9ea7f2010-08-19 15:49:04 -04003#
Joe Gregorio6d5e94f2010-08-25 23:49:30 -04004# Copyright 2010 Google Inc.
5#
6# Licensed under the Apache License, Version 2.0 (the "License");
7# you may not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS,
14# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040018
19"""Discovery document tests
20
21Unit tests for objects created from discovery documents.
22"""
23
24__author__ = 'jcgregorio@google.com (Joe Gregorio)'
25
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040026import httplib2
27import os
28import unittest
Joe Gregorio00cf1d92010-09-27 09:22:03 -040029import urlparse
ade@google.comc5eb46f2010-09-27 23:35:39 +010030try:
31 from urlparse import parse_qs
32except ImportError:
33 from cgi import parse_qs
Joe Gregorio00cf1d92010-09-27 09:22:03 -040034
ade@google.com6a8c1cb2011-09-06 17:40:00 +010035from apiclient.discovery import build, build_from_document, key2param
Joe Gregoriocb8103d2011-02-11 23:20:52 -050036from apiclient.http import HttpMock
Joe Gregoriof4153422011-03-18 22:45:18 -040037from apiclient.http import tunnel_patch
38from apiclient.http import HttpMockSequence
Joe Gregorioc0e0fe92011-03-04 16:16:55 -050039from apiclient.errors import HttpError
Joe Gregorio49396552011-03-08 10:39:00 -050040from apiclient.errors import InvalidJsonError
Joe Gregoriofdf7c802011-06-30 12:33:38 -040041from apiclient.errors import MediaUploadSizeError
42from apiclient.errors import UnacceptableMimeTypeError
Joe Gregoriocb8103d2011-02-11 23:20:52 -050043
44
45DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
46
47def datafile(filename):
48 return os.path.join(DATA_DIR, filename)
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040049
50
Joe Gregorioc5c5a372010-09-22 11:42:32 -040051class Utilities(unittest.TestCase):
52 def test_key2param(self):
53 self.assertEqual('max_results', key2param('max-results'))
54 self.assertEqual('x007_bond', key2param('007-bond'))
55
56
Joe Gregorioc0e0fe92011-03-04 16:16:55 -050057class DiscoveryErrors(unittest.TestCase):
58
59 def test_failed_to_parse_discovery_json(self):
60 self.http = HttpMock(datafile('malformed.json'), {'status': '200'})
61 try:
62 buzz = build('buzz', 'v1', self.http)
63 self.fail("should have raised an exception over malformed JSON.")
Joe Gregorio49396552011-03-08 10:39:00 -050064 except InvalidJsonError:
65 pass
Joe Gregorioc0e0fe92011-03-04 16:16:55 -050066
67
ade@google.com6a8c1cb2011-09-06 17:40:00 +010068class DiscoveryFromDocument(unittest.TestCase):
69 def test_can_build_from_local_document(self):
70 discovery = file(datafile('buzz.json')).read()
71 buzz = build_from_document(discovery, base="https://www.googleapis.com/")
72 self.assertTrue(buzz is not None)
73
74 def test_building_with_base_remembers_base(self):
75 discovery = file(datafile('buzz.json')).read()
76
77 base = "https://www.example.com/"
78 buzz = build_from_document(discovery, base=base)
79 self.assertEquals(base + "buzz/v1/", buzz._baseUrl)
80
81
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040082class Discovery(unittest.TestCase):
Joe Gregorio2379ecc2010-10-26 10:51:28 -040083
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040084 def test_method_error_checking(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -050085 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040086 buzz = build('buzz', 'v1', self.http)
87
88 # Missing required parameters
89 try:
90 buzz.activities().list()
91 self.fail()
92 except TypeError, e:
93 self.assertTrue('Missing' in str(e))
94
95 # Parameter doesn't match regex
96 try:
Joe Gregoriobee86832011-02-22 10:00:19 -050097 buzz.activities().list(scope='@myself', userId='me')
Joe Gregorioba9ea7f2010-08-19 15:49:04 -040098 self.fail()
99 except TypeError, e:
Joe Gregorioca876e42011-02-22 19:39:42 -0500100 self.assertTrue('not an allowed value' in str(e))
Joe Gregorioba9ea7f2010-08-19 15:49:04 -0400101
102 # Parameter doesn't match regex
103 try:
104 buzz.activities().list(scope='not@', userId='foo')
105 self.fail()
106 except TypeError, e:
Joe Gregorioca876e42011-02-22 19:39:42 -0500107 self.assertTrue('not an allowed value' in str(e))
Joe Gregorioba9ea7f2010-08-19 15:49:04 -0400108
109 # Unexpected parameter
110 try:
111 buzz.activities().list(flubber=12)
112 self.fail()
113 except TypeError, e:
114 self.assertTrue('unexpected' in str(e))
115
Joe Gregoriobee86832011-02-22 10:00:19 -0500116 def _check_query_types(self, request):
117 parsed = urlparse.urlparse(request.uri)
118 q = parse_qs(parsed[4])
119 self.assertEqual(q['q'], ['foo'])
120 self.assertEqual(q['i'], ['1'])
121 self.assertEqual(q['n'], ['1.0'])
122 self.assertEqual(q['b'], ['false'])
123 self.assertEqual(q['a'], ['[1, 2, 3]'])
124 self.assertEqual(q['o'], ['{\'a\': 1}'])
125 self.assertEqual(q['e'], ['bar'])
126
127 def test_type_coercion(self):
Joe Gregoriof4153422011-03-18 22:45:18 -0400128 http = HttpMock(datafile('zoo.json'), {'status': '200'})
129 zoo = build('zoo', 'v1', http)
Joe Gregoriobee86832011-02-22 10:00:19 -0500130
131 request = zoo.query(q="foo", i=1.0, n=1.0, b=0, a=[1,2,3], o={'a':1}, e='bar')
132 self._check_query_types(request)
133 request = zoo.query(q="foo", i=1, n=1, b=False, a=[1,2,3], o={'a':1}, e='bar')
134 self._check_query_types(request)
Joe Gregoriof863f7a2011-02-24 03:24:44 -0500135
Joe Gregoriobee86832011-02-22 10:00:19 -0500136 request = zoo.query(q="foo", i="1", n="1", b="", a=[1,2,3], o={'a':1}, e='bar')
137 self._check_query_types(request)
138
Joe Gregorio13217952011-02-22 15:37:38 -0500139 def test_optional_stack_query_parameters(self):
Joe Gregoriof4153422011-03-18 22:45:18 -0400140 http = HttpMock(datafile('zoo.json'), {'status': '200'})
141 zoo = build('zoo', 'v1', http)
142 request = zoo.query(trace='html', fields='description')
Joe Gregorio13217952011-02-22 15:37:38 -0500143
Joe Gregorioca876e42011-02-22 19:39:42 -0500144 parsed = urlparse.urlparse(request.uri)
145 q = parse_qs(parsed[4])
146 self.assertEqual(q['trace'], ['html'])
Joe Gregoriof4153422011-03-18 22:45:18 -0400147 self.assertEqual(q['fields'], ['description'])
148
149 def test_patch(self):
150 http = HttpMock(datafile('zoo.json'), {'status': '200'})
151 zoo = build('zoo', 'v1', http)
152 request = zoo.animals().patch(name='lion', body='{"description": "foo"}')
153
154 self.assertEqual(request.method, 'PATCH')
155
156 def test_tunnel_patch(self):
157 http = HttpMockSequence([
158 ({'status': '200'}, file(datafile('zoo.json'), 'r').read()),
159 ({'status': '200'}, 'echo_request_headers_as_json'),
160 ])
161 http = tunnel_patch(http)
162 zoo = build('zoo', 'v1', http)
163 resp = zoo.animals().patch(name='lion', body='{"description": "foo"}').execute()
164
165 self.assertTrue('x-http-method-override' in resp)
Joe Gregorioca876e42011-02-22 19:39:42 -0500166
ade@google.com850cf552010-08-20 23:24:56 +0100167 def test_buzz_resources(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500168 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorioba9ea7f2010-08-19 15:49:04 -0400169 buzz = build('buzz', 'v1', self.http)
170 self.assertTrue(getattr(buzz, 'activities'))
Joe Gregorioba9ea7f2010-08-19 15:49:04 -0400171 self.assertTrue(getattr(buzz, 'photos'))
172 self.assertTrue(getattr(buzz, 'people'))
173 self.assertTrue(getattr(buzz, 'groups'))
174 self.assertTrue(getattr(buzz, 'comments'))
175 self.assertTrue(getattr(buzz, 'related'))
176
Joe Gregorioc5c5a372010-09-22 11:42:32 -0400177 def test_auth(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500178 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorioc5c5a372010-09-22 11:42:32 -0400179 buzz = build('buzz', 'v1', self.http)
180 auth = buzz.auth_discovery()
181 self.assertTrue('request' in auth)
182
Joe Gregorio2379ecc2010-10-26 10:51:28 -0400183 def test_full_featured(self):
184 # Zoo should exercise all discovery facets
185 # and should also have no future.json file.
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500186 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
Joe Gregorio2379ecc2010-10-26 10:51:28 -0400187 zoo = build('zoo', 'v1', self.http)
188 self.assertTrue(getattr(zoo, 'animals'))
Joe Gregoriof863f7a2011-02-24 03:24:44 -0500189
Joe Gregoriof4153422011-03-18 22:45:18 -0400190 request = zoo.animals().list(name='bat', projection="full")
Joe Gregorio2379ecc2010-10-26 10:51:28 -0400191 parsed = urlparse.urlparse(request.uri)
192 q = parse_qs(parsed[4])
193 self.assertEqual(q['name'], ['bat'])
Joe Gregoriof4153422011-03-18 22:45:18 -0400194 self.assertEqual(q['projection'], ['full'])
Joe Gregorio2379ecc2010-10-26 10:51:28 -0400195
Joe Gregorio3fada332011-01-07 17:07:45 -0500196 def test_nested_resources(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500197 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
Joe Gregorio3fada332011-01-07 17:07:45 -0500198 zoo = build('zoo', 'v1', self.http)
199 self.assertTrue(getattr(zoo, 'animals'))
200 request = zoo.my().favorites().list(max_results="5")
201 parsed = urlparse.urlparse(request.uri)
202 q = parse_qs(parsed[4])
203 self.assertEqual(q['max-results'], ['5'])
204
Joe Gregoriod92897c2011-07-07 11:44:56 -0400205 def test_methods_with_reserved_names(self):
206 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
207 zoo = build('zoo', 'v1', self.http)
208 self.assertTrue(getattr(zoo, 'animals'))
209 request = zoo.global_().print_().assert_(max_results="5")
210 parsed = urlparse.urlparse(request.uri)
211 self.assertEqual(parsed[2], '/zoo/global/print/assert')
212
Joe Gregorio7a6df3a2011-01-31 21:55:21 -0500213 def test_top_level_functions(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500214 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
Joe Gregorio7a6df3a2011-01-31 21:55:21 -0500215 zoo = build('zoo', 'v1', self.http)
216 self.assertTrue(getattr(zoo, 'query'))
217 request = zoo.query(q="foo")
218 parsed = urlparse.urlparse(request.uri)
219 q = parse_qs(parsed[4])
220 self.assertEqual(q['q'], ['foo'])
Joe Gregorio2379ecc2010-10-26 10:51:28 -0400221
Joe Gregoriofdf7c802011-06-30 12:33:38 -0400222 def test_simple_media_uploads(self):
223 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
224 zoo = build('zoo', 'v1', self.http)
225 doc = getattr(zoo.animals().insert, '__doc__')
226 self.assertTrue('media_body' in doc)
227
Joe Gregorio84d3c1f2011-07-25 10:39:45 -0400228 def test_simple_media_upload_no_max_size_provided(self):
229 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
230 zoo = build('zoo', 'v1', self.http)
231 request = zoo.animals().crossbreed(media_body=datafile('small.png'))
232 self.assertEquals('image/png', request.headers['content-type'])
233 self.assertEquals('PNG', request.body[1:4])
234
Joe Gregoriofdf7c802011-06-30 12:33:38 -0400235 def test_simple_media_raise_correct_exceptions(self):
236 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
237 zoo = build('zoo', 'v1', self.http)
238
239 try:
240 zoo.animals().insert(media_body=datafile('smiley.png'))
241 self.fail("should throw exception if media is too large.")
242 except MediaUploadSizeError:
243 pass
244
245 try:
246 zoo.animals().insert(media_body=datafile('small.jpg'))
247 self.fail("should throw exception if mimetype is unacceptable.")
248 except UnacceptableMimeTypeError:
249 pass
250
251 def test_simple_media_good_upload(self):
252 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
253 zoo = build('zoo', 'v1', self.http)
254
255 request = zoo.animals().insert(media_body=datafile('small.png'))
256 self.assertEquals('image/png', request.headers['content-type'])
257 self.assertEquals('PNG', request.body[1:4])
258
259 def test_multipart_media_raise_correct_exceptions(self):
260 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
261 zoo = build('zoo', 'v1', self.http)
262
263 try:
264 zoo.animals().insert(media_body=datafile('smiley.png'), body={})
265 self.fail("should throw exception if media is too large.")
266 except MediaUploadSizeError:
267 pass
268
269 try:
270 zoo.animals().insert(media_body=datafile('small.jpg'), body={})
271 self.fail("should throw exception if mimetype is unacceptable.")
272 except UnacceptableMimeTypeError:
273 pass
274
275 def test_multipart_media_good_upload(self):
276 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
277 zoo = build('zoo', 'v1', self.http)
278
279 request = zoo.animals().insert(media_body=datafile('small.png'), body={})
280 self.assertTrue(request.headers['content-type'].startswith('multipart/related'))
281 self.assertEquals('--==', request.body[0:4])
282
283 def test_media_capable_method_without_media(self):
284 self.http = HttpMock(datafile('zoo.json'), {'status': '200'})
285 zoo = build('zoo', 'v1', self.http)
286
287 request = zoo.animals().insert(body={})
288 self.assertTrue(request.headers['content-type'], 'application/json')
Joe Gregorioc5c5a372010-09-22 11:42:32 -0400289
290class Next(unittest.TestCase):
Joe Gregorioc9359072010-10-25 15:26:13 -0400291 def test_next_for_people_liked(self):
Joe Gregorio3c676f92011-07-25 10:38:14 -0400292 """Legacy test for Buzz _next support."""
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500293 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorioc9359072010-10-25 15:26:13 -0400294 buzz = build('buzz', 'v1', self.http)
295 people = {'links':
Joe Gregorioc5c5a372010-09-22 11:42:32 -0400296 {'next':
297 [{'href': 'http://www.googleapis.com/next-link'}]}}
Joe Gregorioc9359072010-10-25 15:26:13 -0400298 request = buzz.people().liked_next(people)
299 self.assertEqual(request.uri, 'http://www.googleapis.com/next-link')
Joe Gregorio00cf1d92010-09-27 09:22:03 -0400300
Joe Gregorio3c676f92011-07-25 10:38:14 -0400301 def test_next_successful_none_on_no_next_page_token(self):
302 self.http = HttpMock(datafile('tasks.json'), {'status': '200'})
303 tasks = build('tasks', 'v1', self.http)
304 request = tasks.tasklists().list()
305 self.assertEqual(None, tasks.tasklists().list_next(request, {}))
306
307 def test_next_successful_with_next_page_token(self):
308 self.http = HttpMock(datafile('tasks.json'), {'status': '200'})
309 tasks = build('tasks', 'v1', self.http)
310 request = tasks.tasklists().list()
311 next_request = tasks.tasklists().list_next(request, {'nextPageToken': '123abc'})
312 parsed = list(urlparse.urlparse(next_request.uri))
313 q = parse_qs(parsed[4])
314 self.assertEqual(q['pageToken'][0], '123abc')
315
Joe Gregorio555f33c2011-08-19 14:56:07 -0400316 def test_next_with_method_with_no_properties(self):
317 self.http = HttpMock(datafile('latitude.json'), {'status': '200'})
318 service = build('latitude', 'v1', self.http)
319 request = service.currentLocation().get()
Joe Gregorio00cf1d92010-09-27 09:22:03 -0400320
321class DeveloperKey(unittest.TestCase):
322 def test_param(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500323 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorio00cf1d92010-09-27 09:22:03 -0400324 buzz = build('buzz', 'v1', self.http, developerKey='foobie_bletch')
325 activities = {'links':
326 {'next':
327 [{'href': 'http://www.googleapis.com/next-link'}]}}
328 request = buzz.activities().list_next(activities)
329 parsed = urlparse.urlparse(request.uri)
ade@google.comc5eb46f2010-09-27 23:35:39 +0100330 q = parse_qs(parsed[4])
Joe Gregorio00cf1d92010-09-27 09:22:03 -0400331 self.assertEqual(q['key'], ['foobie_bletch'])
332
Joe Gregorioc9359072010-10-25 15:26:13 -0400333 def test_next_for_activities_list(self):
Joe Gregoriocb8103d2011-02-11 23:20:52 -0500334 self.http = HttpMock(datafile('buzz.json'), {'status': '200'})
Joe Gregorioc9359072010-10-25 15:26:13 -0400335 buzz = build('buzz', 'v1', self.http, developerKey='foobie_bletch')
336 activities = {'links':
ade@google.com2ab0de72010-09-27 23:26:54 +0100337 {'next':
338 [{'href': 'http://www.googleapis.com/next-link'}]}}
Joe Gregorioc9359072010-10-25 15:26:13 -0400339 request = buzz.activities().list_next(activities)
340 self.assertEqual(request.uri,
341 'http://www.googleapis.com/next-link?key=foobie_bletch')
342
Joe Gregorioba9ea7f2010-08-19 15:49:04 -0400343
344if __name__ == '__main__':
345 unittest.main()