blob: c56ab40f46f7b609b4389bd587c3cd667cffde9f [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 testscenarios
25import testtools
Takashi Kajinamidfb97392022-05-10 00:51:14 +090026import urllib
Steve Baker450aa7f2014-08-25 10:37:27 +120027
rabid2916d02017-09-22 18:19:24 +053028from heat_tempest_plugin.common import exceptions
29from heat_tempest_plugin.common import remote_client
rabid2916d02017-09-22 18:19:24 +053030from heat_tempest_plugin.services import clients
Zane Bitterb4acd962018-01-18 12:08:23 -050031from tempest import config
Steve Baker450aa7f2014-08-25 10:37:27 +120032
33LOG = logging.getLogger(__name__)
Angus Salkeld24043702014-11-21 08:49:26 +100034_LOG_FORMAT = "%(levelname)8s [%(name)s] %(message)s"
rabi82b71282018-03-08 11:08:36 +053035_resource_types = None
Steve Baker450aa7f2014-08-25 10:37:27 +120036
37
Angus Salkeld08514ad2015-02-06 10:08:31 +100038def call_until_true(duration, sleep_for, func, *args, **kwargs):
Peter Razumovskyf0ac9582015-09-24 16:49:03 +030039 """Call the function until it returns True or the duration elapsed.
40
Steve Baker450aa7f2014-08-25 10:37:27 +120041 Call the given function until it returns True (and return True) or
42 until the specified duration (in seconds) elapses (and return
43 False).
44
45 :param func: A zero argument callable that returns True on success.
46 :param duration: The number of seconds for which to attempt a
47 successful call of the function.
48 :param sleep_for: The number of seconds to sleep after an unsuccessful
49 invocation of the function.
50 """
51 now = time.time()
52 timeout = now + duration
53 while now < timeout:
Angus Salkeld08514ad2015-02-06 10:08:31 +100054 if func(*args, **kwargs):
Steve Baker450aa7f2014-08-25 10:37:27 +120055 return True
56 LOG.debug("Sleeping for %d seconds", sleep_for)
57 time.sleep(sleep_for)
58 now = time.time()
59 return False
60
61
rabi32201342017-11-17 22:57:58 +053062def isotime(at):
63 if at is None:
64 return None
65 return at.strftime('%Y-%m-%dT%H:%M:%SZ')
66
67
Steve Baker450aa7f2014-08-25 10:37:27 +120068def rand_name(name=''):
Takashi Kajinamidfb97392022-05-10 00:51:14 +090069 randbits = str(random.randint(1, 0x7fffffff))
Steve Baker450aa7f2014-08-25 10:37:27 +120070 if name:
71 return name + '-' + randbits
72 else:
73 return randbits
74
75
Zane Bitterf407e102017-10-05 14:19:32 -040076def requires_convergence(test_method):
77 '''Decorator for convergence-only tests.
78
79 The decorated test will be skipped when convergence is disabled.
80 '''
rabif89752b2017-11-18 22:14:30 +053081 plugin = config.CONF.heat_plugin
rabi94a520a2017-11-17 22:49:17 +053082 convergence_enabled = plugin.convergence_engine_enabled
Zane Bitterf407e102017-10-05 14:19:32 -040083 skipper = testtools.skipUnless(convergence_enabled,
84 "Convergence-only tests are disabled")
85 return skipper(test_method)
86
87
rabi82b71282018-03-08 11:08:36 +053088def requires_resource_type(resource_type):
89 '''Decorator for tests requiring a resource type.
90
91 The decorated test will be skipped when the resource type is not available.
92 '''
93 def decorator(test_method):
94 conf = getattr(config.CONF, 'heat_plugin', None)
95 if not conf or conf.auth_url is None:
96 return test_method
97
98 global _resource_types
99 if not _resource_types:
100 manager = clients.ClientManager(conf)
101 obj_rtypes = manager.orchestration_client.resource_types.list()
102 _resource_types = list(t.resource_type for t in obj_rtypes)
103 rtype_available = resource_type and resource_type in _resource_types
104 skipper = testtools.skipUnless(
105 rtype_available,
106 "%s resource type not available, skipping test." % resource_type)
107 return skipper(test_method)
108 return decorator
109
110
Takashi Kajinami1e6b3882022-08-21 11:37:20 +0900111def requires_service(service):
112 '''Decorator for tests requiring a specific service being available.
113
114 The decorated test will be skipped when a service is not available. This
115 based on the [service_available] options implemented in tempest
116 '''
117 def decorator(test_method):
118 if not getattr(config.CONF.service_available, service, True):
119 skipper = testtools.skip(
120 "%s service not available, skipping test." % service)
121 return skipper(test_method)
122 else:
123 return test_method
124 return decorator
125
126
Rabi Mishrad6b25352018-10-17 13:11:05 +0530127def requires_service_type(service_type):
128 '''Decorator for tests requiring a specific service being available.
129
130 The decorated test will be skipped when a service is not available.
131 '''
132 def decorator(test_method):
133 conf = getattr(config.CONF, 'heat_plugin', None)
134 if not conf or conf.auth_url is None:
135 return test_method
136
137 manager = clients.ClientManager(conf)
138 try:
139 manager.identity_client.get_endpoint_url(
140 service_type, conf.region, conf.endpoint_type)
141 except kc_exceptions.EndpointNotFound:
142 skipper = testtools.skip(
Takashi Kajinami1e6b3882022-08-21 11:37:20 +0900143 "%s service type not available, skipping test." % service_type)
Rabi Mishrad6b25352018-10-17 13:11:05 +0530144 return skipper(test_method)
145 else:
146 return test_method
147 return decorator
148
149
Rabi Mishra144bdc62019-01-10 17:00:57 +0530150def _check_require(group, feature, test_method):
151 features_group = getattr(config.CONF, group, None)
152 if not features_group:
153 return test_method
154 feature_enabled = features_group.get(feature, True)
155 skipper = testtools.skipUnless(feature_enabled,
156 "%s - Feature not enabled." % feature)
157 return skipper(test_method)
158
159
rabi876449a2018-03-15 21:56:49 +0530160def requires_feature(feature):
161 '''Decorator for tests requring specific feature.
162
163 The decorated test will be skipped when a specific feature is disabled.
164 '''
165 def decorator(test_method):
Rabi Mishra144bdc62019-01-10 17:00:57 +0530166 return _check_require('heat_features_enabled', feature, test_method)
167 return decorator
168
169
170def requires_service_feature(service, feature):
Takashi Kajinami70e516a2024-01-20 18:56:19 +0900171 '''Decorator for tests requring specific service feature
Rabi Mishra144bdc62019-01-10 17:00:57 +0530172
173 The decorated test will be skipped when a specific feature is disabled.
174 '''
175 def decorator(test_method):
176 group = service + '_feature_enabled'
177 return _check_require(group, feature, test_method)
rabi876449a2018-03-15 21:56:49 +0530178 return decorator
179
180
Andrea Frittolid908bef2018-02-22 11:29:53 +0000181class HeatIntegrationTest(testtools.testcase.WithAttributes,
182 testscenarios.WithScenarios,
Angus Salkeld95f65a22014-11-24 12:38:30 +1000183 testtools.TestCase):
Steve Baker450aa7f2014-08-25 10:37:27 +1200184
185 def setUp(self):
186 super(HeatIntegrationTest, self).setUp()
187
Takashi Kajinamic4b871a2022-07-04 11:42:06 +0900188 if not config.CONF.service_available.heat:
189 raise self.skipException("Heat is not available")
190
rabif89752b2017-11-18 22:14:30 +0530191 self.conf = config.CONF.heat_plugin
Steve Baker450aa7f2014-08-25 10:37:27 +1200192
193 self.assertIsNotNone(self.conf.auth_url,
194 'No auth_url configured')
195 self.assertIsNotNone(self.conf.username,
196 'No username configured')
197 self.assertIsNotNone(self.conf.password,
198 'No password configured')
rabifd98a472016-05-24 10:18:33 +0530199 self.setup_clients(self.conf)
200 self.useFixture(fixtures.FakeLogger(format=_LOG_FORMAT))
rabifd98a472016-05-24 10:18:33 +0530201 if self.conf.disable_ssl_certificate_validation:
202 self.verify_cert = False
203 else:
204 self.verify_cert = self.conf.ca_file or True
Steve Baker450aa7f2014-08-25 10:37:27 +1200205
Steve Bakerb752e912016-08-01 22:05:37 +0000206 def setup_clients(self, conf, admin_credentials=False):
207 self.manager = clients.ClientManager(conf, admin_credentials)
Steve Baker450aa7f2014-08-25 10:37:27 +1200208 self.identity_client = self.manager.identity_client
209 self.orchestration_client = self.manager.orchestration_client
210 self.compute_client = self.manager.compute_client
211 self.network_client = self.manager.network_client
212 self.volume_client = self.manager.volume_client
Angus Salkeld4408da32015-02-03 18:53:30 +1000213 self.object_client = self.manager.object_client
rabid69f0312017-10-26 14:52:52 +0530214 self.metric_client = self.manager.metric_client
rabifd98a472016-05-24 10:18:33 +0530215
216 self.client = self.orchestration_client
217
218 def setup_clients_for_admin(self):
Steve Bakerb752e912016-08-01 22:05:37 +0000219 self.setup_clients(self.conf, True)
Steve Baker450aa7f2014-08-25 10:37:27 +1200220
Steve Baker450aa7f2014-08-25 10:37:27 +1200221 def get_remote_client(self, server_or_ip, username, private_key=None):
Takashi Kajinamidfb97392022-05-10 00:51:14 +0900222 if isinstance(server_or_ip, str):
Steve Baker450aa7f2014-08-25 10:37:27 +1200223 ip = server_or_ip
224 else:
225 network_name_for_ssh = self.conf.network_for_ssh
226 ip = server_or_ip.networks[network_name_for_ssh][0]
227 if private_key is None:
228 private_key = self.keypair.private_key
229 linux_client = remote_client.RemoteClient(ip, username,
230 pkey=private_key,
231 conf=self.conf)
232 try:
233 linux_client.validate_authentication()
234 except exceptions.SSHTimeout:
liyi09461f72017-03-21 12:17:51 +0800235 LOG.exception('ssh connection to %s failed', ip)
Steve Baker450aa7f2014-08-25 10:37:27 +1200236 raise
237
238 return linux_client
239
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400240 def check_connectivity(self, check_ip):
241 def try_connect(ip):
242 try:
Sirushti Murugesan4920fda2015-04-22 00:35:26 +0530243 urllib.request.urlopen('http://%s/' % ip)
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400244 return True
245 except IOError:
246 return False
247
248 timeout = self.conf.connectivity_timeout
249 elapsed_time = 0
250 while not try_connect(check_ip):
251 time.sleep(10)
252 elapsed_time += 10
253 if elapsed_time > timeout:
254 raise exceptions.TimeoutException()
255
Steve Baker450aa7f2014-08-25 10:37:27 +1200256 def _log_console_output(self, servers=None):
257 if not servers:
258 servers = self.compute_client.servers.list()
259 for server in servers:
Steve Baker24641292015-03-13 10:47:50 +1300260 LOG.info('Console output for %s', server.id)
261 LOG.info(server.get_console_output())
Steve Baker450aa7f2014-08-25 10:37:27 +1200262
Steve Baker450aa7f2014-08-25 10:37:27 +1200263 def create_keypair(self, client=None, name=None):
264 if client is None:
265 client = self.compute_client
266 if name is None:
267 name = rand_name('heat-keypair')
268 keypair = client.keypairs.create(name)
269 self.assertEqual(keypair.name, name)
270
271 def delete_keypair():
272 keypair.delete()
273
274 self.addCleanup(delete_keypair)
275 return keypair
276
Sergey Krayneva265c132015-02-13 03:51:03 -0500277 def assign_keypair(self):
278 if self.conf.keypair_name:
279 self.keypair = None
280 self.keypair_name = self.conf.keypair_name
281 else:
282 self.keypair = self.create_keypair()
283 self.keypair_name = self.keypair.id
284
Steve Baker450aa7f2014-08-25 10:37:27 +1200285 @classmethod
286 def _stack_rand_name(cls):
287 return rand_name(cls.__name__)
288
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400289 def _get_network(self, net_name=None):
290 if net_name is None:
291 net_name = self.conf.fixed_network_name
Steve Baker450aa7f2014-08-25 10:37:27 +1200292 networks = self.network_client.list_networks()
293 for net in networks['networks']:
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400294 if net['name'] == net_name:
Steve Baker450aa7f2014-08-25 10:37:27 +1200295 return net
296
Mark Vanderwiel6d8e0862015-10-15 12:51:07 -0500297 def is_network_extension_supported(self, extension_alias):
298 try:
299 self.network_client.show_extension(extension_alias)
300 except network_exceptions.NeutronClientException:
301 return False
302 return True
303
Steve Baker450aa7f2014-08-25 10:37:27 +1200304 @staticmethod
Angus Salkelda89a0282015-07-24 15:47:38 +1000305 def _stack_output(stack, output_key, validate_errors=True):
Steve Baker450aa7f2014-08-25 10:37:27 +1200306 """Return a stack output value for a given key."""
Angus Salkelda89a0282015-07-24 15:47:38 +1000307 value = None
308 for o in stack.outputs:
309 if validate_errors and 'output_error' in o:
310 # scan for errors in the stack output.
311 raise ValueError(
312 'Unexpected output errors in %s : %s' % (
313 output_key, o['output_error']))
314 if o['output_key'] == output_key:
315 value = o['output_value']
316 return value
Steve Baker450aa7f2014-08-25 10:37:27 +1200317
318 def _ping_ip_address(self, ip_address, should_succeed=True):
319 cmd = ['ping', '-c1', '-w1', ip_address]
320
321 def ping():
322 proc = subprocess.Popen(cmd,
323 stdout=subprocess.PIPE,
324 stderr=subprocess.PIPE)
325 proc.wait()
326 return (proc.returncode == 0) == should_succeed
327
328 return call_until_true(
Angus Salkeld08514ad2015-02-06 10:08:31 +1000329 self.conf.build_timeout, 1, ping)
Steve Baker450aa7f2014-08-25 10:37:27 +1200330
Angus Salkelda7500d12015-04-10 15:44:07 +1000331 def _wait_for_all_resource_status(self, stack_identifier,
332 status, failure_pattern='^.*_FAILED$',
333 success_on_not_found=False):
334 for res in self.client.resources.list(stack_identifier):
335 self._wait_for_resource_status(
336 stack_identifier, res.resource_name,
337 status, failure_pattern=failure_pattern,
338 success_on_not_found=success_on_not_found)
339
Steve Baker450aa7f2014-08-25 10:37:27 +1200340 def _wait_for_resource_status(self, stack_identifier, resource_name,
341 status, failure_pattern='^.*_FAILED$',
342 success_on_not_found=False):
343 """Waits for a Resource to reach a given status."""
344 fail_regexp = re.compile(failure_pattern)
345 build_timeout = self.conf.build_timeout
346 build_interval = self.conf.build_interval
347
348 start = timeutils.utcnow()
349 while timeutils.delta_seconds(start,
350 timeutils.utcnow()) < build_timeout:
351 try:
352 res = self.client.resources.get(
353 stack_identifier, resource_name)
354 except heat_exceptions.HTTPNotFound:
355 if success_on_not_found:
356 return
357 # ignore this, as the resource may not have
358 # been created yet
359 else:
360 if res.resource_status == status:
361 return
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530362 wait_for_action = status.split('_')[0]
363 resource_action = res.resource_status.split('_')[0]
364 if (resource_action == wait_for_action and
365 fail_regexp.search(res.resource_status)):
Steve Baker450aa7f2014-08-25 10:37:27 +1200366 raise exceptions.StackResourceBuildErrorException(
367 resource_name=res.resource_name,
368 stack_identifier=stack_identifier,
369 resource_status=res.resource_status,
370 resource_status_reason=res.resource_status_reason)
371 time.sleep(build_interval)
372
373 message = ('Resource %s failed to reach %s status within '
374 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400375 (resource_name, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200376 raise exceptions.TimeoutException(message)
377
Rabi Mishra87be9b42016-02-15 14:15:50 +0530378 def verify_resource_status(self, stack_identifier, resource_name,
379 status='CREATE_COMPLETE'):
380 try:
381 res = self.client.resources.get(stack_identifier, resource_name)
382 except heat_exceptions.HTTPNotFound:
383 return False
384 return res.resource_status == status
385
rabi5eaa4962017-08-31 10:55:13 +0530386 def _verify_status(self, stack, stack_identifier, status,
387 fail_regexp, is_action_cancelled=False):
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530388 if stack.stack_status == status:
Zane Bitter8a142e32018-07-31 19:40:54 -0400389 if status == 'DELETE_COMPLETE' and stack.deletion_time is None:
Thomas Herve0e8567e2016-09-22 15:07:37 +0200390 # Wait for deleted_time to be filled, so that we have more
391 # confidence the operation is finished.
392 return False
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530393 else:
394 return True
395
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530396 wait_for_action = status.split('_')[0]
397 if (stack.action == wait_for_action and
398 fail_regexp.search(stack.stack_status)):
Zane Bitter8a142e32018-07-31 19:40:54 -0400399 raise exceptions.StackBuildErrorException(
400 stack_identifier=stack_identifier,
401 stack_status=stack.stack_status,
402 stack_status_reason=stack.stack_status_reason)
403
404 return False
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530405
Steve Baker450aa7f2014-08-25 10:37:27 +1200406 def _wait_for_stack_status(self, stack_identifier, status,
Sergey Kraynev89082a32015-09-04 04:42:33 -0400407 failure_pattern=None,
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530408 success_on_not_found=False,
409 signal_required=False,
rabi5eaa4962017-08-31 10:55:13 +0530410 resources_to_signal=None,
411 is_action_cancelled=False):
Peter Razumovskyf0ac9582015-09-24 16:49:03 +0300412 """Waits for a Stack to reach a given status.
Steve Baker450aa7f2014-08-25 10:37:27 +1200413
414 Note this compares the full $action_$status, e.g
415 CREATE_COMPLETE, not just COMPLETE which is exposed
416 via the status property of Stack in heatclient
417 """
Sergey Kraynev89082a32015-09-04 04:42:33 -0400418 if failure_pattern:
419 fail_regexp = re.compile(failure_pattern)
420 elif 'FAILED' in status:
421 # If we're looking for e.g CREATE_FAILED, COMPLETE is unexpected.
422 fail_regexp = re.compile('^.*_COMPLETE$')
423 else:
424 fail_regexp = re.compile('^.*_FAILED$')
Steve Baker450aa7f2014-08-25 10:37:27 +1200425 build_timeout = self.conf.build_timeout
426 build_interval = self.conf.build_interval
427
428 start = timeutils.utcnow()
429 while timeutils.delta_seconds(start,
430 timeutils.utcnow()) < build_timeout:
431 try:
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500432 stack = self.client.stacks.get(stack_identifier,
433 resolve_outputs=False)
Steve Baker450aa7f2014-08-25 10:37:27 +1200434 except heat_exceptions.HTTPNotFound:
435 if success_on_not_found:
436 return
437 # ignore this, as the resource may not have
438 # been created yet
439 else:
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530440 if self._verify_status(stack, stack_identifier, status,
rabi5eaa4962017-08-31 10:55:13 +0530441 fail_regexp, is_action_cancelled):
Steve Baker450aa7f2014-08-25 10:37:27 +1200442 return
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530443 if signal_required:
444 self.signal_resources(resources_to_signal)
Steve Baker450aa7f2014-08-25 10:37:27 +1200445 time.sleep(build_interval)
446
447 message = ('Stack %s failed to reach %s status within '
448 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400449 (stack_identifier, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200450 raise exceptions.TimeoutException(message)
451
452 def _stack_delete(self, stack_identifier):
453 try:
Thomas Herve3eab2942015-10-22 17:29:21 +0200454 self._handle_in_progress(self.client.stacks.delete,
455 stack_identifier)
Steve Baker450aa7f2014-08-25 10:37:27 +1200456 except heat_exceptions.HTTPNotFound:
457 pass
458 self._wait_for_stack_status(
459 stack_identifier, 'DELETE_COMPLETE',
460 success_on_not_found=True)
Steven Hardyc9efd972014-11-20 11:31:55 +0000461
Thomas Herve3eab2942015-10-22 17:29:21 +0200462 def _handle_in_progress(self, fn, *args, **kwargs):
463 build_timeout = self.conf.build_timeout
464 build_interval = self.conf.build_interval
465 start = timeutils.utcnow()
466 while timeutils.delta_seconds(start,
467 timeutils.utcnow()) < build_timeout:
468 try:
469 fn(*args, **kwargs)
470 except heat_exceptions.HTTPConflict as ex:
471 # FIXME(sirushtim): Wait a little for the stack lock to be
472 # released and hopefully, the stack should be usable again.
473 if ex.error['error']['type'] != 'ActionInProgress':
474 raise ex
475
476 time.sleep(build_interval)
477 else:
478 break
479
Steven Hardy23284b62015-10-01 19:03:42 +0100480 def update_stack(self, stack_identifier, template=None, environment=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000481 files=None, parameters=None, tags=None,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530482 expected_status='UPDATE_COMPLETE',
Steven Hardy23284b62015-10-01 19:03:42 +0100483 disable_rollback=True,
484 existing=False):
Steven Hardyc9efd972014-11-20 11:31:55 +0000485 env = environment or {}
486 env_files = files or {}
Sergey Kraynevbcc78df2015-02-27 04:34:32 -0500487 parameters = parameters or {}
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530488
Thomas Herve3eab2942015-10-22 17:29:21 +0200489 self._handle_in_progress(
490 self.client.stacks.update,
491 stack_id=stack_identifier,
Thomas Herve3eab2942015-10-22 17:29:21 +0200492 template=template,
493 files=env_files,
494 disable_rollback=disable_rollback,
495 parameters=parameters,
496 environment=env,
497 tags=tags,
498 existing=existing)
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530499
Rakesh H Sa3325d62015-04-04 19:42:29 +0530500 kwargs = {'stack_identifier': stack_identifier,
501 'status': expected_status}
502 if expected_status in ['ROLLBACK_COMPLETE']:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530503 # To trigger rollback you would intentionally fail the stack
504 # Hence check for rollback failures
505 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
506
507 self._wait_for_stack_status(**kwargs)
Steven Hardyc9efd972014-11-20 11:31:55 +0000508
rabi5eaa4962017-08-31 10:55:13 +0530509 def cancel_update_stack(self, stack_identifier, rollback=True,
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300510 expected_status='ROLLBACK_COMPLETE'):
511
512 stack_name = stack_identifier.split('/')[0]
513
rabi5eaa4962017-08-31 10:55:13 +0530514 if rollback:
515 self.client.actions.cancel_update(stack_name)
516 else:
517 self.client.actions.cancel_without_rollback(stack_name)
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300518
519 kwargs = {'stack_identifier': stack_identifier,
520 'status': expected_status}
rabi5eaa4962017-08-31 10:55:13 +0530521 if expected_status == 'UPDATE_FAILED':
522 kwargs['is_action_cancelled'] = True
523
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300524 if expected_status in ['ROLLBACK_COMPLETE']:
525 # To trigger rollback you would intentionally fail the stack
526 # Hence check for rollback failures
527 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
528
529 self._wait_for_stack_status(**kwargs)
530
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500531 def preview_update_stack(self, stack_identifier, template,
532 environment=None, files=None, parameters=None,
Steven Hardye6de2d62015-12-07 15:59:09 +0000533 tags=None, disable_rollback=True,
534 show_nested=False):
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500535 env = environment or {}
536 env_files = files or {}
537 parameters = parameters or {}
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500538
539 return self.client.stacks.preview_update(
540 stack_id=stack_identifier,
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500541 template=template,
542 files=env_files,
543 disable_rollback=disable_rollback,
544 parameters=parameters,
545 environment=env,
Steven Hardye6de2d62015-12-07 15:59:09 +0000546 tags=tags,
547 show_nested=show_nested
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500548 )
549
Steven Hardy03da0742015-03-19 00:13:17 -0400550 def assert_resource_is_a_stack(self, stack_identifier, res_name,
551 wait=False):
552 build_timeout = self.conf.build_timeout
553 build_interval = self.conf.build_interval
554 start = timeutils.utcnow()
555 while timeutils.delta_seconds(start,
556 timeutils.utcnow()) < build_timeout:
557 time.sleep(build_interval)
558 try:
559 nested_identifier = self._get_nested_identifier(
560 stack_identifier, res_name)
561 except Exception:
562 # We may have to wait, if the create is in-progress
563 if wait:
564 time.sleep(build_interval)
565 else:
566 raise
567 else:
568 return nested_identifier
569
570 def _get_nested_identifier(self, stack_identifier, res_name):
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000571 rsrc = self.client.resources.get(stack_identifier, res_name)
572 nested_link = [l for l in rsrc.links if l['rel'] == 'nested']
573 nested_href = nested_link[0]['href']
574 nested_id = nested_href.split('/')[-1]
575 nested_identifier = '/'.join(nested_href.split('/')[-2:])
576 self.assertEqual(rsrc.physical_resource_id, nested_id)
577
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500578 nested_stack = self.client.stacks.get(nested_id, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000579 nested_identifier2 = '%s/%s' % (nested_stack.stack_name,
580 nested_stack.id)
581 self.assertEqual(nested_identifier, nested_identifier2)
582 parent_id = stack_identifier.split("/")[-1]
583 self.assertEqual(parent_id, nested_stack.parent)
584 return nested_identifier
585
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530586 def group_nested_identifier(self, stack_identifier,
587 group_name):
588 # Get the nested stack identifier from a group resource
589 rsrc = self.client.resources.get(stack_identifier, group_name)
590 physical_resource_id = rsrc.physical_resource_id
591
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500592 nested_stack = self.client.stacks.get(physical_resource_id,
593 resolve_outputs=False)
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530594 nested_identifier = '%s/%s' % (nested_stack.stack_name,
595 nested_stack.id)
596 parent_id = stack_identifier.split("/")[-1]
597 self.assertEqual(parent_id, nested_stack.parent)
598 return nested_identifier
599
600 def list_group_resources(self, stack_identifier,
601 group_name, minimal=True):
602 nested_identifier = self.group_nested_identifier(stack_identifier,
603 group_name)
604 if minimal:
605 return self.list_resources(nested_identifier)
606 return self.client.resources.list(nested_identifier)
607
Steven Hardyc9efd972014-11-20 11:31:55 +0000608 def list_resources(self, stack_identifier):
609 resources = self.client.resources.list(stack_identifier)
610 return dict((r.resource_name, r.resource_type) for r in resources)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000611
Steven Hardyd448dae2016-06-14 14:57:28 +0100612 def get_resource_stack_id(self, r):
613 stack_link = [l for l in r.links if l.get('rel') == 'stack'][0]
614 return stack_link['href'].split("/")[-1]
615
Botond Zoltáne0b7aa12017-03-28 08:42:16 +0200616 def get_physical_resource_id(self, stack_identifier, resource_name):
617 try:
618 resource = self.client.resources.get(
619 stack_identifier, resource_name)
620 return resource.physical_resource_id
621 except Exception:
622 raise Exception('Resource (%s) not found in stack (%s)!' %
623 (stack_identifier, resource_name))
624
625 def get_stack_output(self, stack_identifier, output_key,
626 validate_errors=True):
627 stack = self.client.stacks.get(stack_identifier)
628 return self._stack_output(stack, output_key, validate_errors)
629
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530630 def check_input_values(self, group_resources, key, value):
631 # Check inputs for deployment and derived config
632 for r in group_resources:
633 d = self.client.software_deployments.get(
634 r.physical_resource_id)
635 self.assertEqual({key: value}, d.input_values)
636 c = self.client.software_configs.get(
637 d.config_id)
638 foo_input_c = [i for i in c.inputs if i.get('name') == key][0]
639 self.assertEqual(value, foo_input_c.get('value'))
640
641 def signal_resources(self, resources):
642 # Signal all IN_PROGRESS resources
643 for r in resources:
644 if 'IN_PROGRESS' in r.resource_status:
645 stack_id = self.get_resource_stack_id(r)
646 self.client.resources.signal(stack_id, r.resource_name)
647
Steven Hardyf2c82c02014-11-20 14:02:17 +0000648 def stack_create(self, stack_name=None, template=None, files=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000649 parameters=None, environment=None, tags=None,
650 expected_status='CREATE_COMPLETE',
Jay Dobies39c4ce42015-11-04 10:49:08 -0500651 disable_rollback=True, enable_cleanup=True,
rabi6ce8d962017-07-10 16:40:12 +0530652 environment_files=None, timeout=None):
Steven Hardyf2c82c02014-11-20 14:02:17 +0000653 name = stack_name or self._stack_rand_name()
654 templ = template or self.template
655 templ_files = files or {}
656 params = parameters or {}
657 env = environment or {}
rabi6ce8d962017-07-10 16:40:12 +0530658 timeout_mins = timeout or self.conf.build_timeout
Steven Hardyf2c82c02014-11-20 14:02:17 +0000659 self.client.stacks.create(
660 stack_name=name,
661 template=templ,
662 files=templ_files,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530663 disable_rollback=disable_rollback,
Steven Hardyf2c82c02014-11-20 14:02:17 +0000664 parameters=params,
Sabeen Syed277ea692015-02-04 23:30:02 +0000665 environment=env,
Jay Dobies39c4ce42015-11-04 10:49:08 -0500666 tags=tags,
rabi6ce8d962017-07-10 16:40:12 +0530667 environment_files=environment_files,
668 timeout_mins=timeout_mins
Steven Hardyf2c82c02014-11-20 14:02:17 +0000669 )
rabic570e0f2017-10-26 13:07:13 +0530670 if enable_cleanup:
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200671 self.addCleanup(self._stack_delete, name)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000672
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500673 stack = self.client.stacks.get(name, resolve_outputs=False)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000674 stack_identifier = '%s/%s' % (name, stack.id)
Rakesh H Sa3325d62015-04-04 19:42:29 +0530675 kwargs = {'stack_identifier': stack_identifier,
676 'status': expected_status}
Steve Bakerf6c8f122015-02-10 13:54:46 +1300677 if expected_status:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530678 if expected_status in ['ROLLBACK_COMPLETE']:
679 # To trigger rollback you would intentionally fail the stack
680 # Hence check for rollback failures
681 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
682 self._wait_for_stack_status(**kwargs)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000683 return stack_identifier
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000684
685 def stack_adopt(self, stack_name=None, files=None,
686 parameters=None, environment=None, adopt_data=None,
687 wait_for_status='ADOPT_COMPLETE'):
Rabi Mishra477efc92015-07-31 13:01:45 +0530688 if (self.conf.skip_test_stack_action_list and
689 'ADOPT' in self.conf.skip_test_stack_action_list):
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530690 self.skipTest('Testing Stack adopt disabled in conf, skipping')
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000691 name = stack_name or self._stack_rand_name()
692 templ_files = files or {}
693 params = parameters or {}
694 env = environment or {}
695 self.client.stacks.create(
696 stack_name=name,
697 files=templ_files,
698 disable_rollback=True,
699 parameters=params,
700 environment=env,
701 adopt_stack_data=adopt_data,
702 )
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200703 self.addCleanup(self._stack_delete, name)
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500704 stack = self.client.stacks.get(name, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000705 stack_identifier = '%s/%s' % (name, stack.id)
706 self._wait_for_stack_status(stack_identifier, wait_for_status)
707 return stack_identifier
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530708
709 def stack_abandon(self, stack_id):
Rabi Mishra477efc92015-07-31 13:01:45 +0530710 if (self.conf.skip_test_stack_action_list and
711 'ABANDON' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200712 self.addCleanup(self._stack_delete, stack_id)
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530713 self.skipTest('Testing Stack abandon disabled in conf, skipping')
714 info = self.client.stacks.abandon(stack_id=stack_id)
715 return info
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500716
rabi90b3ab42017-05-04 13:02:28 +0530717 def stack_snapshot(self, stack_id,
718 wait_for_status='SNAPSHOT_COMPLETE'):
719 snapshot = self.client.stacks.snapshot(stack_id=stack_id)
720 self._wait_for_stack_status(stack_id, wait_for_status)
721 return snapshot['id']
722
723 def stack_restore(self, stack_id, snapshot_id,
724 wait_for_status='RESTORE_COMPLETE'):
725 self.client.stacks.restore(stack_id, snapshot_id)
726 self._wait_for_stack_status(stack_id, wait_for_status)
727
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500728 def stack_suspend(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530729 if (self.conf.skip_test_stack_action_list and
730 'SUSPEND' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200731 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530732 self.skipTest('Testing Stack suspend disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530733 self._handle_in_progress(self.client.actions.suspend, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000734 # improve debugging by first checking the resource's state.
735 self._wait_for_all_resource_status(stack_identifier,
736 'SUSPEND_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500737 self._wait_for_stack_status(stack_identifier, 'SUSPEND_COMPLETE')
738
739 def stack_resume(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530740 if (self.conf.skip_test_stack_action_list and
741 'RESUME' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200742 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530743 self.skipTest('Testing Stack resume disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530744 self._handle_in_progress(self.client.actions.resume, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000745 # improve debugging by first checking the resource's state.
746 self._wait_for_all_resource_status(stack_identifier,
747 'RESUME_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500748 self._wait_for_stack_status(stack_identifier, 'RESUME_COMPLETE')
Steven Hardy03da0742015-03-19 00:13:17 -0400749
750 def wait_for_event_with_reason(self, stack_identifier, reason,
751 rsrc_name=None, num_expected=1):
752 build_timeout = self.conf.build_timeout
753 build_interval = self.conf.build_interval
754 start = timeutils.utcnow()
755 while timeutils.delta_seconds(start,
756 timeutils.utcnow()) < build_timeout:
757 try:
758 rsrc_events = self.client.events.list(stack_identifier,
759 resource_name=rsrc_name)
760 except heat_exceptions.HTTPNotFound:
liyi09461f72017-03-21 12:17:51 +0800761 LOG.debug("No events yet found for %s", rsrc_name)
Steven Hardy03da0742015-03-19 00:13:17 -0400762 else:
763 matched = [e for e in rsrc_events
764 if e.resource_status_reason == reason]
765 if len(matched) == num_expected:
766 return matched
767 time.sleep(build_interval)
Rakesh H Sc5735a82016-04-28 15:38:09 +0530768
Thomas Hervea6afca82017-04-10 23:44:26 +0200769 def check_autoscale_complete(self, stack_id, expected_num, parent_stack,
rabi55c0f752018-02-07 09:21:28 +0530770 group_name):
Rakesh H Sc5735a82016-04-28 15:38:09 +0530771 res_list = self.client.resources.list(stack_id)
772 all_res_complete = all(res.resource_status in ('UPDATE_COMPLETE',
773 'CREATE_COMPLETE')
774 for res in res_list)
775 all_res = len(res_list) == expected_num
Thomas Hervea6afca82017-04-10 23:44:26 +0200776 if all_res and all_res_complete:
rabi55c0f752018-02-07 09:21:28 +0530777 metadata = self.client.resources.metadata(parent_stack, group_name)
Thomas Hervea6afca82017-04-10 23:44:26 +0200778 return not metadata.get('scaling_in_progress')
779 return False