Merge lp:~rvb/maas/event-display into lp:~maas-committers/maas/trunk

[Raphaël Badin]

Add node event log UI: the latest 5 events are displayed on the node view page along with a link to see the full node event log.

[Blake Rouse (blake-rouse)]

Looks good just a couple of things.

review: Approve

[Raphaël Badin (rvb)]

Thanks for the review!

=== modified file 'src/maasserver/models/eventtype.py'
--- src/maasserver/models/eventtype.py	2014-07-21 08:06:28 +0000
+++ src/maasserver/models/eventtype.py	2014-08-01 13:36:30 +0000
@@ -17,6 +17,8 @@
     ]
 
 
+import logging
+
 from django.db.models import (
     CharField,
     IntegerField,
@@ -25,6 +27,15 @@
 from maasserver.models.cleansave import CleanSave
 from maasserver.models.timestampedmodel import TimestampedModel
 
+# Describes how the log levels are displayed in the UI.
+LOGGING_LEVELS = {
+    logging.DEBUG: 'DEBUG',
+    logging.INFO: 'INFO',
+    logging.WARNING: 'WARNING',
+    logging.ERROR: 'ERROR',
+    logging.CRITICAL: 'CRITICAL',
+}
+
 
 class EventType(CleanSave, TimestampedModel):
     """A type for events.
@@ -42,6 +53,11 @@
 
     level = IntegerField(blank=False, editable=False)
 
+    @property
+    def level_str(self):
+        """A human-readable version of the log level."""
+        return LOGGING_LEVELS[self.level]
+
     class Meta(DefaultMeta):
         verbose_name = "Event type"
 

=== modified file 'src/maasserver/models/tests/test_eventtype.py'
--- src/maasserver/models/tests/test_eventtype.py	2014-07-21 09:47:06 +0000
+++ src/maasserver/models/tests/test_eventtype.py	2014-08-01 13:36:30 +0000
@@ -14,6 +14,7 @@
 __metaclass__ = type
 __all__ = []
 
+from maasserver.models.eventtype import LOGGING_LEVELS
 from maasserver.testing.factory import factory
 from maasserver.testing.testcase import MAASServerTestCase
 
@@ -23,3 +24,17 @@
     def test_displays_event_type_description(self):
         event_type = factory.make_event_type()
         self.assertIn(event_type.description, "%s" % event_type)
+
+    def test_level_str_returns_level_description(self):
+        events_and_levels = [
+            (
+                level,
+                factory.make_event(type=factory.make_event_type(level=level))
+            )
+            for level in LOGGING_LEVELS
+        ]
+
+        self.assertEquals(
+            [event.type.level_str for level, event in events_and_levels],
+            [LOGGING_LEVELS[level] for level, event in events_and_levels],
+        )

=== modified file 'src/maasserver/static/css/components/table_list.css'
--- src/maasserver/static/css/components/table_list.css	2014-02-25 07:27:05 +0000
+++ src/maasserver/static/css/components/table_list.css	2014-08-01 13:36:30 +0000
@@ -43,6 +43,14 @@
     }
 
 table.list tr.warning {
+    background-color: #FEEFB3;
+    }
+
+table.list tr.error, table.list tr.critical {
+    background-color: #FFBABA;
+    }
+
+table.list tr.critical {
     background-color: #ecd7a9;
     }
 

=== added file 'src/maasserver/templates/maasserver/node_event_list.html'
--- src/maasserver/templates/maasserver/node_event_list.html	1970-01-01 00:00:00 +0000
+++ src/maasserver/templates/maasserver/node_event_list.html	2014-08-01 13:36:30 +0000
@@ -0,0 +1,15 @@
+{% extends "maasserver/base.html" %}
+
+{% block nav-active-event-list %}active{% endblock %}
+{% block title %}Events{% endblock %}
+{% block page-title %}
+  {{ paginator.count }} event{{ paginator.count|pluralize }}
+  for node {{ node.hostname }}
+{% endblock %}
+
+{% block html_includes %}{% include "maasserver/snippets.html" %}
+{% endblock %}
+
+{% block content %}
+    {% include "maasserver/node_event_list_snippet.html" %}
+{% endblock %}

=== added file 'src/maasserver/templates/maasserver/node_event_list_snippet.html'
--- src/maasserver/templates/maasserver/node_event_list_snippet.html	1970-01-01 00:00:00 +0000
+++ src/maasserver/templates/maasserver/node_event_list_snippet.html	2014-08-01 13:36:30 +0000
@@ -0,0 +1,35 @@
+<div id="node_event_list">
+  {% if event_list %}
+  <table class="list">
+    <thead>
+      <tr>
+        <th>Level</th>
+        <th>Timestamp</th>
+        <th>Event</th>
+        </tr>
+    </thead>
+    <tbody>
+      {% for event_item in event_list %}
+      <tr {% if event_item.type.level_str == 'WARNING' %} class="warning"
+          {% elif event_item.type.level_str == 'ERROR' %} class="error"
+          {% elif event_item.type.level_str == 'CRITICAL' %} class="critical"
+          {% endif %} id="{{ event_item.id }}">
+        <td width="10%">{{ event_item.type.level_str }}</td>
+        <td width="30%">{{ event_item.created|date:'Y-m-d H:i:s' }}</td>
+        <td class="event_description">
+        {{ event_item.type.description }} 
+        {% if event_item.description %}
+        / {{ event_item.description }}
+        {% endif %}
+        </td>
+        <td></td>
+      </tr>
+      {% endfor %}
+    </tbody>
+  </table>
+  {% include "maasserver/pagination.html" %}
+  {% else %}
+  No event.
+  {% endif %}
+  <div class="clear"></div>
+</div>

=== modified file 'src/maasserver/templates/maasserver/node_view.html'
--- src/maasserver/templates/maasserver/node_view.html	2014-04-15 12:51:56 +0000
+++ src/maasserver/templates/maasserver/node_view.html	2014-08-01 13:36:30 +0000
@@ -222,6 +222,13 @@
         </span>
       </li>
     {% endif %}
+    <li class="block first separate">
+      <h2>Latest node events</h2>
+      {% include "maasserver/node_event_list_snippet.html" %}
+      {% if event_count != 0 %}
+        <a href="{% url 'node-event-list-view' object.system_id %}">Full node event log ({{ event_count }} events).</a>
+      {% endif %}
+    </li>
     {% if probed_details %}
       <li class="block first separate">
         <h2>Raw discovery data</h2>

=== modified file 'src/maasserver/urls.py'
--- src/maasserver/urls.py	2014-07-16 01:12:00 +0000
+++ src/maasserver/urls.py	2014-08-01 13:36:30 +0000
@@ -54,6 +54,7 @@
     MacDelete,
     NodeDelete,
     NodeEdit,
+    NodeEventListView,
     NodeListView,
     NodePreseedView,
     NodeView,
@@ -143,6 +144,9 @@
     url(r'^nodes/enlist-preseed/$', enlist_preseed_view,
         name='enlist-preseed-view'),
     url(
+        r'^nodes/(?P<system_id>[\w\-]+)/events/$', NodeEventListView.as_view(),
+        name='node-event-list-view'),
+    url(
         r'^nodes/(?P<system_id>[\w\-]+)/view/$', NodeView.as_view(),
         name='node-view'),
     url(

=== modified file 'src/maasserver/views/nodes.py'
--- src/maasserver/views/nodes.py	2014-07-31 16:00:15 +0000
+++ src/maasserver/views/nodes.py	2014-08-01 13:36:30 +0000
@@ -17,6 +17,7 @@
     'MacAdd',
     'MacDelete',
     'NodeDelete',
+    'NodeEventListView',
     'NodeListView',
     'NodePreseedView',
     'NodeView',
@@ -74,6 +75,7 @@
     Tag,
     )
 from maasserver.models.config import Config
+from maasserver.models.event import Event
 from maasserver.models.nodeprobeddetails import get_single_probed_details
 from maasserver.node_action import ACTIONS_DICT
 from maasserver.node_constraint_filter_forms import (
@@ -522,6 +524,9 @@
     def get_form_class(self):
         return get_action_form(self.request.user, self.request)
 
+    # The number of events shown on the node view page.
+    number_of_events_shown = 5
+
     def get_context_data(self, **kwargs):
         context = super(NodeView, self).get_context_data(**kwargs)
         node = self.get_object()
@@ -561,6 +566,13 @@
             'enable_third_party_drivers')
         context['drivers'] = get_third_party_driver(node)
 
+        event_list = (
+            Event.objects.filter(node=self.get_object())
+            .order_by('-id')[:self.number_of_events_shown])
+        context['event_list'] = event_list
+        context['event_count'] = Event.objects.filter(
+            node=self.get_object()).count()
+
         return context
 
     def dispatch(self, *args, **kwargs):
@@ -579,6 +591,23 @@
         return reverse('node-view', args=[self.get_object().system_id])
 
 
+class NodeEventListView(NodeViewMixin, PaginatedListView):
+
+    context_object_name = "event_list"
+
+    template_name = "maasserver/node_event_list.html"
+
+    def get_queryset(self):
+        return Event.objects.filter(
+            node=self.get_object()).order_by('-id')
+
+    def get_context_data(self, **kwargs):
+        context = super(NodeEventListView, self).get_context_data(**kwargs)
+        node = self.get_object()
+        context['node'] = node
+        return context
+
+
 class NodeEdit(UpdateView):
 
     template_name = 'maasserver/node_edit.html'

=== modified file 'src/maasserver/views/tests/test_nodes.py'
--- src/maasserver/views/tests/test_nodes.py	2014-07-31 10:56:18 +0000
+++ src/maasserver/views/tests/test_nodes.py	2014-08-01 13:36:30 +0000
@@ -66,7 +66,11 @@
 from maasserver.third_party_drivers import get_third_party_driver
 from maasserver.utils.orm import get_one
 from maasserver.views import nodes as nodes_views
-from maasserver.views.nodes import message_from_form_stats
+from maasserver.views.nodes import (
+    message_from_form_stats,
+    NodeEventListView,
+    NodeView,
+    )
 from maastesting.djangotestcase import count_queries
 from metadataserver.models.commissioningscript import (
     LIST_MODALIASES_OUTPUT_NAME,
@@ -1149,6 +1153,93 @@
         response = self.client.get(reverse('node-view', args=[node.system_id]))
         self.assertNotIn("Third Party Drivers", response.content)
 
+    def test_node_view_show_latest_node_events(self):
+        self.client_log_in()
+        node = factory.make_node()
+        # Create old events.
+        [
+            factory.make_event(node=node)
+            for _ in range(4)
+        ]
+        # Create NodeView.number_of_events_shown events.
+        events = [
+            factory.make_event(node=node)
+            for _ in range(NodeView.number_of_events_shown)
+        ]
+        response = self.client.get(reverse('node-view', args=[node.system_id]))
+        self.assertIn("Latest node events", response.content)
+        document = fromstring(response.content)
+        events_displayed = document.xpath(
+            "//div[@id='node_event_list']//td[@class='event_description']")
+        self.assertItemsEqual(
+            [event.type.description for event in events],
+            [display.text_content().strip() for display in events_displayed]
+        )
+
+    def test_node_view_doesnt_show_events_from_other_nodes(self):
+        self.client_log_in()
+        node = factory.make_node()
+        # Create an event related to another node.
+        event = factory.make_event()
+        response = self.client.get(
+            reverse('node-view', args=[node.system_id]))
+        self.assertIn("Latest node events", response.content)
+        document = fromstring(response.content)
+        events_displayed = document.xpath("//div[@id='node_event_list']")
+        self.assertNotIn(
+            event.type.description,
+            events_displayed[0].text_content().strip(),
+        )
+
+    def test_node_view_contains_link_to_node_event_log(self):
+        self.client_log_in()
+        node = factory.make_node()
+        # Create an event related to another node.
+        [
+            factory.make_event(node=node)
+            for _ in range(4)
+        ]
+        response = self.client.get(
+            reverse('node-view', args=[node.system_id]))
+        node_event_list = reverse(
+            'node-event-list-view', args=[node.system_id])
+        self.assertIn(node_event_list, get_content_links(response))
+
+
+class NodeEventLogTest(MAASServerTestCase):
+
+    def test_event_log_shows_event_list(self):
+        self.client_log_in()
+        node = factory.make_node()
+        events = [
+            factory.make_event(node=node)
+            for _ in range(NodeView.number_of_events_shown)
+        ]
+        response = self.client.get(
+            reverse('node-event-list-view', args=[node.system_id]))
+        document = fromstring(response.content)
+        events_displayed = document.xpath(
+            "//div[@id='node_event_list']//td[@class='event_description']")
+        self.assertItemsEqual(
+            [event.type.description for event in events],
+            [display.text_content().strip() for display in events_displayed]
+        )
+
+    def test_event_log_is_paginated(self):
+        self.client_log_in()
+        self.patch(NodeEventListView, "paginate_by", 3)
+        node = factory.make_node()
+        # Create 4 events.
+        [factory.make_event(node=node) for _ in range(4)]
+
+        response = self.client.get(
+            reverse('node-event-list-view', args=[node.system_id]))
+        self.assertEqual(httplib.OK, response.status_code)
+        doc = fromstring(response.content)
+        self.assertEqual(
+            1, len(doc.cssselect('div.pagination')),
+            "Couldn't find pagination tag.")
+
 
 class ConstructThirdPartyDriversNoticeTest(MAASServerTestCase):