Merge lp:~brendan-donegan/checkbox/cdts-report into lp:checkbox

[Brendan Donegan]

This adds the following additional information to the test report

    - client name
    - date report created
    - links to requirements documents where a requirements_docs.txt file is
      provided in CHECKBOX_SHARE/data

It needs to be ported to checkbox-ihv-ng as well.

[Zygmunt Krynicki (zyga)]

Please prefix commits with general area

[Zygmunt Krynicki (zyga)]

Why aren't we using option list for passing client name and instead we are inventing another argument?

review: Needs Information

[Zygmunt Krynicki (zyga)]

Please use PLAINBOX PROVIDER DATA Instead of CHECKBOX SHARE/data

[Brendan Donegan (brendan-donegan)]

> Why aren't we using option list for passing client name and instead we are
> inventing another argument?

Because the option_list is the option_list (a parameter to the exporter), whereas client name is a separate parameter to the export. Have a look at the constructor for the xml exporter.

review: Needs Resubmitting

[Zygmunt Krynicki (zyga)]

Maybe we could fix that. That is the intended goal of the option_list

[lp:~brendan-donegan/checkbox/cdts-report]

2836. By Brendan Donegan on 2014-03-28

checkbox-gui: Add additional information to report

This adds the following additional information to the test report

- client name
- date report created
- links to requirements documents where a requirements_docs.txt file is
  provided in CHECKBOX_SHARE/data

Signed-off-by: Brendan Donegan <email address hidden>

[Chris Gregan (cgregan)]

Looks good...demo works as expected.

review: Approve

[Zygmunt Krynicki (zyga)]

We need to fix the API to not add redundant arguments that make sense to one exporter so please don't merge this yet

review: Needs Fixing

[Daniel Manrique (roadmr)]

All this code made it into plainbox/checkbox-gui already (apologies for poaching it), would it make sense to decline this merge request now?

Unmerged revisions

2836. By Brendan Donegan on 2014-03-28

checkbox-gui: Add additional information to report

This adds the following additional information to the test report

- client name
- date report created
- links to requirements documents where a requirements_docs.txt file is
  provided in CHECKBOX_SHARE/data

Signed-off-by: Brendan Donegan <email address hidden>

=== modified file 'checkbox-gui/checkbox-gui/main.cpp'
--- checkbox-gui/checkbox-gui/main.cpp	2014-03-19 13:48:36 +0000
+++ checkbox-gui/checkbox-gui/main.cpp	2014-03-28 17:48:41 +0000
@@ -40,9 +40,9 @@
 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
-    QByteArray applicationName;
-    applicationName = QFileInfo(QCoreApplication::applicationFilePath()).fileName().toUtf8();
-    qputenv("APP_ID", applicationName);
+    QByteArray clientName;
+    clientName = QFileInfo(QCoreApplication::applicationFilePath()).fileName().toUtf8();
+    qputenv("APP_ID", clientName);
 
     qmlRegisterType<WhiteListItem>("Ubuntu.Checkbox", 0, 1, "WhiteListItem");
     qmlRegisterType<TestItem>("Ubuntu.Checkbox", 0, 1, "TestItem");
@@ -53,7 +53,7 @@
     GuiEngine guiengine((QObject*)&app);
 
     // Register the applicationName with the QML runtime
-    viewer.rootContext()->setContextProperty("applicationName", applicationName);
+    viewer.rootContext()->setContextProperty("clientName", clientName);
 
     // Register the GuiEngine with the QML runtime
     viewer.rootContext()->setContextProperty("guiEngine", &guiengine);

=== modified file 'checkbox-gui/checkbox-gui/qml/SubmissionDialog.qml'
--- checkbox-gui/checkbox-gui/qml/SubmissionDialog.qml	2014-03-20 11:17:53 +0000
+++ checkbox-gui/checkbox-gui/qml/SubmissionDialog.qml	2014-03-28 17:48:41 +0000
@@ -94,7 +94,8 @@
             if (!export_path) {
                 export_path = guiEngine.GetSaveFileName();
             }
-            var success = guiEngine.GuiExportSessionToFileAsXML(export_path);
+            var success = guiEngine.GuiExportSessionToFileAsXML(
+                export_path, clientName);
             if (submit_to == "certification") {
                 if (success) {
                     dialog.text = guiEngine.SendSubmissionViaCertificationTransport(export_path,
@@ -117,7 +118,7 @@
         onClicked: {
             onClicked:{
                 var mysavepath = '/tmp/report.html';
-                runmanagerview.reportIsSaved = guiEngine.GuiExportSessionToFileAsHTML(mysavepath);
+                runmanagerview.reportIsSaved = guiEngine.GuiExportSessionToFileAsHTML(mysavepath, clientName);
                 Qt.openUrlExternally(mysavepath)
             }
         }

=== modified file 'checkbox-gui/checkbox-gui/qml/checkbox-gui.qml'
--- checkbox-gui/checkbox-gui/qml/checkbox-gui.qml	2014-01-29 10:00:26 +0000
+++ checkbox-gui/checkbox-gui/qml/checkbox-gui.qml	2014-03-28 17:48:41 +0000
@@ -29,7 +29,7 @@
     id: mainView
     width: units.gu(100)
     height: units.gu(90)
-    applicationName: applicationName
+    applicationName: clientName
 
     // TODO - For Resume dialog, when plainbox starts up, check if this is a 'Resume'
     // if it is, set pageName = "ResumeView", state = "RESUME"

=== modified file 'checkbox-gui/gui-engine/gui-engine.cpp'
--- checkbox-gui/gui-engine/gui-engine.cpp	2014-03-20 10:35:19 +0000
+++ checkbox-gui/gui-engine/gui-engine.cpp	2014-03-28 17:48:41 +0000
@@ -2009,7 +2009,8 @@
     return reply;
 }
 
-bool GuiEngine::GuiExportSessionToFileAsXML(const QString& output_file)
+bool GuiEngine::GuiExportSessionToFileAsXML(const QString& output_file,
+                                            const QString& clientName)
 {
     QString output_format = "xml";
     QStringList options;    // No options
@@ -2020,12 +2021,13 @@
     }
 
     // FIXME - When we get a useful success/failure code here, return to caller
-    QString done = ExportSessionToFile(m_session,output_format,options,output_file);
+    QString done = ExportSessionToFile(m_session,output_format,options,output_file, clientName);
 
     return true;
 }
 
-bool GuiEngine::GuiExportSessionToFileAsHTML(const QString& output_file)
+bool GuiEngine::GuiExportSessionToFileAsHTML(const QString& output_file,
+                                             const QString& clientName)
 {
     QString output_format = "html";
     QStringList options;    // No options
@@ -2036,7 +2038,7 @@
     }
 
     // FIXME - When we get a useful success/failure code here, return to caller
-    QString done = ExportSessionToFile(m_session,output_format,options,output_file);
+    QString done = ExportSessionToFile(m_session,output_format,options,output_file,clientName);
 
     return true;
 }
@@ -2044,7 +2046,8 @@
 const QString GuiEngine::ExportSessionToFile(const QDBusObjectPath session, \
                                              const QString &output_format, \
                                              const QStringList &option_list, \
-                                             const QString &output_file)
+                                             const QString &output_file, \
+                                             const QString &applicationName)
 {
     QString empty;
 
@@ -2071,7 +2074,8 @@
                        QVariant::fromValue<QString>(session.path()), \
                        QVariant::fromValue<QString>(output_format), \
                        varlist, \
-                       QVariant::fromValue<QString>(output_file));
+                       QVariant::fromValue<QString>(output_file), \
+                       QVariant::fromValue<QString>(applicationName));
 
     if (!reply.isValid()) {
         qDebug() << "Error: " << reply.error();

=== modified file 'checkbox-gui/gui-engine/gui-engine.h'
--- checkbox-gui/gui-engine/gui-engine.h	2014-03-20 10:35:19 +0000
+++ checkbox-gui/gui-engine/gui-engine.h	2014-03-28 17:48:41 +0000
@@ -163,8 +163,10 @@
         QString GuiExportSessionAsXML(void);
         QString GuiExportSessionAsHTML(void);
 
-        bool GuiExportSessionToFileAsXML(const QString& output_file);
-        bool GuiExportSessionToFileAsHTML(const QString& output_file);
+        bool GuiExportSessionToFileAsXML(const QString& output_file, \
+                                         const QString& clientName);
+        bool GuiExportSessionToFileAsHTML(const QString& output_file, \
+                                          const QString& clientName);
         
         const QString SendSubmissionViaCertificationTransport( \
                                      const QString &submission_path,
@@ -199,8 +201,9 @@
 
         const QString ExportSessionToFile(const QDBusObjectPath session, \
                                     const QString& output_format, \
-                                    const QStringList& option_list,
-                                    const QString& output_file);
+                                    const QStringList& option_list, \
+                                    const QString& output_file, \
+                                    const QString& applicationName);
         
         QString SendDataViaTransport(const QString &transport, \
                                      const QString &url, \

=== modified file 'checkbox-ng/checkbox_ng/service.py'
--- checkbox-ng/checkbox_ng/service.py	2014-03-26 19:05:10 +0000
+++ checkbox-ng/checkbox_ng/service.py	2014-03-28 17:48:41 +0000
@@ -1201,12 +1201,13 @@
         return self.native.export_session(session, output_format, option_list)
 
     @dbus.service.method(
-        dbus_interface=SERVICE_IFACE, in_signature='osass', out_signature='s')
+        dbus_interface=SERVICE_IFACE, in_signature='osasss', out_signature='s')
     @PlainBoxObjectWrapper.translate
     def ExportSessionToFile(self, session: 'o', output_format: 's',
-                            option_list: 'as', output_file: 's'):
+                            option_list: 'as', output_file: 's',
+                            client_name: 's'):
         return self.native.export_session_to_file(
-            session, output_format, option_list, output_file)
+            session, output_format, option_list, output_file, None, client_name)
 
     @dbus.service.method(
         dbus_interface=SERVICE_IFACE, in_signature='', out_signature='as')

=== modified file 'plainbox-provider-checkbox/provider_jobs/miscellanea.txt.in'
--- plainbox-provider-checkbox/provider_jobs/miscellanea.txt.in	2014-03-20 14:07:18 +0000
+++ plainbox-provider-checkbox/provider_jobs/miscellanea.txt.in	2014-03-28 17:48:41 +0000
@@ -5,6 +5,7 @@
  dpkg
  lsb
  package
+ requirements
  uname
  dmi_attachment
  sysfs_attachment

=== modified file 'plainbox-provider-resource-generic/provider_jobs/resource.txt.in'
--- plainbox-provider-resource-generic/provider_jobs/resource.txt.in	2014-03-25 01:18:06 +0000
+++ plainbox-provider-resource-generic/provider_jobs/resource.txt.in	2014-03-28 17:48:41 +0000
@@ -187,3 +187,9 @@
       echo "state: unsupported"
   fi
 description: Creates resource info for RTC
+
+name: requirements
+estimated_duration: 0.01
+plugin: resource
+command: cat $PLAINBOX_PROVIDER_DATA/requirements_docs.txt
+description: Provide links to requirements documents

=== modified file 'plainbox/plainbox/data/report/checkbox.xsl'
--- plainbox/plainbox/data/report/checkbox.xsl	2013-09-03 15:16:51 +0000
+++ plainbox/plainbox/data/report/checkbox.xsl	2014-03-28 17:48:41 +0000
@@ -19,6 +19,9 @@
                     <h1>System Testing<span class="grey"> Report</span></h1>
                 </div>
                 <div id="content" class="clearfix">
+                    <xsl:apply-templates select=".//summary" />
+                </div>
+                <div id="content" class="clearfix">
                     <h2>Hardware Information</h2>
                     <xsl:apply-templates select=".//hardware/dmi" />
                     <xsl:apply-templates select=".//hardware/sysfs-attributes" />
@@ -29,6 +32,7 @@
                     <h2>Software Information</h2>
                     <xsl:apply-templates select=".//software/packages" />
                     <xsl:apply-templates select=".//software/lsbrelease" />
+                    <xsl:apply-templates select=".//software/requirements"/>
                 </div>
                 <div id="content" class="clearfix">
                     <h2>Tests Performed</h2>
@@ -45,9 +49,10 @@
 </xsl:template>
 
 <xsl:template match="summary">
-    <h3 id="summary">Summary</h3>
-    <p>This report was created using <xsl:value-of select="client/@name" /> <xsl:text> </xsl:text><xsl:value-of select="client/@version" /> on <xsl:value-of select="date_created/@value" />, on <xsl:value-of select="distribution/@value" /><xsl:text> </xsl:text><xsl:value-of select="distroseries/@value" /> (<xsl:value-of select="architecture/@value" />).</p>
-    <p>You can view other reports for this system <a href="https://launchpad.net/+hwdb/+fingerprint/{system_id/@value}">here</a>.</p>
+    <p>
+     This report was created using <xsl:value-of select="client/@name" /> <xsl:text> </xsl:text><xsl:value-of select="client/@version" /> on 
+     <xsl:value-of select="date_created/@value" />
+    </p>
 </xsl:template>
 
 <xsl:template match="hardware/udev">
@@ -123,7 +128,20 @@
     </table>
     </div>
 </xsl:template>
-
+<xsl:template match="software/requirements">
+    <span onClick="showHide('requirements');"><h3 id="requirements"><img class="disclosureimg" src="${PLAINBOX_ASSETS}/report/images/closed.png" />Requirements</h3></span>
+    <div class="data" id="requirements-contents">
+    <table>
+        <xsl:for-each select="requirement">
+            <tr>
+                <td>
+                 <a href="{.}"><xsl:value-of select="@name" /></a>
+                </td>
+            </tr>
+        </xsl:for-each>
+    </table>
+    </div>
+</xsl:template>
 
 <xsl:template match="questions">
     <h3 id="questions">Tests</h3>

=== modified file 'plainbox/plainbox/data/report/hardware-1_0.rng'
--- plainbox/plainbox/data/report/hardware-1_0.rng	2013-03-15 15:50:24 +0000
+++ plainbox/plainbox/data/report/hardware-1_0.rng	2014-03-28 17:48:41 +0000
@@ -228,6 +228,25 @@
                 </element>
             </optional>
             <optional>
+                <element name="requirements">
+                    <zeroOrMore>
+                        <element name="requirements">
+                            <attribute name="name"/>
+                            <attribute name="id">
+                                <data type="integer">
+                                    <except>
+                                        <value/>
+                                    </except>
+                                </data>
+                            </attribute>
+                            <oneOrMore>
+                                <ref name="property"/>
+                            </oneOrMore>
+                        </element>
+                    </zeroOrMore>
+                </element>
+            </optional>
+            <optional>
                 <element name="xorg">
                     <attribute name="version">
                         <text/>

=== modified file 'plainbox/plainbox/impl/exporter/xml.py'
--- plainbox/plainbox/impl/exporter/xml.py	2014-03-26 19:30:43 +0000
+++ plainbox/plainbox/impl/exporter/xml.py	2014-03-28 17:48:41 +0000
@@ -377,6 +377,22 @@
                             ("name", key),
                             ("type", "str"))))
                     package_property.text = value
+        requirements_data = self.get_resource(data, "requirements")
+        if requirements_data is not None:
+            requirements = ET.SubElement(software, "requirements")
+            for index, requirements_dict in enumerate(requirements_data):
+                requirement = ET.SubElement(
+                    requirements, "requirement", attrib=OrderedDict((
+                        ("id", str(index)),
+                        ("name", requirements_dict["name"]))))
+                for key, value in requirements_dict.items():
+                    if key == "name":
+                        continue
+                    requirements_property = ET.SubElement(
+                        requirement, "property", attrib=OrderedDict((
+                            ("name", key),
+                            ("type", "str"))))
+                    requirements_property.text = value
 
     def _add_summary(self, element, data):
         """

=== modified file 'plainbox/plainbox/impl/highlevel.py'
--- plainbox/plainbox/impl/highlevel.py	2014-03-28 12:35:30 +0000
+++ plainbox/plainbox/impl/highlevel.py	2014-03-28 17:48:41 +0000
@@ -301,16 +301,20 @@
         return temp_stream.getvalue()
 
     def export_session_to_file(self, session, output_format, option_list,
-                               output_file):
+                               output_file, client_version=None, 
+                               client_name=None):
         with open(output_file, 'wb') as stream:
             self._export_session_to_stream(
-                session, output_format, option_list, stream)
+                session, output_format, option_list,
+                stream, client_version, client_name)
         return output_file
 
     def _export_session_to_stream(self, session, output_format, option_list,
-                                  stream):
+                                  stream, client_version, client_name):
         exporter_cls = get_all_exporters()[output_format]
-        exporter = exporter_cls(option_list)
+        exporter = exporter_cls(option_list, 
+            client_version=client_version,
+            client_name=client_name)
         data_subset = exporter.get_session_data_subset(session)
         exporter.dump(data_subset, stream)