-
Notifications
You must be signed in to change notification settings - Fork 1
/
code_generator.py
625 lines (587 loc) · 28.2 KB
/
code_generator.py
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
import json
import os
import re
from config import Config
from jinja2 import Environment, FileSystemLoader
from swagger import Swagger
class CodeGenerator(object):
def __init__(self, language):
self._env = Environment(loader=FileSystemLoader(language + '/templates'), trim_blocks=True, lstrip_blocks=True)
self._swagger = Swagger()
self._swagger_json = self.swagger.swagger_json
self._test_count = 0
self._config = Config()
self._language = language
@staticmethod
def to_camelcase(string):
return re.sub(r'(?!^)_([a-zA-Z])', lambda m: m.group(1).upper(), string)
###############################################################################
####### GENERATE TESTS
###############################################################################
def generate_tests(self):
if self.config.is_proxied:
host = self.config.proxy_url
else:
host = self.config.host
api_key = self.config.api_key
class_names = self.get_class_names()
generated_test_class = self.generate_test_class_header()
for key in sorted(class_names): # Loop through all sorted endpoints, grouped by class name
for endpoint in class_names[key]:
objects = self.swagger.get_endpoint_objects(endpoint)
for method in objects:
if method != "parameters":
test_name = self.generate_test_name(endpoint, method)
response_codes = self.swagger.get_response_codes(endpoint, method)
response_code = response_codes[0]
raw_data = self.swagger.get_example_data(endpoint, method, response_code)
data = json.dumps(raw_data, indent=2, sort_keys=True)
api_call = self.generate_api_call(endpoint, method)
#if (endpoint == '/whitelabel/links/subuser') and (method == 'get'):
# print(endpoint)
# print(method)
# print(query_params)
# query_params = self.swagger.get_query_parameters(endpoint, method, 'nodejs')
#else:
query_params = self.swagger.get_query_parameters(endpoint, method)
params = self.generate_params(response_code, query_params, mock=False, caller="test")
url_params = self.generate_url_params(endpoint)
if self._language == "python":
if raw_data:
try:
if "true" in data:
data = data.replace("true", "True")
if "false" in data:
data = data.replace("false", "False")
except TypeError, e:
pass
else:
data = None
headers = self.generate_headers(response_code)
if self._language == "ruby":
if raw_data:
pass
else:
data = None
headers = json.dumps(self.generate_headers(response_code))
if self._language == "csharp":
method = method.upper()
headers = self.generate_headers(response_code)
headers = "headers.Add(\"X-Mock\", \"" + str(headers["X-Mock"]) + "\");"
if raw_data:
data = json.dumps(raw_data, indent=2, sort_keys=True).replace('"', "'")
else:
data = None
if self._language == "php":
if raw_data:
try:
if "True" in data:
data = data.replace("True", "true")
if "False" in data:
data = data.replace("False", "false")
except TypeError, e:
pass
else:
data = None
headers = "X-Mock: " + response_code
if self._language == "java":
if raw_data:
data = json.dumps(json.dumps(raw_data, separators=(',', ':')))
else:
data = None
headers = "\"X-Mock\" ," + "\"" + response_code + "\""
method = method.upper()
api_call = api_call[:-1]
if self._language == "nodejs":
headers = ""
method = method.upper()
api_call = "/v3/" + api_call[:-1]
if self._language == "go":
headers = ""
method = method.upper()
api_call = "/" + api_call[:-1]
if raw_data:
pass
else:
data = None
if data:
data = data.replace("<img src='cid:ii_139db99fdb5c3704'>", "<img src=[CID GOES HERE]>")
if response_code != "default": # schema undefined in swagger
generated_test_class += self.generate_test_class_function(test_name,
endpoint,
method,
response_code,
api_call,
params=params,
url_params=url_params,
data=data,
headers=headers
)
if self._language == "php":
generated_test_class += self.generate_test_class_footer()
generated_test_class += "}"
if self._language == "ruby":
generated_test_class += "end"
if self._language == "java":
generated_test_class += "}"
if self._language == "csharp":
generated_test_class += self.generate_test_class_footer()
generated_test_class += " }\n}"
if self._language == "python":
generated_test_class += self.generate_test_class_footer()
return generated_test_class
def generate_test_class_header(self):
t = self.env.get_template('test_header.jinja')
return t.render()
def generate_test_class_footer(self):
t = self.env.get_template('test_footer.jinja')
return t.render()
def generate_test_class_function(self,
test_name,
endpoint,
method,
response_code,
api_call,
data=None,
params=None,
url_params=None,
headers=None
):
t = self.env.get_template('test_class_function.jinja')
return t.render(test_name = test_name,
endpoint = endpoint,
method = method,
response_code = response_code,
api_call = api_call,
data = data,
params = params,
url_params = url_params,
headers = headers
)
def generate_test_name(self, endpoint, method):
endpoint = endpoint.replace("/", "_").replace("{", "_").replace("}", "_")
call = ""
if self._language == "python":
call = "(self):"
if self._language == "php":
call = "()"
if self._language == "csharp":
split_endpoint = endpoint.split('__')
split_endpoint = '_'.join(split_endpoint)
split_endpoint = self.upper_first(self.to_camelcase(split_endpoint[1:]).replace("_", ""))
return "Test" + split_endpoint + self.upper_first(self.to_camelcase(method))
return "test" + endpoint + "_" + method + call
def generate_api_call(self, endpoint, method):
seperator = ""
if self._language == "ruby":
endpoint = endpoint.replace("/", ".").replace("{", "_(").replace("}", ")")
# Account for Ruby reserved word
endpoint = endpoint.replace("mail.send", "mail._(\"send\")")
seperator = "."
if self._language == "python":
endpoint = endpoint.replace("/", ".").replace("{", "_(").replace("}", ")")
# Account for Python reserved word
endpoint = endpoint.replace("global", "_(\"global\")")
seperator = "."
if self._language == "csharp":
endpoint = endpoint[1:] + "\""
endpoint = endpoint.replace("}/", " + \"/")
endpoint = endpoint.replace("{", "\" + ").replace("}\"", "")
return endpoint
if self._language == "php":
endpoint = endpoint.replace("{", "_($").replace("}/", ")->")
endpoint = endpoint.replace("}", ")->")
endpoint = endpoint[1:]
endpoint = endpoint.replace("/", "()->")
if endpoint.endswith(">"):
seperator = ""
else:
seperator = "()->"
if self._language == "java":
endpoint = endpoint[1:] + "/"
return endpoint
if self._language == "nodejs":
endpoint = endpoint[1:] + "/"
return endpoint
if self._language == "go":
endpoint = endpoint[1:] + "/"
return endpoint
return endpoint + seperator + method
def generate_headers(self, response_code):
header = {}
header["X-Mock"] = int(response_code)
return header
###############################################################################
####### GENERATE USAGE.md
###############################################################################
def generate_docs(self):
class_names = self.get_raw_class_names()
generated_documentation = self.generate_documenation_title()
generated_documentation += self.generate_documentation_toc(self.get_raw_class_names())
for key in sorted(class_names):
heading = self.generate_heading_name(key.upper().replace('_', ' '))
heading_link = heading.lower().replace(' ', '_')
generated_documentation += self.generate_documentation_header(heading, heading_link)
for endpoint in class_names[key]:
objects = self.swagger.get_endpoint_objects(endpoint)
for method in objects:
if method != "parameters":
generated_documentation += self.generate_documentation_endpoint(endpoint, method)
return generated_documentation.encode('ascii', 'ignore')
def generate_documenation_title(self):
t = self.env.get_template('documentation_title.jinja')
return t.render()
def generate_documentation_toc(self, class_names):
toc = ''
for key in sorted(class_names):
heading = self.generate_heading_name(key.upper().replace('_', ' '))
heading_link = heading.lower().replace(' ', '_')
toc += "* [" + heading + "]" + "(#" + heading_link + ")\n"
t = self.env.get_template('documentation_toc.jinja')
return t.render(toc=toc)
def generate_documentation_header(self, heading, heading_link):
t = self.env.get_template('documentation_header.jinja')
return t.render(heading=heading, heading_link=heading_link)
def generate_documentation_endpoint(self, endpoint, method):
t = self.env.get_template('documentation_endpoint.jinja')
title = self.swagger.get_endpoint_short_description(endpoint, method)
description = self.swagger.get_endpoint_description(endpoint, method)
api_call = self.generate_api_call(endpoint, method)
response_codes = self.swagger.get_response_codes(endpoint, method)
response_code = response_codes[0]
raw_data = self.swagger.get_example_data(endpoint, method, response_code)
data = json.dumps(raw_data, indent=2, sort_keys=True)
query_params = self.swagger.get_query_parameters(endpoint, method)
params = self.generate_params(response_code, query_params, mock=False, caller="docs")
url_params = self.generate_url_params(endpoint, None, True, "docs")
if self._language == "python":
try:
if "true" in data:
data = data.replace("true", "True")
if "false" in data:
data = data.replace("false", "False")
except TypeError, e:
pass
if raw_data:
pass
else:
data = None
if self._language == "java":
method = method.upper()
if raw_data:
data = json.dumps(json.dumps(raw_data, separators=(',', ':')))
else:
data = None
api_call = api_call[:-1]
if self._language == "csharp":
method = method.upper()
if raw_data:
data = json.dumps(raw_data, indent=2, sort_keys=True).replace('"', "'")
else:
data = None
#api_call = api_call.replace("event", "_(\"event\")")
#api_call = api_call.replace("default", "_(\"default\")")
if self._language == "nodejs":
method = method.upper()
api_call = "/v3/" + api_call[:-1]
if raw_data:
pass
else:
data = None
if self._language == "ruby":
if raw_data:
pass
else:
data = None
if self._language == "php":
if raw_data:
pass
else:
data = None
if self._language == "go":
method = method.upper()
api_call = "/" + api_call[:-1]
if raw_data:
pass
else:
data = None
if data:
data = data.replace("<img src='cid:ii_139db99fdb5c3704'>", "<img src=[CID GOES HERE]>")
return t.render(title=title,
description=description,
endpoint=endpoint,
method_title=method.upper(),
method=method,
api_call=api_call,
params=params,
url_params=url_params,
data=data
)
def generate_heading_name(self, heading_name):
#TODO: allow for customizations through the config file
return heading_name
def get_raw_class_names(self):
class_names = {}
for endpoint in sorted(self.swagger_json["paths"]):
split_endpoint = endpoint.split('/')
class_name = split_endpoint[1].capitalize()
try:
class_names[class_name].append(endpoint)
except KeyError, e:
class_names[class_name] = []
class_names[class_name].append(endpoint)
return class_names
###############################################################################
####### GENERATE EXAMPLES
###############################################################################
def generate_examples(self):
class_names = self.get_class_names()
for key in sorted(class_names):
path = '{0}'.format(os.path.abspath(os.path.dirname(__file__)))
newpath = '{0}/{1}/generated_files/examples/{2}'.format(path, self._language, key.lower())
if not os.path.exists(newpath):
os.makedirs(newpath)
suffix = ""
if self._language == "python":
suffix = ".py"
if self._language == "php":
suffix = ".php"
if self._language == "ruby":
suffix = ".rb"
if self._language == "java":
suffix = ".java"
if self._language == "nodejs":
suffix = ".js"
if self._language == "csharp":
suffix = ".cs"
if self._language == "go":
suffix = ".go"
file = open(str(newpath + '/' + key.lower() + suffix), 'w')
generated_examples = self.generate_example_title()
for endpoint in class_names[key]:
objects = self.swagger.get_endpoint_objects(endpoint)
for method in objects:
if method != "parameters":
generated_examples += self.generate_examples_endpoint(endpoint, method)
if self._language == "go":
generated_examples += "func main() {\n"
generated_examples += " // add your function calls here\n"
generated_examples += "}\n"
file.write(generated_examples.encode('ascii', 'ignore'))
file.close()
print generated_examples
return generated_examples.encode('ascii', 'ignore')
def generate_example_title(self):
t = self.env.get_template('examples_header.jinja')
return t.render()
def generate_examples_endpoint(self, endpoint, method):
t = self.env.get_template('examples_endpoint.jinja')
title = self.swagger.get_endpoint_short_description(endpoint, method)
func_title = ""
description = self.swagger.get_endpoint_description(endpoint, method)
api_call = self.generate_api_call(endpoint, method)
response_codes = self.swagger.get_response_codes(endpoint, method)
response_code = response_codes[0]
raw_data = self.swagger.get_example_data(endpoint, method, response_code)
data = json.dumps(raw_data, indent=2, sort_keys=True)
query_params = self.swagger.get_query_parameters(endpoint, method)
params = self.generate_params(response_code, query_params, mock=False, caller="examples")
url_params = self.generate_url_params(endpoint, None, None, "examples")
if self._language == "ruby":
if raw_data:
pass
else:
data = None
if self._language == "php":
if raw_data:
pass
else:
data = None
if self._language == "python":
try:
if "true" in data:
data = data.replace("true", "True")
if "false" in data:
data = data.replace("false", "False")
except TypeError, e:
pass
if raw_data:
pass
else:
data = None
if self._language == "java":
method = method.upper()
if raw_data:
data = json.dumps(json.dumps(raw_data, separators=(',', ':')))
else:
data = None
api_call = api_call[:-1]
if self._language == "nodejs":
method = method.upper()
if raw_data:
pass
else:
data = None
api_call = "/v3/" + api_call[:-1]
if self._language == "go":
method = method.upper()
if raw_data:
pass
else:
data = None
api_call = "/" + api_call[:-1]
func_title = title.replace(" ", "")
func_title = func_title.replace("&", "")
func_title = func_title.replace(".", "")
func_title = func_title.replace("/", "")
func_title = func_title.replace("[Needs:Statsobjectdefined,hascategoryID?]", "")
func_title = func_title.replace("'", "")
if self._language == "csharp":
method = method.upper()
if raw_data:
data = json.dumps(raw_data, indent=2, sort_keys=True).replace('"', "'")
else:
data = None
api_call = api_call.replace("event", "_(\"event\")")
api_call = api_call.replace("default", "_(\"default\")")
if data:
data = data.replace("<img src='cid:ii_139db99fdb5c3704'>", "<img src=[CID GOES HERE]>")
return t.render(title=title,
description=description,
endpoint=endpoint,
method_title=method.upper(),
method=method,
api_call=api_call,
params=params,
url_params=url_params,
data=data,
func_title=func_title
)
###############################################################################
####### UTILITY FUNCTIONS
###############################################################################
def upper_first(self, string):
return string[0].upper() + string[1:]
# Used in tests and examples
def get_class_names(self):
class_names = {}
for endpoint in sorted(self.swagger_json["paths"]):
raw_endpoint = endpoint
split_endpoint = endpoint.split('/')
class_name = self.to_camelcase(split_endpoint[1].capitalize())
try:
class_names[class_name].append(raw_endpoint)
except KeyError, e:
class_names[class_name] = []
class_names[class_name].append(raw_endpoint)
return class_names
# Used in tests, docs and examples
# params should be formatted like: {"hello": "world", "bye": 2}
def generate_params(self, response_code, params=None, mock=None, caller=None):
all_params = {}
if mock:
if response_code == "default":
all_params["mock"] = 0 # Means the response code is undefined in swagger
else:
all_params["mock"] = int(response_code)
if params:
for param in params:
all_params[param] = params[param]
if all_params == {}:
all_params = None
if (self._language == "ruby") and (all_params != None):
all_params = json.dumps(all_params)
if (self._language == "csharp") and (all_params != None):
all_params = json.dumps(all_params, indent=2, sort_keys=True).replace('"', "'")
if (self._language == "php") and (all_params != None):
all_params = json.dumps(all_params)
if (self._language == "java") and (all_params != None):
java_params = ""
for key in all_params:
java_params += "queryParams.put(\"" + str(key) + "\", \""+ str(all_params[key]) + "\");\n "
java_params = java_params[:-7]
return java_params
if (self._language == "nodejs") and (all_params != None):
nodejs_params = ""
for key in all_params:
if caller == "examples":
nodejs_params += "request.queryParams[\"" + str(key) + "\"] = '" + str(all_params[key]) + "'\n "
else:
nodejs_params += "request.queryParams[\"" + str(key) + "\"] = '" + str(all_params[key]) + "'\n "
if caller == "docs":
nodejs_params = json.dumps(all_params, indent=2, sort_keys=True).replace('"', "'")
else:
nodejs_params = json.dumps(all_params, indent=2, sort_keys=True).replace('"', "'")
return nodejs_params
if (self._language == "go") and (all_params != None):
go_params = ""
for key in all_params:
if caller == "examples":
go_params += "queryParams[\"" + str(key) + "\"] = \"" + str(all_params[key]) + "\"\n "
if caller == "test":
go_params += "queryParams[\"" + str(key) + "\"] = \"" + str(all_params[key]) + "\"\n "
if caller == "docs":
go_params += "queryParams[\"" + str(key) + "\"] = \"" + str(all_params[key]) + "\"\n"
return go_params
return all_params
# Used in tests, docs and examples
def generate_url_params(self, endpoint, value=None, docs=None, caller=None):
if value == None:
value = "test_url_param"
#TODO: grab these from stoplight, can override with config
if endpoint.count('{') < 1:
return None
elif endpoint.count('{') == 1:
if self._language == "ruby":
return endpoint.split('{', 1)[-1].split('}')[0] + " = " + "\"" + value + "\""
if self._language == "csharp":
return "var " + endpoint.split('{', 1)[-1].split('}')[0] + " = " + "\"" + value + "\";"
if self._language == "python":
return endpoint.split('{', 1)[-1].split('}')[0] + " = " + "\"" + value + "\""
if self._language == "php":
return "$" + endpoint.split('{', 1)[-1].split('}')[0] + " = " + "\"" + value + "\""
else:
split_endpoint = endpoint.split('{')
if self._language == "java":
url_params = ""
if self._language == "nodejs":
url_params = ""
if self._language == "go":
url_params = ""
if self._language == "ruby":
url_params = split_endpoint[1].split('}')[0] + " = " + "\"" + value + "\"\n"
if (caller == "docs") or (caller == "examples"):
url_params += "" + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
else:
url_params += " " + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
if self._language == "csharp":
url_params = "var " + split_endpoint[1].split('}')[0] + " = " + "\"" + value + "\";\n"
if (caller == "docs") or (caller == "examples"):
url_params += "var " + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\";"
else:
url_params += " var " + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\";"
if self._language == "python":
url_params = split_endpoint[1].split('}')[0] + " = " + "\"" + value + "\"\n"
if (caller == "docs") or (caller == "examples"):
url_params += "" + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
else:
url_params += " " + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
if self._language == "php":
url_params = "$" + split_endpoint[1].split('}')[0] + " = " + "\"" + value + "\";\n"
if (caller == "docs") or (caller == "examples"):
url_params += "$" + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
else:
url_params += " $" + split_endpoint[2].split('}')[0] + " = " + "\"" + value + "\""
return url_params
@property
def env(self):
return self._env
@property
def swagger_json(self):
return self._swagger_json
@property
def config(self):
return self._config
@property
def swagger(self):
return self._swagger