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
|
import textwrap
from stone.backends.python_client import PythonClientBackend
from stone.ir import (
ApiNamespace,
ApiRoute,
Int32,
List,
Map,
Nullable,
String,
Void,
StructField,
Struct,
)
MYPY = False
if MYPY:
import typing # noqa: F401 # pylint: disable=import-error,unused-import,useless-suppression
import unittest
class TestGeneratedPythonClient(unittest.TestCase):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
def _evaluate_namespace(self, ns):
# type: (ApiNamespace) -> typing.Text
backend = PythonClientBackend(
target_folder_path='output',
args=['-a', 'scope', '-a', 'another_attribute',
'-m', 'files', '-c', 'DropboxBase', '-t', 'dropbox'])
backend._generate_routes(ns)
return backend.output_buffer_to_string()
def _evaluate_namespace_with_auth_mode(self, ns, auth_mode):
# type: (ApiNamespace, str) -> typing.Text
# supply supported auth modes to the SDK generator using the new syntax
backend = PythonClientBackend(
target_folder_path='output',
args=['-w', auth_mode, '-m', 'files', '-c', 'DropboxBase', '-t', 'dropbox'])
backend._generate_route_methods({ns})
return backend.output_buffer_to_string()
def test_route_with_version_number(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(), {})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_get_metadata(self):
"""
:meth:`files_get_metadata_v2`
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_auth_mode1(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(),
{'auth': 'app'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'user, app'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_auth_mode2(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(),
{'auth': 'user'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'user, app'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
def files_get_metadata(self):
"""
:meth:`files_get_metadata_v2`
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
def files_get_metadata_v2(self):
arg = None
r = self.request(
files.get_metadata_v2,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
def test_route_with_auth_mode3(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 1, None)
route1.set_attributes(None, ':route:`get_metadata:2`', Void(), Void(), Void(),
{'auth': 'app'})
route2 = ApiRoute('get_metadata', 2, None)
route2.set_attributes(None, None, Void(), Int32(), Void(),
{'auth': 'app, team'})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
result = self._evaluate_namespace_with_auth_mode(ns, 'user')
expected = textwrap.dedent('''\
# ------------------------------------------
# Routes in files namespace
''')
self.assertEqual(result, expected)
def test_route_with_version_number_name_conflict(self):
# type: () -> None
route1 = ApiRoute('get_metadata', 2, None)
route1.set_attributes(None, None, Void(), Int32(), Void(), {})
route2 = ApiRoute('get_metadata_v2', 1, None)
route2.set_attributes(None, None, Void(), Void(), Void(), {})
ns = ApiNamespace('files')
ns.add_route(route1)
ns.add_route(route2)
with self.assertRaises(RuntimeError) as cm:
self._evaluate_namespace(ns)
self.assertEqual(
'There is a name conflict between {!r} and {!r}'.format(route1, route2),
str(cm.exception))
def test_route_argument_doc_string(self):
backend = PythonClientBackend(
target_folder_path='output',
args=['-m', 'files', '-c', 'DropboxBase', '-t', 'dropbox'])
ns = ApiNamespace('files')
self.assertEqual(backend._format_type_in_doc(ns, Int32()), 'int')
self.assertEqual(backend._format_type_in_doc(ns, Void()), 'None')
self.assertEqual(backend._format_type_in_doc(ns, List(String())), 'List[str]')
self.assertEqual(backend._format_type_in_doc(ns, Nullable(String())),
'Nullable[str]')
self.assertEqual(backend._format_type_in_doc(ns, Map(String(), Int32())),
'Map[str, int]')
def test_route_with_attributes_in_docstring(self):
# type: () -> None
route = ApiRoute('get_metadata', 1, None)
route.set_attributes(None, None, Void(), Void(), Void(), {
'scope': 'events.read', 'another_attribute': 'foo'
})
ns = ApiNamespace('files')
ns.add_route(route)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_get_metadata(self):
"""
Route attributes:
scope: events.read
another_attribute: foo
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
''')
self.assertEqual(result, expected)
def test_route_with_none_attribute_in_docstring(self):
# type: () -> None
route = ApiRoute('get_metadata', 1, None)
route.set_attributes(None, None, Void(), Void(), Void(), {
'scope': 'events.read', 'another_attribute': None
})
ns = ApiNamespace('files')
ns.add_route(route)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_get_metadata(self):
"""
Route attributes:
scope: events.read
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
''')
self.assertEqual(result, expected)
def test_route_with_attributes_and_doc_in_docstring(self):
# type: () -> None
"""
In particular make sure there's spacing b/w overview and attrs.
"""
route = ApiRoute('get_metadata', 1, None)
route.set_attributes(None, "Test string.", Void(), Void(), Void(),
{'scope': 'events.read'})
ns = ApiNamespace('files')
ns.add_route(route)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_get_metadata(self):
"""
Test string.
Route attributes:
scope: events.read
:rtype: None
"""
arg = None
r = self.request(
files.get_metadata,
'files',
arg,
None,
)
return None
''')
self.assertEqual(result, expected)
def test_route_with_doc_and_attribute_and_data_types(self):
# type: () -> None
ns = ApiNamespace('files')
struct = Struct('MyStruct', ns, None)
struct.set_attributes(None, [
StructField('field1', Int32(), None, None),
StructField('field2', Int32(), None, None),
])
route = ApiRoute('test/route', 1, None)
route.set_attributes(
None, "Test string.", struct, Int32(), Void(), {'scope': 'events.read'}
)
ns.add_route(route)
result = self._evaluate_namespace(ns)
expected = textwrap.dedent('''\
def files_test_route(self,
field1,
field2):
"""
Test string.
Route attributes:
scope: events.read
:type field1: int
:type field2: int
:rtype: int
"""
arg = files.MyStruct(field1,
field2)
r = self.request(
files.test_route,
'files',
arg,
None,
)
return r
''')
self.assertEqual(result, expected)
# TODO: add more unit tests for client code generation
|
