blob: ccbc12a22bb6374134c20c911477180897189731 [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
rabi876449a2018-03-15 21:56:49 +0530135def requires_feature(feature):
136 '''Decorator for tests requring specific feature.
137
138 The decorated test will be skipped when a specific feature is disabled.
139 '''
140 def decorator(test_method):
141 features_group = getattr(config.CONF, 'heat_features_enabled', None)
142 if not features_group:
143 return test_method
144 feature_enabled = config.CONF.heat_features_enabled.get(feature, False)
145 skipper = testtools.skipUnless(feature_enabled,
146 "%s - Feature not enabled." % feature)
147 return skipper(test_method)
148 return decorator
149
150
Andrea Frittolid908bef2018-02-22 11:29:53 +0000151class HeatIntegrationTest(testtools.testcase.WithAttributes,
152 testscenarios.WithScenarios,
Angus Salkeld95f65a22014-11-24 12:38:30 +1000153 testtools.TestCase):
Steve Baker450aa7f2014-08-25 10:37:27 +1200154
155 def setUp(self):
156 super(HeatIntegrationTest, self).setUp()
157
rabif89752b2017-11-18 22:14:30 +0530158 self.conf = config.CONF.heat_plugin
Steve Baker450aa7f2014-08-25 10:37:27 +1200159
160 self.assertIsNotNone(self.conf.auth_url,
161 'No auth_url configured')
162 self.assertIsNotNone(self.conf.username,
163 'No username configured')
164 self.assertIsNotNone(self.conf.password,
165 'No password configured')
rabifd98a472016-05-24 10:18:33 +0530166 self.setup_clients(self.conf)
167 self.useFixture(fixtures.FakeLogger(format=_LOG_FORMAT))
168 self.updated_time = {}
169 if self.conf.disable_ssl_certificate_validation:
170 self.verify_cert = False
171 else:
172 self.verify_cert = self.conf.ca_file or True
Steve Baker450aa7f2014-08-25 10:37:27 +1200173
Steve Bakerb752e912016-08-01 22:05:37 +0000174 def setup_clients(self, conf, admin_credentials=False):
175 self.manager = clients.ClientManager(conf, admin_credentials)
Steve Baker450aa7f2014-08-25 10:37:27 +1200176 self.identity_client = self.manager.identity_client
177 self.orchestration_client = self.manager.orchestration_client
178 self.compute_client = self.manager.compute_client
179 self.network_client = self.manager.network_client
180 self.volume_client = self.manager.volume_client
Angus Salkeld4408da32015-02-03 18:53:30 +1000181 self.object_client = self.manager.object_client
rabid69f0312017-10-26 14:52:52 +0530182 self.metric_client = self.manager.metric_client
rabifd98a472016-05-24 10:18:33 +0530183
184 self.client = self.orchestration_client
185
186 def setup_clients_for_admin(self):
Steve Bakerb752e912016-08-01 22:05:37 +0000187 self.setup_clients(self.conf, True)
Steve Baker450aa7f2014-08-25 10:37:27 +1200188
Steve Baker450aa7f2014-08-25 10:37:27 +1200189 def get_remote_client(self, server_or_ip, username, private_key=None):
190 if isinstance(server_or_ip, six.string_types):
191 ip = server_or_ip
192 else:
193 network_name_for_ssh = self.conf.network_for_ssh
194 ip = server_or_ip.networks[network_name_for_ssh][0]
195 if private_key is None:
196 private_key = self.keypair.private_key
197 linux_client = remote_client.RemoteClient(ip, username,
198 pkey=private_key,
199 conf=self.conf)
200 try:
201 linux_client.validate_authentication()
202 except exceptions.SSHTimeout:
liyi09461f72017-03-21 12:17:51 +0800203 LOG.exception('ssh connection to %s failed', ip)
Steve Baker450aa7f2014-08-25 10:37:27 +1200204 raise
205
206 return linux_client
207
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400208 def check_connectivity(self, check_ip):
209 def try_connect(ip):
210 try:
Sirushti Murugesan4920fda2015-04-22 00:35:26 +0530211 urllib.request.urlopen('http://%s/' % ip)
Anastasia Kuznetsova3e0ab4d2015-03-06 18:10:13 +0400212 return True
213 except IOError:
214 return False
215
216 timeout = self.conf.connectivity_timeout
217 elapsed_time = 0
218 while not try_connect(check_ip):
219 time.sleep(10)
220 elapsed_time += 10
221 if elapsed_time > timeout:
222 raise exceptions.TimeoutException()
223
Steve Baker450aa7f2014-08-25 10:37:27 +1200224 def _log_console_output(self, servers=None):
225 if not servers:
226 servers = self.compute_client.servers.list()
227 for server in servers:
Steve Baker24641292015-03-13 10:47:50 +1300228 LOG.info('Console output for %s', server.id)
229 LOG.info(server.get_console_output())
Steve Baker450aa7f2014-08-25 10:37:27 +1200230
Steve Baker450aa7f2014-08-25 10:37:27 +1200231 def create_keypair(self, client=None, name=None):
232 if client is None:
233 client = self.compute_client
234 if name is None:
235 name = rand_name('heat-keypair')
236 keypair = client.keypairs.create(name)
237 self.assertEqual(keypair.name, name)
238
239 def delete_keypair():
240 keypair.delete()
241
242 self.addCleanup(delete_keypair)
243 return keypair
244
Sergey Krayneva265c132015-02-13 03:51:03 -0500245 def assign_keypair(self):
246 if self.conf.keypair_name:
247 self.keypair = None
248 self.keypair_name = self.conf.keypair_name
249 else:
250 self.keypair = self.create_keypair()
251 self.keypair_name = self.keypair.id
252
Steve Baker450aa7f2014-08-25 10:37:27 +1200253 @classmethod
254 def _stack_rand_name(cls):
255 return rand_name(cls.__name__)
256
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400257 def _get_network(self, net_name=None):
258 if net_name is None:
259 net_name = self.conf.fixed_network_name
Steve Baker450aa7f2014-08-25 10:37:27 +1200260 networks = self.network_client.list_networks()
261 for net in networks['networks']:
Anastasia Kuznetsova673fc432015-03-12 16:41:36 +0400262 if net['name'] == net_name:
Steve Baker450aa7f2014-08-25 10:37:27 +1200263 return net
264
Mark Vanderwiel6d8e0862015-10-15 12:51:07 -0500265 def is_network_extension_supported(self, extension_alias):
266 try:
267 self.network_client.show_extension(extension_alias)
268 except network_exceptions.NeutronClientException:
269 return False
270 return True
271
Steve Baker450aa7f2014-08-25 10:37:27 +1200272 @staticmethod
Angus Salkelda89a0282015-07-24 15:47:38 +1000273 def _stack_output(stack, output_key, validate_errors=True):
Steve Baker450aa7f2014-08-25 10:37:27 +1200274 """Return a stack output value for a given key."""
Angus Salkelda89a0282015-07-24 15:47:38 +1000275 value = None
276 for o in stack.outputs:
277 if validate_errors and 'output_error' in o:
278 # scan for errors in the stack output.
279 raise ValueError(
280 'Unexpected output errors in %s : %s' % (
281 output_key, o['output_error']))
282 if o['output_key'] == output_key:
283 value = o['output_value']
284 return value
Steve Baker450aa7f2014-08-25 10:37:27 +1200285
286 def _ping_ip_address(self, ip_address, should_succeed=True):
287 cmd = ['ping', '-c1', '-w1', ip_address]
288
289 def ping():
290 proc = subprocess.Popen(cmd,
291 stdout=subprocess.PIPE,
292 stderr=subprocess.PIPE)
293 proc.wait()
294 return (proc.returncode == 0) == should_succeed
295
296 return call_until_true(
Angus Salkeld08514ad2015-02-06 10:08:31 +1000297 self.conf.build_timeout, 1, ping)
Steve Baker450aa7f2014-08-25 10:37:27 +1200298
Angus Salkelda7500d12015-04-10 15:44:07 +1000299 def _wait_for_all_resource_status(self, stack_identifier,
300 status, failure_pattern='^.*_FAILED$',
301 success_on_not_found=False):
302 for res in self.client.resources.list(stack_identifier):
303 self._wait_for_resource_status(
304 stack_identifier, res.resource_name,
305 status, failure_pattern=failure_pattern,
306 success_on_not_found=success_on_not_found)
307
Steve Baker450aa7f2014-08-25 10:37:27 +1200308 def _wait_for_resource_status(self, stack_identifier, resource_name,
309 status, failure_pattern='^.*_FAILED$',
310 success_on_not_found=False):
311 """Waits for a Resource to reach a given status."""
312 fail_regexp = re.compile(failure_pattern)
313 build_timeout = self.conf.build_timeout
314 build_interval = self.conf.build_interval
315
316 start = timeutils.utcnow()
317 while timeutils.delta_seconds(start,
318 timeutils.utcnow()) < build_timeout:
319 try:
320 res = self.client.resources.get(
321 stack_identifier, resource_name)
322 except heat_exceptions.HTTPNotFound:
323 if success_on_not_found:
324 return
325 # ignore this, as the resource may not have
326 # been created yet
327 else:
328 if res.resource_status == status:
329 return
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530330 wait_for_action = status.split('_')[0]
331 resource_action = res.resource_status.split('_')[0]
332 if (resource_action == wait_for_action and
333 fail_regexp.search(res.resource_status)):
Steve Baker450aa7f2014-08-25 10:37:27 +1200334 raise exceptions.StackResourceBuildErrorException(
335 resource_name=res.resource_name,
336 stack_identifier=stack_identifier,
337 resource_status=res.resource_status,
338 resource_status_reason=res.resource_status_reason)
339 time.sleep(build_interval)
340
341 message = ('Resource %s failed to reach %s status within '
342 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400343 (resource_name, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200344 raise exceptions.TimeoutException(message)
345
Rabi Mishra87be9b42016-02-15 14:15:50 +0530346 def verify_resource_status(self, stack_identifier, resource_name,
347 status='CREATE_COMPLETE'):
348 try:
349 res = self.client.resources.get(stack_identifier, resource_name)
350 except heat_exceptions.HTTPNotFound:
351 return False
352 return res.resource_status == status
353
rabi5eaa4962017-08-31 10:55:13 +0530354 def _verify_status(self, stack, stack_identifier, status,
355 fail_regexp, is_action_cancelled=False):
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530356 if stack.stack_status == status:
Sergey Kraynev89082a32015-09-04 04:42:33 -0400357 # Handle UPDATE_COMPLETE/FAILED case: Make sure we don't
358 # wait for a stale UPDATE_COMPLETE/FAILED status.
359 if status in ('UPDATE_FAILED', 'UPDATE_COMPLETE'):
rabi5eaa4962017-08-31 10:55:13 +0530360 if is_action_cancelled:
361 return True
362
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530363 if self.updated_time.get(
364 stack_identifier) != stack.updated_time:
365 self.updated_time[stack_identifier] = stack.updated_time
366 return True
Thomas Herve0e8567e2016-09-22 15:07:37 +0200367 elif status == 'DELETE_COMPLETE' and stack.deletion_time is None:
368 # Wait for deleted_time to be filled, so that we have more
369 # confidence the operation is finished.
370 return False
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530371 else:
372 return True
373
Sirushti Murugesane5ad25b2015-04-18 23:30:59 +0530374 wait_for_action = status.split('_')[0]
375 if (stack.action == wait_for_action and
376 fail_regexp.search(stack.stack_status)):
Sergey Kraynev89082a32015-09-04 04:42:33 -0400377 # Handle UPDATE_COMPLETE/UPDATE_FAILED case.
378 if status in ('UPDATE_FAILED', 'UPDATE_COMPLETE'):
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530379 if self.updated_time.get(
380 stack_identifier) != stack.updated_time:
381 self.updated_time[stack_identifier] = stack.updated_time
382 raise exceptions.StackBuildErrorException(
383 stack_identifier=stack_identifier,
384 stack_status=stack.stack_status,
385 stack_status_reason=stack.stack_status_reason)
386 else:
387 raise exceptions.StackBuildErrorException(
388 stack_identifier=stack_identifier,
389 stack_status=stack.stack_status,
390 stack_status_reason=stack.stack_status_reason)
391
Steve Baker450aa7f2014-08-25 10:37:27 +1200392 def _wait_for_stack_status(self, stack_identifier, status,
Sergey Kraynev89082a32015-09-04 04:42:33 -0400393 failure_pattern=None,
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530394 success_on_not_found=False,
395 signal_required=False,
rabi5eaa4962017-08-31 10:55:13 +0530396 resources_to_signal=None,
397 is_action_cancelled=False):
Peter Razumovskyf0ac9582015-09-24 16:49:03 +0300398 """Waits for a Stack to reach a given status.
Steve Baker450aa7f2014-08-25 10:37:27 +1200399
400 Note this compares the full $action_$status, e.g
401 CREATE_COMPLETE, not just COMPLETE which is exposed
402 via the status property of Stack in heatclient
403 """
Sergey Kraynev89082a32015-09-04 04:42:33 -0400404 if failure_pattern:
405 fail_regexp = re.compile(failure_pattern)
406 elif 'FAILED' in status:
407 # If we're looking for e.g CREATE_FAILED, COMPLETE is unexpected.
408 fail_regexp = re.compile('^.*_COMPLETE$')
409 else:
410 fail_regexp = re.compile('^.*_FAILED$')
Steve Baker450aa7f2014-08-25 10:37:27 +1200411 build_timeout = self.conf.build_timeout
412 build_interval = self.conf.build_interval
413
414 start = timeutils.utcnow()
415 while timeutils.delta_seconds(start,
416 timeutils.utcnow()) < build_timeout:
417 try:
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500418 stack = self.client.stacks.get(stack_identifier,
419 resolve_outputs=False)
Steve Baker450aa7f2014-08-25 10:37:27 +1200420 except heat_exceptions.HTTPNotFound:
421 if success_on_not_found:
422 return
423 # ignore this, as the resource may not have
424 # been created yet
425 else:
Sirushti Murugesan13a8a172015-04-14 00:30:05 +0530426 if self._verify_status(stack, stack_identifier, status,
rabi5eaa4962017-08-31 10:55:13 +0530427 fail_regexp, is_action_cancelled):
Steve Baker450aa7f2014-08-25 10:37:27 +1200428 return
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530429 if signal_required:
430 self.signal_resources(resources_to_signal)
Steve Baker450aa7f2014-08-25 10:37:27 +1200431 time.sleep(build_interval)
432
433 message = ('Stack %s failed to reach %s status within '
434 'the required time (%s s).' %
Anastasia Kuznetsova9a745572015-03-04 13:19:15 +0400435 (stack_identifier, status, build_timeout))
Steve Baker450aa7f2014-08-25 10:37:27 +1200436 raise exceptions.TimeoutException(message)
437
438 def _stack_delete(self, stack_identifier):
439 try:
Thomas Herve3eab2942015-10-22 17:29:21 +0200440 self._handle_in_progress(self.client.stacks.delete,
441 stack_identifier)
Steve Baker450aa7f2014-08-25 10:37:27 +1200442 except heat_exceptions.HTTPNotFound:
443 pass
444 self._wait_for_stack_status(
445 stack_identifier, 'DELETE_COMPLETE',
446 success_on_not_found=True)
Steven Hardyc9efd972014-11-20 11:31:55 +0000447
Thomas Herve3eab2942015-10-22 17:29:21 +0200448 def _handle_in_progress(self, fn, *args, **kwargs):
449 build_timeout = self.conf.build_timeout
450 build_interval = self.conf.build_interval
451 start = timeutils.utcnow()
452 while timeutils.delta_seconds(start,
453 timeutils.utcnow()) < build_timeout:
454 try:
455 fn(*args, **kwargs)
456 except heat_exceptions.HTTPConflict as ex:
457 # FIXME(sirushtim): Wait a little for the stack lock to be
458 # released and hopefully, the stack should be usable again.
459 if ex.error['error']['type'] != 'ActionInProgress':
460 raise ex
461
462 time.sleep(build_interval)
463 else:
464 break
465
Steven Hardy23284b62015-10-01 19:03:42 +0100466 def update_stack(self, stack_identifier, template=None, environment=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000467 files=None, parameters=None, tags=None,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530468 expected_status='UPDATE_COMPLETE',
Steven Hardy23284b62015-10-01 19:03:42 +0100469 disable_rollback=True,
470 existing=False):
Steven Hardyc9efd972014-11-20 11:31:55 +0000471 env = environment or {}
472 env_files = files or {}
Sergey Kraynevbcc78df2015-02-27 04:34:32 -0500473 parameters = parameters or {}
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530474
Sergey Kraynev89082a32015-09-04 04:42:33 -0400475 self.updated_time[stack_identifier] = self.client.stacks.get(
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500476 stack_identifier, resolve_outputs=False).updated_time
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530477
Thomas Herve3eab2942015-10-22 17:29:21 +0200478 self._handle_in_progress(
479 self.client.stacks.update,
480 stack_id=stack_identifier,
Thomas Herve3eab2942015-10-22 17:29:21 +0200481 template=template,
482 files=env_files,
483 disable_rollback=disable_rollback,
484 parameters=parameters,
485 environment=env,
486 tags=tags,
487 existing=existing)
Sirushti Murugesan3a195a52015-05-01 09:47:09 +0530488
Rakesh H Sa3325d62015-04-04 19:42:29 +0530489 kwargs = {'stack_identifier': stack_identifier,
490 'status': expected_status}
491 if expected_status in ['ROLLBACK_COMPLETE']:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530492 # To trigger rollback you would intentionally fail the stack
493 # Hence check for rollback failures
494 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
495
496 self._wait_for_stack_status(**kwargs)
Steven Hardyc9efd972014-11-20 11:31:55 +0000497
rabi5eaa4962017-08-31 10:55:13 +0530498 def cancel_update_stack(self, stack_identifier, rollback=True,
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300499 expected_status='ROLLBACK_COMPLETE'):
500
501 stack_name = stack_identifier.split('/')[0]
502
503 self.updated_time[stack_identifier] = self.client.stacks.get(
504 stack_identifier, resolve_outputs=False).updated_time
505
rabi5eaa4962017-08-31 10:55:13 +0530506 if rollback:
507 self.client.actions.cancel_update(stack_name)
508 else:
509 self.client.actions.cancel_without_rollback(stack_name)
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300510
511 kwargs = {'stack_identifier': stack_identifier,
512 'status': expected_status}
rabi5eaa4962017-08-31 10:55:13 +0530513 if expected_status == 'UPDATE_FAILED':
514 kwargs['is_action_cancelled'] = True
515
Oleksii Chuprykovfc2c58f2016-04-29 17:03:17 +0300516 if expected_status in ['ROLLBACK_COMPLETE']:
517 # To trigger rollback you would intentionally fail the stack
518 # Hence check for rollback failures
519 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
520
521 self._wait_for_stack_status(**kwargs)
522
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500523 def preview_update_stack(self, stack_identifier, template,
524 environment=None, files=None, parameters=None,
Steven Hardye6de2d62015-12-07 15:59:09 +0000525 tags=None, disable_rollback=True,
526 show_nested=False):
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500527 env = environment or {}
528 env_files = files or {}
529 parameters = parameters or {}
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500530
531 return self.client.stacks.preview_update(
532 stack_id=stack_identifier,
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500533 template=template,
534 files=env_files,
535 disable_rollback=disable_rollback,
536 parameters=parameters,
537 environment=env,
Steven Hardye6de2d62015-12-07 15:59:09 +0000538 tags=tags,
539 show_nested=show_nested
Jason Dunsmoreb5aa9022015-09-09 16:57:04 -0500540 )
541
Steven Hardy03da0742015-03-19 00:13:17 -0400542 def assert_resource_is_a_stack(self, stack_identifier, res_name,
543 wait=False):
544 build_timeout = self.conf.build_timeout
545 build_interval = self.conf.build_interval
546 start = timeutils.utcnow()
547 while timeutils.delta_seconds(start,
548 timeutils.utcnow()) < build_timeout:
549 time.sleep(build_interval)
550 try:
551 nested_identifier = self._get_nested_identifier(
552 stack_identifier, res_name)
553 except Exception:
554 # We may have to wait, if the create is in-progress
555 if wait:
556 time.sleep(build_interval)
557 else:
558 raise
559 else:
560 return nested_identifier
561
562 def _get_nested_identifier(self, stack_identifier, res_name):
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000563 rsrc = self.client.resources.get(stack_identifier, res_name)
564 nested_link = [l for l in rsrc.links if l['rel'] == 'nested']
565 nested_href = nested_link[0]['href']
566 nested_id = nested_href.split('/')[-1]
567 nested_identifier = '/'.join(nested_href.split('/')[-2:])
568 self.assertEqual(rsrc.physical_resource_id, nested_id)
569
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500570 nested_stack = self.client.stacks.get(nested_id, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000571 nested_identifier2 = '%s/%s' % (nested_stack.stack_name,
572 nested_stack.id)
573 self.assertEqual(nested_identifier, nested_identifier2)
574 parent_id = stack_identifier.split("/")[-1]
575 self.assertEqual(parent_id, nested_stack.parent)
576 return nested_identifier
577
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530578 def group_nested_identifier(self, stack_identifier,
579 group_name):
580 # Get the nested stack identifier from a group resource
581 rsrc = self.client.resources.get(stack_identifier, group_name)
582 physical_resource_id = rsrc.physical_resource_id
583
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500584 nested_stack = self.client.stacks.get(physical_resource_id,
585 resolve_outputs=False)
Rabi Mishra8bcff8a2015-09-21 18:15:04 +0530586 nested_identifier = '%s/%s' % (nested_stack.stack_name,
587 nested_stack.id)
588 parent_id = stack_identifier.split("/")[-1]
589 self.assertEqual(parent_id, nested_stack.parent)
590 return nested_identifier
591
592 def list_group_resources(self, stack_identifier,
593 group_name, minimal=True):
594 nested_identifier = self.group_nested_identifier(stack_identifier,
595 group_name)
596 if minimal:
597 return self.list_resources(nested_identifier)
598 return self.client.resources.list(nested_identifier)
599
Steven Hardyc9efd972014-11-20 11:31:55 +0000600 def list_resources(self, stack_identifier):
601 resources = self.client.resources.list(stack_identifier)
602 return dict((r.resource_name, r.resource_type) for r in resources)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000603
Steven Hardyd448dae2016-06-14 14:57:28 +0100604 def get_resource_stack_id(self, r):
605 stack_link = [l for l in r.links if l.get('rel') == 'stack'][0]
606 return stack_link['href'].split("/")[-1]
607
Botond Zoltáne0b7aa12017-03-28 08:42:16 +0200608 def get_physical_resource_id(self, stack_identifier, resource_name):
609 try:
610 resource = self.client.resources.get(
611 stack_identifier, resource_name)
612 return resource.physical_resource_id
613 except Exception:
614 raise Exception('Resource (%s) not found in stack (%s)!' %
615 (stack_identifier, resource_name))
616
617 def get_stack_output(self, stack_identifier, output_key,
618 validate_errors=True):
619 stack = self.client.stacks.get(stack_identifier)
620 return self._stack_output(stack, output_key, validate_errors)
621
Rabi Mishra81ca6bc2016-06-16 15:09:20 +0530622 def check_input_values(self, group_resources, key, value):
623 # Check inputs for deployment and derived config
624 for r in group_resources:
625 d = self.client.software_deployments.get(
626 r.physical_resource_id)
627 self.assertEqual({key: value}, d.input_values)
628 c = self.client.software_configs.get(
629 d.config_id)
630 foo_input_c = [i for i in c.inputs if i.get('name') == key][0]
631 self.assertEqual(value, foo_input_c.get('value'))
632
633 def signal_resources(self, resources):
634 # Signal all IN_PROGRESS resources
635 for r in resources:
636 if 'IN_PROGRESS' in r.resource_status:
637 stack_id = self.get_resource_stack_id(r)
638 self.client.resources.signal(stack_id, r.resource_name)
639
Steven Hardyf2c82c02014-11-20 14:02:17 +0000640 def stack_create(self, stack_name=None, template=None, files=None,
Sabeen Syed277ea692015-02-04 23:30:02 +0000641 parameters=None, environment=None, tags=None,
642 expected_status='CREATE_COMPLETE',
Jay Dobies39c4ce42015-11-04 10:49:08 -0500643 disable_rollback=True, enable_cleanup=True,
rabi6ce8d962017-07-10 16:40:12 +0530644 environment_files=None, timeout=None):
Steven Hardyf2c82c02014-11-20 14:02:17 +0000645 name = stack_name or self._stack_rand_name()
646 templ = template or self.template
647 templ_files = files or {}
648 params = parameters or {}
649 env = environment or {}
rabi6ce8d962017-07-10 16:40:12 +0530650 timeout_mins = timeout or self.conf.build_timeout
Steven Hardyf2c82c02014-11-20 14:02:17 +0000651 self.client.stacks.create(
652 stack_name=name,
653 template=templ,
654 files=templ_files,
Rakesh H Sa3325d62015-04-04 19:42:29 +0530655 disable_rollback=disable_rollback,
Steven Hardyf2c82c02014-11-20 14:02:17 +0000656 parameters=params,
Sabeen Syed277ea692015-02-04 23:30:02 +0000657 environment=env,
Jay Dobies39c4ce42015-11-04 10:49:08 -0500658 tags=tags,
rabi6ce8d962017-07-10 16:40:12 +0530659 environment_files=environment_files,
660 timeout_mins=timeout_mins
Steven Hardyf2c82c02014-11-20 14:02:17 +0000661 )
rabic570e0f2017-10-26 13:07:13 +0530662 if enable_cleanup:
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200663 self.addCleanup(self._stack_delete, name)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000664
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500665 stack = self.client.stacks.get(name, resolve_outputs=False)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000666 stack_identifier = '%s/%s' % (name, stack.id)
Rakesh H Sa3325d62015-04-04 19:42:29 +0530667 kwargs = {'stack_identifier': stack_identifier,
668 'status': expected_status}
Steve Bakerf6c8f122015-02-10 13:54:46 +1300669 if expected_status:
Rakesh H Sa3325d62015-04-04 19:42:29 +0530670 if expected_status in ['ROLLBACK_COMPLETE']:
671 # To trigger rollback you would intentionally fail the stack
672 # Hence check for rollback failures
673 kwargs['failure_pattern'] = '^ROLLBACK_FAILED$'
674 self._wait_for_stack_status(**kwargs)
Steven Hardyf2c82c02014-11-20 14:02:17 +0000675 return stack_identifier
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000676
677 def stack_adopt(self, stack_name=None, files=None,
678 parameters=None, environment=None, adopt_data=None,
679 wait_for_status='ADOPT_COMPLETE'):
Rabi Mishra477efc92015-07-31 13:01:45 +0530680 if (self.conf.skip_test_stack_action_list and
681 'ADOPT' in self.conf.skip_test_stack_action_list):
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530682 self.skipTest('Testing Stack adopt disabled in conf, skipping')
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000683 name = stack_name or self._stack_rand_name()
684 templ_files = files or {}
685 params = parameters or {}
686 env = environment or {}
687 self.client.stacks.create(
688 stack_name=name,
689 files=templ_files,
690 disable_rollback=True,
691 parameters=params,
692 environment=env,
693 adopt_stack_data=adopt_data,
694 )
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200695 self.addCleanup(self._stack_delete, name)
Sergey Kraynevf07f4712016-02-15 05:24:17 -0500696 stack = self.client.stacks.get(name, resolve_outputs=False)
Angus Salkeld2bd63a42015-01-07 11:11:29 +1000697 stack_identifier = '%s/%s' % (name, stack.id)
698 self._wait_for_stack_status(stack_identifier, wait_for_status)
699 return stack_identifier
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530700
701 def stack_abandon(self, stack_id):
Rabi Mishra477efc92015-07-31 13:01:45 +0530702 if (self.conf.skip_test_stack_action_list and
703 'ABANDON' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200704 self.addCleanup(self._stack_delete, stack_id)
Sirushti Murugesan04ee8022015-02-02 23:00:23 +0530705 self.skipTest('Testing Stack abandon disabled in conf, skipping')
706 info = self.client.stacks.abandon(stack_id=stack_id)
707 return info
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500708
rabi90b3ab42017-05-04 13:02:28 +0530709 def stack_snapshot(self, stack_id,
710 wait_for_status='SNAPSHOT_COMPLETE'):
711 snapshot = self.client.stacks.snapshot(stack_id=stack_id)
712 self._wait_for_stack_status(stack_id, wait_for_status)
713 return snapshot['id']
714
715 def stack_restore(self, stack_id, snapshot_id,
716 wait_for_status='RESTORE_COMPLETE'):
717 self.client.stacks.restore(stack_id, snapshot_id)
718 self._wait_for_stack_status(stack_id, wait_for_status)
719
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500720 def stack_suspend(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530721 if (self.conf.skip_test_stack_action_list and
722 'SUSPEND' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200723 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530724 self.skipTest('Testing Stack suspend disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530725 self._handle_in_progress(self.client.actions.suspend, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000726 # improve debugging by first checking the resource's state.
727 self._wait_for_all_resource_status(stack_identifier,
728 'SUSPEND_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500729 self._wait_for_stack_status(stack_identifier, 'SUSPEND_COMPLETE')
730
731 def stack_resume(self, stack_identifier):
Rabi Mishra477efc92015-07-31 13:01:45 +0530732 if (self.conf.skip_test_stack_action_list and
733 'RESUME' in self.conf.skip_test_stack_action_list):
Steve Bakerdbea6ab2015-08-19 13:37:08 +1200734 self.addCleanup(self._stack_delete, stack_identifier)
Rabi Mishra477efc92015-07-31 13:01:45 +0530735 self.skipTest('Testing Stack resume disabled in conf, skipping')
rabif7d67082016-05-17 18:51:22 +0530736 self._handle_in_progress(self.client.actions.resume, stack_identifier)
Angus Salkelda7500d12015-04-10 15:44:07 +1000737 # improve debugging by first checking the resource's state.
738 self._wait_for_all_resource_status(stack_identifier,
739 'RESUME_COMPLETE')
Oleksii Chuprykovd9cd9dc2015-02-03 10:34:55 -0500740 self._wait_for_stack_status(stack_identifier, 'RESUME_COMPLETE')
Steven Hardy03da0742015-03-19 00:13:17 -0400741
742 def wait_for_event_with_reason(self, stack_identifier, reason,
743 rsrc_name=None, num_expected=1):
744 build_timeout = self.conf.build_timeout
745 build_interval = self.conf.build_interval
746 start = timeutils.utcnow()
747 while timeutils.delta_seconds(start,
748 timeutils.utcnow()) < build_timeout:
749 try:
750 rsrc_events = self.client.events.list(stack_identifier,
751 resource_name=rsrc_name)
752 except heat_exceptions.HTTPNotFound:
liyi09461f72017-03-21 12:17:51 +0800753 LOG.debug("No events yet found for %s", rsrc_name)
Steven Hardy03da0742015-03-19 00:13:17 -0400754 else:
755 matched = [e for e in rsrc_events
756 if e.resource_status_reason == reason]
757 if len(matched) == num_expected:
758 return matched
759 time.sleep(build_interval)
Rakesh H Sc5735a82016-04-28 15:38:09 +0530760
Thomas Hervea6afca82017-04-10 23:44:26 +0200761 def check_autoscale_complete(self, stack_id, expected_num, parent_stack,
rabi55c0f752018-02-07 09:21:28 +0530762 group_name):
Rakesh H Sc5735a82016-04-28 15:38:09 +0530763 res_list = self.client.resources.list(stack_id)
764 all_res_complete = all(res.resource_status in ('UPDATE_COMPLETE',
765 'CREATE_COMPLETE')
766 for res in res_list)
767 all_res = len(res_list) == expected_num
Thomas Hervea6afca82017-04-10 23:44:26 +0200768 if all_res and all_res_complete:
rabi55c0f752018-02-07 09:21:28 +0530769 metadata = self.client.resources.metadata(parent_stack, group_name)
Thomas Hervea6afca82017-04-10 23:44:26 +0200770 return not metadata.get('scaling_in_progress')
771 return False