From 0b2a87a405c5d9fb9495f67e71c2ab5124c2cb75 Mon Sep 17 00:00:00 2001
From: Steve Baker <sbaker@redhat.com>
Date: Thu, 25 Feb 2016 14:06:13 +1300
Subject: [PATCH] Register a log formatter for stack event list

Currently "stack event list" overrides the value formatter to use for
the default log formatting style. This change creates a formatter
namespace for event list so that it can have its own custom list of
formatters.

This means that the 'log' formatter is now registered and is the
default. The formatter expects event objects rather than dicts, and
so ignores the columns argument.

The intention is that this will be the first of more custom formatters
for event list, making the effort to establish this pattern worth it.

Change-Id: I22f884f871d7467c8abadec477b3e732eb8c2150
---
 heatclient/osc/v1/event.py                 | 27 +++++++++++++++++-----
 heatclient/tests/unit/osc/v1/test_event.py |  9 ++++----
 setup.cfg                                  |  8 +++++++
 3 files changed, 33 insertions(+), 11 deletions(-)

diff --git a/heatclient/osc/v1/event.py b/heatclient/osc/v1/event.py
index feee81d5..233b3ed7 100644
--- a/heatclient/osc/v1/event.py
+++ b/heatclient/osc/v1/event.py
@@ -15,6 +15,7 @@
 import logging
 import time
 
+from cliff.formatters import base
 from cliff import lister
 from cliff import show
 from openstackclient.common import utils
@@ -88,7 +89,11 @@ class ListEvent(lister.Lister):
 
     @property
     def formatter_default(self):
-        return 'value'
+        return 'log'
+
+    @property
+    def formatter_namespace(self):
+        return 'heatclient.event.formatter.list'
 
     def get_parser(self, prog_name):
         parser = super(ListEvent, self).get_parser(prog_name)
@@ -173,8 +178,8 @@ class ListEvent(lister.Lister):
             nested_depth = 0
 
         if parsed_args.follow:
-            if parsed_args.formatter != 'value':
-                msg = _('--follow can only be specified with --format value')
+            if parsed_args.formatter != 'log':
+                msg = _('--follow can only be specified with --format log')
                 raise exc.CommandError(msg)
 
             marker = parsed_args.marker
@@ -205,9 +210,8 @@ class ListEvent(lister.Lister):
         if parsed_args.sort:
             events = utils.sort_items(events, ','.join(parsed_args.sort))
 
-        if parsed_args.formatter == 'value':
-            events = heat_utils.event_log_formatter(events).split('\n')
-            return [], [e.split(' ') for e in events]
+        if parsed_args.formatter == 'log':
+            return [], events
 
         if len(events):
             if hasattr(events[0], 'resource_name'):
@@ -220,3 +224,14 @@ class ListEvent(lister.Lister):
             columns,
             (utils.get_item_properties(s, columns) for s in events)
         )
+
+
+class LogFormatter(base.ListFormatter):
+    """A formatter which prints event objects in a log style"""
+
+    def add_argument_group(self, parser):
+        pass
+
+    def emit_list(self, column_names, data, stdout, parsed_args):
+        stdout.write(heat_utils.event_log_formatter(data))
+        stdout.write('\n')
diff --git a/heatclient/tests/unit/osc/v1/test_event.py b/heatclient/tests/unit/osc/v1/test_event.py
index 668a62e6..62bef59e 100644
--- a/heatclient/tests/unit/osc/v1/test_event.py
+++ b/heatclient/tests/unit/osc/v1/test_event.py
@@ -225,14 +225,13 @@ class TestEventList(TestEvent):
         self.assertEqual([], data)
         self.assertEqual(expected, self.fake_stdout.make_string())
 
-    def test_event_list_value_format(self):
+    def test_event_list_log_format(self):
         arglist = ['my_stack']
         expected = ('2015-11-13 10:02:17 [resource1]: CREATE_COMPLETE  '
-                    'state changed')
+                    'state changed\n')
         parsed_args = self.check_parser(self.cmd, arglist, [])
 
-        columns, data = self.cmd.take_action(parsed_args)
+        self.cmd.run(parsed_args)
 
         self.event_client.list.assert_called_with(**self.defaults)
-        self.assertEqual([], columns)
-        self.assertEqual([expected.split(' ')], data)
+        self.assertEqual(expected, self.fake_stdout.make_string())
diff --git a/setup.cfg b/setup.cfg
index 57fd8a07..8c5bd2ff 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -72,6 +72,14 @@ openstack.orchestration.v1 =
     stack_template_show = heatclient.osc.v1.stack:TemplateShowStack
     stack_update = heatclient.osc.v1.stack:UpdateStack
 
+heatclient.event.formatter.list =
+    log = heatclient.osc.v1.event:LogFormatter
+    table = cliff.formatters.table:TableFormatter
+    csv = cliff.formatters.commaseparated:CSVLister
+    value = cliff.formatters.value:ValueFormatter
+    yaml = cliff.formatters.yaml_format:YAMLFormatter
+    json = cliff.formatters.json_format:JSONFormatter
+
 [global]
 setup-hooks =
     pbr.hooks.setup_hook