aboutsummaryrefslogtreecommitdiffstats
path: root/sfc/lib/openstack_utils.py
blob: 59ccdaca80331798e7fe282e6deb03fe5fe8307d (plain)
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
import os
import time
import json
import logging
import yaml
import urllib2


from tackerclient.tacker import client as tackerclient
from functest.utils import constants
from functest.utils import env
from snaps.openstack.tests import openstack_tests
from snaps.config.vm_inst import FloatingIpConfig
import snaps.openstack.create_instance as cr_inst
from snaps.openstack.utils import (
    nova_utils, neutron_utils, heat_utils, keystone_utils)
from openstack import connection
from neutronclient.neutron import client as neutronclient

logger = logging.getLogger(__name__)
DEFAULT_TACKER_API_VERSION = '1.0'
DEFAULT_API_VERSION = '2'


class OpenStackSFC:

    def __init__(self):
        self.conn = self.get_os_connection()
        self.os_creds = openstack_tests.get_credentials(
            os_env_file=constants.ENV_FILE)
        self.creators = []
        self.nova = nova_utils.nova_client(self.os_creds)
        self.neutron = neutron_utils.neutron_client(self.os_creds)
        self.heat = heat_utils.heat_client(self.os_creds)
        self.keystone = keystone_utils.keystone_client(self.os_creds)
        self.neutron_client = neutronclient.\
            Client(self.get_neutron_client_version(),
                   session=self.conn.session)

    def get_os_connection(self):
        return connection.from_config(verify=False)

    def get_neutron_client_version(self):
        api_version = os.getenv('OS_NETWORK_API_VERSION')
        if api_version is not None:
            logger.info("OS_NETWORK_API_VERSION is %s" % api_version)
            return api_version
        return DEFAULT_API_VERSION

    def register_glance_image(self, name, url, img_format, public):
        logger.info("Registering the image...")
        image = self.conn.image.find_image(name)
        if image:
            logger.info("Image %s already exists." % image.name)
        else:
            if 'http' in url:
                logger.info("Downloading image")
                response = urllib2.urlopen(url)
                image_data = response.read()
            else:
                with open(url) as f:
                    image_data = f.read()

            image_settings = {'name': name,
                              'disk_format': img_format,
                              'data': image_data,
                              'is_public': public,
                              'container_format': 'bare'}
            image = self.conn.image.upload_image(**image_settings)
            self.creators.append(image)
            logger.info("Image created")

            self.image_settings = image_settings

        return image

    def create_flavor(self, name, ram, disk, vcpus):
        logger.info("Creating flavor...")
        flavor_settings = {"name": name, "ram": ram, "disk": disk,
                           "vcpus": vcpus}

        flavor = self.conn.compute.create_flavor(**flavor_settings)

        self.creators.append(flavor)
        return flavor

    def create_network_infrastructure(self, net_name, subnet_name, subnet_cidr,
                                      router_name):
        logger.info("Creating Networks...")
        # Network and subnet
        network = self.conn.network.create_network(name=net_name)
        self.creators.append(network)

        subnet_settings = {"name": subnet_name, "cidr": subnet_cidr,
                           "network_id": network.id, 'ip_version': '4'}
        subnet = self.conn.network.create_subnet(**subnet_settings)
        self.creators.append(subnet)

        # Router
        ext_network_name = env.get('EXTERNAL_NETWORK')
        ext_net = self.conn.network.find_network(ext_network_name)
        router_dict = {'network_id': ext_net.id}

        logger.info("Creating Router...")
        router = self.conn.network.create_router(name=router_name)

        self.conn.network.add_interface_to_router(router.id,
                                                  subnet_id=subnet.id)

        self.conn.network.update_router(router.id,
                                        external_gateway_info=router_dict)
        router_obj = self.conn.network.get_router(router.id)
        self.creators.append(router_obj)

        return network, router_obj

    def create_security_group(self, sec_grp_name):
        logger.info("Creating the security groups...")
        sec_group = self.conn.network.create_security_group(name=sec_grp_name)

        rule_ping = {"security_group_id": sec_group.id,
                     "direction": "ingress",
                     "protocol": "icmp"}

        rule_ssh = {"security_group_id": sec_group.id,
                    "direction": "ingress",
                    "protocol": "tcp",
                    "port_range_min": 22,
                    "port_range_max": 22}

        rule_http = {"security_group_id": sec_group.id,
                     "direction": "ingress",
                     "protocol": "tcp",
                     "port_range_min": 80,
                     "port_range_max": 80}

        rules = [rule_ping, rule_ssh, rule_http]

        for rule in rules:
            self.conn.network.create_security_group_rule(**rule)

        self.creators.append(sec_group)

        return sec_group

    def create_instance(self, vm_name, flavor, image, network,
                        sec_group, av_zone, ports, port_security=True):
        logger.info("Creating Key Pair {}...".format(vm_name))

        keypair = self.conn.compute.\
            create_keypair(name="{}_keypair".format(vm_name))
        self.creators.append(keypair)
        flavor_obj = self.conn.compute.find_flavor(flavor)

        logger.info("Creating Port {}...".format(ports))
        port_list = []
        for port in ports:
            if port_security:
                port_obj = self.conn.network.create_port(
                    name=port, is_port_security_enabled=port_security,
                    network_id=network.id, security_group_ids=[sec_group.id])
            else:
                port_obj = self.conn.network.create_port(
                    name=port, is_port_security_enabled=port_security,
                    network_id=network.id)
            port_list.append(port_obj)
            self.creators.append(port_obj)
        logger.info("Creating the instance {}...".format(vm_name))

        if len(port_list) > 1:
            network_list = [{"port": port_list[0].id},
                            {"port": port_list[1].id}]
        else:
            network_list = [{"port": port_obj.id}]

        instance = self.conn.compute.create_server(name=vm_name,
                                                   image_id=image.id,
                                                   flavor_id=flavor_obj.id,
                                                   networks=network_list,
                                                   key_name=keypair.name,
                                                   availability_zone=av_zone)

        logger.info("Waiting for {} to become Active".format(instance.name))
        self.conn.compute.wait_for_server(instance)
        logger.info("{} is active".format(instance.name))

        self.creators.append(instance)

        return instance, port_list

    def get_av_zones(self):
        '''
        Return the availability zone each host belongs to
        '''
        hosts = self.get_hypervisor_hosts()
        return ['nova::{0}'.format(host) for host in hosts]

    def get_hypervisor_hosts(self):
        """
        Returns the host names of all nova nodes with active hypervisors
        :param nova: the Nova client
        :return: a list of hypervisor host names
        """
        try:
            nodes = []
            hypervisors = self.conn.compute.hypervisors()
            for hypervisor in hypervisors:
                if hypervisor.state == "up":
                    nodes.append(hypervisor.name)
            return nodes
        except Exception as e:
            logger.error("Error [get_hypervisors(compute)]: %s" % e)
        return None

    def get_compute_client(self):
        '''
        Return the compute where the client sits
        '''
        return self.get_vm_compute('client')

    def get_compute_server(self):
        '''
        Return the compute where the server sits
        '''
        return self.get_vm_compute('server')

    def get_vm_compute(self, vm_name):
        '''
        Return the compute where the vm sits
        '''
        for creator in self.creators:
            # We want to filter the vm creators
            if hasattr(creator, 'get_vm_inst'):
                # We want to fetch by vm_name
                if creator.get_vm_inst().name == vm_name:
                    return creator.get_vm_inst().compute_host

        raise Exception("There is no VM with name '{}'!!".format(vm_name))

    def assign_floating_ip(self, vm, vm_port):
        '''
        Assign floating ips to all the VMs
        '''
        logger.info(" Creating floating ips ")

        ext_network_name = env.get('EXTERNAL_NETWORK')
        ext_net = self.conn.network.find_network(ext_network_name)

        fip = self.conn.network.create_ip(floating_network_id=ext_net.id,
                                          port_id=vm_port.id)
        logger.info(
            " FLoating IP address {} created".format(fip.floating_ip_address))

        logger.info(" Adding Floating IPs to instances ")
        self.conn.compute.add_floating_ip_to_server(
            vm.id, fip.floating_ip_address)

        self.creators.append(fip)
        return fip.floating_ip_address

    # We need this function because tacker VMs cannot be created through SNAPs
    def assign_floating_ip_vnfs(self, router, ips=None):
        '''
        Assign floating ips to all the SFs. Optionally specify the
        subnet IPs that a floating IP should be assigned to, assuming that the
        SF is connected to a single subnet globally and per port.
        '''
        stacks = self.heat.stacks.list()
        fips = []
        project_name = 'admin'
        for stack in stacks:
            servers = heat_utils.get_stack_servers(self.heat,
                                                   self.nova,
                                                   self.neutron_client,
                                                   self.keystone,
                                                   stack,
                                                   project_name)
            sf_creator = cr_inst.generate_creator(self.os_creds,
                                                  servers[0],
                                                  self.image_settings,
                                                  project_name)

            name = servers[0].name + "-float"
            if ips is None:
                port_name = servers[0].ports[0].name
            else:
                port_name = None
                for port in servers[0].ports:
                    if port.ips[0]['ip_address'] in ips:
                        port_name = port.name
                        break

            if port_name is None:
                err_msg = ("The VNF {} does not have any suitable port {} "
                           "for floating IP assignment"
                           .format(name,
                                   'with ip any of ' +
                                   str(ips) if ips else ''))
                logger.error(err_msg)
                raise Exception(err_msg)

            float_ip = FloatingIpConfig(name=name,
                                        port_name=port_name,
                                        router_name=router.name)
            ip = sf_creator.add_floating_ip(float_ip)
            self.creators.append(sf_creator)
            fips.append(ip.ip)

        return fips

    def get_instance_port(self, vm, vm_creator, port_name=None):
        '''
        Get the neutron port id of the client
        '''
        if not port_name:
            port_name = vm.name + "-port"
        port = vm_creator.get_port_by_name(port_name)
        if port is not None:
            return port
        else:
            logger.error("The VM {0} does not have any port"
                         " with name {1}".format(vm.name, port_name))
            raise Exception("Client VM does not have the desired port")

    def delete_all_security_groups(self):
        '''
        Deletes all the available security groups
        Needed until this bug is fixed:
        https://bugs.launchpad.net/networking-odl/+bug/1763705
        '''
        logger.info("Deleting remaining security groups...")
        sec_groups = self.conn.network.security_groups()
        for sg in sec_groups:
            self.conn.network.delete_security_group(sg)

    def wait_for_vnf(self, vnf_creator):
        '''
        Waits for VNF to become active
        '''
        return vnf_creator.vm_active(block=True, poll_interval=5)

    def create_port_groups(self, vnf_ports, vm_instance):
        '''
        Creates a networking-sfc port pair and group
        '''
        logger.info("Creating the port pairs...")
        port_pair = dict()
        port_pair['name'] = vm_instance.name + '-connection-points'
        port_pair['description'] = 'port pair for ' + vm_instance.name

        # In the symmetric testcase ingres != egress (VNF has 2 interfaces)
        if len(vnf_ports) == 1:
            port_pair['ingress'] = vnf_ports[0].id
            port_pair['egress'] = vnf_ports[0].id
        elif len(vnf_ports) == 2:
            port_pair['ingress'] = vnf_ports[0].id
            port_pair['egress'] = vnf_ports[1].id
        else:
            logger.error("Only SFs with one or two ports are supported")
            raise Exception("Failed to create port pairs")
        port_pair_info = \
            self.neutron_client.create_sfc_port_pair({'port_pair': port_pair})
        if not port_pair_info:
            logger.warning("Chain creation failed due to port pair "
                           "creation failed for vnf %(vnf)s",
                           {'vnf': vm_instance.name})
            return None

        # Avoid race conditions by checking the port pair is already committed
        iterations = 5
        found_it = False
        for _ in range(iterations):
            pp_list = self.neutron_client.list_sfc_port_pairs()['port_pairs']
            for pp in pp_list:
                if pp['id'] == port_pair_info['port_pair']['id']:
                    found_it = True
                    break
            if found_it:
                break
            else:
                time.sleep(3)

        if not found_it:
            raise Exception("Port pair was not committed in openstack")

        logger.info("Creating the port pair groups for %s" % vm_instance.name)

        port_pair_group = {}
        port_pair_group['name'] = vm_instance.name + '-port-pair-group'
        port_pair_group['description'] = \
            'port pair group for ' + vm_instance.name
        port_pair_group['port_pairs'] = []
        port_pair_group['port_pairs'].append(port_pair_info['port_pair']['id'])
        ppg_config = {'port_pair_group': port_pair_group}
        port_pair_group_info = \
            self.neutron_client.create_sfc_port_pair_group(ppg_config)
        if not port_pair_group_info:
            logger.warning("Chain creation failed due to port pair group "
                           "creation failed for vnf "
                           "{}".format(vm_instance.name))
            return None

        return port_pair_group_info['port_pair_group']['id']

    def create_classifier(self,  neutron_port, port, protocol, fc_name,
                          symmetrical, server_port=None, server_ip=None):
        '''
        Create the classifier
        '''
        logger.info("Creating the classifier...")

        if symmetrical:
            sfc_classifier_params = {'name': fc_name,
                                     'destination_ip_prefix': server_ip,
                                     'logical_source_port': neutron_port,
                                     'logical_destination_port': server_port,
                                     'destination_port_range_min': port,
                                     'destination_port_range_max': port,
                                     'protocol': protocol}
        else:
            sfc_classifier_params = {'name': fc_name,
                                     'logical_source_port': neutron_port,
                                     'destination_port_range_min': port,
                                     'destination_port_range_max': port,
                                     'protocol': protocol}

        fc_config = {'flow_classifier': sfc_classifier_params}
        self.neutron_client.create_sfc_flow_classifier(fc_config)

    def create_chain(self, port_groups, neutron_port, port, protocol,
                     vnffg_name, symmetrical, server_port=None,
                     server_ip=None):
        '''
        Create the classifier
        '''
        logger.info("Creating the classifier...")

        if symmetrical:
            sfc_classifier_params = {'name': vnffg_name + '-classifier',
                                     'destination_ip_prefix': server_ip,
                                     'logical_source_port': neutron_port,
                                     'logical_destination_port': server_port,
                                     'destination_port_range_min': port,
                                     'destination_port_range_max': port,
                                     'protocol': protocol}
        else:
            sfc_classifier_params = {'name': vnffg_name + '-classifier',
                                     'logical_source_port': neutron_port,
                                     'destination_port_range_min': port,
                                     'destination_port_range_max': port,
                                     'protocol': protocol}

        fc_config = {'flow_classifier': sfc_classifier_params}
        fc_info = \
            self.neutron_client.create_sfc_flow_classifier(fc_config)

        logger.info("Creating the chain...")
        port_chain = {}
        port_chain['name'] = vnffg_name + '-port-chain'
        port_chain['description'] = 'port-chain for SFC'
        port_chain['port_pair_groups'] = port_groups
        port_chain['flow_classifiers'] = []
        port_chain['flow_classifiers'].append(fc_info['flow_classifier']['id'])
        if symmetrical:
            port_chain['chain_parameters'] = {}
            port_chain['chain_parameters']['symmetric'] = True
        chain_config = {'port_chain': port_chain}
        return self.neutron_client.create_sfc_port_chain(chain_config)

    def update_chain(self, vnffg_name, fc_name, symmetrical):
        '''
        Update the new Flow Classifier ID
        '''
        fc_id = self.neutron_client.find_resource('flow_classifier',
                                                  fc_name)['id']
        logger.info("Update the chain...")
        port_chain = {}
        port_chain['name'] = vnffg_name + '-port-chain'
        port_chain['flow_classifiers'] = []
        port_chain['flow_classifiers'].append(fc_id)
        if symmetrical:
            port_chain['chain_parameters'] = {}
            port_chain['chain_parameters']['symmetric'] = True
        chain_config = {'port_chain': port_chain}
        pc_id = self.neutron_client.find_resource('port_chain',
                                                  port_chain['name'])['id']
        return self.neutron_client.update_sfc_port_chain(pc_id, chain_config)

    def swap_classifiers(self, vnffg_1_name, vnffg_2_name, symmetric=False):

        '''
        Swap Classifiers
        '''
        logger.info("Swap classifiers...")

        self.update_chain(vnffg_1_name, 'dummy', symmetric)
        vnffg_1_classifier_name = vnffg_1_name + '-classifier'
        self.update_chain(vnffg_2_name, vnffg_1_classifier_name, symmetric)
        vnffg_2_classifier_name = vnffg_2_name + '-classifier'
        self.update_chain(vnffg_1_name, vnffg_2_classifier_name, symmetric)

    def delete_port_groups(self):
        '''
        Delete all port groups and port pairs
        '''
        logger.info("Deleting the port groups...")
        ppg_list = self.neutron_client.\
            list_sfc_port_pair_groups()['port_pair_groups']
        for ppg in ppg_list:
            self.neutron_client.delete_sfc_port_pair_group(ppg['id'])

        logger.info("Deleting the port pairs...")
        pp_list = self.neutron_client.list_sfc_port_pairs()['port_pairs']
        for pp in pp_list:
            self.neutron_client.delete_sfc_port_pair(pp['id'])

    def delete_chain(self):
        '''
        Delete the classifiers and the chains
        '''
        logger.info("Deleting the chain...")
        pc_list = self.neutron_client.list_sfc_port_chains()['port_chains']
        for pc in pc_list:
            self.neutron_client.delete_sfc_port_chain(pc['id'])

        logger.info("Deleting the classifiers...")
        fc_list = self.neutron_client.\
            list_sfc_flow_classifiers()['flow_classifiers']
        for fc in fc_list:
            self.neutron_client.delete_sfc_flow_classifier(fc['id'])


# TACKER SECTION #
def get_tacker_client_version():
    api_version = os.getenv('OS_TACKER_API_VERSION')
    if api_version is not None:
        logger.info("OS_TACKER_API_VERSION is set in env as '%s'", api_version)
        return api_version
    return DEFAULT_TACKER_API_VERSION


def get_tacker_client(other_creds={}):
    creds_override = None
    os_creds = openstack_tests.get_credentials(
        os_env_file=constants.ENV_FILE,
        overrides=creds_override)
    sess = keystone_utils.keystone_session(os_creds)
    return tackerclient.Client(get_tacker_client_version(), session=sess)


def get_id_from_name(tacker_client, resource_type, resource_name):
    try:
        params = {'fields': 'id', 'name': resource_name}
        collection = resource_type + 's'
        path = '/' + collection
        resp = tacker_client.list(collection, path, **params)
        return resp[collection][0]['id']
    except Exception as e:
        logger.error("Error [get_id_from_name(tacker_client, "
                     "resource_type, resource_name)]: %s" % e)
        return None


def get_vnfd_id(tacker_client, vnfd_name):
    return get_id_from_name(tacker_client, 'vnfd', vnfd_name)


def get_vim_id(tacker_client, vim_name):
    return get_id_from_name(tacker_client, 'vim', vim_name)


def get_vnf_id(tacker_client, vnf_name, timeout=5):
    vnf_id = None
    while vnf_id is None and timeout >= 0:
        vnf_id = get_id_from_name(tacker_client, 'vnf', vnf_name)
        if vnf_id is None:
            logger.info("Could not retrieve ID for vnf with name [%s]."
                        " Retrying." % vnf_name)
            time.sleep(1)
            timeout -= 1
    return vnf_id


def get_vnffg_id(tacker_client, vnffg_name, timeout=5):
    vnffg_id = None
    while vnffg_id is None and timeout >= 0:
        vnffg_id = get_id_from_name(tacker_client, 'vnffg', vnffg_name)
        if vnffg_id is None:
            logger.info("Could not retrieve ID for vnffg with name [%s]."
                        " Retrying." % vnffg_name)
            time.sleep(1)
            timeout -= 1
    return vnffg_id


def get_vnffgd_id(tacker_client, vnffgd_name):
    return get_id_from_name(tacker_client, 'vnffgd', vnffgd_name)


def list_vnfds(tacker_client, verbose=False):
    try:
        vnfds = tacker_client.list_vnfds(retrieve_all=True)
        if not verbose:
            vnfds = [vnfd['id'] for vnfd in vnfds['vnfds']]
        return vnfds
    except Exception as e:
        logger.error("Error [list_vnfds(tacker_client)]: %s" % e)
        return None


def create_vnfd(tacker_client, tosca_file=None, vnfd_name=None):
    logger.info("Creating the vnfd...")
    try:
        vnfd_body = {}
        if tosca_file is not None:
            with open(tosca_file) as tosca_fd:
                vnfd = tosca_fd.read()
                vnfd_body = yaml.safe_load(vnfd)
            logger.info('VNFD template:\n{0}'.format(vnfd))
        return tacker_client.create_vnfd(
            body={"vnfd": {"attributes": {"vnfd": vnfd_body},
                  "name": vnfd_name}})
    except Exception as e:
        logger.error("Error [create_vnfd(tacker_client, '%s')]: %s"
                     % (tosca_file, e))
        return None


def delete_vnfd(tacker_client, vnfd_id=None, vnfd_name=None):
    try:
        vnfd = vnfd_id
        if vnfd is None:
            if vnfd_name is None:
                raise Exception('You need to provide VNFD id or VNFD name')
            vnfd = get_vnfd_id(tacker_client, vnfd_name)
        return tacker_client.delete_vnfd(vnfd)
    except Exception as e:
        logger.error("Error [delete_vnfd(tacker_client, '%s', '%s')]: %s"
                     % (vnfd_id, vnfd_name, e))
        return None


def list_vnfs(tacker_client, verbose=False):
    try:
        vnfs = tacker_client.list_vnfs(retrieve_all=True)
        if not verbose:
            vnfs = [vnf['id'] for vnf in vnfs['vnfs']]
        return vnfs
    except Exception as e:
        logger.error("Error [list_vnfs(tacker_client)]: %s" % e)
        return None


def create_vnf(tacker_client, vnf_name, vnfd_id=None,
               vnfd_name=None, vim_id=None, vim_name=None, param_file=None):
    logger.info("Creating the vnf...")
    try:
        vnf_body = {
            'vnf': {
                'attributes': {},
                'name': vnf_name
            }
        }
        if param_file is not None:
            params = None
            with open(param_file) as f:
                params = f.read()
            vnf_body['vnf']['attributes']['param_values'] = params

        if vnfd_id is not None:
            vnf_body['vnf']['vnfd_id'] = vnfd_id
        else:
            if vnfd_name is None:
                raise Exception('vnfd id or vnfd name is required')
            vnf_body['vnf']['vnfd_id'] = get_vnfd_id(tacker_client, vnfd_name)

        if vim_id is not None:
            vnf_body['vnf']['vim_id'] = vim_id
        else:
            if vim_name is None:
                raise Exception('vim id or vim name is required')
            vnf_body['vnf']['vim_id'] = get_vim_id(tacker_client, vim_name)
        return tacker_client.create_vnf(body=vnf_body)

    except Exception as e:
        logger.error("error [create_vnf(tacker_client,"
                     " '%s', '%s', '%s')]: %s"
                     % (vnf_name, vnfd_id, vnfd_name, e))
        return None


def get_vnf(tacker_client, vnf_id=None, vnf_name=None):
    try:
        if vnf_id is None and vnf_name is None:
            raise Exception('You must specify vnf_id or vnf_name')

        _id = get_vnf_id(tacker_client, vnf_name) if vnf_id is None else vnf_id

        if _id is not None:
            all_vnfs = list_vnfs(tacker_client, verbose=True)['vnfs']
            return next((vnf for vnf in all_vnfs if vnf['id'] == _id), None)
        else:
            raise Exception('Could not retrieve ID from name [%s]' % vnf_name)

    except Exception as e:
        logger.error("Could not retrieve VNF [vnf_id=%s, vnf_name=%s] - %s"
                     % (vnf_id, vnf_name, e))
        return None


def get_vnf_ip(tacker_client, vnf_id=None, vnf_name=None):
    """
    Get the management ip of the first VNF component as obtained from the
    tacker REST API:
        {
        "vnf": {
            ...
            "mgmt_url": "{\"VDU1\": \"192.168.120.3\"}",
            ...
        }
    """
    vnf = get_vnf(tacker_client, vnf_id, vnf_name)
    return json.loads(vnf['mgmt_url']).values()[0]


def wait_for_vnf(tacker_client, vnf_id=None, vnf_name=None, timeout=100):
    try:
        vnf = get_vnf(tacker_client, vnf_id, vnf_name)
        if vnf is None:
            raise Exception("Could not retrieve VNF - id='%s', name='%s'"
                            % (vnf_id, vnf_name))
        logger.info('Waiting for vnf {0}'.format(str(vnf)))
        while vnf['status'] != 'ACTIVE' and timeout >= 0:
            if vnf['status'] == 'ERROR':
                raise Exception('Error when booting vnf %s' % vnf['id'])
            elif vnf['status'] == 'PENDING_CREATE':
                time.sleep(3)
                timeout -= 3
            vnf = get_vnf(tacker_client, vnf_id, vnf_name)

        if (timeout < 0):
            raise Exception('Timeout when booting vnf %s' % vnf['id'])

        return vnf['id']
    except Exception as e:
        logger.error("error [wait_for_vnf(tacker_client, '%s', '%s')]: %s"
                     % (vnf_id, vnf_name, e))
        return None


def delete_vnf(tacker_client, vnf_id=None, vnf_name=None):
    try:
        vnf = vnf_id
        if vnf is None:
            if vnf_name is None:
                raise Exception('You need to provide a VNF id or name')
            vnf = get_vnf_id(tacker_client, vnf_name)
        return tacker_client.delete_vnf(vnf)
    except Exception as e:
        logger.error("Error [delete_vnf(tacker_client, '%s', '%s')]: %s"
                     % (vnf_id, vnf_name, e))
        return None


def create_vim(tacker_client, vim_file=None):
    logger.info("Creating the vim...")
    try:
        vim_body = {}
        if vim_file is not None:
            with open(vim_file) as vim_fd:
                vim_body = json.load(vim_fd)
            logger.info('VIM template:\n{0}'.format(vim_body))
        return tacker_client.create_vim(body=vim_body)
    except Exception as e:
        logger.error("Error [create_vim(tacker_client, '%s')]: %s"
                     % (vim_file, e))
        return None


def create_vnffgd(tacker_client, tosca_file=None, vnffgd_name=None):
    logger.info("Creating the vnffgd...")
    try:
        vnffgd_body = {}
        if tosca_file is not None:
            with open(tosca_file) as tosca_fd:
                vnffgd = tosca_fd.read()
                vnffgd_body = yaml.safe_load(vnffgd)
            logger.info('VNFFGD template:\n{0}'.format(vnffgd))
        return tacker_client.create_vnffgd(
            body={'vnffgd': {'name': vnffgd_name,
                  'template': {'vnffgd': vnffgd_body}}})
    except Exception as e:
        logger.error("Error [create_vnffgd(tacker_client, '%s')]: %s"
                     % (tosca_file, e))
        return None


def create_vnffg(tacker_client, vnffg_name=None, vnffgd_id=None,
                 vnffgd_name=None, param_file=None, symmetrical=False):
    '''
      Creates the vnffg which will provide the RSP and the classifier
    '''
    logger.info("Creating the vnffg...")
    try:
        vnffg_body = {
            'vnffg': {
                'attributes': {},
                'name': vnffg_name,
                'symmetrical': symmetrical
            }
        }
        if param_file is not None:
            params = None
            with open(param_file) as f:
                params = f.read()
            params_dict = yaml.safe_load(params)
            vnffg_body['vnffg']['attributes']['param_values'] = params_dict
        if vnffgd_id is not None:
            vnffg_body['vnffg']['vnffgd_id'] = vnffgd_id
        else:
            if vnffgd_name is None:
                raise Exception('vnffgd id or vnffgd name is required')
            vnffg_body['vnffg']['vnffgd_id'] = get_vnffgd_id(tacker_client,
                                                             vnffgd_name)
        return tacker_client.create_vnffg(body=vnffg_body)
    except Exception as e:
        logger.error("error [create_vnffg(tacker_client,"
                     " '%s', '%s', '%s')]: %s"
                     % (vnffg_name, vnffgd_id, vnffgd_name, e))
        return None


def list_vnffgds(tacker_client, verbose=False):
    try:
        vnffgds = tacker_client.list_vnffgds(retrieve_all=True)
        if not verbose:
            vnffgds = [vnffgd['id'] for vnffgd in vnffgds['vnffgds']]
        return vnffgds
    except Exception as e:
        logger.error("Error [list_vnffgds(tacker_client)]: %s" % e)
        return None


def list_vnffgs(tacker_client, verbose=False):
    try:
        vnffgs = tacker_client.list_vnffgs(retrieve_all=True)
        if not verbose:
            vnffgs = [vnffg['id'] for vnffg in vnffgs['vnffgs']]
        return vnffgs
    except Exception as e:
        logger.error("Error [list_vnffgs(tacker_client)]: %s" % e)
        return None


def delete_vnffg(tacker_client, vnffg_id=None, vnffg_name=None):
    try:
        vnffg = vnffg_id
        if vnffg is None:
            if vnffg_name is None:
                raise Exception('You need to provide a VNFFG id or name')
            vnffg = get_vnffg_id(tacker_client, vnffg_name)
        return tacker_client.delete_vnffg(vnffg)
    except Exception as e:
        logger.error("Error [delete_vnffg(tacker_client, '%s', '%s')]: %s"
                     % (vnffg_id, vnffg_name, e))
        return None


def delete_vnffgd(tacker_client, vnffgd_id=None, vnffgd_name=None):
    try:
        vnffgd = vnffgd_id
        if vnffgd is None:
            if vnffgd_name is None:
                raise Exception('You need to provide VNFFGD id or VNFFGD name')
            vnffgd = get_vnffgd_id(tacker_client, vnffgd_name)
        return tacker_client.delete_vnffgd(vnffgd)
    except Exception as e:
        logger.error("Error [delete_vnffgd(tacker_client, '%s', '%s')]: %s"
                     % (vnffgd_id, vnffgd_name, e))
        return None


def list_vims(tacker_client, verbose=False):
    try:
        vims = tacker_client.list_vims(retrieve_all=True)
        if not verbose:
            vims = [vim['id'] for vim in vims['vims']]
        return vims
    except Exception as e:
        logger.error("Error [list_vims(tacker_client)]: %s" % e)
        return None


def delete_vim(tacker_client, vim_id=None, vim_name=None):
    try:
        vim = vim_id
        if vim is None:
            if vim_name is None:
                raise Exception('You need to provide VIM id or VIM name')
            vim = get_vim_id(tacker_client, vim_name)
        return tacker_client.delete_vim(vim)
    except Exception as e:
        logger.error("Error [delete_vim(tacker_client, '%s', '%s')]: %s"
                     % (vim_id, vim_name, e))
        return None


def get_tacker_items():
    tacker_client = get_tacker_client()
    logger.debug("VIMs: %s" % list_vims(tacker_client))
    logger.debug("VNFDs: %s" % list_vnfds(tacker_client))
    logger.debug("VNFs: %s" % list_vnfs(tacker_client))
    logger.debug("VNFFGDs: %s" % list_vnffgds(tacker_client))
    logger.debug("VNFFGs: %s" % list_vnffgs(tacker_client))


def register_vim(tacker_client, vim_file=None):
    tmp_file = '/tmp/register-vim.json'
    if vim_file is not None:
        with open(vim_file) as f:
            json_dict = json.load(f)

        json_dict['vim']['auth_url'] = os.environ['OS_AUTH_URL']
        json_dict['vim']['auth_cred']['password'] = os.environ['OS_PASSWORD']

        json.dump(json_dict, open(tmp_file, 'w'))

    create_vim(tacker_client, vim_file=tmp_file)


def create_vnf_in_av_zone(tacker_client,
                          vnf_name,
                          vnfd_name,
                          vim_name,
                          default_param_file,
                          av_zone=None):
    param_file = default_param_file

    if av_zone is not None or av_zone != 'nova':
        param_file = os.path.join(
            '/tmp',
            'param_{0}.json'.format(av_zone.replace('::', '_')))
        data = {'zone': av_zone}
        with open(param_file, 'w+') as f:
            json.dump(data, f)
    create_vnf(tacker_client,
               vnf_name,
               vnfd_name=vnfd_name,
               vim_name=vim_name,
               param_file=param_file)


def create_vnffg_with_param_file(tacker_client, vnffgd_name, vnffg_name,
                                 default_param_file, client_port,
                                 server_port=None, server_ip=None):
    param_file = default_param_file
    data = {}
    if client_port:
        data['net_src_port_id'] = client_port
    if server_port:
        data['net_dst_port_id'] = server_port
    if server_ip:
        data['ip_dst_prefix'] = server_ip

    if client_port is not None or server_port is not None:
        param_file = os.path.join(
            '/tmp',
            'param_{0}.json'.format(vnffg_name))
        with open(param_file, 'w+') as f:
            json.dump(data, f)

    symmetrical = True if client_port and server_port else False

    create_vnffg(tacker_client,
                 vnffgd_name=vnffgd_name,
                 vnffg_name=vnffg_name,
                 param_file=param_file,
                 symmetrical=symmetrical)