snaps/openstack/tests/create_stack_tests.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 import time
  16
  17 import pkg_resources
  18 from heatclient.exc import HTTPBadRequest
  19 from snaps import file_utils
  20 from snaps.openstack.create_flavor import OpenStackFlavor, FlavorSettings
  21 from snaps.openstack.create_image import OpenStackImage
  22
  23 try:
  24     from urllib.request import URLError
  25 except ImportError:
  26     from urllib2 import URLError
  27
  28 import logging
  29 import unittest
  30 import uuid
  31
  32 from snaps.openstack import create_stack
  33 from snaps.openstack.create_stack import StackSettings, StackSettingsError
  34 from snaps.openstack.tests import openstack_tests
  35 from snaps.openstack.tests.os_source_file_test import OSIntegrationTestCase
  36 from snaps.openstack.utils import heat_utils
  37
  38 __author__ = 'spisarski'
  39
  40 logger = logging.getLogger('create_stack_tests')
  41
  42
  43 class StackSettingsUnitTests(unittest.TestCase):
  44     """
  45     Tests the construction of the StackSettings class
  46     """
  47
  48     def test_no_params(self):
  49         with self.assertRaises(StackSettingsError):
  50             StackSettings()
  51
  52     def test_empty_config(self):
  53         with self.assertRaises(StackSettingsError):
  54             StackSettings(**dict())
  55
  56     def test_name_only(self):
  57         with self.assertRaises(StackSettingsError):
  58             StackSettings(name='foo')
  59
  60     def test_config_with_name_only(self):
  61         with self.assertRaises(StackSettingsError):
  62             StackSettings(**{'name': 'foo'})
  63
  64     def test_config_minimum_template(self):
  65         settings = StackSettings(**{'name': 'stack', 'template': 'foo'})
  66         self.assertEqual('stack', settings.name)
  67         self.assertEqual('foo', settings.template)
  68         self.assertIsNone(settings.template_path)
  69         self.assertIsNone(settings.env_values)
  70         self.assertEqual(create_stack.STACK_COMPLETE_TIMEOUT,
  71                          settings.stack_create_timeout)
  72
  73     def test_config_minimum_template_path(self):
  74         settings = StackSettings(**{'name': 'stack', 'template_path': 'foo'})
  75         self.assertEqual('stack', settings.name)
  76         self.assertIsNone(settings.template)
  77         self.assertEqual('foo', settings.template_path)
  78         self.assertIsNone(settings.env_values)
  79         self.assertEqual(create_stack.STACK_COMPLETE_TIMEOUT,
  80                          settings.stack_create_timeout)
  81
  82     def test_minimum_template(self):
  83         settings = StackSettings(name='stack', template='foo')
  84         self.assertEqual('stack', settings.name)
  85         self.assertEqual('foo', settings.template)
  86         self.assertIsNone(settings.template_path)
  87         self.assertIsNone(settings.env_values)
  88         self.assertEqual(create_stack.STACK_COMPLETE_TIMEOUT,
  89                          settings.stack_create_timeout)
  90
  91     def test_minimum_template_path(self):
  92         settings = StackSettings(name='stack', template_path='foo')
  93         self.assertEqual('stack', settings.name)
  94         self.assertEqual('foo', settings.template_path)
  95         self.assertIsNone(settings.template)
  96         self.assertIsNone(settings.env_values)
  97         self.assertEqual(create_stack.STACK_COMPLETE_TIMEOUT,
  98                          settings.stack_create_timeout)
  99
 100     def test_all(self):
 101         env_values = {'foo': 'bar'}
 102         settings = StackSettings(name='stack', template='bar',
 103                                  template_path='foo', env_values=env_values,
 104                                  stack_create_timeout=999)
 105         self.assertEqual('stack', settings.name)
 106         self.assertEqual('bar', settings.template)
 107         self.assertEqual('foo', settings.template_path)
 108         self.assertEqual(env_values, settings.env_values)
 109         self.assertEqual(999, settings.stack_create_timeout)
 110
 111     def test_config_all(self):
 112         env_values = {'foo': 'bar'}
 113         settings = StackSettings(
 114             **{'name': 'stack', 'template': 'bar', 'template_path': 'foo',
 115                'env_values': env_values, 'stack_create_timeout': 999})
 116         self.assertEqual('stack', settings.name)
 117         self.assertEqual('bar', settings.template)
 118         self.assertEqual('foo', settings.template_path)
 119         self.assertEqual(env_values, settings.env_values)
 120         self.assertEqual(999, settings.stack_create_timeout)
 121
 122
 123 class CreateStackSuccessTests(OSIntegrationTestCase):
 124     """
 125     Test for the CreateStack class defined in create_stack.py
 126     """
 127
 128     def setUp(self):
 129         """
 130         Instantiates the CreateStack object that is responsible for downloading
 131         and creating an OS stack file within OpenStack
 132         """
 133         super(self.__class__, self).__start__()
 134
 135         self.guid = str(uuid.uuid4())
 136         self.heat_cli = heat_utils.heat_client(self.os_creds)
 137         self.stack_creator = None
 138
 139         self.image_creator = OpenStackImage(
 140             self.os_creds, openstack_tests.cirros_image_settings(
 141                 name=self.__class__.__name__ + '-' + str(self.guid) + '-image',
 142                 image_metadata=self.image_metadata))
 143         self.image_creator.create()
 144
 145         # Create Flavor
 146         self.flavor_creator = OpenStackFlavor(
 147             self.admin_os_creds,
 148             FlavorSettings(name=self.guid + '-flavor-name', ram=128, disk=10,
 149                            vcpus=1))
 150         self.flavor_creator.create()
 151
 152         self.env_values = {
 153             'image_name': self.image_creator.image_settings.name,
 154             'flavor_name': self.flavor_creator.flavor_settings.name}
 155
 156         self.heat_tmplt_path = pkg_resources.resource_filename(
 157             'snaps.openstack.tests.heat', 'test_heat_template.yaml')
 158
 159     def tearDown(self):
 160         """
 161         Cleans the stack and downloaded stack file
 162         """
 163         if self.stack_creator:
 164             try:
 165                 self.stack_creator.clean()
 166             except:
 167                 pass
 168
 169         if self.image_creator:
 170             try:
 171                 self.image_creator.clean()
 172             except:
 173                 pass
 174
 175         if self.flavor_creator:
 176             try:
 177                 self.flavor_creator.clean()
 178             except:
 179                 pass
 180
 181         super(self.__class__, self).__clean__()
 182
 183     def test_create_stack_template_file(self):
 184         """
 185         Tests the creation of an OpenStack stack from Heat template file.
 186         """
 187         # Create Stack
 188         # Set the default stack settings, then set any custom parameters sent
 189         # from the app
 190         stack_settings = StackSettings(
 191             name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
 192             template_path=self.heat_tmplt_path,
 193             env_values=self.env_values)
 194         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 195                                                              stack_settings)
 196         created_stack = self.stack_creator.create()
 197         self.assertIsNotNone(created_stack)
 198
 199         retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
 200                                                      created_stack.id)
 201         self.assertIsNotNone(retrieved_stack)
 202         self.assertEqual(created_stack.name, retrieved_stack.name)
 203         self.assertEqual(created_stack.id, retrieved_stack.id)
 204         self.assertIsNotNone(self.stack_creator.get_outputs())
 205         self.assertEquals(0, len(self.stack_creator.get_outputs()))
 206
 207     def test_create_stack_template_dict(self):
 208         """
 209         Tests the creation of an OpenStack stack from a heat dict() object.
 210         """
 211         # Create Stack
 212         # Set the default stack settings, then set any custom parameters sent
 213         # from the app
 214         template_dict = heat_utils.parse_heat_template_str(
 215             file_utils.read_file(self.heat_tmplt_path))
 216         stack_settings = StackSettings(
 217             name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
 218             template=template_dict,
 219             env_values=self.env_values)
 220         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 221                                                              stack_settings)
 222         created_stack = self.stack_creator.create()
 223         self.assertIsNotNone(created_stack)
 224
 225         retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
 226                                                      created_stack.id)
 227         self.assertIsNotNone(retrieved_stack)
 228         self.assertEqual(created_stack.name, retrieved_stack.name)
 229         self.assertEqual(created_stack.id, retrieved_stack.id)
 230         self.assertIsNotNone(self.stack_creator.get_outputs())
 231         self.assertEquals(0, len(self.stack_creator.get_outputs()))
 232
 233     def test_create_delete_stack(self):
 234         """
 235         Tests the creation then deletion of an OpenStack stack to ensure
 236         clean() does not raise an Exception.
 237         """
 238         # Create Stack
 239         template_dict = heat_utils.parse_heat_template_str(
 240             file_utils.read_file(self.heat_tmplt_path))
 241         stack_settings = StackSettings(
 242             name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
 243             template=template_dict,
 244             env_values=self.env_values)
 245         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 246                                                              stack_settings)
 247         created_stack = self.stack_creator.create()
 248         self.assertIsNotNone(created_stack)
 249
 250         retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
 251                                                      created_stack.id)
 252         self.assertIsNotNone(retrieved_stack)
 253         self.assertEqual(created_stack.name, retrieved_stack.name)
 254         self.assertEqual(created_stack.id, retrieved_stack.id)
 255         self.assertIsNotNone(self.stack_creator.get_outputs())
 256         self.assertEquals(0, len(self.stack_creator.get_outputs()))
 257         self.assertEqual(create_stack.STATUS_CREATE_COMPLETE,
 258                          self.stack_creator.get_status())
 259
 260         # Delete Stack manually
 261         heat_utils.delete_stack(self.heat_cli, created_stack)
 262
 263         end_time = time.time() + 90
 264         deleted = False
 265         while time.time() < end_time:
 266             status = heat_utils.get_stack_status(self.heat_cli,
 267                                                  retrieved_stack.id)
 268             if status == create_stack.STATUS_DELETE_COMPLETE:
 269                 deleted = True
 270                 break
 271
 272         self.assertTrue(deleted)
 273
 274         # Must not throw an exception when attempting to cleanup non-existent
 275         # stack
 276         self.stack_creator.clean()
 277         self.assertIsNone(self.stack_creator.get_stack())
 278
 279     def test_create_same_stack(self):
 280         """
 281         Tests the creation of an OpenStack stack when the stack already exists.
 282         """
 283         # Create Stack
 284         template_dict = heat_utils.parse_heat_template_str(
 285             file_utils.read_file(self.heat_tmplt_path))
 286         stack_settings = StackSettings(
 287             name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
 288             template=template_dict,
 289             env_values=self.env_values)
 290         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 291                                                              stack_settings)
 292         created_stack1 = self.stack_creator.create()
 293
 294         retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
 295                                                      created_stack1.id)
 296         self.assertIsNotNone(retrieved_stack)
 297         self.assertEqual(created_stack1.name, retrieved_stack.name)
 298         self.assertEqual(created_stack1.id, retrieved_stack.id)
 299         self.assertIsNotNone(self.stack_creator.get_outputs())
 300         self.assertEqual(0, len(self.stack_creator.get_outputs()))
 301
 302         # Should be retrieving the instance data
 303         stack_creator2 = create_stack.OpenStackHeatStack(self.os_creds,
 304                                                          stack_settings)
 305         stack2 = stack_creator2.create()
 306         self.assertEqual(created_stack1.id, stack2.id)
 307
 308
 309 class CreateStackNegativeTests(OSIntegrationTestCase):
 310     """
 311     Negative test cases for the CreateStack class
 312     """
 313
 314     def setUp(self):
 315         super(self.__class__, self).__start__()
 316
 317         self.stack_name = self.__class__.__name__ + '-' + str(uuid.uuid4())
 318         self.stack_creator = None
 319         self.heat_tmplt_path = pkg_resources.resource_filename(
 320             'snaps.openstack.tests.heat', 'test_heat_template.yaml')
 321
 322     def tearDown(self):
 323         if self.stack_creator:
 324             self.stack_creator.clean()
 325         super(self.__class__, self).__clean__()
 326
 327     def test_missing_dependencies(self):
 328         """
 329         Expect an StackCreationError when the stack file does not exist
 330         """
 331         stack_settings = StackSettings(name=self.stack_name,
 332                                        template_path=self.heat_tmplt_path)
 333         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 334                                                              stack_settings)
 335         with self.assertRaises(HTTPBadRequest):
 336             self.stack_creator.create()
 337
 338     def test_bad_stack_file(self):
 339         """
 340         Expect an StackCreationError when the stack file does not exist
 341         """
 342         stack_settings = StackSettings(name=self.stack_name,
 343                                        template_path='foo')
 344         self.stack_creator = create_stack.OpenStackHeatStack(self.os_creds,
 345                                                              stack_settings)
 346         with self.assertRaises(IOError):
 347             self.stack_creator.create()