# # Licensed under the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. You may obtain # a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # License for the specific language governing permissions and limitations # under the License. import copy import json from ceilometerclient import exc as ceilometerclient_exc import mock import mox import six from heat.common import exception from heat.common import template_format from heat.engine.clients.os import ceilometer from heat.engine import properties as props from heat.engine import resource from heat.engine.resources.openstack.ceilometer import alarm from heat.engine import rsrc_defn from heat.engine import scheduler from heat.engine import stack as parser from heat.engine import template as tmpl from heat.tests import common from heat.tests import utils alarm_template = ''' { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "Alarm Test", "Parameters" : {}, "Resources" : { "MEMAlarmHigh": { "Type": "OS::Ceilometer::Alarm", "Properties": { "description": "Scale-up if MEM > 50% for 1 minute", "meter_name": "MemoryUtilization", "statistic": "avg", "period": "60", "evaluation_periods": "1", "threshold": "50", "alarm_actions": [], "matching_metadata": {}, "comparison_operator": "gt" } }, "signal_handler" : { "Type" : "SignalResourceType" } } } ''' not_string_alarm_template = ''' { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "Alarm Test", "Parameters" : {}, "Resources" : { "MEMAlarmHigh": { "Type": "OS::Ceilometer::Alarm", "Properties": { "description": "Scale-up if MEM > 50% for 1 minute", "meter_name": "MemoryUtilization", "statistic": "avg", "period": 60, "evaluation_periods": 1, "threshold": 50, "alarm_actions": [], "matching_metadata": {}, "comparison_operator": "gt" } }, "signal_handler" : { "Type" : "SignalResourceType" } } } ''' combination_alarm_template = ''' { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "Combination Alarm Test", "Resources" : { "CombinAlarm": { "Type": "OS::Ceilometer::CombinationAlarm", "Properties": { "description": "Do stuff in combination", "alarm_ids": ["alarm1", "alarm2"], "operator": "and", "alarm_actions": [], } } } } ''' class FakeCeilometerAlarm(object): alarm_id = 'foo' class CeilometerAlarmTest(common.HeatTestCase): def setUp(self): super(CeilometerAlarmTest, self).setUp() self.fa = mock.Mock() def create_stack(self, template=None): if template is None: template = alarm_template temp = template_format.parse(template) template = tmpl.Template(temp) ctx = utils.dummy_context() ctx.tenant_id = 'test_tenant' stack = parser.Stack(ctx, utils.random_name(), template, disable_rollback=True) stack.store() self.m.StubOutWithMock(alarm.CeilometerAlarm, 'ceilometer') alarm.CeilometerAlarm.ceilometer().MultipleTimes().AndReturn( self.fa) al = copy.deepcopy(temp['Resources']['MEMAlarmHigh']['Properties']) al['description'] = mox.IgnoreArg() al['name'] = mox.IgnoreArg() al['alarm_actions'] = mox.IgnoreArg() al['insufficient_data_actions'] = None al['ok_actions'] = None al['repeat_actions'] = True al['enabled'] = True rule = dict( period=60, evaluation_periods=1, threshold=50) for field in ['period', 'evaluation_periods', 'threshold']: del al[field] for field in ['statistic', 'comparison_operator', 'meter_name']: rule[field] = al[field] del al[field] if 'query' in al and al['query']: query = al['query'] else: query = [] if 'query' in al: del al['query'] if 'matching_metadata' in al and al['matching_metadata']: for k, v in al['matching_metadata'].items(): key = 'metadata.metering.' + k query.append(dict(field=key, op='eq', value=six.text_type(v))) if 'matching_metadata' in al: del al['matching_metadata'] if query: rule['query'] = query al['threshold_rule'] = rule al['type'] = 'threshold' self.m.StubOutWithMock(self.fa.alarms, 'create') self.fa.alarms.create(**al).AndReturn(FakeCeilometerAlarm()) return stack def test_mem_alarm_high_update_no_replace(self): ''' Make sure that we can change the update-able properties without replacing the Alarm rsrc. ''' # short circuit the alarm's references t = template_format.parse(alarm_template) properties = t['Resources']['MEMAlarmHigh']['Properties'] properties['alarm_actions'] = ['signal_handler'] properties['matching_metadata'] = {'a': 'v'} properties['query'] = [dict(field='b', op='eq', value='w')] self.stack = self.create_stack(template=json.dumps(t)) self.m.StubOutWithMock(self.fa.alarms, 'update') schema = props.schemata(alarm.CeilometerAlarm.properties_schema) exns = ['period', 'evaluation_periods', 'threshold', 'statistic', 'comparison_operator', 'meter_name', 'matching_metadata', 'query'] al2 = dict((k, mox.IgnoreArg()) for k, s in schema.items() if s.update_allowed and k not in exns) al2['alarm_id'] = mox.IgnoreArg() al2['type'] = 'threshold' al2['threshold_rule'] = dict( meter_name=properties['meter_name'], period=90, evaluation_periods=2, threshold=39, statistic='max', comparison_operator='lt', query=[ dict(field='c', op='ne', value='z'), dict(field='metadata.metering.x', op='eq', value='y') ]) self.fa.alarms.update(**al2).AndReturn(None) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] properties = copy.copy(rsrc.properties.data) properties.update({ 'comparison_operator': 'lt', 'description': 'fruity', 'evaluation_periods': '2', 'period': '90', 'enabled': True, 'repeat_actions': True, 'statistic': 'max', 'threshold': '39', 'insufficient_data_actions': [], 'alarm_actions': [], 'ok_actions': ['signal_handler'], 'matching_metadata': {'x': 'y'}, 'query': [dict(field='c', op='ne', value='z')] }) snippet = rsrc_defn.ResourceDefinition(rsrc.name, rsrc.type(), properties) scheduler.TaskRunner(rsrc.update, snippet)() self.m.VerifyAll() def test_mem_alarm_high_update_replace(self): ''' Make sure that the Alarm resource IS replaced when non-update-able properties are changed. ''' t = template_format.parse(alarm_template) properties = t['Resources']['MEMAlarmHigh']['Properties'] properties['alarm_actions'] = ['signal_handler'] properties['matching_metadata'] = {'a': 'v'} self.stack = self.create_stack(template=json.dumps(t)) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] properties = copy.copy(rsrc.properties.data) properties['meter_name'] = 'temp' snippet = rsrc_defn.ResourceDefinition(rsrc.name, rsrc.type(), properties) updater = scheduler.TaskRunner(rsrc.update, snippet) self.assertRaises(resource.UpdateReplace, updater) self.m.VerifyAll() def test_mem_alarm_suspend_resume(self): """ Make sure that the Alarm resource gets disabled on suspend and reenabled on resume. """ self.stack = self.create_stack() self.m.StubOutWithMock(self.fa.alarms, 'update') al_suspend = {'alarm_id': mox.IgnoreArg(), 'enabled': False} self.fa.alarms.update(**al_suspend).AndReturn(None) al_resume = {'alarm_id': mox.IgnoreArg(), 'enabled': True} self.fa.alarms.update(**al_resume).AndReturn(None) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] scheduler.TaskRunner(rsrc.suspend)() self.assertEqual((rsrc.SUSPEND, rsrc.COMPLETE), rsrc.state) scheduler.TaskRunner(rsrc.resume)() self.assertEqual((rsrc.RESUME, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def test_mem_alarm_high_correct_int_parameters(self): self.stack = self.create_stack(not_string_alarm_template) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) self.assertIsNone(rsrc.validate()) self.assertIsInstance(rsrc.properties['evaluation_periods'], int) self.assertIsInstance(rsrc.properties['period'], int) self.assertIsInstance(rsrc.properties['threshold'], int) self.m.VerifyAll() def test_alarm_metadata_prefix(self): t = template_format.parse(alarm_template) properties = t['Resources']['MEMAlarmHigh']['Properties'] # Test for bug/1383521, where meter_name is in NOVA_METERS properties[alarm.CeilometerAlarm.METER_NAME] = 'memory.usage' properties['matching_metadata'] = {'metadata.user_metadata.groupname': 'foo'} self.stack = self.create_stack(template=json.dumps(t)) rsrc = self.stack['MEMAlarmHigh'] rsrc.properties.data = rsrc.cfn_to_ceilometer(self.stack, properties) self.assertIsNone(rsrc.properties.data.get('matching_metadata')) query = rsrc.properties.data['threshold_rule']['query'] expected_query = [{'field': u'metadata.user_metadata.groupname', 'value': u'foo', 'op': 'eq'}] self.assertEqual(expected_query, query) def test_mem_alarm_high_correct_matching_metadata(self): t = template_format.parse(alarm_template) properties = t['Resources']['MEMAlarmHigh']['Properties'] properties['matching_metadata'] = {'fro': 'bar', 'bro': True, 'dro': 1234, 'pro': '{"Mem": {"Ala": {"Hig"}}}', 'tro': [1, 2, 3, 4]} self.stack = self.create_stack(template=json.dumps(t)) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) rsrc.properties.data = rsrc.cfn_to_ceilometer(self.stack, properties) self.assertIsNone(rsrc.properties.data.get('matching_metadata')) for key in rsrc.properties.data['threshold_rule']['query']: self.assertIsInstance(key['value'], six.text_type) self.m.VerifyAll() def test_no_matching_metadata(self): """Make sure that we can pass in an empty matching_metadata.""" t = template_format.parse(alarm_template) properties = t['Resources']['MEMAlarmHigh']['Properties'] properties['alarm_actions'] = ['signal_handler'] del properties['matching_metadata'] self.stack = self.create_stack(template=json.dumps(t)) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) self.assertIsNone(rsrc.validate()) self.m.VerifyAll() def test_mem_alarm_high_not_correct_string_parameters(self): snippet = template_format.parse(not_string_alarm_template) for p in ('period', 'evaluation_periods'): snippet['Resources']['MEMAlarmHigh']['Properties'][p] = '60a' stack = utils.parse_stack(snippet) resource_defns = stack.t.resource_definitions(stack) rsrc = alarm.CeilometerAlarm( 'MEMAlarmHigh', resource_defns['MEMAlarmHigh'], stack) error = self.assertRaises(exception.StackValidationFailed, rsrc.validate) self.assertEqual( "Property error : Resources.MEMAlarmHigh.Properties.%s: " "Value '60a' is not an integer" % p, six.text_type(error)) def test_mem_alarm_high_not_integer_parameters(self): snippet = template_format.parse(not_string_alarm_template) for p in ('period', 'evaluation_periods'): snippet['Resources']['MEMAlarmHigh']['Properties'][p] = [60] stack = utils.parse_stack(snippet) resource_defns = stack.t.resource_definitions(stack) rsrc = alarm.CeilometerAlarm( 'MEMAlarmHigh', resource_defns['MEMAlarmHigh'], stack) error = self.assertRaises(exception.StackValidationFailed, rsrc.validate) self.assertEqual( "Property error : Resources.MEMAlarmHigh.Properties.%s: " "int() argument must be a string or a number, not " "'list'" % p, six.text_type(error)) def test_mem_alarm_high_check_not_required_parameters(self): snippet = template_format.parse(not_string_alarm_template) snippet['Resources']['MEMAlarmHigh']['Properties'].pop('meter_name') stack = utils.parse_stack(snippet) resource_defns = stack.t.resource_definitions(stack) rsrc = alarm.CeilometerAlarm( 'MEMAlarmHigh', resource_defns['MEMAlarmHigh'], stack) error = self.assertRaises(exception.StackValidationFailed, rsrc.validate) self.assertEqual( "Property error : Resources.MEMAlarmHigh.Properties: " "Property meter_name not assigned", six.text_type(error)) for p in ('period', 'evaluation_periods', 'statistic', 'comparison_operator'): snippet = template_format.parse(not_string_alarm_template) snippet['Resources']['MEMAlarmHigh']['Properties'].pop(p) stack = utils.parse_stack(snippet) resource_defns = stack.t.resource_definitions(stack) rsrc = alarm.CeilometerAlarm( 'MEMAlarmHigh', resource_defns['MEMAlarmHigh'], stack) self.assertIsNone(rsrc.validate()) def test_delete_alarm_not_found(self): t = template_format.parse(alarm_template) self.stack = self.create_stack(template=json.dumps(t)) self.m.StubOutWithMock(self.fa.alarms, 'delete') self.fa.alarms.delete('foo').AndRaise( ceilometerclient_exc.HTTPNotFound()) self.m.ReplayAll() self.stack.create() rsrc = self.stack['MEMAlarmHigh'] scheduler.TaskRunner(rsrc.delete)() self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def _prepare_check_resource(self): snippet = template_format.parse(not_string_alarm_template) self.stack = utils.parse_stack(snippet) res = self.stack['MEMAlarmHigh'] res.ceilometer = mock.Mock() mock_alarm = mock.Mock(enabled=True, state='ok') res.ceilometer().alarms.get.return_value = mock_alarm return res @mock.patch.object(alarm.watchrule.WatchRule, 'load') def test_check(self, mock_load): res = self._prepare_check_resource() scheduler.TaskRunner(res.check)() self.assertEqual((res.CHECK, res.COMPLETE), res.state) @mock.patch.object(alarm.watchrule.WatchRule, 'load') def test_check_watchrule_failure(self, mock_load): res = self._prepare_check_resource() exc = alarm.exception.WatchRuleNotFound(watch_name='Boom') mock_load.side_effect = exc self.assertRaises(exception.ResourceFailure, scheduler.TaskRunner(res.check)) self.assertEqual((res.CHECK, res.FAILED), res.state) self.assertIn('Boom', res.status_reason) @mock.patch.object(alarm.watchrule.WatchRule, 'load') def test_check_alarm_failure(self, mock_load): res = self._prepare_check_resource() res.ceilometer().alarms.get.side_effect = Exception('Boom') self.assertRaises(exception.ResourceFailure, scheduler.TaskRunner(res.check)) self.assertEqual((res.CHECK, res.FAILED), res.state) self.assertIn('Boom', res.status_reason) class CombinationAlarmTest(common.HeatTestCase): def setUp(self): super(CombinationAlarmTest, self).setUp() self.fc = mock.Mock() self.m.StubOutWithMock(ceilometer.CeilometerClientPlugin, '_create') def create_alarm(self): ceilometer.CeilometerClientPlugin._create().AndReturn( self.fc) self.m.StubOutWithMock(self.fc.alarms, 'create') self.fc.alarms.create( alarm_actions=[], description=u'Do stuff in combination', enabled=True, insufficient_data_actions=None, ok_actions=None, name=mox.IgnoreArg(), type='combination', repeat_actions=True, combination_rule={'alarm_ids': [u'alarm1', u'alarm2'], 'operator': u'and'} ).AndReturn(FakeCeilometerAlarm()) snippet = template_format.parse(combination_alarm_template) self.stack = utils.parse_stack(snippet) resource_defns = self.stack.t.resource_definitions(self.stack) return alarm.CombinationAlarm( 'CombinAlarm', resource_defns['CombinAlarm'], self.stack) def test_create(self): rsrc = self.create_alarm() self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() self.assertEqual((rsrc.CREATE, rsrc.COMPLETE), rsrc.state) self.assertEqual('foo', rsrc.resource_id) self.m.VerifyAll() def test_invalid_alarm_list(self): snippet = template_format.parse(combination_alarm_template) snippet['Resources']['CombinAlarm']['Properties']['alarm_ids'] = [] stack = utils.parse_stack(snippet) resource_defns = stack.t.resource_definitions(stack) rsrc = alarm.CombinationAlarm( 'CombinAlarm', resource_defns['CombinAlarm'], stack) error = self.assertRaises(exception.StackValidationFailed, rsrc.validate) self.assertEqual( "Property error : Resources.CombinAlarm.Properties.alarm_ids: " "length (0) is out of range (min: 1, max: None)", six.text_type(error)) def test_update(self): rsrc = self.create_alarm() self.m.StubOutWithMock(self.fc.alarms, 'update') self.fc.alarms.update( alarm_id='foo', combination_rule={'alarm_ids': [u'alarm1', u'alarm3']}) self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() update_template = copy.deepcopy(rsrc.t) update_template['Properties']['alarm_ids'] = ['alarm1', 'alarm3'] scheduler.TaskRunner(rsrc.update, update_template)() self.assertEqual((rsrc.UPDATE, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def test_suspend(self): rsrc = self.create_alarm() self.m.StubOutWithMock(self.fc.alarms, 'update') self.fc.alarms.update(alarm_id='foo', enabled=False) self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() scheduler.TaskRunner(rsrc.suspend)() self.assertEqual((rsrc.SUSPEND, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def test_resume(self): rsrc = self.create_alarm() self.m.StubOutWithMock(self.fc.alarms, 'update') self.fc.alarms.update(alarm_id='foo', enabled=True) self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() rsrc.state_set(rsrc.SUSPEND, rsrc.COMPLETE) scheduler.TaskRunner(rsrc.resume)() self.assertEqual((rsrc.RESUME, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def test_delete(self): rsrc = self.create_alarm() self.m.StubOutWithMock(self.fc.alarms, 'delete') self.fc.alarms.delete('foo') self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() scheduler.TaskRunner(rsrc.delete)() self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def test_delete_not_found(self): rsrc = self.create_alarm() self.m.StubOutWithMock(self.fc.alarms, 'delete') self.fc.alarms.delete('foo').AndRaise( ceilometerclient_exc.HTTPNotFound()) self.m.ReplayAll() scheduler.TaskRunner(rsrc.create)() scheduler.TaskRunner(rsrc.delete)() self.assertEqual((rsrc.DELETE, rsrc.COMPLETE), rsrc.state) self.m.VerifyAll() def _prepare_check_resource(self): snippet = template_format.parse(combination_alarm_template) self.stack = utils.parse_stack(snippet) res = self.stack['CombinAlarm'] res.ceilometer = mock.Mock() mock_alarm = mock.Mock(enabled=True, state='ok') res.ceilometer().alarms.get.return_value = mock_alarm return res def test_check(self): res = self._prepare_check_resource() scheduler.TaskRunner(res.check)() self.assertEqual((res.CHECK, res.COMPLETE), res.state) def test_check_failure(self): res = self._prepare_check_resource() res.ceilometer().alarms.get.side_effect = Exception('Boom') self.assertRaises(exception.ResourceFailure, scheduler.TaskRunner(res.check)) self.assertEqual((res.CHECK, res.FAILED), res.state) self.assertIn('Boom', res.status_reason)