openstack/python-aodhclient
Code Issues Proposed changes

support alarm type param

Browse Source 
this patch adds --type option. it is required when creating, listing,
or searching alarms. it is not an option for delete/update

Change-Id: Ib36b15f782e3cbcda5641b316c18da56023f2bf2
This commit is contained in:
gordon chung
2016-01-08 19:28:52 -05:00
parent 65b3c0ee2b
commit 86134761cd
3 changed files with 71 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
aodhclient/tests/functional/test_alarm.py
View File

@@ -12,6 +12,8 @@
import uuid import uuid
from tempest_lib import exceptions
from aodhclient.tests.functional import base from aodhclient.tests.functional import base
@@ -31,8 +33,8 @@ class AodhClientTest(base.ClientTestBase):
# CREATE # CREATE
result = self.aodh(u'alarm', result = self.aodh(u'alarm',
params=(u"create --name alarm1 -m meter_name " params=(u"create --type threshold --name alarm1 "
" --threshold 5 " " -m meter_name --threshold 5 "
"--project-id %s" % PROJECT_ID)) "--project-id %s" % PROJECT_ID))
alarm = self.details_multiple(result)[0] alarm = self.details_multiple(result)[0]
ALARM_ID = alarm['alarm_id'] ALARM_ID = alarm['alarm_id']
@@ -42,12 +44,18 @@ class AodhClientTest(base.ClientTestBase):
# CREATE FAIL # CREATE FAIL
result = self.aodh(u'alarm', result = self.aodh(u'alarm',
params=(u"create --name alarm1 -m meter_name " params=(u"create --type threshold --name alarm1 "
" --threshold 5 " "-m meter_name --threshold 5 "
"--project-id %s" % PROJECT_ID), "--project-id %s" % PROJECT_ID),
fail_ok=True, merge_stderr=True) fail_ok=True, merge_stderr=True)
self.assertEqual(result.strip(), 'Conflict (HTTP 409)') self.assertEqual(result.strip(), 'Conflict (HTTP 409)')
# CREATE FAIL MISSING PARAM
self.assertRaises(exceptions.CommandFailed,
self.aodh, u'alarm',
params=(u"create --type threshold --name alarm1 "
"--project-id %s" % PROJECT_ID))
# UPDATE # UPDATE
result = self.aodh( result = self.aodh(
'alarm', params=("update %s --severity critical --threshold 10" 'alarm', params=("update %s --severity critical --threshold 10"
@@ -68,7 +76,7 @@ class AodhClientTest(base.ClientTestBase):
self.assertEqual('10.0', alarm_show['threshold']) self.assertEqual('10.0', alarm_show['threshold'])
# LIST # LIST
result = self.aodh('alarm', params="list") result = self.aodh('alarm', params="list --type threshold")
self.assertIn(ALARM_ID, self.assertIn(ALARM_ID,
[r['alarm_id'] for r in self.parser.listing(result)]) [r['alarm_id'] for r in self.parser.listing(result)])
for alarm_list in self.parser.listing(result): for alarm_list in self.parser.listing(result):
@@ -76,7 +84,7 @@ class AodhClientTest(base.ClientTestBase):
self.assertEqual('alarm1', alarm_list['name']) self.assertEqual('alarm1', alarm_list['name'])
# SEARCH ALL # SEARCH ALL
result = self.aodh('alarm', params=("search")) result = self.aodh('alarm', params=("search --type threshold"))
self.assertIn(ALARM_ID, self.assertIn(ALARM_ID,
[r['alarm_id'] for r in self.parser.listing(result)]) [r['alarm_id'] for r in self.parser.listing(result)])
for alarm_list in self.parser.listing(result): for alarm_list in self.parser.listing(result):
@@ -85,7 +93,7 @@ class AodhClientTest(base.ClientTestBase):
# SEARCH SOME # SEARCH SOME
result = self.aodh('alarm', result = self.aodh('alarm',
params=("search --query " params=("search --type threshold --query "
"'{\"=\": {\"project_id\": \"%s\"}}'" "'{\"=\": {\"project_id\": \"%s\"}}'"
% PROJECT_ID)) % PROJECT_ID))
alarm_list = self.parser.listing(result)[0] alarm_list = self.parser.listing(result)[0]
@@ -107,6 +115,6 @@ class AodhClientTest(base.ClientTestBase):
self.assertEqual(result.strip(), "Not found (HTTP 404)") self.assertEqual(result.strip(), "Not found (HTTP 404)")
# LIST DOES NOT HAVE ALARM # LIST DOES NOT HAVE ALARM
result = self.aodh('alarm', params="list") result = self.aodh('alarm', params="list --type threshold")
self.assertNotIn(ALARM_ID, self.assertNotIn(ALARM_ID,
[r['alarm_id'] for r in self.parser.listing(result)]) [r['alarm_id'] for r in self.parser.listing(result)])

5
aodhclient/v2/alarm.py
View File

@@ -20,9 +20,10 @@ class AlarmManager(base.Manager):
url = "v2/alarms" url = "v2/alarms"
def list(self): def list(self, alarm_type):
"""List alarms""" """List alarms"""
return self._get(self.url).json() return self._get(self.url + '?q.field=type&q.op=eq' +
'&q.value=' + alarm_type).json()
def get(self, alarm_id): def get(self, alarm_id):
"""Get an alarm """Get an alarm

74
aodhclient/v2/alarm_cli.py
View File

@@ -17,7 +17,7 @@ from oslo_utils import strutils
from aodhclient import utils from aodhclient import utils
ALARM_TYPES = ['threshold']
ALARM_STATES = ['ok', 'alarm', 'insufficient data'] ALARM_STATES = ['ok', 'alarm', 'insufficient data']
ALARM_SEVERITY = ['low', 'moderate', 'critical'] ALARM_SEVERITY = ['low', 'moderate', 'critical']
ALARM_OPERATORS = ['lt', 'le', 'eq', 'ne', 'ge', 'gt'] ALARM_OPERATORS = ['lt', 'le', 'eq', 'ne', 'ge', 'gt']
@@ -27,12 +27,23 @@ STATISTICS = ['max', 'min', 'avg', 'sum', 'count']
class CliAlarmList(lister.Lister): class CliAlarmList(lister.Lister):
"""List alarms""" """List alarms"""
COLS = ('alarm_id', 'name', 'state', 'severity', 'enabled', @staticmethod
'repeat_actions', 'threshold_rule', 'time_constraints') def get_columns(alarm_type):
cols = ['alarm_id', 'name', 'state', 'severity', 'enabled',
'repeat_actions', 'time_constraints']
if alarm_type == 'threshold':
cols.append('threshold_rule')
return cols
def get_parser(self, prog_name):
parser = super(CliAlarmList, self).get_parser(prog_name)
parser.add_argument('-t', '--type', required=True,
help='Type of alarm')
return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
alarms = self.app.client.alarm.list() alarms = self.app.client.alarm.list(alarm_type=parsed_args.type)
return utils.list2cols(self.COLS, alarms) return utils.list2cols(self.get_columns(parsed_args.type), alarms)
class CliAlarmSearch(CliAlarmList): class CliAlarmSearch(CliAlarmList):
@@ -44,8 +55,13 @@ class CliAlarmSearch(CliAlarmList):
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
alarms = self.app.client.alarm.search(query=parsed_args.query) type_query = '{"=": {"type": "%s"}}' % parsed_args.type
return utils.list2cols(self.COLS, alarms) if parsed_args.query:
query = '{"and": [%s, %s]}' % (type_query, parsed_args.query)
else:
query = type_query
alarms = self.app.client.alarm.search(query=query)
return utils.list2cols(self.get_columns(parsed_args.type), alarms)
def _format_alarm(alarm): def _format_alarm(alarm):
@@ -73,6 +89,9 @@ class CliAlarmCreate(show.ShowOne):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(CliAlarmCreate, self).get_parser(prog_name) parser = super(CliAlarmCreate, self).get_parser(prog_name)
parser.add_argument('-t', '--type', metavar='<TYPE>',
required=self.create,
choices=ALARM_TYPES, help='Type of alarm')
parser.add_argument('--name', metavar='<NAME>', required=self.create, parser.add_argument('--name', metavar='<NAME>', required=self.create,
help='Name of the alarm') help='Name of the alarm')
parser.add_argument('--project-id', metavar='<PROJECT_ID>', parser.add_argument('--project-id', metavar='<PROJECT_ID>',
@@ -84,15 +103,16 @@ class CliAlarmCreate(show.ShowOne):
parser.add_argument('--description', metavar='<DESCRIPTION>', parser.add_argument('--description', metavar='<DESCRIPTION>',
help='Free text description of the alarm') help='Free text description of the alarm')
parser.add_argument('--state', metavar='<STATE>', parser.add_argument('--state', metavar='<STATE>',
choices=ALARM_STATES,
help='State of the alarm, one of: ' help='State of the alarm, one of: '
+ str(ALARM_STATES)) + str(ALARM_STATES))
parser.add_argument('--severity', metavar='<SEVERITY>', parser.add_argument('--severity', metavar='<SEVERITY>',
choices=ALARM_SEVERITY,
help='Severity of the alarm, one of: ' help='Severity of the alarm, one of: '
+ str(ALARM_SEVERITY)) + str(ALARM_SEVERITY))
parser.add_argument('--enabled', type=strutils.bool_from_string, parser.add_argument('--enabled', type=strutils.bool_from_string,
metavar='{True|False}', metavar='{True|False}',
help=('True if alarm evaluation/actioning is ' help=('True if alarm evaluation is enabled'))
'enabled'))
parser.add_argument('--alarm-action', dest='alarm_actions', parser.add_argument('--alarm-action', dest='alarm_actions',
metavar='<Webhook URL>', action='append', metavar='<Webhook URL>', action='append',
help=('URL to invoke when state transitions to ' help=('URL to invoke when state transitions to '
@@ -125,34 +145,43 @@ class CliAlarmCreate(show.ShowOne):
help=('True if actions should be repeatedly ' help=('True if actions should be repeatedly '
'notified while alarm remains in target ' 'notified while alarm remains in target '
'state')) 'state'))
parser.add_argument(
'-m', '--meter-name', metavar='<METRIC>', required=self.create, threshold_group = parser.add_argument_group('threshold alarm')
threshold_group.add_argument(
'-m', '--meter-name', metavar='<METRIC>',
dest='meter_name', help='Metric to evaluate against') dest='meter_name', help='Metric to evaluate against')
parser.add_argument( threshold_group.add_argument(
'--threshold', type=float, metavar='<THRESHOLD>',
dest='threshold', help='Threshold to evaluate against.')
threshold_group.add_argument(
'--period', type=int, metavar='<PERIOD>', dest='period', '--period', type=int, metavar='<PERIOD>', dest='period',
help='Length of each period (seconds) to evaluate over.') help='Length of each period (seconds) to evaluate over.')
parser.add_argument( threshold_group.add_argument(
'--evaluation-periods', type=int, metavar='<EVAL_PERIODS>', '--evaluation-periods', type=int, metavar='<EVAL_PERIODS>',
dest='evaluation_periods', dest='evaluation_periods',
help='Number of periods to evaluate over') help='Number of periods to evaluate over')
parser.add_argument( threshold_group.add_argument(
'--statistic', metavar='<STATISTIC>', dest='statistic', '--statistic', metavar='<STATISTIC>', dest='statistic',
choices=STATISTICS,
help='Statistic to evaluate, one of: ' + str(STATISTICS)) help='Statistic to evaluate, one of: ' + str(STATISTICS))
parser.add_argument( threshold_group.add_argument(
'--comparison-operator', metavar='<OPERATOR>', '--comparison-operator', metavar='<OPERATOR>',
dest='comparison_operator', dest='comparison_operator', choices=ALARM_OPERATORS,
help='Operator to compare with, one of: ' + str(ALARM_OPERATORS)) help='Operator to compare with, one of: ' + str(ALARM_OPERATORS))
parser.add_argument( threshold_group.add_argument(
'--threshold', type=float, metavar='<THRESHOLD>',
required=self.create, dest='threshold',
help='Threshold to evaluate against.')
parser.add_argument(
'-q', '--query', metavar='<QUERY>', dest='query', '-q', '--query', metavar='<QUERY>', dest='query',
help='key[op]data_type::value; list. data_type is optional, ' help='key[op]data_type::value; list. data_type is optional, '
'but if supplied must be string, integer, float, or boolean.') 'but if supplied must be string, integer, float, or boolean.')
self.parser = parser
return parser return parser
def _validate_args(self, parsed_args):
if (parsed_args.type == 'threshold' and
not (parsed_args.meter_name and parsed_args.threshold)):
self.parser.error('threshold requires --meter-name and '
'--threshold')
def _alarm_from_args(self, parsed_args): def _alarm_from_args(self, parsed_args):
alarm = utils.dict_from_parsed_args( alarm = utils.dict_from_parsed_args(
parsed_args, ['name', 'project_id', 'user_id', 'description', parsed_args, ['name', 'project_id', 'user_id', 'description',
@@ -164,7 +193,8 @@ class CliAlarmCreate(show.ShowOne):
'statistic', 'comparison_operator', 'threshold', 'statistic', 'comparison_operator', 'threshold',
'query']) 'query'])
if self.create: if self.create:
alarm['type'] = 'threshold' alarm['type'] = parsed_args.type
self._validate_args(parsed_args)
return alarm return alarm
def take_action(self, parsed_args): def take_action(self, parsed_args):