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
|
# Copyright 2014 Google Inc. All rights reserved.
#
# 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.
"""Unit tests for oauth2client.clientsecrets."""
import errno
from io import StringIO
import os
import tempfile
import unittest
import oauth2client
from oauth2client import _helpers
from oauth2client import clientsecrets
DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
VALID_FILE = os.path.join(DATA_DIR, 'client_secrets.json')
INVALID_FILE = os.path.join(DATA_DIR, 'unfilled_client_secrets.json')
NONEXISTENT_FILE = os.path.join(
os.path.dirname(__file__), 'afilethatisntthere.json')
class Test__validate_clientsecrets(unittest.TestCase):
def test_with_none(self):
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(None)
def test_with_other_than_one_key(self):
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets({})
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets({'one': 'val', 'two': 'val'})
def test_with_non_dictionary(self):
non_dict = [None]
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(non_dict)
def test_invalid_client_type(self):
fake_type = 'fake_type'
self.assertNotEqual(fake_type, clientsecrets.TYPE_WEB)
self.assertNotEqual(fake_type, clientsecrets.TYPE_INSTALLED)
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets({fake_type: None})
def test_missing_required_type_web(self):
required = clientsecrets.VALID_CLIENT[
clientsecrets.TYPE_WEB]['required']
# We will certainly have less than all 5 keys.
self.assertEqual(len(required), 5)
clientsecrets_dict = {
clientsecrets.TYPE_WEB: {'not_required': None},
}
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(clientsecrets_dict)
def test_string_not_configured_type_web(self):
string_props = clientsecrets.VALID_CLIENT[
clientsecrets.TYPE_WEB]['string']
self.assertTrue('client_id' in string_props)
clientsecrets_dict = {
clientsecrets.TYPE_WEB: {
'client_id': '[[template]]',
'client_secret': 'seekrit',
'redirect_uris': None,
'auth_uri': None,
'token_uri': None,
},
}
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(clientsecrets_dict)
def test_missing_required_type_installed(self):
required = clientsecrets.VALID_CLIENT[
clientsecrets.TYPE_INSTALLED]['required']
# We will certainly have less than all 5 keys.
self.assertEqual(len(required), 5)
clientsecrets_dict = {
clientsecrets.TYPE_INSTALLED: {'not_required': None},
}
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(clientsecrets_dict)
def test_string_not_configured_type_installed(self):
string_props = clientsecrets.VALID_CLIENT[
clientsecrets.TYPE_INSTALLED]['string']
self.assertTrue('client_id' in string_props)
clientsecrets_dict = {
clientsecrets.TYPE_INSTALLED: {
'client_id': '[[template]]',
'client_secret': 'seekrit',
'redirect_uris': None,
'auth_uri': None,
'token_uri': None,
},
}
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._validate_clientsecrets(clientsecrets_dict)
def test_success_type_web(self):
client_info = {
'client_id': 'eye-dee',
'client_secret': 'seekrit',
'redirect_uris': None,
'auth_uri': None,
'token_uri': None,
}
clientsecrets_dict = {
clientsecrets.TYPE_WEB: client_info,
}
result = clientsecrets._validate_clientsecrets(clientsecrets_dict)
self.assertEqual(result, (clientsecrets.TYPE_WEB, client_info))
def test_success_type_installed(self):
client_info = {
'client_id': 'eye-dee',
'client_secret': 'seekrit',
'redirect_uris': None,
'auth_uri': None,
'token_uri': None,
}
clientsecrets_dict = {
clientsecrets.TYPE_INSTALLED: client_info,
}
result = clientsecrets._validate_clientsecrets(clientsecrets_dict)
self.assertEqual(result, (clientsecrets.TYPE_INSTALLED, client_info))
class Test__loadfile(unittest.TestCase):
def test_success(self):
client_type, client_info = clientsecrets._loadfile(VALID_FILE)
expected_client_info = {
'client_id': 'foo_client_id',
'client_secret': 'foo_client_secret',
'redirect_uris': [],
'auth_uri': oauth2client.GOOGLE_AUTH_URI,
'token_uri': oauth2client.GOOGLE_TOKEN_URI,
'revoke_uri': oauth2client.GOOGLE_REVOKE_URI,
}
self.assertEqual(client_type, clientsecrets.TYPE_WEB)
self.assertEqual(client_info, expected_client_info)
def test_non_existent(self):
path = os.path.join(DATA_DIR, 'fake.json')
self.assertFalse(os.path.exists(path))
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets._loadfile(path)
def test_bad_json(self):
filename = tempfile.mktemp()
with open(filename, 'wb') as file_obj:
file_obj.write(b'[')
with self.assertRaises(ValueError):
clientsecrets._loadfile(filename)
class OAuth2CredentialsTests(unittest.TestCase):
def test_validate_error(self):
payload = (
b'{'
b' "web": {'
b' "client_id": "[[CLIENT ID REQUIRED]]",'
b' "client_secret": "[[CLIENT SECRET REQUIRED]]",'
b' "redirect_uris": ["http://localhost:8080/oauth2callback"],'
b' "auth_uri": "",'
b' "token_uri": ""'
b' }'
b'}')
ERRORS = [
('{}', 'Invalid'),
('{"foo": {}}', 'Unknown'),
('{"web": {}}', 'Missing'),
('{"web": {"client_id": "dkkd"}}', 'Missing'),
(payload, 'Property'),
]
for src, match in ERRORS:
# Ensure that it is unicode
src = _helpers._from_bytes(src)
# Test load(s)
with self.assertRaises(
clientsecrets.InvalidClientSecretsError) as exc_manager:
clientsecrets.loads(src)
self.assertTrue(str(exc_manager.exception).startswith(match))
# Test loads(fp)
with self.assertRaises(
clientsecrets.InvalidClientSecretsError) as exc_manager:
fp = StringIO(src)
clientsecrets.load(fp)
self.assertTrue(str(exc_manager.exception).startswith(match))
def test_load_by_filename_missing_file(self):
with self.assertRaises(
clientsecrets.InvalidClientSecretsError) as exc_manager:
clientsecrets._loadfile(NONEXISTENT_FILE)
self.assertEquals(exc_manager.exception.args[1], NONEXISTENT_FILE)
self.assertEquals(exc_manager.exception.args[3], errno.ENOENT)
class CachedClientsecretsTests(unittest.TestCase):
class CacheMock(object):
def __init__(self):
self.cache = {}
self.last_get_ns = None
self.last_set_ns = None
def get(self, key, namespace=''):
# ignoring namespace for easier testing
self.last_get_ns = namespace
return self.cache.get(key, None)
def set(self, key, value, namespace=''):
# ignoring namespace for easier testing
self.last_set_ns = namespace
self.cache[key] = value
def setUp(self):
self.cache_mock = self.CacheMock()
def test_cache_miss(self):
client_type, client_info = clientsecrets.loadfile(
VALID_FILE, cache=self.cache_mock)
self.assertEqual('web', client_type)
self.assertEqual('foo_client_secret', client_info['client_secret'])
cached = self.cache_mock.cache[VALID_FILE]
self.assertEqual({client_type: client_info}, cached)
# make sure we're using non-empty namespace
ns = self.cache_mock.last_set_ns
self.assertTrue(bool(ns))
# make sure they're equal
self.assertEqual(ns, self.cache_mock.last_get_ns)
def test_cache_hit(self):
self.cache_mock.cache[NONEXISTENT_FILE] = {'web': 'secret info'}
client_type, client_info = clientsecrets.loadfile(
NONEXISTENT_FILE, cache=self.cache_mock)
self.assertEqual('web', client_type)
self.assertEqual('secret info', client_info)
# make sure we didn't do any set() RPCs
self.assertEqual(None, self.cache_mock.last_set_ns)
def test_validation(self):
with self.assertRaises(clientsecrets.InvalidClientSecretsError):
clientsecrets.loadfile(INVALID_FILE, cache=self.cache_mock)
def test_without_cache(self):
# this also ensures loadfile() is backward compatible
client_type, client_info = clientsecrets.loadfile(VALID_FILE)
self.assertEqual('web', client_type)
self.assertEqual('foo_client_secret', client_info['client_secret'])
|
