1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
23 import snaps.config.stack as stack_config
24 from snaps.config.flavor import FlavorConfig
25 from snaps.openstack.create_flavor import OpenStackFlavor
27 from snaps.openstack.create_image import OpenStackImage
28 from snaps.openstack.create_instance import OpenStackVmInstance
29 from snaps.openstack.create_stack import StackConfig
30 from snaps.openstack.tests import openstack_tests
31 from snaps.openstack.tests.os_source_file_test import OSComponentTestCase
32 from snaps.openstack.utils import (
33 heat_utils, neutron_utils, nova_utils, settings_utils, glance_utils,
36 __author__ = 'spisarski'
38 logger = logging.getLogger('heat_utils_tests')
41 class HeatSmokeTests(OSComponentTestCase):
43 Tests to ensure that the heat client can communicate with the cloud
46 def test_heat_connect_success(self):
48 Tests to ensure that the proper credentials can connect.
50 heat = heat_utils.heat_client(self.os_creds)
52 # This should not throw an exception
53 stacks = heat.stacks.list()
57 def test_heat_connect_fail(self):
59 Tests to ensure that the improper credentials cannot connect.
61 from snaps.openstack.os_credentials import OSCreds
63 heat = heat_utils.heat_client(
64 OSCreds(username='user', password='pass',
65 auth_url=self.os_creds.auth_url,
66 project_name=self.os_creds.project_name,
67 proxy_settings=self.os_creds.proxy_settings))
68 stacks = heat.stacks.list()
70 # This should throw an exception
71 with self.assertRaises(Exception):
76 class HeatUtilsCreateSimpleStackTests(OSComponentTestCase):
78 Test basic Heat functionality
83 Instantiates OpenStack instances that cannot be spawned by Heat
85 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
86 stack_name1 = guid + '-stack1'
87 stack_name2 = guid + '-stack2'
88 self.network_name = guid + '-net'
89 self.subnet_name = guid + '-subnet'
90 self.vm_inst_name = guid + '-inst'
92 self.image_creator = OpenStackImage(
93 self.os_creds, openstack_tests.cirros_image_settings(
94 name=guid + '-image', image_metadata=self.image_metadata))
95 self.image_creator.create()
98 self.flavor_creator = OpenStackFlavor(
100 FlavorConfig(name=guid + '-flavor', ram=256, disk=10, vcpus=1))
101 self.flavor_creator.create()
103 env_values = {'image_name': self.image_creator.image_settings.name,
104 'flavor_name': self.flavor_creator.flavor_settings.name,
105 'net_name': self.network_name,
106 'subnet_name': self.subnet_name,
107 'inst_name': self.vm_inst_name}
108 heat_tmplt_path = pkg_resources.resource_filename(
109 'snaps.openstack.tests.heat', 'test_heat_template.yaml')
110 self.stack_settings1 = StackConfig(
111 name=stack_name1, template_path=heat_tmplt_path,
112 env_values=env_values)
113 self.stack_settings2 = StackConfig(
114 name=stack_name2, template_path=heat_tmplt_path,
115 env_values=env_values)
118 self.heat_client = heat_utils.heat_client(self.os_creds)
122 Cleans the stack and image
126 heat_utils.delete_stack(self.heat_client, self.stack1)
132 heat_utils.delete_stack(self.heat_client, self.stack2)
136 if self.image_creator:
138 self.image_creator.clean()
142 if self.flavor_creator:
144 self.flavor_creator.clean()
148 def test_create_stack(self):
150 Tests the creation of an OpenStack Heat stack1 that does not exist.
152 self.stack1 = heat_utils.create_stack(self.heat_client,
153 self.stack_settings1)
155 stack_query_1 = heat_utils.get_stack(
156 self.heat_client, stack_settings=self.stack_settings1)
157 self.assertEqual(self.stack1, stack_query_1)
159 stack_query_2 = heat_utils.get_stack(
160 self.heat_client, stack_name=self.stack_settings1.name)
161 self.assertEqual(self.stack1, stack_query_2)
163 stack_query_3 = heat_utils.get_stack_by_id(self.heat_client,
165 self.assertEqual(self.stack1, stack_query_3)
167 resources = heat_utils.get_resources(self.heat_client, self.stack1)
168 self.assertIsNotNone(resources)
169 self.assertEqual(4, len(resources))
171 outputs = heat_utils.get_outputs(self.heat_client, self.stack1)
172 self.assertIsNotNone(outputs)
173 self.assertEqual(0, len(outputs))
175 self.assertTrue(stack_active(self.heat_client, self.stack1))
177 neutron = neutron_utils.neutron_client(self.os_creds)
178 networks = heat_utils.get_stack_networks(
179 self.heat_client, neutron, self.stack1)
180 self.assertIsNotNone(networks)
181 self.assertEqual(1, len(networks))
182 self.assertEqual(self.network_name, networks[0].name)
184 subnets = neutron_utils.get_subnets_by_network(neutron, networks[0])
185 self.assertEqual(1, len(subnets))
186 self.assertEqual(self.subnet_name, subnets[0].name)
188 nova = nova_utils.nova_client(self.os_creds)
189 servers = heat_utils.get_stack_servers(
190 self.heat_client, nova, self.stack1)
191 self.assertIsNotNone(servers)
192 self.assertEqual(1, len(servers))
193 self.assertEqual(self.vm_inst_name, servers[0].name)
195 def test_create_stack_x2(self):
197 Tests the creation of an OpenStack keypair that does not exist.
199 self.stack1 = heat_utils.create_stack(self.heat_client,
200 self.stack_settings1)
202 stack1_query_1 = heat_utils.get_stack(
203 self.heat_client, stack_settings=self.stack_settings1)
204 self.assertEqual(self.stack1, stack1_query_1)
206 stack1_query_2 = heat_utils.get_stack(
207 self.heat_client, stack_name=self.stack_settings1.name)
208 self.assertEqual(self.stack1, stack1_query_2)
210 stack1_query_3 = heat_utils.get_stack_by_id(self.heat_client,
212 self.assertEqual(self.stack1, stack1_query_3)
214 self.assertTrue(stack_active(self.heat_client, self.stack1))
216 self.stack2 = heat_utils.create_stack(self.heat_client,
217 self.stack_settings2)
219 stack2_query_1 = heat_utils.get_stack(
220 self.heat_client, stack_settings=self.stack_settings2)
221 self.assertEqual(self.stack2, stack2_query_1)
223 stack2_query_2 = heat_utils.get_stack(
224 self.heat_client, stack_name=self.stack_settings2.name)
225 self.assertEqual(self.stack2, stack2_query_2)
227 stack2_query_3 = heat_utils.get_stack_by_id(self.heat_client,
229 self.assertEqual(self.stack2, stack2_query_3)
231 self.assertTrue(stack_active(self.heat_client, self.stack2))
234 class HeatUtilsCreateComplexStackTests(OSComponentTestCase):
236 Test basic Heat functionality
241 Instantiates OpenStack instances that cannot be spawned by Heat
243 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
244 stack_name = guid + '-stack'
245 self.network_name = guid + '-net'
246 self.subnet_name = guid + '-subnet'
247 self.vm_inst1_name = guid + '-inst1'
248 self.vm_inst2_name = guid + '-inst2'
249 self.flavor1_name = guid + '-flavor1'
250 self.flavor2_name = guid + '-flavor2'
251 self.keypair_name = guid + '-keypair'
253 self.image_creator1 = OpenStackImage(
254 self.os_creds, openstack_tests.cirros_image_settings(
255 name=guid + '-image1', image_metadata=self.image_metadata))
256 self.image_creator1.create()
258 self.image_creator2 = OpenStackImage(
259 self.os_creds, openstack_tests.cirros_image_settings(
260 name=guid + '-image2', image_metadata=self.image_metadata))
261 self.image_creator2.create()
263 env_values = {'image1_name': self.image_creator1.image_settings.name,
264 'image2_name': self.image_creator2.image_settings.name,
265 'flavor1_name': self.flavor1_name,
266 'flavor2_name': self.flavor2_name,
267 'net_name': self.network_name,
268 'subnet_name': self.subnet_name,
269 'keypair_name': self.keypair_name,
270 'inst1_name': self.vm_inst1_name,
271 'inst2_name': self.vm_inst2_name,
272 'external_net_name': self.ext_net_name}
273 heat_tmplt_path = pkg_resources.resource_filename(
274 'snaps.openstack.tests.heat', 'floating_ip_heat_template.yaml')
275 stack_settings = StackConfig(
276 name=stack_name, template_path=heat_tmplt_path,
277 env_values=env_values)
278 self.heat_client = heat_utils.heat_client(self.os_creds)
279 self.stack = heat_utils.create_stack(self.heat_client, stack_settings)
281 self.assertTrue(stack_active(self.heat_client, self.stack))
283 self.keypair1_settings = None
284 self.keypair2_settings = None
288 Cleans the stack and image
292 heat_utils.delete_stack(self.heat_client, self.stack)
293 # Wait until stack deployment has completed
294 end_time = (time.time() +
295 stack_config.STACK_COMPLETE_TIMEOUT)
297 while time.time() < end_time:
298 status = heat_utils.get_stack_status(self.heat_client,
300 if status == stack_config.STATUS_DELETE_COMPLETE:
303 elif status == stack_config.STATUS_DELETE_FAILED:
310 nova = nova_utils.nova_client(self.os_creds)
311 neutron = neutron_utils.neutron_client(self.os_creds)
312 glance = glance_utils.glance_client(self.os_creds)
313 servers = heat_utils.get_stack_servers(
314 self.heat_client, nova, self.stack)
315 for server in servers:
316 vm_settings = settings_utils.create_vm_inst_config(
317 nova, neutron, server)
318 img_settings = settings_utils.determine_image_config(
320 [self.image_creator1.image_settings,
321 self.image_creator2.image_settings])
322 vm_creator = OpenStackVmInstance(
323 self.os_creds, vm_settings, img_settings)
324 vm_creator.initialize()
326 vm_creator.vm_deleted(block=True)
328 heat_utils.delete_stack(self.heat_client, self.stack)
333 if self.image_creator1:
335 self.image_creator1.clean()
339 if self.image_creator2:
341 self.image_creator2.clean()
345 if self.keypair1_settings:
346 expanded_path = os.path.expanduser(
347 self.keypair1_settings.private_filepath)
348 os.chmod(expanded_path, 0o755)
349 os.remove(expanded_path)
351 if self.keypair2_settings:
352 expanded_path = os.path.expanduser(
353 self.keypair2_settings.private_filepath)
354 os.chmod(expanded_path, 0o755)
355 os.remove(expanded_path)
357 def test_get_settings_from_stack(self):
359 Tests that a heat template with floating IPs and can have the proper
360 settings derived from settings_utils.py.
362 resources = heat_utils.get_resources(self.heat_client, self.stack)
363 self.assertIsNotNone(resources)
364 self.assertEqual(12, len(resources))
366 options = heat_utils.get_outputs(self.heat_client, self.stack)
367 self.assertIsNotNone(options)
368 self.assertEqual(1, len(options))
370 neutron = neutron_utils.neutron_client(self.os_creds)
371 networks = heat_utils.get_stack_networks(
372 self.heat_client, neutron, self.stack)
373 self.assertIsNotNone(networks)
374 self.assertEqual(1, len(networks))
375 self.assertEqual(self.network_name, networks[0].name)
377 network_settings = settings_utils.create_network_config(
378 neutron, networks[0])
379 self.assertIsNotNone(network_settings)
380 self.assertEqual(self.network_name, network_settings.name)
382 nova = nova_utils.nova_client(self.os_creds)
383 glance = glance_utils.glance_client(self.os_creds)
385 servers = heat_utils.get_stack_servers(
386 self.heat_client, nova, self.stack)
387 self.assertIsNotNone(servers)
388 self.assertEqual(2, len(servers))
390 image_settings = settings_utils.determine_image_config(
392 [self.image_creator1.image_settings,
393 self.image_creator2.image_settings])
395 self.assertIsNotNone(image_settings)
396 if image_settings.name.endswith('1'):
398 self.image_creator1.image_settings.name, image_settings.name)
401 self.image_creator2.image_settings.name, image_settings.name)
403 image_settings = settings_utils.determine_image_config(
405 [self.image_creator1.image_settings,
406 self.image_creator2.image_settings])
407 if image_settings.name.endswith('1'):
409 self.image_creator1.image_settings.name, image_settings.name)
412 self.image_creator2.image_settings.name, image_settings.name)
414 self.keypair1_settings = settings_utils.determine_keypair_config(
415 self.heat_client, self.stack, servers[0],
416 priv_key_key='private_key')
417 self.assertIsNotNone(self.keypair1_settings)
418 self.assertEqual(self.keypair_name, self.keypair1_settings.name)
420 self.keypair2_settings = settings_utils.determine_keypair_config(
421 self.heat_client, self.stack, servers[1],
422 priv_key_key='private_key')
423 self.assertIsNotNone(self.keypair2_settings)
424 self.assertEqual(self.keypair_name, self.keypair2_settings.name)
427 class HeatUtilsRouterTests(OSComponentTestCase):
429 Test Heat volume functionality
434 Instantiates OpenStack instances that cannot be spawned by Heat
436 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
437 stack_name = guid + '-stack'
439 self.net_name = guid + '-net'
440 self.subnet_name = guid + '-subnet'
441 self.router_name = guid + '-router'
444 'net_name': self.net_name,
445 'subnet_name': self.subnet_name,
446 'router_name': self.router_name,
447 'external_net_name': self.ext_net_name}
449 heat_tmplt_path = pkg_resources.resource_filename(
450 'snaps.openstack.tests.heat', 'router_heat_template.yaml')
451 self.stack_settings = StackConfig(
452 name=stack_name, template_path=heat_tmplt_path,
453 env_values=env_values)
455 self.heat_client = heat_utils.heat_client(self.os_creds)
456 self.neutron = neutron_utils.neutron_client(self.os_creds)
460 Cleans the image and downloaded image file
464 heat_utils.delete_stack(self.heat_client, self.stack)
468 def test_create_router_with_stack(self):
470 Tests the creation of an OpenStack router with Heat and the retrieval
471 of the Router Domain objects from heat_utils#get_stack_routers().
473 self.stack = heat_utils.create_stack(
474 self.heat_client, self.stack_settings)
476 # Wait until stack deployment has completed
477 end_time = time.time() + stack_config.STACK_COMPLETE_TIMEOUT
479 while time.time() < end_time:
480 status = heat_utils.get_stack_status(self.heat_client,
482 if status == stack_config.STATUS_CREATE_COMPLETE:
485 elif status == stack_config.STATUS_CREATE_FAILED:
491 self.assertTrue(is_active)
493 routers = heat_utils.get_stack_routers(
494 self.heat_client, self.neutron, self.stack)
496 self.assertEqual(1, len(routers))
499 self.assertEqual(self.router_name, router.name)
501 ext_net = neutron_utils.get_network(
502 self.neutron, network_name=self.ext_net_name)
503 self.assertEqual(ext_net.id, router.external_network_id)
506 class HeatUtilsVolumeTests(OSComponentTestCase):
508 Test Heat volume functionality
513 Instantiates OpenStack instances that cannot be spawned by Heat
515 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
516 stack_name = guid + '-stack'
517 self.volume_name = guid + '-vol'
518 self.volume_type_name = guid + '-vol-type'
521 'volume_name': self.volume_name,
522 'volume_type_name': self.volume_type_name}
524 heat_tmplt_path = pkg_resources.resource_filename(
525 'snaps.openstack.tests.heat', 'volume_heat_template.yaml')
526 self.stack_settings = StackConfig(
527 name=stack_name, template_path=heat_tmplt_path,
528 env_values=env_values)
530 self.heat_client = heat_utils.heat_client(self.os_creds)
531 self.cinder = cinder_utils.cinder_client(self.os_creds)
539 heat_utils.delete_stack(self.heat_client, self.stack)
543 def test_create_vol_with_stack(self):
545 Tests the creation of an OpenStack volume with Heat.
547 self.stack = heat_utils.create_stack(
548 self.heat_client, self.stack_settings)
549 self.assertTrue(stack_active(self.heat_client, self.stack))
551 volumes = heat_utils.get_stack_volumes(
552 self.heat_client, self.cinder, self.stack)
554 self.assertEqual(1, len(volumes))
557 self.assertEqual(self.volume_name, volume.name)
558 self.assertEqual(self.volume_type_name, volume.type)
559 self.assertEqual(1, volume.size)
560 self.assertEqual(False, volume.multi_attach)
562 def test_create_vol_types_with_stack(self):
564 Tests the creation of an OpenStack volume with Heat.
566 self.stack = heat_utils.create_stack(
567 self.heat_client, self.stack_settings)
568 self.assertTrue(stack_active(self.heat_client, self.stack))
570 volume_types = heat_utils.get_stack_volume_types(
571 self.heat_client, self.cinder, self.stack)
573 self.assertEqual(1, len(volume_types))
575 volume_type = volume_types[0]
577 self.assertEqual(self.volume_type_name, volume_type.name)
578 self.assertTrue(volume_type.public)
579 self.assertIsNone(volume_type.qos_spec)
581 encryption = volume_type.encryption
582 self.assertIsNotNone(encryption)
583 self.assertIsNone(encryption.cipher)
584 self.assertEqual('front-end', encryption.control_location)
585 self.assertIsNone(encryption.key_size)
586 self.assertEqual(u'nova.volume.encryptors.luks.LuksEncryptor',
588 self.assertEqual(volume_type.id, encryption.volume_type_id)
591 class HeatUtilsFlavorTests(OSComponentTestCase):
593 Test Heat volume functionality
598 Instantiates OpenStack instances that cannot be spawned by Heat
600 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
601 self.name_prefix = guid
602 stack_name = guid + '-stack'
604 heat_tmplt_path = pkg_resources.resource_filename(
605 'snaps.openstack.tests.heat', 'flavor_heat_template.yaml')
606 self.stack_settings = StackConfig(
607 name=stack_name, template_path=heat_tmplt_path)
609 self.heat_client = heat_utils.heat_client(self.os_creds)
610 self.nova = nova_utils.nova_client(self.os_creds)
618 heat_utils.delete_stack(self.heat_client, self.stack)
622 def test_create_flavor_with_stack(self):
624 Tests the creation of an OpenStack volume with Heat.
626 self.stack = heat_utils.create_stack(
627 self.heat_client, self.stack_settings)
629 self.assertTrue(stack_active(self.heat_client, self.stack))
631 flavors = heat_utils.get_stack_flavors(
632 self.heat_client, self.nova, self.stack)
634 self.assertEqual(1, len(flavors))
637 self.assertTrue(flavor.name.startswith(self.name_prefix))
638 self.assertEqual(1024, flavor.ram)
639 self.assertEqual(200, flavor.disk)
640 self.assertEqual(8, flavor.vcpus)
641 self.assertEqual(0, flavor.ephemeral)
642 self.assertIsNone(flavor.swap)
643 self.assertEqual(1.0, flavor.rxtx_factor)
644 self.assertTrue(flavor.is_public)
647 class HeatUtilsKeypairTests(OSComponentTestCase):
649 Test Heat volume functionality
654 Instantiates OpenStack instances that cannot be spawned by Heat
656 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
657 stack_name = guid + '-stack'
658 self.keypair_name = guid + '-kp'
660 env_values = {'keypair_name': self.keypair_name}
662 heat_tmplt_path = pkg_resources.resource_filename(
663 'snaps.openstack.tests.heat', 'keypair_heat_template.yaml')
664 self.stack_settings = StackConfig(
665 name=stack_name, template_path=heat_tmplt_path,
666 env_values=env_values)
668 self.heat_client = heat_utils.heat_client(self.os_creds)
669 self.nova = nova_utils.nova_client(self.os_creds)
677 heat_utils.delete_stack(self.heat_client, self.stack)
681 def test_create_keypair_with_stack(self):
683 Tests the creation of an OpenStack keypair with Heat.
685 self.stack = heat_utils.create_stack(
686 self.heat_client, self.stack_settings)
687 self.assertTrue(stack_active(self.heat_client, self.stack))
689 keypairs = heat_utils.get_stack_keypairs(
690 self.heat_client, self.nova, self.stack)
692 self.assertEqual(1, len(keypairs))
693 keypair = keypairs[0]
695 self.assertEqual(self.keypair_name, keypair.name)
697 outputs = heat_utils.get_outputs(self.heat_client, self.stack)
699 for output in outputs:
700 if output.key == 'private_key':
701 self.assertTrue(output.value.startswith(
702 '-----BEGIN RSA PRIVATE KEY-----'))
704 keypair = nova_utils.get_keypair_by_id(self.nova, keypair.id)
705 self.assertIsNotNone(keypair)
707 self.assertEqual(self.keypair_name, keypair.name)
710 class HeatUtilsSecurityGroupTests(OSComponentTestCase):
712 Test Heat volume functionality
717 Instantiates OpenStack instances that cannot be spawned by Heat
719 guid = self.__class__.__name__ + '-' + str(uuid.uuid4())
720 stack_name = guid + '-stack'
721 self.sec_grp_name = guid + '-sec-grp'
723 env_values = {'security_group_name': self.sec_grp_name}
725 heat_tmplt_path = pkg_resources.resource_filename(
726 'snaps.openstack.tests.heat', 'security_group_heat_template.yaml')
727 self.stack_settings = StackConfig(
728 name=stack_name, template_path=heat_tmplt_path,
729 env_values=env_values)
731 self.heat_client = heat_utils.heat_client(self.os_creds)
732 self.neutron = neutron_utils.neutron_client(self.os_creds)
740 heat_utils.delete_stack(self.heat_client, self.stack)
744 def test_create_security_group_with_stack(self):
746 Tests the creation of an OpenStack SecurityGroup with Heat.
748 self.stack = heat_utils.create_stack(
749 self.heat_client, self.stack_settings)
750 self.assertTrue(stack_active(self.heat_client, self.stack))
752 sec_grp = heat_utils.get_stack_security_groups(
753 self.heat_client, self.neutron, self.stack)[0]
755 self.assertEqual(self.sec_grp_name, sec_grp.name)
756 self.assertEqual('Test description', sec_grp.description)
757 self.assertEqual(2, len(sec_grp.rules))
760 has_icmp_rule = False
762 for rule in sec_grp.rules:
763 if (rule.security_group_id == sec_grp.id
764 and rule.direction == 'egress'
765 and rule.ethertype == 'IPv4'
766 and rule.port_range_min == 22
767 and rule.port_range_max == 22
768 and rule.protocol == 'tcp'
769 and rule.remote_group_id is None
770 and rule.remote_ip_prefix == '0.0.0.0/0'):
772 if (rule.security_group_id == sec_grp.id
773 and rule.direction == 'ingress'
774 and rule.ethertype == 'IPv4'
775 and rule.port_range_min is None
776 and rule.port_range_max is None
777 and rule.protocol == 'icmp'
778 and rule.remote_group_id is None
779 and rule.remote_ip_prefix == '0.0.0.0/0'):
782 self.assertTrue(has_ssh_rule)
783 self.assertTrue(has_icmp_rule)
786 def stack_active(heat_cli, stack):
788 Blocks until stack application has successfully completed or failed
789 :param heat_cli: the Heat client
790 :param stack: the Stack domain object
793 # Wait until stack deployment has completed
794 end_time = time.time() + stack_config.STACK_COMPLETE_TIMEOUT
796 while time.time() < end_time:
797 status = heat_utils.get_stack_status(heat_cli, stack.id)
798 if status == stack_config.STATUS_CREATE_COMPLETE:
801 elif status == stack_config.STATUS_CREATE_FAILED: