/
vnc_api.py
1288 lines (1105 loc) · 50.4 KB
/
vnc_api.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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# Copyright (c) 2013 Juniper Networks, Inc. All rights reserved.
#
import logging
import requests
from requests.exceptions import ConnectionError
import ConfigParser
import pprint
from cfgm_common import jsonutils as json
import sys
import time
import platform
import functools
import __main__ as main
import ssl
import re
import os
import gen.resource_common
import gen.vnc_api_client_gen
from gen.vnc_api_client_gen import all_resource_type_tuples
from gen.resource_xsd import *
from gen.resource_client import *
from gen.generatedssuper import GeneratedsSuper
import cfgm_common
from cfgm_common import rest, utils
from cfgm_common.exceptions import *
from cfgm_common import ssl_adapter
from pprint import pformat
def check_homepage(func):
@functools.wraps(func)
def wrapper(self, *args, **kwargs):
if not self._srv_root_url:
homepage = self._request(rest.OP_GET, self._base_url,
retry_on_error=False)
self._parse_homepage(homepage)
return func(self, *args, **kwargs)
return wrapper
def compare_refs(old_refs, new_refs):
# compare refs in an object
old_ref_dict = dict((':'.join(ref['to']), ref['attr']) for ref in old_refs or [])
new_ref_dict = dict((':'.join(ref['to']), ref['attr']) for ref in new_refs or [])
return old_ref_dict == new_ref_dict
# end compare_refs
def get_object_class(res_type):
cls_name = '%s' %(utils.CamelCase(res_type))
return utils.str_to_class(cls_name, __name__)
# end get_object_class
def _read_cfg(cfg_parser, section, option, default):
try:
val = cfg_parser.get(section, option)
except (AttributeError,
ConfigParser.NoOptionError,
ConfigParser.NoSectionError):
val = default
return val
#end _read_cfg
def _cfg_curl_logging(api_curl_log_file=None):
formatter = logging.Formatter('%(asctime)s %(levelname)-8s %(message)s',datefmt='%Y/%m/%d %H:%M:%S')
curl_logger = logging.getLogger('log_curl')
curl_logger.setLevel(logging.DEBUG)
api_curl_log_file="/var/log/contrail/%s" %(api_curl_log_file)
if os.path.exists(api_curl_log_file):
curl_log_handler = logging.FileHandler(api_curl_log_file,mode='a')
else:
curl_log_handler = logging.FileHandler(api_curl_log_file,mode='w')
curl_log_handler.setFormatter(formatter)
curl_logger.addHandler(curl_log_handler)
return curl_logger
# End _cfg_curl_logging
class ActionUriDict(dict):
"""Action uri dictionary with operator([]) overloading to parse home page
and populate the action_uri, if not populated already.
"""
def __init__(self, vnc_api, *args, **kwargs):
dict.__init__(self, args, **kwargs)
self.vnc_api = vnc_api
def __getitem__(self, key):
try:
return dict.__getitem__(self, key)
except KeyError:
homepage = self.vnc_api._request(rest.OP_GET, self.vnc_api._base_url,
retry_on_error=False)
self.vnc_api._parse_homepage(homepage)
return dict.__getitem__(self, key)
class VncApi(object):
_DEFAULT_WEB_SERVER = "127.0.0.1"
hostname = platform.node()
_DEFAULT_HEADERS = {
'Content-type': 'application/json; charset="UTF-8"',
'X-Contrail-Useragent': '%s:%s'
%(hostname, getattr(main, '__file__', '')),
}
_AUTHN_SUPPORTED_TYPES = ["keystone"]
_DEFAULT_AUTHN_TYPE = "keystone"
_DEFAULT_AUTHN_HEADERS = _DEFAULT_HEADERS
_DEFAULT_AUTHN_PROTOCOL = "http"
_DEFAULT_AUTHN_SERVER = _DEFAULT_WEB_SERVER
_DEFAULT_AUTHN_PORT = 35357
_DEFAULT_AUTHN_URL = "/v2.0/tokens"
_DEFAULT_AUTHN_USER = ""
_DEFAULT_AUTHN_PASSWORD = ""
_DEFAULT_AUTHN_TENANT = 'default-tenant'
_DEFAULT_DOMAIN_ID = "default"
# Keystone and and vnc-api SSL support
# contrail-api will remain to be on http
# with LB (haproxy/F5/nginx..etc) configured for
# ssl termination on port 8082(default contrail-api port)
_DEFAULT_API_SERVER_CONNECT="http"
_DEFAULT_API_SERVER_SSL_CONNECT="https"
_DEFAULT_KS_CERT_BUNDLE="/tmp/keystonecertbundle.pem"
_DEFAULT_API_CERT_BUNDLE="/tmp/apiservercertbundle.pem"
# Connection to api-server through Quantum
_DEFAULT_WEB_PORT = 8082
_DEFAULT_BASE_URL = "/"
# The number of items beyond which instead of GET /<collection>
# a POST /list-bulk-collection is issued
POST_FOR_LIST_THRESHOLD = 25
# Number of pools and number of pool per conn to api-server
_DEFAULT_MAX_POOLS = 100
_DEFAULT_MAX_CONNS_PER_POOL = 100
def __init__(self, username=None, password=None, tenant_name=None,
api_server_host=None, api_server_port=None,
api_server_url=None, conf_file=None, user_info=None,
auth_token=None, auth_host=None, auth_port=None,
auth_protocol = None, auth_url=None, auth_type=None,
wait_for_connect=False, api_server_use_ssl=False,
domain_name=None, exclude_hrefs=None):
# TODO allow for username/password to be present in creds file
self._obj_serializer = self._obj_serializer_diff
for object_type, resource_type in all_resource_type_tuples:
for oper_str in ('_create', '_read', '_update', '_delete',
's_list', '_get_default_id'):
method = getattr(self, '_object%s' %(oper_str))
bound_method = functools.partial(method, resource_type)
functools.update_wrapper(bound_method, method)
if oper_str == '_get_default_id':
setattr(self, 'get_default_%s_id' % (object_type),
bound_method)
else:
setattr(self, '%s%s' %(object_type, oper_str),
bound_method)
cfg_parser = ConfigParser.ConfigParser()
try:
cfg_parser.read(conf_file or
"/etc/contrail/vnc_api_lib.ini")
except Exception as e:
logger = logging.getLogger(__name__)
logger.warn("Exception: %s", str(e))
self._api_connect_protocol = VncApi._DEFAULT_API_SERVER_CONNECT
# API server SSL Support
use_ssl = api_server_use_ssl
if isinstance(api_server_use_ssl, basestring):
use_ssl = (api_server_use_ssl.lower() == 'true')
if use_ssl:
self._api_connect_protocol = VncApi._DEFAULT_API_SERVER_SSL_CONNECT
# keystone
self._authn_type = auth_type or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_TYPE',
self._DEFAULT_AUTHN_TYPE)
if self._authn_type == 'keystone':
self._authn_protocol = auth_protocol or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_PROTOCOL',
self._DEFAULT_AUTHN_PROTOCOL)
self._authn_server = auth_host or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_SERVER',
self._DEFAULT_AUTHN_SERVER)
self._authn_port = auth_port or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_PORT',
self._DEFAULT_AUTHN_PORT)
self._authn_url = auth_url or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_URL',
self._DEFAULT_AUTHN_URL)
self._username = username or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_USER',
self._DEFAULT_AUTHN_USER)
self._password = password or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_PASSWORD',
self._DEFAULT_AUTHN_PASSWORD)
self._tenant_name = tenant_name or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_TENANT',
self._DEFAULT_AUTHN_TENANT)
self._domain_name = domain_name or \
_read_cfg(cfg_parser, 'auth', 'AUTHN_DOMAIN',
self._DEFAULT_DOMAIN_ID)
#contrail-api SSL support
try:
self._apiinsecure = cfg_parser.getboolean('global','insecure')
except (AttributeError,
ConfigParser.NoOptionError,
ConfigParser.NoSectionError):
self._apiinsecure = False
apicertfile=_read_cfg(cfg_parser,'global','certfile','')
apikeyfile=_read_cfg(cfg_parser,'global','keyfile','')
apicafile=_read_cfg(cfg_parser,'global','cafile','')
self._use_api_certs=False
if api_server_use_ssl:
certs = []
if apicafile:
certs.append(apicafile)
if apicertfile:
certs.append(apicertfile)
if apikeyfile:
certs.append(apikeyfile)
if certs:
self._apicertbundle=utils.getCertKeyCaBundle(VncApi._DEFAULT_API_CERT_BUNDLE,certs)
self._use_api_certs=True
# keystone SSL support
try:
self._ksinsecure = cfg_parser.getboolean('auth', 'insecure')
except (AttributeError,
ConfigParser.NoOptionError,
ConfigParser.NoSectionError):
self._ksinsecure = False
kscertfile=_read_cfg(cfg_parser,'auth','certfile','')
kskeyfile=_read_cfg(cfg_parser,'auth','keyfile','')
kscafile=_read_cfg(cfg_parser,'auth','cafile','')
self._use_ks_certs=False
if self._authn_protocol == 'https':
certs = []
if kscafile:
certs.append(kscafile)
if kscertfile:
certs.append(kscertfile)
if kskeytfile:
certs.append(kskeyfile)
if certs:
self._kscertbundle=utils.getCertKeyCaBundle(VncApi._DEFAULT_KS_CERT_BUNDLE,certs)
self._use_ks_certs=True
if 'v2' in self._authn_url:
self._authn_body = \
'{"auth":{"passwordCredentials":{' + \
'"username": "%s",' % (self._username) + \
' "password": "%s"},' % (self._password) + \
' "tenantName":"%s"}}' % (self._tenant_name)
else:
self._authn_body = \
'{"auth":{"identity":{' + \
'"methods": ["password"],' + \
' "password":{' + \
' "user":{' + \
' "name": "%s",' % (self._username) + \
' "domain": { "name": "%s" },' % (self._domain_name) + \
' "password": "%s"' % (self._password) + \
'}' + \
'}' + \
'},' + \
' "scope":{' + \
' "project":{' + \
' "domain": { "name": "%s" },' % (self._domain_name) + \
' "name": "%s"' % (self._tenant_name) + \
'}' + \
'}' + \
'}' + \
'}'
self._user_info = user_info
if not api_server_host:
self._web_host = _read_cfg(cfg_parser, 'global', 'WEB_SERVER',
self._DEFAULT_WEB_SERVER)
else:
self._web_host = api_server_host
if not api_server_port:
self._web_port = _read_cfg(cfg_parser, 'global', 'WEB_PORT',
self._DEFAULT_WEB_PORT)
else:
self._web_port = api_server_port
self._max_pools = int(_read_cfg(
cfg_parser, 'global', 'MAX_POOLS',
self._DEFAULT_MAX_POOLS))
self._max_conns_per_pool = int(_read_cfg(
cfg_parser, 'global', 'MAX_CONNS_PER_POOL',
self._DEFAULT_MAX_CONNS_PER_POOL))
self._curl_logging = False
if _read_cfg(cfg_parser, 'global', 'curl_log', False):
self._curl_logging=True
self._curl_logger=_cfg_curl_logging(_read_cfg(cfg_parser,'global','curl_log',False))
# Where client's view of world begins
if not api_server_url:
self._base_url = _read_cfg(cfg_parser, 'global', 'BASE_URL',
self._DEFAULT_BASE_URL)
else:
self._base_url = api_server_url
# Where server says its root is when _base_url is fetched
self._srv_root_url = None
# Type-independent actions offered by server
self._action_uri = ActionUriDict(self)
self._headers = self._DEFAULT_HEADERS.copy()
self._headers[rest.hdr_client_tenant()] = self._tenant_name
self._auth_token_input = False
self._auth_token = None
if auth_token:
self._auth_token = auth_token
self._auth_token_input = True
self._headers['X-AUTH-TOKEN'] = self._auth_token
# user information for quantum
if self._user_info:
if 'user_id' in self._user_info:
self._headers['X-API-USER-ID'] = self._user_info['user_id']
if 'user' in self._user_info:
self._headers['X-API-USER'] = self._user_info['user']
if 'role' in self._user_info:
self.set_user_roles([self._user_info['role']])
self._exclude_hrefs = exclude_hrefs
self._create_api_server_session()
retry_count = 6
while retry_count:
try:
homepage = self._request(rest.OP_GET, self._base_url,
retry_on_error=False)
self._parse_homepage(homepage)
except ServiceUnavailableError as e:
logger = logging.getLogger(__name__)
logger.warn("Exception: %s", str(e))
if wait_for_connect:
# Retry connect infinitely when http retcode 503
continue
elif retry_count:
# Retry connect 60 times when http retcode 503
retry_count -= 1
time.sleep(1)
else:
# connected succesfully
break
#end __init__
@check_homepage
def _object_create(self, res_type, obj):
obj_cls = get_object_class(res_type)
obj._pending_field_updates |= obj._pending_ref_updates
obj._pending_ref_updates = set([])
# Ignore fields with None value in json representation
# encode props + refs in object body
obj_json_param = json.dumps(obj, default=self._obj_serializer)
json_body = '{"%s":%s}' %(res_type, obj_json_param)
content = self._request_server(rest.OP_POST,
obj_cls.create_uri,
data=json_body)
obj_dict = json.loads(content)[res_type]
obj.uuid = obj_dict['uuid']
if 'parent_uuid' in obj_dict:
obj.parent_uuid = obj_dict['parent_uuid']
obj.set_server_conn(self)
# encode any prop-<list|map> operations and
# POST on /prop-collection-update
prop_coll_body = {'uuid': obj.uuid,
'updates': []}
operations = []
for prop_name in obj._pending_field_list_updates:
operations.extend(obj._pending_field_list_updates[prop_name])
for prop_name in obj._pending_field_map_updates:
operations.extend(obj._pending_field_map_updates[prop_name])
for oper, elem_val, elem_pos in operations:
if isinstance(elem_val, GeneratedsSuper):
serialized_elem_value = elem_val.exportDict('')
else:
serialized_elem_value = elem_val
prop_coll_body['updates'].append(
{'field': prop_name, 'operation': oper,
'value': serialized_elem_value, 'position': elem_pos})
# all pending fields picked up
obj.clear_pending_updates()
if prop_coll_body['updates']:
prop_coll_json = json.dumps(prop_coll_body)
self._request_server(rest.OP_POST,
self._action_uri['prop-collection-update'],
data=prop_coll_json)
return obj.uuid
# end _object_create
@check_homepage
def _object_read(self, res_type, fq_name=None, fq_name_str=None,
id=None, ifmap_id=None, fields=None):
obj_cls = get_object_class(res_type)
(args_ok, result) = self._read_args_to_id(
res_type, fq_name, fq_name_str, id, ifmap_id)
if not args_ok:
return result
id = result
uri = obj_cls.resource_uri_base[res_type] + '/' + id
if fields:
comma_sep_fields = ','.join(f for f in fields)
query_params = {'fields': comma_sep_fields}
else:
query_params = {'exclude_back_refs':True,
'exclude_children':True,}
if self._exclude_hrefs is not None:
query_params['exclude_hrefs'] = True
response = self._request_server(rest.OP_GET, uri, query_params)
obj_dict = response[res_type]
obj = obj_cls.from_dict(**obj_dict)
obj.clear_pending_updates()
obj.set_server_conn(self)
return obj
# end _object_read
@check_homepage
def _object_update(self, res_type, obj):
obj_cls = get_object_class(res_type)
# Read in uuid from api-server if not specified in obj
if not obj.uuid:
obj.uuid = self.fq_name_to_id(res_type, obj.get_fq_name())
# Generate PUT on object only if some attr was modified
content = None
if obj.get_pending_updates():
# Ignore fields with None value in json representation
obj_json_param = json.dumps(obj, default=self._obj_serializer)
if obj_json_param:
json_body = '{"%s":%s}' %(res_type, obj_json_param)
uri = obj_cls.resource_uri_base[res_type] + '/' + obj.uuid
content = self._request_server(rest.OP_PUT, uri, data=json_body)
# Generate POST on /prop-collection-update if needed/pending
prop_coll_body = {'uuid': obj.uuid,
'updates': []}
operations = []
for prop_name in obj._pending_field_list_updates:
operations.extend(obj._pending_field_list_updates[prop_name])
for prop_name in obj._pending_field_map_updates:
operations.extend(obj._pending_field_map_updates[prop_name])
for oper, elem_val, elem_pos in operations:
if isinstance(elem_val, GeneratedsSuper):
serialized_elem_value = elem_val.exportDict('')
else:
serialized_elem_value = elem_val
prop_coll_body['updates'].append(
{'field': prop_name, 'operation': oper,
'value': serialized_elem_value, 'position': elem_pos})
if prop_coll_body['updates']:
prop_coll_json = json.dumps(prop_coll_body)
self._request_server(rest.OP_POST,
self._action_uri['prop-collection-update'],
data=prop_coll_json)
# Generate POST on /ref-update if needed/pending
for ref_name in obj._pending_ref_updates:
ref_orig = set([(x.get('uuid'),
tuple(x.get('to', [])), x.get('attr'))
for x in getattr(obj, '_original_' + ref_name, [])])
ref_new = set([(x.get('uuid'),
tuple(x.get('to', [])), x.get('attr'))
for x in getattr(obj, ref_name, [])])
for ref in ref_orig - ref_new:
self.ref_update(res_type, obj.uuid, ref_name, ref[0],
list(ref[1]), 'DELETE')
for ref in ref_new - ref_orig:
self.ref_update(res_type, obj.uuid, ref_name, ref[0],
list(ref[1]), 'ADD', ref[2])
obj.clear_pending_updates()
return content
# end _object_update
@check_homepage
def _objects_list(self, res_type, parent_id=None, parent_fq_name=None,
obj_uuids=None, back_ref_id=None, fields=None,
detail=False, count=False, filters=None):
return self.resource_list(res_type, parent_id=parent_id,
parent_fq_name=parent_fq_name, back_ref_id=back_ref_id,
obj_uuids=obj_uuids, fields=fields, detail=detail, count=count,
filters=filters)
# end _objects_list
@check_homepage
def _object_delete(self, res_type, fq_name=None, id=None, ifmap_id=None):
obj_cls = get_object_class(res_type)
(args_ok, result) = self._read_args_to_id(
res_type=res_type, fq_name=fq_name, id=id, ifmap_id=ifmap_id)
if not args_ok:
return result
id = result
uri = obj_cls.resource_uri_base[res_type] + '/' + id
content = self._request_server(rest.OP_DELETE, uri)
# end _object_delete
def _object_get_default_id(self, res_type):
obj_cls = get_object_class(res_type)
return self.fq_name_to_id(res_type, obj_cls().get_fq_name())
# end _object_get_default_id
def _obj_serializer_diff(self, obj):
if hasattr(obj, 'serialize_to_json'):
return obj.serialize_to_json(obj.get_pending_updates())
else:
return dict((k, v) for k, v in obj.__dict__.iteritems())
#end _obj_serializer_diff
def _obj_serializer_all(self, obj):
if hasattr(obj, 'serialize_to_json'):
return obj.serialize_to_json()
else:
return dict((k, v) for k, v in obj.__dict__.iteritems())
#end _obj_serializer_all
def _create_api_server_session(self):
self._api_server_session = requests.Session()
adapter = requests.adapters.HTTPAdapter(
pool_connections=self._max_conns_per_pool,
pool_maxsize=self._max_pools)
ssladapter = ssl_adapter.SSLAdapter(ssl.PROTOCOL_SSLv23)
ssladapter.init_poolmanager(
connections=self._max_conns_per_pool,
maxsize=self._max_pools)
self._api_server_session.mount("http://", adapter)
self._api_server_session.mount("https://", ssladapter)
#end _create_api_server_session
# Authenticate with configured service
def _authenticate(self, response=None, headers=None):
if self._authn_type is None:
return headers
url = "%s://%s:%s%s" % (self._authn_protocol, self._authn_server, self._authn_port,
self._authn_url)
new_headers = headers or {}
try:
if self._ksinsecure:
response = requests.post(url, data=self._authn_body,
headers=self._DEFAULT_AUTHN_HEADERS, verify=False)
elif not self._ksinsecure and self._use_ks_certs:
response = requests.post(url, data=self._authn_body,
headers=self._DEFAULT_AUTHN_HEADERS, verify=self._kscertbundle)
else:
response = requests.post(url, data=self._authn_body,
headers=self._DEFAULT_AUTHN_HEADERS)
except Exception as e:
errmsg = 'Unable to connect to keystone for authentication. '
errmsg += 'Exception %s' %(e)
raise RuntimeError(errmsg)
if (response.status_code == 200) or (response.status_code == 201):
# plan is to re-issue original request with new token
if 'v2' in self._authn_url:
authn_content = json.loads(response.text)
self._auth_token = authn_content['access']['token']['id']
else:
self._auth_token = response.headers['x-subject-token']
new_headers['X-AUTH-TOKEN'] = self._auth_token
return new_headers
else:
raise RuntimeError('Authentication Failure')
#end _authenticate
def _http_get(self, uri, headers=None, query_params=None):
url = "%s://%s:%s%s" \
% (self._api_connect_protocol,self._web_host, self._web_port, uri)
if self._apiinsecure:
response = self._api_server_session.get(url, headers=headers,
params=query_params,verify=False)
elif not self._apiinsecure and self._use_api_certs:
response = self._api_server_session.get(url, headers=headers,
params=query_params,verify=self._apicertbundle)
else:
response = self._api_server_session.get(url, headers=headers,
params=query_params)
#print 'Sending Request URL: ' + pformat(url)
#print ' Headers: ' + pformat(headers)
#print ' QParams: ' + pformat(query_params)
#response = self._api_server_session.get(url, headers = headers,
# params = query_params)
#print 'Received Response: ' + pformat(response.text)
return (response.status_code, response.text)
#end _http_get
def _http_post(self, uri, body, headers):
url = "%s://%s:%s%s" \
% (self._api_connect_protocol,self._web_host, self._web_port, uri)
if self._apiinsecure:
response = self._api_server_session.post(url, data=body,
headers=headers, verify=False)
elif not self._apiinsecure and self._use_api_certs:
response = self._api_server_session.post(url, data=body,
headers=headers, verify=self._apicertbundle)
else:
response = self._api_server_session.post(url, data=body,
headers=headers)
return (response.status_code, response.text)
#end _http_post
def _http_delete(self, uri, body, headers):
url = "%s://%s:%s%s" \
% (self._api_connect_protocol,self._web_host, self._web_port, uri)
if self._apiinsecure:
response = self._api_server_session.delete(url, data=body,
headers=headers, verify=False)
elif not self._apiinsecure and self._use_api_certs:
response = self._api_server_session.delete(url, data=body,
headers=headers, verify=self._apicertbundle)
else:
response = self._api_server_session.delete(url, data=body,
headers=headers)
return (response.status_code, response.text)
#end _http_delete
def _http_put(self, uri, body, headers):
url = "%s://%s:%s%s" \
% (self._api_connect_protocol,self._web_host, self._web_port, uri)
if self._apiinsecure:
response = self._api_server_session.put(url, data=body,
headers=headers, verify=False)
elif not self._apiinsecure and self._use_api_certs:
response = self._api_server_session.put(url, data=body,
headers=headers, verify=self._apicertbundle)
else:
response = self._api_server_session.put(url, data=body,
headers=headers)
return (response.status_code, response.text)
#end _http_delete
def _parse_homepage(self, py_obj):
srv_root_url = py_obj['href']
self._srv_root_url = srv_root_url
for link in py_obj['links']:
# strip base from *_url to get *_uri
uri = link['link']['href'].replace(srv_root_url, '')
if link['link']['rel'] == 'collection':
cls = utils.obj_type_to_vnc_class(link['link']['name'], __name__)
if not cls:
continue
cls.create_uri = uri
elif link['link']['rel'] == 'resource-base':
cls = utils.obj_type_to_vnc_class(link['link']['name'], __name__)
if not cls:
continue
resource_type = link['link']['name']
cls.resource_uri_base[resource_type] = uri
elif link['link']['rel'] == 'action':
act_type = link['link']['name']
self._action_uri[act_type] = uri
#end _parse_homepage
def _find_url(self, json_body, resource_name):
rname = unicode(resource_name)
py_obj = json.loads(json_body)
pprint.pprint(py_obj)
for link in py_obj['links']:
if link['link']['name'] == rname:
return link['link']['href']
return None
#end _find_url
def _read_args_to_id(self, res_type, fq_name=None, fq_name_str=None,
id=None, ifmap_id=None):
arg_count = ((fq_name is not None) + (fq_name_str is not None) +
(id is not None) + (ifmap_id is not None))
if (arg_count == 0):
return (False, "at least one of the arguments has to be provided")
elif (arg_count > 1):
return (False, "only one of the arguments should be provided")
if id:
return (True, id)
if fq_name:
return (True, self.fq_name_to_id(res_type, fq_name))
if fq_name_str:
return (True, self.fq_name_to_id(res_type, fq_name_str.split(':')))
if ifmap_id:
return (True, self.ifmap_to_id(ifmap_id))
#end _read_args_to_id
def _request_server(self, op, url, data=None, retry_on_error=True,
retry_after_authn=False, retry_count=30):
if not self._srv_root_url:
raise ConnectionError("Unable to retrive the api server root url.")
return self._request(op, url, data=data, retry_on_error=retry_on_error,
retry_after_authn=retry_after_authn,
retry_count=retry_count)
#end _request_server
def _log_curl(self, op, url, data=None):
op_str = {rest.OP_GET: 'GET', rest.OP_POST: 'POST', rest.OP_DELETE: 'DELETE', rest.OP_PUT: 'PUT'}
base_url="http://%s:%s" %(self._authn_server, self._web_port)
cmd_url="%s%s" %(base_url, url)
cmd_hdr=None
cmd_op=str(op_str[op])
cmd_data=None
header_list = [ j + ":" + k for (j,k) in self._headers.items()]
header_string = ''.join(['-H "' + str(i) + '" ' for i in header_list])
pattern=re.compile(r'(.*-H "X-AUTH-TOKEN:)[0-9a-z]+(")')
cmd_hdr=re.sub(pattern,r'\1$TOKEN\2',header_string)
if op == rest.OP_GET:
if data:
query_string="?" + "&".join([ str(i)+ "=" + str(j) for (i,j) in data.items()])
cmd_url=base_url+url+query_string
elif op == rest.OP_DELETE:
pass
else:
cmd_data=str(data)
if cmd_data:
cmd="curl -X %s %s -d '%s' %s" %(cmd_op, cmd_hdr, cmd_data, cmd_url)
else:
cmd="curl -X %s %s %s" %(cmd_op, cmd_hdr, cmd_url)
self._curl_logger.debug(cmd)
#End _log_curl
def _request(self, op, url, data=None, retry_on_error=True,
retry_after_authn=False, retry_count=30):
retried = 0
if self._curl_logging:
self._log_curl(op=op,url=url,data=data)
while True:
try:
if (op == rest.OP_GET):
(status, content) = self._http_get(
url, headers=self._headers, query_params=data)
if status == 200:
content = json.loads(content)
elif (op == rest.OP_POST):
(status, content) = self._http_post(url, body=data,
headers=self._headers)
elif (op == rest.OP_DELETE):
(status, content) = self._http_delete(url, body=data,
headers=self._headers)
elif (op == rest.OP_PUT):
(status, content) = self._http_put(url, body=data,
headers=self._headers)
else:
raise ValueError
except ConnectionError:
if not retry_on_error:
raise ConnectionError
time.sleep(1)
self._create_api_server_session()
continue
if status == 200:
return content
# Exception Response, see if it can be resolved
if ((status == 401) and (not self._auth_token_input) and (not retry_after_authn)):
self._headers = self._authenticate(content, self._headers)
# Recursive call after authentication (max 1 level)
content = self._request(op, url, data=data, retry_after_authn=True)
return content
elif status == 404:
raise NoIdError('Error: oper %s url %s body %s response %s'
% (op, url, data, content))
elif status == 403:
raise PermissionDenied(content)
elif status == 412:
raise OverQuota(content)
elif status == 409:
raise RefsExistError(content)
elif status == 504:
# Request sent to API server, but no response came within 50s
raise TimeOutError('Gateway Timeout 504')
elif status in [502, 503]:
# 502: API server died after accepting request, so retry
# 503: no API server available even before sending the request
retried += 1
if retried >= retry_count:
raise ServiceUnavailableError('Service Unavailable Timeout %d' % status)
time.sleep(1)
continue
elif status == 400:
raise BadRequest(status, content)
else: # Unknown Error
raise HttpError(status, content)
# end while True
#end _request_server
def _prop_collection_post(
self, obj_uuid, obj_field, oper, value, position):
uri = self._action_uri['prop-collection-update']
if isinstance(value, GeneratedsSuper):
serialized_value = value.exportDict('')
else:
serialized_value = value
oper_param = {'field': obj_field,
'operation': oper,
'value': serialized_value}
if position:
oper_param['position'] = position
dict_body = {'uuid': obj_uuid, 'updates': [oper_param]}
return self._request_server(
rest.OP_POST, uri, data=json.dumps(dict_body))
# end _prop_collection_post
def _prop_collection_get(self, obj_uuid, obj_field, position):
uri = self._action_uri['prop-collection-get']
query_params = {'uuid': obj_uuid, 'fields': obj_field}
if position:
query_params['position'] = position
content = self._request_server(
rest.OP_GET, uri, data=query_params)
return content[obj_field]
# end _prop_collection_get
def _prop_map_get_elem_key(self, id, obj_field, elem):
_, res_type = self.id_to_fq_name_type(id)
obj_class = utils.obj_type_to_vnc_class(res_type, __name__)
key_name = obj_class.prop_map_field_key_names[obj_field]
if isinstance(value, GeneratedsSuper):
return getattr(value, key_name)
return value[key_name]
# end _prop_map_get_elem_key
@check_homepage
def prop_list_add_element(self, obj_uuid, obj_field, value, position=None):
return self._prop_collection_post(
obj_uuid, obj_field, 'add', value, position)
# end prop_list_add_element
@check_homepage
def prop_list_modify_element(self, obj_uuid, obj_field, value, position):
return self._prop_collection_post(
obj_uuid, obj_field, 'modify', value, position)
# end prop_list_modify_element
@check_homepage
def prop_list_delete_element(self, obj_uuid, obj_field, position):
return self._prop_collection_post(
obj_uuid, obj_field, 'delete', None, position)
# end prop_list_delete_element
@check_homepage
def prop_list_get(self, obj_uuid, obj_field, position=None):
return self._prop_collection_get(obj_uuid, obj_field, position)
# end prop_list_get
@check_homepage
def prop_map_set_element(self, obj_uuid, obj_field, value):
position = self._prop_map_get_elem_key(obj_uuid, obj_field, value)
return self._prop_collection_post(
obj_uuid, obj_field, 'set', value, position)
# end prop_map_set_element
@check_homepage
def prop_map_delete_element(self, obj_uuid, obj_field, position):
return self._prop_collection_post(
obj_uuid, obj_field, 'delete', None, position)
# end prop_map_delete_element
@check_homepage
def prop_map_get(self, obj_uuid, obj_field, position=None):
return self._prop_collection_get(obj_uuid, obj_field, position)
# end prop_list_get
@check_homepage
def ref_update(self, obj_type, obj_uuid, ref_type, ref_uuid,
ref_fq_name, operation, attr=None):
if ref_type.endswith(('_refs', '-refs')):
ref_type = ref_type[:-5].replace('_', '-')
json_body = json.dumps({'type': obj_type, 'uuid': obj_uuid,
'ref-type': ref_type, 'ref-uuid': ref_uuid,
'ref-fq-name': ref_fq_name,
'operation': operation, 'attr': attr},
default=self._obj_serializer_diff)
uri = self._action_uri['ref-update']
try:
content = self._request_server(rest.OP_POST, uri, data=json_body)
except HttpError as he:
if he.status_code == 404:
return None
raise he
return json.loads(content)['uuid']
#end ref_update
@check_homepage
def ref_relax_for_delete(self, obj_uuid, ref_uuid):
# don't account for reference of <obj_uuid> in delete of <ref_uuid> in future
json_body = json.dumps({'uuid': obj_uuid, 'ref-uuid': ref_uuid})
uri = self._action_uri['ref-relax-for-delete']
try:
content = self._request_server(rest.OP_POST, uri, data=json_body)
except HttpError as he:
if he.status_code == 404:
return None
raise he
return json.loads(content)['uuid']
# end ref_relax_for_delete
def obj_to_id(self, obj):
return self.fq_name_to_id(obj.get_type(), obj.get_fq_name())
#end obj_to_id
@check_homepage
def fq_name_to_id(self, obj_type, fq_name):
json_body = json.dumps({'type': obj_type, 'fq_name': fq_name})
uri = self._action_uri['name-to-id']
try:
content = self._request_server(rest.OP_POST, uri, data=json_body)
except HttpError as he:
if he.status_code == 404:
return None
raise he
return json.loads(content)['uuid']
#end fq_name_to_id
@check_homepage
def id_to_fq_name(self, id):
json_body = json.dumps({'uuid': id})
uri = self._action_uri['id-to-name']
content = self._request_server(rest.OP_POST, uri, data=json_body)
return json.loads(content)['fq_name']
#end id_to_fq_name
@check_homepage
def id_to_fq_name_type(self, id):
json_body = json.dumps({'uuid': id})
uri = self._action_uri['id-to-name']
content = self._request_server(rest.OP_POST, uri, data=json_body)
json_rsp = json.loads(content)
return (json_rsp['fq_name'], json_rsp['type'])
# This is required only for helping ifmap-subscribers using rest publish
@check_homepage
def ifmap_to_id(self, ifmap_id):
json_body = json.dumps({'ifmap_id': ifmap_id})