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.
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
24 from urllib.request import URLError
26 from urllib2 import URLError
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
38 __author__ = 'spisarski'
40 logger = logging.getLogger('create_stack_tests')
43 class StackSettingsUnitTests(unittest.TestCase):
45 Tests the construction of the StackSettings class
48 def test_no_params(self):
49 with self.assertRaises(StackSettingsError):
52 def test_empty_config(self):
53 with self.assertRaises(StackSettingsError):
54 StackSettings(**dict())
56 def test_name_only(self):
57 with self.assertRaises(StackSettingsError):
58 StackSettings(name='foo')
60 def test_config_with_name_only(self):
61 with self.assertRaises(StackSettingsError):
62 StackSettings(**{'name': 'foo'})
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)
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)
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)
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)
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)
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)
123 class CreateStackSuccessTests(OSIntegrationTestCase):
125 Test for the CreateStack class defined in create_stack.py
130 Instantiates the CreateStack object that is responsible for downloading
131 and creating an OS stack file within OpenStack
133 super(self.__class__, self).__start__()
135 self.guid = str(uuid.uuid4())
137 self.heat_creds = self.admin_os_creds
138 self.heat_creds.project_name = self.admin_os_creds.project_name
140 self.heat_cli = heat_utils.heat_client(self.heat_creds)
141 self.stack_creator = None
143 self.image_creator = OpenStackImage(
144 self.heat_creds, openstack_tests.cirros_image_settings(
145 name=self.__class__.__name__ + '-' + str(self.guid) + '-image',
146 image_metadata=self.image_metadata))
147 self.image_creator.create()
150 self.flavor_creator = OpenStackFlavor(
152 FlavorSettings(name=self.guid + '-flavor-name', ram=128, disk=10,
154 self.flavor_creator.create()
157 'image_name': self.image_creator.image_settings.name,
158 'flavor_name': self.flavor_creator.flavor_settings.name}
160 self.heat_tmplt_path = pkg_resources.resource_filename(
161 'snaps.openstack.tests.heat', 'test_heat_template.yaml')
165 Cleans the stack and downloaded stack file
167 if self.stack_creator:
169 self.stack_creator.clean()
173 if self.image_creator:
175 self.image_creator.clean()
179 if self.flavor_creator:
181 self.flavor_creator.clean()
185 super(self.__class__, self).__clean__()
187 def test_create_stack_template_file(self):
189 Tests the creation of an OpenStack stack from Heat template file.
192 # Set the default stack settings, then set any custom parameters sent
194 stack_settings = StackSettings(
195 name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
196 template_path=self.heat_tmplt_path,
197 env_values=self.env_values)
198 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
200 created_stack = self.stack_creator.create()
201 self.assertIsNotNone(created_stack)
203 retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
205 self.assertIsNotNone(retrieved_stack)
206 self.assertEqual(created_stack.name, retrieved_stack.name)
207 self.assertEqual(created_stack.id, retrieved_stack.id)
208 self.assertIsNotNone(self.stack_creator.get_outputs())
209 self.assertEquals(0, len(self.stack_creator.get_outputs()))
211 def test_create_stack_template_dict(self):
213 Tests the creation of an OpenStack stack from a heat dict() object.
216 # Set the default stack settings, then set any custom parameters sent
218 template_dict = heat_utils.parse_heat_template_str(
219 file_utils.read_file(self.heat_tmplt_path))
220 stack_settings = StackSettings(
221 name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
222 template=template_dict,
223 env_values=self.env_values)
224 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
226 created_stack = self.stack_creator.create()
227 self.assertIsNotNone(created_stack)
229 retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
231 self.assertIsNotNone(retrieved_stack)
232 self.assertEqual(created_stack.name, retrieved_stack.name)
233 self.assertEqual(created_stack.id, retrieved_stack.id)
234 self.assertIsNotNone(self.stack_creator.get_outputs())
235 self.assertEquals(0, len(self.stack_creator.get_outputs()))
237 def test_create_delete_stack(self):
239 Tests the creation then deletion of an OpenStack stack to ensure
240 clean() does not raise an Exception.
243 template_dict = heat_utils.parse_heat_template_str(
244 file_utils.read_file(self.heat_tmplt_path))
245 stack_settings = StackSettings(
246 name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
247 template=template_dict,
248 env_values=self.env_values)
249 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
251 created_stack = self.stack_creator.create()
252 self.assertIsNotNone(created_stack)
254 retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
256 self.assertIsNotNone(retrieved_stack)
257 self.assertEqual(created_stack.name, retrieved_stack.name)
258 self.assertEqual(created_stack.id, retrieved_stack.id)
259 self.assertIsNotNone(self.stack_creator.get_outputs())
260 self.assertEquals(0, len(self.stack_creator.get_outputs()))
261 self.assertEqual(create_stack.STATUS_CREATE_COMPLETE,
262 self.stack_creator.get_status())
264 # Delete Stack manually
265 heat_utils.delete_stack(self.heat_cli, created_stack)
267 end_time = time.time() + 90
269 while time.time() < end_time:
270 status = heat_utils.get_stack_status(self.heat_cli,
272 if status == create_stack.STATUS_DELETE_COMPLETE:
276 self.assertTrue(deleted)
278 # Must not throw an exception when attempting to cleanup non-existent
280 self.stack_creator.clean()
281 self.assertIsNone(self.stack_creator.get_stack())
283 def test_create_same_stack(self):
285 Tests the creation of an OpenStack stack when the stack already exists.
288 template_dict = heat_utils.parse_heat_template_str(
289 file_utils.read_file(self.heat_tmplt_path))
290 stack_settings = StackSettings(
291 name=self.__class__.__name__ + '-' + str(self.guid) + '-stack',
292 template=template_dict,
293 env_values=self.env_values)
294 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
296 created_stack1 = self.stack_creator.create()
298 retrieved_stack = heat_utils.get_stack_by_id(self.heat_cli,
300 self.assertIsNotNone(retrieved_stack)
301 self.assertEqual(created_stack1.name, retrieved_stack.name)
302 self.assertEqual(created_stack1.id, retrieved_stack.id)
303 self.assertIsNotNone(self.stack_creator.get_outputs())
304 self.assertEqual(0, len(self.stack_creator.get_outputs()))
306 # Should be retrieving the instance data
307 stack_creator2 = create_stack.OpenStackHeatStack(self.heat_creds,
309 stack2 = stack_creator2.create()
310 self.assertEqual(created_stack1.id, stack2.id)
313 class CreateStackNegativeTests(OSIntegrationTestCase):
315 Negative test cases for the CreateStack class
319 super(self.__class__, self).__start__()
321 self.heat_creds = self.admin_os_creds
322 self.heat_creds.project_name = self.admin_os_creds.project_name
324 self.stack_name = self.__class__.__name__ + '-' + str(uuid.uuid4())
325 self.stack_creator = None
326 self.heat_tmplt_path = pkg_resources.resource_filename(
327 'snaps.openstack.tests.heat', 'test_heat_template.yaml')
330 if self.stack_creator:
331 self.stack_creator.clean()
332 super(self.__class__, self).__clean__()
334 def test_missing_dependencies(self):
336 Expect an StackCreationError when the stack file does not exist
338 stack_settings = StackSettings(name=self.stack_name,
339 template_path=self.heat_tmplt_path)
340 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
342 with self.assertRaises(HTTPBadRequest):
343 self.stack_creator.create()
345 def test_bad_stack_file(self):
347 Expect an StackCreationError when the stack file does not exist
349 stack_settings = StackSettings(name=self.stack_name,
351 self.stack_creator = create_stack.OpenStackHeatStack(self.heat_creds,
353 with self.assertRaises(IOError):
354 self.stack_creator.create()