blob: 83ccdc2a95a69b512bb3e1aa333818e42b080aaa [file] [log] [blame]
Steve Baker450aa7f2014-08-25 10:37:27 +12001# Licensed under the Apache License, Version 2.0 (the "License"); you may
2# not use this file except in compliance with the License. You may obtain
3# a copy of the License at
4#
5# http://www.apache.org/licenses/LICENSE-2.0
6#
7# Unless required by applicable law or agreed to in writing, software
8# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
9# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
10# License for the specific language governing permissions and limitations
11# under the License.
12
Steve Baker450aa7f2014-08-25 10:37:27 +120013import random
14import re
Steve Baker450aa7f2014-08-25 10:37:27 +120015import subprocess
Steve Baker450aa7f2014-08-25 10:37:27 +120016import time
17
Pavlo Shchelokovskyy60e0ecd2014-12-14 22:17:21 +020018import fixtures
Steve Baker450aa7f2014-08-25 10:37:27 +120019from heatclient import exc as heat_exceptions
Thomas Hervedb36c092017-03-23 11:20:14 +010020from keystoneauth1 import exceptions as kc_exceptions
Mark Vanderwiel6d8e0862015-10-15 12:51:07 -050021from neutronclient.common import exceptions as network_exceptions
Steve Baker24641292015-03-13 10:47:50 +130022from oslo_log import log as logging
Jens Rosenboom4f069fb2015-02-18 14:19:07 +010023from oslo_utils import timeutils
Pavlo Shchelokovskyy60e0ecd2014-12-14 22:17:21 +020024import six
Sirushti Murugesan4920fda2015-04-22 00:35:26 +053025from six.moves import urllib
Pavlo Shchelokovskyy60e0ecd2014-12-14 22:17:21 +020026import testscenarios
27import testtools
Steve Baker450aa7f2014-08-25 10:37:27 +120028
rabid2916d02017-09-22 18:19:24 +053029from heat_tempest_plugin.common import exceptions
30from heat_tempest_plugin.common import remote_client
rabid2916d02017-09-22 18:19:24 +053031from heat_tempest_plugin.services import clients
Zane Bitterb4acd962018-01-18 12:08:23 -050032from tempest import config
Steve Baker450aa7f2014-08-25 10:37:27 +120033
34LOG = logging.getLogger(__name__)
Angus Salkeld24043702014-11-21 08:49:26 +100035_LOG_FORMAT = "%(levelname)8s [%(name)s] %(message)s"
rabi82b71282018-03-08 11:08:36 +053036_resource_types = None
Steve Baker450aa7f2014-08-25 10:37:27 +120037
38
Angus Salkeld08514ad2015-02-06 10:08:31 +100039def call_until_true(duration, sleep_for, func, *args, **kwargs):
Peter Razumovskyf0ac9582015-09-24 16:49:03 +030040 """Call the function until it returns True or the duration elapsed.
41
Steve Baker450aa7f2014-08-25 10:37:27 +120042 Call the given function until it returns True (and return True) or
43 until the specified duration (in seconds) elapses (and return
44 False).
45
46 :param func: A zero argument callable that returns True on success.
47 :param duration: The number of seconds for which to attempt a
48 successful call of the function.
49 :param sleep_for: The number of seconds to sleep after an unsuccessful
50 invocation of the function.
51 """
52 now = time.time()
53 timeout = now + duration
54 while now < timeout:
Angus Salkeld08514ad2015-02-06 10:08:31 +100055 if func(*args, **kwargs):
Steve Baker450aa7f2014-08-25 10:37:27 +120056 return True
57 LOG.debug("Sleeping for %d seconds", sleep_for)
58 time.sleep(sleep_for)
59 now = time.time()
60 return False
61
62
rabi32201342017-11-17 22:57:58 +053063def isotime(at):
64 if at is None:
65 return None
66 return at.strftime('%Y-%m-%dT%H:%M:%SZ')
67
68
Steve Baker450aa7f2014-08-25 10:37:27 +120069def rand_name(name=''):
ricolina4eb53d2017-04-24 23:51:09 +080070 randbits = six.text_type(random.randint(1, 0x7fffffff))
Steve Baker450aa7f2014-08-25 10:37:27 +120071 if name:
72 return name + '-' + randbits
73 else:
74 return randbits
75
76
Zane Bitterf407e102017-10-05 14:19:32 -040077def requires_convergence(test_method):
78 '''Decorator for convergence-only tests.
79
80 The decorated test will be skipped when convergence is disabled.
81 '''
rabif89752b2017-11-18 22:14:30 +053082 plugin = config.CONF.heat_plugin
rabi94a520a2017-11-17 22:49:17 +053083 convergence_enabled = plugin.convergence_engine_enabled
Zane Bitterf407e102017-10-05 14:19:32 -040084 skipper = testtools.skipUnless(convergence_enabled,
85 "Convergence-only tests are disabled")
86 return skipper(test_method)
87
88
rabi82b71282018-03-08 11:08:36 +053089def requires_resource_type(resource_type):
90 '''Decorator for tests requiring a resource type.
91
92 The decorated test will be skipped when the resource type is not available.
93 '''
94 def decorator(test_method):
95 conf = getattr(config.CONF, 'heat_plugin', None)
96 if not conf or conf.auth_url is None:
97 return test_method
98
99 global _resource_types
100 if not _resource_types:
101 manager = clients.ClientManager(conf)
102 obj_rtypes = manager.orchestration_client.resource_types.list()
103 _resource_types = list(t.resource_type for t in obj_rtypes)
104 rtype_available = resource_type and resource_type in _resource_types
105 skipper = testtools.skipUnless(
106 rtype_available,
107 "%s resource type not available, skipping test." % resource_type)
108 return skipper(test_method)
109 return decorator
110
111
Rabi Mishrad6b25352018-10-17 13:11:05 +0530112def requires_service_type(service_type):
113 '''Decorator for tests requiring a specific service being available.
114
115 The decorated test will be skipped when a service is not available.
116 '''
117 def decorator(test_method):
118 conf = getattr(config.CONF, 'heat_plugin', None)
119 if not conf or conf.auth_url is None:
120 return test_method
121
122 manager = clients.ClientManager(conf)
123 try:
124 manager.identity_client.get_endpoint_url(
125 service_type, conf.region, conf.endpoint_type)
126 except kc_exceptions.EndpointNotFound:
127 skipper = testtools.skip(
128 "%s service not available, skipping test." % service_type)
129 return skipper(test_method)
130 else:
131 return test_method
132 return decorator
133
134
Rabi Mishra144bdc62019-01-10 17:00:57 +0530135def _check_require(group, feature, test_method):
136 features_group = getattr(config.CONF, group, None)
137 if not features_group:
138 return test_method
139 feature_enabled = features_group.get(feature, True)
140 skipper = testtools.skipUnless(feature_enabled,
141 "%s - Feature not enabled." % feature)
142 return skipper(test_method)
143
144
rabi876449a2018-03-15 21:56:49 +0530145def requires_feature(feature):
146 '''Decorator for tests requring specific feature.
147
148 The decorated test will be skipped when a specific feature is disabled.
149 '''
150 def decorator(test_method):
Rabi Mishra144bdc62019-01-10 17:00:57 +0530151 return _check_require('heat_features_enabled', feature, test_method)
152 return decorator
153
154
155def requires_service_feature(service, feature):
156 '''Decorator for tests requring specific service feature enabled in tempest.
157
158 The decorated test will be skipped when a specific feature is disabled.
159 '''
160 def decorator(test_method):
161 group = service + '_feature_enabled'
162 return _check_require(group, feature, test_method)
rabi876449a2018-03-15 21:56:49 +0530163 return decorator
164
165
Andrea Frittolid908bef2018-02-22 11:29:53 +0000166class HeatIntegrationTest(testtools.testcase.WithAttributes,
167 testscenarios.WithScenarios,
Angus Salkeld95f65a22014-11-24 12:38:30 +1000168 testtools.TestCase):
Steve Baker450aa7f2014-08-25 10:37:27 +1200169
170 def setUp(self):
171 super(HeatIntegrationTest, self).setUp()
172
rabif89752b2017-11-18 22:14:30 +0530173 self.conf = config.CONF.heat_plugin
Steve Baker450aa7f2014-08-25 10:37:27 +1200174
175 self.assertIsNotNone(self.conf.auth_url,
176 'No auth_url configured')
177 self.assertIsNotNone(self.conf.username,
178 'No username configured')
179 self.assertIsNotNone(self.conf.password,
180 'No password configured')
rabifd98a472016-05-24 10:18:33 +0530181 self.setup_clients(self.conf)
182 self.useFixture(fixtures.FakeLogger(format=_LOG_FORMAT))
rabifd98a472016-05-24 10:18:33 +0530183 if self.conf.disable_ssl_certificate_validation:
184 self.verify_cert = False
185 else:
186 self.verify_cert = self.conf.ca_file or True
Steve Baker450aa7f2014-08-25 10:37:27 +1200187
Steve Bakerb752e912016-08-01 22:05:37 +0000188 def setup_clients(self, conf, admin_credentials=False):
189 self.manager = clients.ClientManager(conf, admin_credentials)
Steve Baker450aa7f2014-08-25 10:37:27 +1200190 self.identity_client = self.manager.identity_client
191 self.orchestration_client = self.manager.orchestration_client
192 self.compute_client = self.manager.compute_client
193 self.network_client = self.manager.network_client
194 self.volume_client = self.manager.volume_client
Angus Salkeld4408da32015-02-03 18:53:30 +1000195 self.object_client = self.manager.object_client
rabid69f0312017-10-26 14:52:52 +0530196 self.metric_client = self.manager.metric_client
rabifd98a472016-05-24 10:18:33 +0530197
198 self.client = self.orchestration_client
199
200 def setup_clients_for_admin(self):
Steve Bakerb752e912016-08-01 22:05:37 +0000201 self.setup_clients(self.conf, True)
Steve Baker450aa7f2014-08-25 10:37:27 +1200202
Steve Baker450aa7f2014-08-25 10:37:27 +1200203 def get_remote_client(self, server_or_ip, username, private_key=None):
204 if isinstance(server_or_ip, six.string_types):
205 ip = server_or_ip
206 else:
207 network_name_for_ssh = self.conf.network_for_ssh
208 ip = server_or_ip.networks[network_name_for_ssh][0]
209 if private_key is None:
210 private_key = self.keypair.private_key
211 linux_client = remote_client.RemoteClient(ip, username,
212 pkey=private_key,
213 conf=self.conf)
214 try:
215 linux_client.validate_authentication()
216 except exceptions.SSHTimeout:
liyi09461f72017-03-21 12:17:51 +0800217 LOG.exception('ssh connection to %s failed', ip)
Steve Baker450aa7f2014-08-25 10:37:27 +1200218 raise
219
220 return linux_client
221
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400222 def check_connectivity(self, check_ip):
223 def try_connect(ip):
224 try:
Sirushti Murugesan4920fda2015-04-22 00:35:26 +0530225 urllib.request.urlopen('http://%s/' % ip)
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400226 return True
227 except IOError:
228 return False
229
230 timeout = self.conf.connectivity_timeout
231 elapsed_time = 0
232 while not try_connect(check_ip):
233 time.sleep(10)
234 elapsed_time += 10
235 if elapsed_time > timeout:
236 raise exceptions.TimeoutException()
237
Steve Baker450aa7f2014-08-25 10:37:27 +1200238 def _log_console_output(self, servers=None):
239 if not servers:
240 servers = self.compute_client.servers.list()
241 for server in servers:
Steve Baker24641292015-03-13 10:47:50 +1300242 LOG.info('Console output for %s', server.id)
243 LOG.info(server.get_console_output())
Steve Baker450aa7f2014-08-25 10:37:27 +1200244
Steve Baker450aa7f2014-08-25 10:37:27 +1200245 def create_keypair(self, client=None, name=None):
246 if client is None:
247 client = self.compute_client
248 if name is None:
249 name = rand_name('heat-keypair')
250 keypair = client.keypairs.create(name)
251 self.assertEqual(keypair.name, name)
252
253 def delete_keypair():
254 keypair.delete()
255
256 self.addCleanup(delete_keypair)
257 return keypair
258
Sergey Krayneva265c132015-02-13 03:51:03 -0500259 def assign_keypair(self):
260 if self.conf.keypair_name:
261 self.keypair = None
262 self.keypair_name = self.conf.keypair_name
263 else:
264 self.keypair = self.create_keypair()
265 self.keypair_name = self.keypair.id
266
Steve Baker450aa7f2014-08-25 10:37:27 +1200267 @classmethod
268 def _stack_rand_name(cls):
269 return rand_name(cls.__name__)
270
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400271 def _get_network(self, net_name=None):
272 if net_name is None:
273 net_name = self.conf.fixed_network_name
Steve Baker450aa7f2014-08-25 10:37:27 +1200274 networks = self.network_client.list_networks()
275 for net in networks['networks']:
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400276 if net['name'] == net_name:
Steve Baker450aa7f2014-08-25 10:37:27 +1200277 return net
278
Mark Vanderwiel6d8e0862015-10-15 12:51:07 -0500279 def is_network_extension_supported(self, extension_alias):
280 try:
281 self.network_client.show_extension(extension_alias)
282 except network_exceptions.NeutronClientException:
283 return False
284 return True
285
Steve Baker450aa7f2014-08-25 10:37:27 +1200286 @staticmethod
Angus Salkelda89a0282015-07-24 15:47:38 +1000287 def _stack_output(stack, output_key, validate_errors=True):
Steve Baker450aa7f2014-08-25 10:37:27 +1200288 """Return a stack output value for a given key."""
Angus Salkelda89a0282015-07-24 15:47:38 +1000289 value = None
290 for o in stack.outputs:
291 if validate_errors and 'output_error' in o:
292 # scan for errors in the stack output.
293 raise ValueError(
294 'Unexpected output errors in %s : %s' % (
295 output_key, o['output_error']))
296 if o['output_key'] == output_key:
297 value = o['output_value']
298 return value
Steve Baker450aa7f2014-08-25 10:37:27 +1200299
300 def _ping_ip_address(self, ip_address, should_succeed=True):
301 cmd = ['ping', '-c1', '-w1', ip_address]
302
303 def ping():
304 proc = subprocess.Popen(cmd,
305 stdout=subprocess.PIPE,
306 stderr=subprocess.PIPE)
307 proc.wait()
308 return (proc.returncode == 0) == should_succeed
309
310 return call_until_true(
Angus Salkeld08514ad2015-02-06 10:08:31 +1000311 self.conf.build_timeout, 1, ping)
Steve Baker450aa7f2014-08-25 10:37:27 +1200312
Angus Salkelda7500d12015-04-10 15:44:07 +1000313 def _wait_for_all_resource_status(self, stack_identifier,
314 status, failure_pattern='^.*_FAILED$',
315 success_on_not_found=False):
316 for res in self.client.resources.list(stack_identifier):
317 self._wait_for_resource_status(
318 stack_identifier, res.resource_name,
319 status, failure_pattern=failure_pattern,
320 success_on_not_found=success_on_not_found)
321
Steve Baker450aa7f2014-08-25 10:37:27 +1200322 def _wait_for_resource_status(self, stack_identifier, resource_name,
323 status, failure_pattern='^.*_FAILED$',
324 success_on_not_found=False):
325 """Waits for a Resource to reach a given status."""
326 fail_regexp = re.compile(failure_pattern)
327 build_timeout = self.conf.build_timeout
328 build_interval = self.conf.build_interval
329
330 start = timeutils.utcnow()
331 while timeutils.delta_seconds(start,
332 timeutils.utcnow()) < build_timeout:
333 try:
334 res = self.client.resources.get(
335 stack_identifier, resource_name)
336 except heat_exceptions.HTTPNotFound:
337 if success_on_not_found:
338 return
339 # ignore this, as the resource may not have
340 # been created yet
341 else:
342 if res.resource_status == status:
343 return
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530344 wait_for_action = status.split('_')[0]
345 resource_action = res.resource_status.split('_')[0]
346 if (resource_action == wait_for_action and
347 fail_regexp.search(res.resource_status)):
Steve Baker450aa7f2014-08-25 10:37:27 +1200348 raise exceptions.StackResourceBuildErrorException(
349 resource_name=res.resource_name,
350 stack_identifier=stack_identifier,
351 resource_status=res.resource_status,
352 resource_status_reason=res.resource_status_reason)
353 time.sleep(build_interval)
354
355 message = ('Resource %s failed to reach %s status within '
356 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400357 (resource_name, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200358 raise exceptions.TimeoutException(message)
359
Rabi Mishra87be9b42016-02-15 14:15:50 +0530360 def verify_resource_status(self, stack_identifier, resource_name,
361 status='CREATE_COMPLETE'):
362 try:
363 res = self.client.resources.get(stack_identifier, resource_name)
364 except heat_exceptions.HTTPNotFound:
365 return False
366 return res.resource_status == status
367
rabi5eaa4962017-08-31 10:55:13 +0530368 def _verify_status(self, stack, stack_identifier, status,
369 fail_regexp, is_action_cancelled=False):
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530370 if stack.stack_status == status:
Zane Bitter8a142e32018-07-31 19:40:54 -0400371 if status == 'DELETE_COMPLETE' and stack.deletion_time is None:
Thomas Herve0e8567e2016-09-22 15:07:37 +0200372 # Wait for deleted_time to be filled, so that we have more
373 # confidence the operation is finished.
374 return False
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530375 else:
376 return True
377
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530378 wait_for_action = status.split('_')[0]
379 if (stack.action == wait_for_action and
380 fail_regexp.search(stack.stack_status)):
Zane Bitter8a142e32018-07-31 19:40:54 -0400381 raise exceptions.StackBuildErrorException(
382 stack_identifier=stack_identifier,
383 stack_status=stack.stack_status,
384 stack_status_reason=stack.stack_status_reason)
385
386 return False
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530387
Steve Baker450aa7f2014-08-25 10:37:27 +1200388 def _wait_for_stack_status(self, stack_identifier, status,
Sergey Kraynev89082a32015-09-04 04:42:33 -0400389 failure_pattern=None,
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530390 success_on_not_found=False,
391 signal_required=False,
rabi5eaa4962017-08-31 10:55:13 +0530392 resources_to_signal=None,
393 is_action_cancelled=False):
Peter Razumovskyf0ac9582015-09-24 16:49:03 +0300394 """Waits for a Stack to reach a given status.
Steve Baker450aa7f2014-08-25 10:37:27 +1200395
396 Note this compares the full $action_$status, e.g
397 CREATE_COMPLETE, not just COMPLETE which is exposed
398 via the status property of Stack in heatclient
399 """
Sergey Kraynev89082a32015-09-04 04:42:33 -0400400 if failure_pattern:
401 fail_regexp = re.compile(failure_pattern)
402 elif 'FAILED' in status:
403 # If we're looking for e.g CREATE_FAILED, COMPLETE is unexpected.
404 fail_regexp = re.compile('^.*_COMPLETE$')
405 else:
406 fail_regexp = re.compile('^.*_FAILED$')
Steve Baker450aa7f2014-08-25 10:37:27 +1200407 build_timeout = self.conf.build_timeout
408 build_interval = self.conf.build_interval
409
410 start = timeutils.utcnow()
411 while timeutils.delta_seconds(start,
412 timeutils.utcnow()) < build_timeout:
413 try:
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500414 stack = self.client.stacks.get(stack_identifier,
415 resolve_outputs=False)
Steve Baker450aa7f2014-08-25 10:37:27 +1200416 except heat_exceptions.HTTPNotFound:
417 if success_on_not_found:
418 return
419 # ignore this, as the resource may not have
420 # been created yet
421 else:
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530422 if self._verify_status(stack, stack_identifier, status,
rabi5eaa4962017-08-31 10:55:13 +0530423 fail_regexp, is_action_cancelled):
Steve Baker450aa7f2014-08-25 10:37:27 +1200424 return
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530425 if signal_required:
426 self.signal_resources(resources_to_signal)
Steve Baker450aa7f2014-08-25 10:37:27 +1200427 time.sleep(build_interval)
428
429 message = ('Stack %s failed to reach %s status within '
430 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400431 (stack_identifier, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200432 raise exceptions.TimeoutException(message)
433
434 def _stack_delete(self, stack_identifier):
435 try:
Thomas Herve3eab2942015-10-22 17:29:21 +0200436 self._handle_in_progress(self.client.stacks.delete,
437 stack_identifier)
Steve Baker450aa7f2014-08-25 10:37:27 +1200438 except heat_exceptions.HTTPNotFound:
439 pass
440 self._wait_for_stack_status(
441 stack_identifier, 'DELETE_COMPLETE',
442 success_on_not_found=True)
Steven Hardyc9efd972014-11-20 11:31:55 +0000443
Thomas Herve3eab2942015-10-22 17:29:21 +0200444 def _handle_in_progress(self, fn, *args, **kwargs):
445 build_timeout = self.conf.build_timeout
446 build_interval = self.conf.build_interval
447 start = timeutils.utcnow()
448 while timeutils.delta_seconds(start,
449 timeutils.utcnow()) < build_timeout:
450 try:
451 fn(*args, **kwargs)
452 except heat_exceptions.HTTPConflict as ex:
453 # FIXME(sirushtim): Wait a little for the stack lock to be
454 # released and hopefully, the stack should be usable again.
455 if ex.error['error']['type'] != 'ActionInProgress':
456 raise ex
457
458 time.sleep(build_interval)
459 else:
460 break
461
Steven Hardy23284b62015-10-01 19:03:42 +0100462 def update_stack(self, stack_identifier, template=None, environment=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000463 files=None, parameters=None, tags=None,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530464 expected_status='UPDATE_COMPLETE',
Steven Hardy23284b62015-10-01 19:03:42 +0100465 disable_rollback=True,
466 existing=False):
Steven Hardyc9efd972014-11-20 11:31:55 +0000467 env = environment or {}
468 env_files = files or {}
Sergey Kraynevbcc78df2015-02-27 04:34:32 -0500469 parameters = parameters or {}
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530470
Thomas Herve3eab2942015-10-22 17:29:21 +0200471 self._handle_in_progress(
472 self.client.stacks.update,
473 stack_id=stack_identifier,
Thomas Herve3eab2942015-10-22 17:29:21 +0200474 template=template,
475 files=env_files,
476 disable_rollback=disable_rollback,
477 parameters=parameters,
478 environment=env,
479 tags=tags,
480 existing=existing)
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530481
Rakesh H Sa3325d62015-04-04 19:42:29 +0530482 kwargs = {'stack_identifier': stack_identifier,
483 'status': expected_status}
484 if expected_status in ['ROLLBACK_COMPLETE']:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530485 # To trigger rollback you would intentionally fail the stack
486 # Hence check for rollback failures
487 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
488
489 self._wait_for_stack_status(**kwargs)
Steven Hardyc9efd972014-11-20 11:31:55 +0000490
rabi5eaa4962017-08-31 10:55:13 +0530491 def cancel_update_stack(self, stack_identifier, rollback=True,
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300492 expected_status='ROLLBACK_COMPLETE'):
493
494 stack_name = stack_identifier.split('/')[0]
495
rabi5eaa4962017-08-31 10:55:13 +0530496 if rollback:
497 self.client.actions.cancel_update(stack_name)
498 else:
499 self.client.actions.cancel_without_rollback(stack_name)
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300500
501 kwargs = {'stack_identifier': stack_identifier,
502 'status': expected_status}
rabi5eaa4962017-08-31 10:55:13 +0530503 if expected_status == 'UPDATE_FAILED':
504 kwargs['is_action_cancelled'] = True
505
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300506 if expected_status in ['ROLLBACK_COMPLETE']:
507 # To trigger rollback you would intentionally fail the stack
508 # Hence check for rollback failures
509 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
510
511 self._wait_for_stack_status(**kwargs)
512
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500513 def preview_update_stack(self, stack_identifier, template,
514 environment=None, files=None, parameters=None,
Steven Hardye6de2d62015-12-07 15:59:09 +0000515 tags=None, disable_rollback=True,
516 show_nested=False):
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500517 env = environment or {}
518 env_files = files or {}
519 parameters = parameters or {}
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500520
521 return self.client.stacks.preview_update(
522 stack_id=stack_identifier,
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500523 template=template,
524 files=env_files,
525 disable_rollback=disable_rollback,
526 parameters=parameters,
527 environment=env,
Steven Hardye6de2d62015-12-07 15:59:09 +0000528 tags=tags,
529 show_nested=show_nested
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500530 )
531
Steven Hardy03da0742015-03-19 00:13:17 -0400532 def assert_resource_is_a_stack(self, stack_identifier, res_name,
533 wait=False):
534 build_timeout = self.conf.build_timeout
535 build_interval = self.conf.build_interval
536 start = timeutils.utcnow()
537 while timeutils.delta_seconds(start,
538 timeutils.utcnow()) < build_timeout:
539 time.sleep(build_interval)
540 try:
541 nested_identifier = self._get_nested_identifier(
542 stack_identifier, res_name)
543 except Exception:
544 # We may have to wait, if the create is in-progress
545 if wait:
546 time.sleep(build_interval)
547 else:
548 raise
549 else:
550 return nested_identifier
551
552 def _get_nested_identifier(self, stack_identifier, res_name):
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000553 rsrc = self.client.resources.get(stack_identifier, res_name)
554 nested_link = [l for l in rsrc.links if l['rel'] == 'nested']
555 nested_href = nested_link[0]['href']
556 nested_id = nested_href.split('/')[-1]
557 nested_identifier = '/'.join(nested_href.split('/')[-2:])
558 self.assertEqual(rsrc.physical_resource_id, nested_id)
559
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500560 nested_stack = self.client.stacks.get(nested_id, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000561 nested_identifier2 = '%s/%s' % (nested_stack.stack_name,
562 nested_stack.id)
563 self.assertEqual(nested_identifier, nested_identifier2)
564 parent_id = stack_identifier.split("/")[-1]
565 self.assertEqual(parent_id, nested_stack.parent)
566 return nested_identifier
567
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530568 def group_nested_identifier(self, stack_identifier,
569 group_name):
570 # Get the nested stack identifier from a group resource
571 rsrc = self.client.resources.get(stack_identifier, group_name)
572 physical_resource_id = rsrc.physical_resource_id
573
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500574 nested_stack = self.client.stacks.get(physical_resource_id,
575 resolve_outputs=False)
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530576 nested_identifier = '%s/%s' % (nested_stack.stack_name,
577 nested_stack.id)
578 parent_id = stack_identifier.split("/")[-1]
579 self.assertEqual(parent_id, nested_stack.parent)
580 return nested_identifier
581
582 def list_group_resources(self, stack_identifier,
583 group_name, minimal=True):
584 nested_identifier = self.group_nested_identifier(stack_identifier,
585 group_name)
586 if minimal:
587 return self.list_resources(nested_identifier)
588 return self.client.resources.list(nested_identifier)
589
Steven Hardyc9efd972014-11-20 11:31:55 +0000590 def list_resources(self, stack_identifier):
591 resources = self.client.resources.list(stack_identifier)
592 return dict((r.resource_name, r.resource_type) for r in resources)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000593
Steven Hardyd448dae2016-06-14 14:57:28 +0100594 def get_resource_stack_id(self, r):
595 stack_link = [l for l in r.links if l.get('rel') == 'stack'][0]
596 return stack_link['href'].split("/")[-1]
597
Botond Zoltáne0b7aa12017-03-28 08:42:16 +0200598 def get_physical_resource_id(self, stack_identifier, resource_name):
599 try:
600 resource = self.client.resources.get(
601 stack_identifier, resource_name)
602 return resource.physical_resource_id
603 except Exception:
604 raise Exception('Resource (%s) not found in stack (%s)!' %
605 (stack_identifier, resource_name))
606
607 def get_stack_output(self, stack_identifier, output_key,
608 validate_errors=True):
609 stack = self.client.stacks.get(stack_identifier)
610 return self._stack_output(stack, output_key, validate_errors)
611
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530612 def check_input_values(self, group_resources, key, value):
613 # Check inputs for deployment and derived config
614 for r in group_resources:
615 d = self.client.software_deployments.get(
616 r.physical_resource_id)
617 self.assertEqual({key: value}, d.input_values)
618 c = self.client.software_configs.get(
619 d.config_id)
620 foo_input_c = [i for i in c.inputs if i.get('name') == key][0]
621 self.assertEqual(value, foo_input_c.get('value'))
622
623 def signal_resources(self, resources):
624 # Signal all IN_PROGRESS resources
625 for r in resources:
626 if 'IN_PROGRESS' in r.resource_status:
627 stack_id = self.get_resource_stack_id(r)
628 self.client.resources.signal(stack_id, r.resource_name)
629
Steven Hardyf2c82c02014-11-20 14:02:17 +0000630 def stack_create(self, stack_name=None, template=None, files=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000631 parameters=None, environment=None, tags=None,
632 expected_status='CREATE_COMPLETE',
Jay Dobies39c4ce42015-11-04 10:49:08 -0500633 disable_rollback=True, enable_cleanup=True,
rabi6ce8d962017-07-10 16:40:12 +0530634 environment_files=None, timeout=None):
Steven Hardyf2c82c02014-11-20 14:02:17 +0000635 name = stack_name or self._stack_rand_name()
636 templ = template or self.template
637 templ_files = files or {}
638 params = parameters or {}
639 env = environment or {}
rabi6ce8d962017-07-10 16:40:12 +0530640 timeout_mins = timeout or self.conf.build_timeout
Steven Hardyf2c82c02014-11-20 14:02:17 +0000641 self.client.stacks.create(
642 stack_name=name,
643 template=templ,
644 files=templ_files,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530645 disable_rollback=disable_rollback,
Steven Hardyf2c82c02014-11-20 14:02:17 +0000646 parameters=params,
Sabeen Syed277ea692015-02-04 23:30:02 +0000647 environment=env,
Jay Dobies39c4ce42015-11-04 10:49:08 -0500648 tags=tags,
rabi6ce8d962017-07-10 16:40:12 +0530649 environment_files=environment_files,
650 timeout_mins=timeout_mins
Steven Hardyf2c82c02014-11-20 14:02:17 +0000651 )
rabic570e0f2017-10-26 13:07:13 +0530652 if enable_cleanup:
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200653 self.addCleanup(self._stack_delete, name)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000654
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500655 stack = self.client.stacks.get(name, resolve_outputs=False)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000656 stack_identifier = '%s/%s' % (name, stack.id)
Rakesh H Sa3325d62015-04-04 19:42:29 +0530657 kwargs = {'stack_identifier': stack_identifier,
658 'status': expected_status}
Steve Bakerf6c8f122015-02-10 13:54:46 +1300659 if expected_status:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530660 if expected_status in ['ROLLBACK_COMPLETE']:
661 # To trigger rollback you would intentionally fail the stack
662 # Hence check for rollback failures
663 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
664 self._wait_for_stack_status(**kwargs)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000665 return stack_identifier
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000666
667 def stack_adopt(self, stack_name=None, files=None,
668 parameters=None, environment=None, adopt_data=None,
669 wait_for_status='ADOPT_COMPLETE'):
Rabi Mishra477efc92015-07-31 13:01:45 +0530670 if (self.conf.skip_test_stack_action_list and
671 'ADOPT' in self.conf.skip_test_stack_action_list):
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530672 self.skipTest('Testing Stack adopt disabled in conf, skipping')
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000673 name = stack_name or self._stack_rand_name()
674 templ_files = files or {}
675 params = parameters or {}
676 env = environment or {}
677 self.client.stacks.create(
678 stack_name=name,
679 files=templ_files,
680 disable_rollback=True,
681 parameters=params,
682 environment=env,
683 adopt_stack_data=adopt_data,
684 )
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200685 self.addCleanup(self._stack_delete, name)
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500686 stack = self.client.stacks.get(name, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000687 stack_identifier = '%s/%s' % (name, stack.id)
688 self._wait_for_stack_status(stack_identifier, wait_for_status)
689 return stack_identifier
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530690
691 def stack_abandon(self, stack_id):
Rabi Mishra477efc92015-07-31 13:01:45 +0530692 if (self.conf.skip_test_stack_action_list and
693 'ABANDON' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200694 self.addCleanup(self._stack_delete, stack_id)
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530695 self.skipTest('Testing Stack abandon disabled in conf, skipping')
696 info = self.client.stacks.abandon(stack_id=stack_id)
697 return info
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500698
rabi90b3ab42017-05-04 13:02:28 +0530699 def stack_snapshot(self, stack_id,
700 wait_for_status='SNAPSHOT_COMPLETE'):
701 snapshot = self.client.stacks.snapshot(stack_id=stack_id)
702 self._wait_for_stack_status(stack_id, wait_for_status)
703 return snapshot['id']
704
705 def stack_restore(self, stack_id, snapshot_id,
706 wait_for_status='RESTORE_COMPLETE'):
707 self.client.stacks.restore(stack_id, snapshot_id)
708 self._wait_for_stack_status(stack_id, wait_for_status)
709
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500710 def stack_suspend(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530711 if (self.conf.skip_test_stack_action_list and
712 'SUSPEND' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200713 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530714 self.skipTest('Testing Stack suspend disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530715 self._handle_in_progress(self.client.actions.suspend, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000716 # improve debugging by first checking the resource's state.
717 self._wait_for_all_resource_status(stack_identifier,
718 'SUSPEND_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500719 self._wait_for_stack_status(stack_identifier, 'SUSPEND_COMPLETE')
720
721 def stack_resume(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530722 if (self.conf.skip_test_stack_action_list and
723 'RESUME' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200724 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530725 self.skipTest('Testing Stack resume disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530726 self._handle_in_progress(self.client.actions.resume, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000727 # improve debugging by first checking the resource's state.
728 self._wait_for_all_resource_status(stack_identifier,
729 'RESUME_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500730 self._wait_for_stack_status(stack_identifier, 'RESUME_COMPLETE')
Steven Hardy03da0742015-03-19 00:13:17 -0400731
732 def wait_for_event_with_reason(self, stack_identifier, reason,
733 rsrc_name=None, num_expected=1):
734 build_timeout = self.conf.build_timeout
735 build_interval = self.conf.build_interval
736 start = timeutils.utcnow()
737 while timeutils.delta_seconds(start,
738 timeutils.utcnow()) < build_timeout:
739 try:
740 rsrc_events = self.client.events.list(stack_identifier,
741 resource_name=rsrc_name)
742 except heat_exceptions.HTTPNotFound:
liyi09461f72017-03-21 12:17:51 +0800743 LOG.debug("No events yet found for %s", rsrc_name)
Steven Hardy03da0742015-03-19 00:13:17 -0400744 else:
745 matched = [e for e in rsrc_events
746 if e.resource_status_reason == reason]
747 if len(matched) == num_expected:
748 return matched
749 time.sleep(build_interval)
Rakesh H Sc5735a82016-04-28 15:38:09 +0530750
Thomas Hervea6afca82017-04-10 23:44:26 +0200751 def check_autoscale_complete(self, stack_id, expected_num, parent_stack,
rabi55c0f752018-02-07 09:21:28 +0530752 group_name):
Rakesh H Sc5735a82016-04-28 15:38:09 +0530753 res_list = self.client.resources.list(stack_id)
754 all_res_complete = all(res.resource_status in ('UPDATE_COMPLETE',
755 'CREATE_COMPLETE')
756 for res in res_list)
757 all_res = len(res_list) == expected_num
Thomas Hervea6afca82017-04-10 23:44:26 +0200758 if all_res and all_res_complete:
rabi55c0f752018-02-07 09:21:28 +0530759 metadata = self.client.resources.metadata(parent_stack, group_name)
Thomas Hervea6afca82017-04-10 23:44:26 +0200760 return not metadata.get('scaling_in_progress')
761 return False