Merge lp:~newell-jensen/maas/xml-to-yaml-commissioning-result into lp:~maas-committers/maas/trunk

[Newell Jensen]

Edited commissioningresult.html and model to have tabbed xml and yaml (default) output, if required.

This branch is the third and final of three, which together allow the user to view the xml output in the ui as either yaml (default tab) or xml.

[Newell Jensen (newell-jensen)]

Attached is a screen shot of the UI for this branch.

On Tue, Sep 9, 2014 at 2:37 PM, Newell Jensen <email address hidden>
wrote:

> Newell Jensen has proposed merging
> lp:~newell-jensen/maas/xml-to-yaml-commissioning-result into lp:maas with
> lp:~newell-jensen/maas/xml-to-yaml-node-view as a prerequisite.
>
> Commit message:
> Edited commissioningresult.html and model to have tabbed xml and yaml
> (default) output, if required.
>
>
> Requested reviews:
> MAAS Maintainers (maas-maintainers)
> Related bugs:
> Bug #1358859 in MAAS: "Commissioning output xml is hard to understand,
> would be nice to have yaml as an output option."
> https://bugs.launchpad.net/maas/+bug/1358859
>
> For more details, see:
>
> https://code.launchpad.net/~newell-jensen/maas/xml-to-yaml-commissioning-result/+merge/234016
>
> This branch is the third and final of three, which together allow the user
> to view the xml output in the ui as either yaml (default tab) or xml.
> --
>
> https://code.launchpad.net/~newell-jensen/maas/xml-to-yaml-commissioning-result/+merge/234016
> You are the owner of
> lp:~newell-jensen/maas/xml-to-yaml-commissioning-result.
>
> === modified file
> 'src/maasserver/templates/metadataserver/nodecommissionresult.html'
> --- src/maasserver/templates/metadataserver/nodecommissionresult.html
> 2014-08-18 17:23:04 +0000
> +++ src/maasserver/templates/metadataserver/nodecommissionresult.html
> 2014-09-09 21:35:02 +0000
> @@ -5,6 +5,14 @@
> {% block page-title %}Commissioning result for node: {{
> object.node.hostname }}{% endblock %}
>
> {% block content %}
> + <script type="text/javascript">
> + <!--
> + YUI().use('history', 'tabview', function (Y) {
> + var tabview = new Y.TabView({srcNode: '#tags'});
> + tabview.render();
> + });
> + // -->
> + </script>
> <ul class="data-list">
> <li class="block size7 first" id="name">
> <h4>Output file</h4>
> @@ -30,9 +38,26 @@
> <li class="block first separate" id="output">
> {% if object.data %}
> <h2>Output</h2>
> -<pre>
> -{{ object.get_data_as_html }}
> -</pre>
> + {% if object.name == "99-maas-02-capture-lldp.out" or object.name
> == "00-maas-01-lshw.out" %}
> + <div class="block first" id="tags">
> + <ul class="list size2 no-background normal">
> + <li><a href="#yaml">DiscYAML</a></li>
> + <li><a href="#xml">Discovery XML</a></li>
> + </ul>
> + <div class="last size12 no-background normal">
> + <div id="yaml">
> + <pre>{{ object.get_data_as_yaml_html }}</pre>
> + </div>
> + <div id="xml">
> + <pre>{{ object.get_data_as_html }}</pre>
> + </div>
> + </div>
> + </div>
> + {% else %}
> + <pre>
> + {{ object.get_data_as_html }}
> + </pre>
> + {% endif %}
> {% endif %}
> </li>
> </ul>
>
> === modified file 'src/metadataserver/models/noderesult.py'
> --- src/metadataserver/models/noderesult.py 2014-08-13 21:49:35 +0000
> +++ src/metadataserver/models/noderesult.py 2014-09-09 21:35:02 +0000
> @@ -27,6 +27,7 @@
> from django.utils.html ...

[Andres Rodriguez (andreserl)]

Hi Newell,

Can you please attach it to the bug report?

[Newell Jensen (newell-jensen)]

Yes,

Here is the screenshot for this branch:

https://bugs.launchpad.net/maas/+bug/1358859/+attachment/4199993/+files/commissioning-result-tabs.png

On Tue, Sep 9, 2014 at 2:54 PM, Andres Rodriguez <email address hidden>
wrote:

> Hi Newell,
>
> Can you please attach it to the bug report?
> --
>
> https://code.launchpad.net/~newell-jensen/maas/xml-to-yaml-commissioning-result/+merge/234016
> You are the owner of
> lp:~newell-jensen/maas/xml-to-yaml-commissioning-result.
>

[Blake Rouse (blake-rouse)]

Why is the text for YAML "DiscYAML" and not "Discovery YAML"?

review: Needs Information

[Newell Jensen (newell-jensen)]

> Why is the text for YAML "DiscYAML" and not "Discovery YAML"?

Because that was a keystroke "delete" typo, fixing now.

[Blake Rouse (blake-rouse)]

Looks good now! Thanks.

review: Approve

=== modified file 'src/maasserver/templates/metadataserver/nodecommissionresult.html'
--- src/maasserver/templates/metadataserver/nodecommissionresult.html	2014-08-18 17:23:04 +0000
+++ src/maasserver/templates/metadataserver/nodecommissionresult.html	2014-09-11 18:20:32 +0000
@@ -5,6 +5,14 @@
 {% block page-title %}Commissioning result for node: {{ object.node.hostname }}{% endblock %}
 
 {% block content %}
+  <script type="text/javascript">
+    <!--
+      YUI().use('tabview', function (Y) {
+        var tabview = new Y.TabView({srcNode: '#tags'});
+        tabview.render();
+      });
+    // -->
+  </script>
   <ul class="data-list">
     <li class="block size7 first" id="name">
       <h4>Output file</h4>
@@ -30,9 +38,26 @@
     <li class="block first separate" id="output">
       {% if object.data %}
       <h2>Output</h2>
-<pre>
-{{ object.get_data_as_html }}
-</pre>
+        {% if object.name == "99-maas-02-capture-lldp.out" or object.name == "00-maas-01-lshw.out" %}
+        <div class="block first" id="tags">
+          <ul class="list size2 no-background normal">
+	    <li><a href="#yaml">YAML</a></li>
+	    <li><a href="#xml">XML</a></li>
+	  </ul>
+          <div class="last size12 no-background normal">
+	    <div id="yaml">
+	      <pre>{{ object.get_data_as_yaml_html }}</pre>
+	    </div>
+	    <div id="xml">
+	      <pre>{{ object.get_data_as_html }}</pre>	
+	    </div>
+	  </div>
+	</div>
+        {% else %}
+	<pre>
+	  {{ object.get_data_as_html }}
+	</pre>
+        {% endif %}
       {% endif %}
     </li>
   </ul>

=== modified file 'src/metadataserver/models/noderesult.py'
--- src/metadataserver/models/noderesult.py	2014-08-13 21:49:35 +0000
+++ src/metadataserver/models/noderesult.py	2014-09-11 18:20:32 +0000
@@ -27,6 +27,7 @@
 from django.utils.html import escape
 from maasserver.models.cleansave import CleanSave
 from maasserver.models.timestampedmodel import TimestampedModel
+from maasserver.utils.converters import XMLToYAML
 from metadataserver import DefaultMeta
 from metadataserver.enum import (
     RESULT_TYPE,
@@ -121,3 +122,14 @@
     def get_data_as_html(self):
         """More-or-less human-readable HTML representation of the output."""
         return escape(self.data.decode('utf-8', 'replace'))
+
+    def get_data_as_yaml_html(self):
+        """More-or-less human-readable Yaml HTML representation
+        of the output.
+        """
+        from metadataserver.models.commissioningscript import (
+            LLDP_OUTPUT_NAME,
+            LSHW_OUTPUT_NAME,
+        )
+        if self.name in (LLDP_OUTPUT_NAME, LSHW_OUTPUT_NAME):
+            return escape(XMLToYAML(self.data).convert())

=== modified file 'src/metadataserver/models/tests/test_nodecommissionresult.py'
--- src/metadataserver/models/tests/test_nodecommissionresult.py	2014-09-05 11:25:28 +0000
+++ src/metadataserver/models/tests/test_nodecommissionresult.py	2014-09-11 18:20:32 +0000
@@ -19,10 +19,15 @@
 from django.core.exceptions import ValidationError
 from django.http import Http404
 from maasserver.testing.factory import factory
+from maasserver.utils.converters import XMLToYAML
 from maastesting.djangotestcase import DjangoTestCase
 from metadataserver.enum import RESULT_TYPE
 from metadataserver.fields import Bin
 from metadataserver.models import NodeResult
+from metadataserver.models.commissioningscript import (
+    LLDP_OUTPUT_NAME,
+    LSHW_OUTPUT_NAME,
+    )
 
 
 class TestNodeResult(DjangoTestCase):
@@ -68,6 +73,16 @@
             data=output.encode('ascii'))
         self.assertEqual(output, result.get_data_as_html())
 
+    def test_get_data_as_yaml_html_returns_output(self):
+        data = "<data>bar</data>".encode("utf-8")
+        expected = XMLToYAML(data).convert()
+        lshw_result = factory.make_NodeResult_for_commissioning(
+            name=LSHW_OUTPUT_NAME, script_result=0, data=data)
+        lldp_result = factory.make_NodeResult_for_commissioning(
+            name=LLDP_OUTPUT_NAME, script_result=0, data=data)
+        self.assertEqual(expected, lshw_result.get_data_as_yaml_html())
+        self.assertEqual(expected, lldp_result.get_data_as_yaml_html())
+
     def test_get_data_as_html_escapes_binary(self):
         output = b'\x00\xff'
         result = factory.make_NodeResult_for_commissioning(data=output)