Add support for new alarm-history command1.0.6

Expose the new alarm history API via the CLI.

Change-Id: I5757d309dd7143dfab83985fb51ee6d320478e3b

2 files changed, 176 insertions, 3 deletions

diff --git a/ceilometerclient/tests/v2/test_alarms.py b/ceilometerclient/tests/v2/test_alarms.py
index f64ded1..0c2fa72 100644
--- a/ceilometerclient/tests/v2/test_alarms.py
+++ b/ceilometerclient/tests/v2/test_alarms.py
@@ -20,7 +20,7 @@ import copy
 import testtools
 
 from ceilometerclient.tests import utils
-import ceilometerclient.v2.alarms
+from ceilometerclient.v2 import alarms
 
 AN_ALARM = {u'alarm_actions': [u'http://site:8000/alarm'],
             u'ok_actions': [u'http://site:8000/ok'],
@@ -108,6 +108,47 @@ del UPDATE_LEGACY_ALARM['alarm_id']
 del UPDATE_LEGACY_ALARM['timestamp']
 del UPDATE_LEGACY_ALARM['state_timestamp']
 
+FULL_DETAIL = ('{"alarm_actions": [], '
+               '"user_id": "8185aa72421a4fd396d4122cba50e1b5", '
+               '"name": "scombo", '
+               '"timestamp": "2013-10-03T08:58:33.647912", '
+               '"enabled": true, '
+               '"state_timestamp": "2013-10-03T08:58:33.647912", '
+               '"rule": {"operator": "or", "alarm_ids": '
+               '["062cc907-3a9f-4867-ab3b-fa83212b39f7"]}, '
+               '"alarm_id": "alarm-id, '
+               '"state": "insufficient data", '
+               '"insufficient_data_actions": [], '
+               '"repeat_actions": false, '
+               '"ok_actions": [], '
+               '"project_id": "57d04f24d0824b78b1ea9bcecedbda8f", '
+               '"type": "combination", '
+               '"description": "Combined state of alarms '
+               '062cc907-3a9f-4867-ab3b-fa83212b39f7"}')
+ALARM_HISTORY = [{'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                  'event_id': 'c74a8611-6553-4764-a860-c15a6aabb5d0',
+                  'timestamp': '2013-10-03T08:59:28.326000',
+                  'detail': '{"state": "alarm"}',
+                  'alarm_id': 'alarm-id',
+                  'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'type': 'state transition'},
+                 {'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                  'event_id': 'c74a8611-6553-4764-a860-c15a6aabb5d0',
+                  'timestamp': '2013-10-03T08:59:28.326000',
+                  'detail': '{"description": "combination of one"}',
+                  'alarm_id': 'alarm-id',
+                  'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'type': 'rule change'},
+                 {'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                  'event_id': '4fd7df9e-190d-4471-8884-dc5a33d5d4bb',
+                  'timestamp': '2013-10-03T08:58:33.647000',
+                  'detail': FULL_DETAIL,
+                  'alarm_id': 'alarm-id',
+                  'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                  'type': 'creation'}]
 
 fixtures = {
     '/v2/alarms':
@@ -159,6 +200,20 @@ fixtures = {
             None,
         ),
     },
+    '/v2/alarms/alarm-id/history':
+    {
+        'GET': (
+            {},
+            ALARM_HISTORY,
+        ),
+    },
+    '/v2/alarms/alarm-id/history?q.op=&q.value=NOW&q.field=timestamp':
+    {
+        'GET': (
+            {},
+            ALARM_HISTORY,
+        ),
+    },
 }
 
 
@@ -167,7 +222,7 @@ class AlarmManagerTest(testtools.TestCase):
     def setUp(self):
         super(AlarmManagerTest, self).setUp()
         self.api = utils.FakeAPI(fixtures)
-        self.mgr = ceilometerclient.v2.alarms.AlarmManager(self.api)
+        self.mgr = alarms.AlarmManager(self.api)
 
     def test_list_all(self):
         alarms = list(self.mgr.list())
@@ -261,13 +316,33 @@ class AlarmManagerTest(testtools.TestCase):
         self.assertEqual(self.api.calls, expect)
         self.assertTrue(deleted is None)
 
+    def _do_test_get_history(self, q, url):
+        history = self.mgr.get_history(q=q, alarm_id='alarm-id')
+        expect = [('GET', url, {}, None)]
+        self.assertEqual(self.api.calls, expect)
+        for i in xrange(len(history)):
+            change = history[i]
+            self.assertTrue(isinstance(change, alarms.AlarmChange))
+            for k, v in ALARM_HISTORY[i].iteritems():
+                self.assertEqual(getattr(change, k), v)
+
+    def test_get_all_history(self):
+        url = '/v2/alarms/alarm-id/history'
+        self._do_test_get_history(None, url)
+
+    def test_get_constrained_history(self):
+        q = [dict(field='timestamp', value='NOW')]
+        url = ('/v2/alarms/alarm-id/history'
+               '?q.op=&q.value=NOW&q.field=timestamp')
+        self._do_test_get_history(q, url)
+
 
 class AlarmLegacyManagerTest(testtools.TestCase):
 
     def setUp(self):
         super(AlarmLegacyManagerTest, self).setUp()
         self.api = utils.FakeAPI(fixtures)
-        self.mgr = ceilometerclient.v2.alarms.AlarmManager(self.api)
+        self.mgr = alarms.AlarmManager(self.api)
 
     def test_create(self):
         alarm = self.mgr.create(**CREATE_LEGACY_ALARM)
diff --git a/ceilometerclient/tests/v2/test_shell.py b/ceilometerclient/tests/v2/test_shell.py
index 6d5da90..402343b 100644
--- a/ceilometerclient/tests/v2/test_shell.py
+++ b/ceilometerclient/tests/v2/test_shell.py
@@ -10,9 +10,15 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+import cStringIO
 import mock
+import re
+import sys
+
+from testtools import matchers
 
 from ceilometerclient.tests import utils
+from ceilometerclient.v2 import alarms
 from ceilometerclient.v2 import shell as ceilometer_shell
 
 
@@ -37,3 +43,95 @@ class ShellAlarmStateCommandsTest(utils.BaseTestCase):
         ceilometer_shell.do_alarm_state_set(self.cc, self.args)
         self.cc.alarms.set_state.assert_called_once_with(self.ALARM_ID, 'ok')
         self.assertFalse(self.cc.alarms.get_state.called)
+
+
+class ShellAlarmHistoryCommandTest(utils.BaseTestCase):
+
+    ALARM_ID = '768ff714-8cfb-4db9-9753-d484cb33a1cc'
+    FULL_DETAIL = ('{"alarm_actions": [], '
+                   '"user_id": "8185aa72421a4fd396d4122cba50e1b5", '
+                   '"name": "scombo", '
+                   '"timestamp": "2013-10-03T08:58:33.647912", '
+                   '"enabled": true, '
+                   '"state_timestamp": "2013-10-03T08:58:33.647912", '
+                   '"rule": {"operator": "or", "alarm_ids": '
+                   '["062cc907-3a9f-4867-ab3b-fa83212b39f7"]}, '
+                   '"alarm_id": "768ff714-8cfb-4db9-9753-d484cb33a1cc", '
+                   '"state": "insufficient data", '
+                   '"insufficient_data_actions": [], '
+                   '"repeat_actions": false, '
+                   '"ok_actions": [], '
+                   '"project_id": "57d04f24d0824b78b1ea9bcecedbda8f", '
+                   '"type": "combination", '
+                   '"description": "Combined state of alarms '
+                   '062cc907-3a9f-4867-ab3b-fa83212b39f7"}')
+    ALARM_HISTORY = [{'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                      'event_id': 'c74a8611-6553-4764-a860-c15a6aabb5d0',
+                      'timestamp': '2013-10-03T08:59:28.326000',
+                      'detail': '{"state": "alarm"}',
+                      'alarm_id': '768ff714-8cfb-4db9-9753-d484cb33a1cc',
+                      'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'type': 'state transition'},
+                     {'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                      'event_id': 'c74a8611-6553-4764-a860-c15a6aabb5d0',
+                      'timestamp': '2013-10-03T08:59:28.326000',
+                      'detail': '{"description": "combination of one"}',
+                      'alarm_id': '768ff714-8cfb-4db9-9753-d484cb33a1cc',
+                      'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'type': 'rule change'},
+                     {'on_behalf_of': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'user_id': '8185aa72421a4fd396d4122cba50e1b5',
+                      'event_id': '4fd7df9e-190d-4471-8884-dc5a33d5d4bb',
+                      'timestamp': '2013-10-03T08:58:33.647000',
+                      'detail': FULL_DETAIL,
+                      'alarm_id': '768ff714-8cfb-4db9-9753-d484cb33a1cc',
+                      'project_id': '57d04f24d0824b78b1ea9bcecedbda8f',
+                      'type': 'creation'}]
+    TIMESTAMP_RE = (' +\| (\d{4})-(\d{2})-(\d{2})T'
+                    '(\d{2})\:(\d{2})\:(\d{2})\.(\d{6}) \| +')
+
+    def setUp(self):
+        super(ShellAlarmHistoryCommandTest, self).setUp()
+        self.cc = mock.Mock()
+        self.cc.alarms = mock.Mock()
+        self.args = mock.Mock()
+        self.args.alarm_id = self.ALARM_ID
+
+    def _do_test_alarm_history(self, raw_query=None, parsed_query=None):
+        self.args.query = raw_query
+        orig = sys.stdout
+        sys.stdout = cStringIO.StringIO()
+        history = [alarms.AlarmChange(mock.Mock(), change)
+                   for change in self.ALARM_HISTORY]
+        self.cc.alarms.get_history.return_value = history
+
+        try:
+            ceilometer_shell.do_alarm_history(self.cc, self.args)
+            self.cc.alarms.get_history.assert_called_once_with(
+                q=parsed_query,
+                alarm_id=self.ALARM_ID
+            )
+            out = sys.stdout.getvalue()
+            required = [
+                '.*creation%sname: scombo.*' % self.TIMESTAMP_RE,
+                '.*rule change%sdescription: combination of one.*' %
+                self.TIMESTAMP_RE,
+                '.*state transition%sstate: alarm.*' % self.TIMESTAMP_RE,
+            ]
+            for r in required:
+                self.assertThat(out, matchers.MatchesRegex(r, re.DOTALL))
+        finally:
+            sys.stdout.close()
+            sys.stdout = orig
+
+    def test_alarm_all_history(self):
+        self._do_test_alarm_history()
+
+    def test_alarm_constrained_history(self):
+        parsed_query = [dict(field='timestamp',
+                             value='2013-10-03T08:59:28',
+                             op='gt')]
+        self._do_test_alarm_history(raw_query='timestamp>2013-10-03T08:59:28',
+                                    parsed_query=parsed_query)