Merge lp:~roadmr/checkbox/modalias-parsing into lp:checkbox

[Daniel Manrique]

checkbox-support:parsers:submission: add modalias info to package elements

checkbox-support:parsers:submission: add modalias info to package elements

A "modalias" element is added to the package's data dict if the xml
element contains that property, taken from the package's Modalias Debian
control field.

This actually processes the new "modalias" data from package_resource at submission parsing time. As an example, when parsing, a package without modaliases looks like this:

            {
                "name": "oem-brightness-workaround-1076262",
                "version": "1stella4"
            },

One with modaliases is like this:
            {
                "modalias": "hwe(pci:*)",
                "name": "oem-all-disablemmc-1405558-dkms",
                "version": "1oem2"
            },

Users of the SubmissionParser such as hexr will receive this data and are then responsible for processing it suitably.

This shouldn't affect hexr until we actually add awareness of this key, because currently it only pays attention to the name and version keys of the dictionary, any additions are ignored at the moment.

[Zygmunt Krynicki (zyga)]

16:31 <@zyga> roadmr: http://bazaar.launchpad.net/~roadmr/checkbox/modalias-parsing/revision/3760
16:31 <@zyga> roadmr: how is package_version related to the modalias?
16:33 < roadmr> zyga: good question... I think this is designed to express a package (identified by name) and convey that we may have different versions of the same package
16:33 < roadmr> zyga: this reflects how it's stored in hexr's database where there's a package table with just the names, and a packageversion intermediate table with versions and a link to packages
16:33 < roadmr> zyga: in here, a particular package version may contain a specific set of modaliases for which the package provides drivers or functionality
16:34 < roadmr> zyga: this is somewhat tied to version because conceivably a newer version of the same package may have a different set of modaliases
16:34 < roadmr> zyga: but mostly I think it's a "historical naming" convention, I would just call it "package" and it would have "name", "version" and "modalias" attributes
16:48 <@zyga> roadmr: ok, thanks
16:48 < roadmr> zyga: np, thanks for the review :D

review: Approve

=== modified file 'checkbox-support/checkbox_support/parsers/submission.py'
--- checkbox-support/checkbox_support/parsers/submission.py	2014-11-11 05:47:37 +0000
+++ checkbox-support/checkbox_support/parsers/submission.py	2015-05-07 13:42:53 +0000
@@ -589,6 +589,8 @@
             "name": package["name"],
             "version": package["properties"]["version"],
             }
+        if 'modalias' in package["properties"]:
+            package_version['modalias'] = package['properties']['modalias']
         self.dispatcher.publishEvent("package_version", package_version)
 
     def addPackageVersion(self, test_run, package_version):

=== added file 'checkbox-support/checkbox_support/parsers/tests/fixtures/submission_packages_modaliases.xml'
--- checkbox-support/checkbox_support/parsers/tests/fixtures/submission_packages_modaliases.xml	1970-01-01 00:00:00 +0000
+++ checkbox-support/checkbox_support/parsers/tests/fixtures/submission_packages_modaliases.xml	2015-05-07 13:42:53 +0000
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+<system version="1.0">
+<software>
+<packages>
+<package id="4" name="accountsservice">
+<property name="description" type="str">amd64</property>
+<property name="desired" type="str">Install</property>
+<property name="status" type="str">Installed</property>
+<property name="version" type="str">0.6.21-6ubuntu2</property>
+</package>
+<package id="5" name="a_package_with_modaliases">
+<property name="description" type="str">amd64</property>
+<property name="desired" type="str">Install</property>
+<property name="status" type="str">Installed</property>
+<property name="version" type="str">1.0-1-ubuntu1~bogus</property>
+<property name="modalias" type="str">nvidia_340(pci:v000010DEd000005E7sv*sd00000595bc03sc*i*)</property>
+</package>
+</packages>
+</software>
+</system>

=== modified file 'checkbox-support/checkbox_support/parsers/tests/test_submission.py'
--- checkbox-support/checkbox_support/parsers/tests/test_submission.py	2014-05-20 18:54:24 +0000
+++ checkbox-support/checkbox_support/parsers/tests/test_submission.py	2015-05-07 13:42:53 +0000
@@ -184,6 +184,24 @@
         self.assertEqual(package_version["name"], "accountsservice")
         self.assertEqual(package_version["version"], "0.6.21-6ubuntu2")
 
+    def test_package_modaliases(self):
+        """
+        Modaliases information is in the packages element if a package
+        contains it.
+        """
+        result = self.getResult("submission_packages_modaliases.xml")
+        self.assertTrue("package_versions" in result)
+        self.assertEqual(len(result["package_versions"]), 2)
+
+        package = result["package_versions"][0]
+        self.assertEqual(package["name"], "accountsservice")
+        self.assertNotIn("modalias", package)
+
+        package = result["package_versions"][1]
+        self.assertEqual(package["name"], "a_package_with_modaliases")
+        self.assertEqual(package["modalias"], "nvidia_340(pci:v000010DEd000005E7sv*sd00000595bc03sc*i*)")
+        self.assertEqual(package["version"], "1.0-1-ubuntu1~bogus")
+
     def test_test_results(self):
         """Test results are in the questions element."""
         result = self.getResult("submission_questions.xml")