Merge lp:~sylvain-pineau/checkbox/xlsx_exporter_new_categories into lp:checkbox

[Sylvain Pineau]

This MR allows the xlsx exporter to understand the categories proposed by the new units format as can be seen in the new touch provider.

See: http://people.canonical.com/~spineau/test.xlsx

[Sylvain Pineau (sylvain-pineau)]

self-approved

review: Approve

[Zygmunt Krynicki (zyga)]

I'm pretty unhappy about landing that just like that.

- The commit message is lacking, you could have made separate commits for this
- The feature is questionable, it seems that we're *AGAIN* using internal identifiers for dislay where we *ALREADY* have better data. Why are we doing that?
- Some coding below is odd but that's a lesser thing

In general I blame the deadline for the demo on Monday. I really don't like patches that show up, self-approved, on Friday before a demo Monday. Sigh.

Please patch this.

review: Needs Fixing

[Zygmunt Krynicki (zyga)]

Update, looking at the history I see there were separate commits. I'm sorry, launchpad's means of displaying merged branches is just broken. The remainder of my comment stands though.

=== modified file 'plainbox/plainbox/impl/exporter/__init__.py'
--- plainbox/plainbox/impl/exporter/__init__.py	2014-09-17 19:12:22 +0000
+++ plainbox/plainbox/impl/exporter/__init__.py	2014-11-28 16:02:18 +0000
@@ -198,6 +198,8 @@
                 continue
             data['result_map'][job_id] = OrderedDict()
             data['result_map'][job_id]['summary'] = job_state.job.summary
+            data['result_map'][job_id]['category_id'] = \
+                job_state.job.partial_category_id
             data['result_map'][job_id]['outcome'] = job_state.result.outcome
             if job_state.result.execution_duration:
                 data['result_map'][job_id]['execution_duration'] = \

=== modified file 'plainbox/plainbox/impl/exporter/test_init.py'
--- plainbox/plainbox/impl/exporter/test_init.py	2014-05-21 10:36:42 +0000
+++ plainbox/plainbox/impl/exporter/test_init.py	2014-11-28 16:02:18 +0000
@@ -133,10 +133,12 @@
             'result_map': {
                 'job_a': OrderedDict([
                     ('summary', 'job_a'),
+                    ('category_id', 'uncategorised'),
                     ('outcome', 'pass')
                 ]),
                 'job_b': OrderedDict([
                     ('summary', 'job_b'),
+                    ('category_id', 'uncategorised'),
                     ('outcome', 'fail')
                 ])
             }
@@ -201,6 +203,7 @@
             'result_map': {
                 'job_a': OrderedDict([
                     ('summary', 'This is job A'),
+                    ('category_id', 'uncategorised'),
                     ('outcome', 'pass'),
                     ('comments', None),
                     ('via', None),
@@ -213,6 +216,7 @@
                 ]),
                 'job_b': OrderedDict([
                     ('summary', 'This is job B'),
+                    ('category_id', 'uncategorised'),
                     ('outcome', 'pass'),
                     ('comments', 'foo'),
                     ('via', None),

=== modified file 'plainbox/plainbox/impl/exporter/xlsx.py'
--- plainbox/plainbox/impl/exporter/xlsx.py	2014-10-14 22:26:02 +0000
+++ plainbox/plainbox/impl/exporter/xlsx.py	2014-11-28 16:02:18 +0000
@@ -423,7 +423,44 @@
             ):
                 result_map[parent]['category_status'] = IJobResult.OUTCOME_SKIP
 
-    def _tree(self, result_map, via=None, level=0, max_level=0):
+    def _tree(self, result_map):
+        res = {}
+        tmp_result_map = {}
+        for job_name in result_map:
+            if re.search(
+                    'resource|attachment',
+                    result_map[job_name]['plugin']):
+                continue
+            category = result_map[job_name]['category_id']
+            if category not in res:
+                tmp_result_map[category] = {}
+                tmp_result_map[category]['category_status'] = None
+                tmp_result_map[category]['plugin'] = 'local'
+                tmp_result_map[category]['summary'] = category
+                res[category] = {}
+            res[category][job_name] = {}
+            # Generate categories status
+            child_status = result_map[job_name]['outcome']
+            if child_status == IJobResult.OUTCOME_FAIL:
+                tmp_result_map[category]['category_status'] = \
+                    IJobResult.OUTCOME_FAIL
+            elif (
+                child_status == IJobResult.OUTCOME_PASS and
+                tmp_result_map[category]['category_status'] !=
+                    IJobResult.OUTCOME_FAIL
+            ):
+                tmp_result_map[category]['category_status'] = \
+                    IJobResult.OUTCOME_PASS
+            elif (
+                tmp_result_map[category]['category_status'] not in
+                (IJobResult.OUTCOME_PASS, IJobResult.OUTCOME_FAIL)
+            ):
+                tmp_result_map[category]['category_status'] = \
+                    IJobResult.OUTCOME_SKIP
+        result_map.update(tmp_result_map)
+        return res, 2
+
+    def _legacy_tree(self, result_map, via=None, level=0, max_level=0):
         res = {}
         for job_name in [j for j in result_map if result_map[j]['via'] == via]:
             if re.search(
@@ -434,7 +471,7 @@
             # Find the maximum depth of the test tree
             if level > max_level:
                 max_level = level
-            res[job_name], max_level = self._tree(
+            res[job_name], max_level = self._legacy_tree(
                 result_map, result_map[job_name]['hash'], level, max_level)
             # Generate parent categories status
             if via is not None:
@@ -476,7 +513,9 @@
                 if self.OPTION_WITH_DESCRIPTION in self._option_list:
                     self.worksheet4.write(
                         self._lineno, level + 1,
-                        result_map[job].get('description', ""), self.format15)
+                        result_map[job].get(
+                            'description',
+                            result_map[job].get('summary', "")), self.format15)
                 if level:
                     self.worksheet3.set_row(
                         self._lineno, 13, None, {'level': level})
@@ -574,7 +613,10 @@
                             self._lineno, 12 + 10.5 * desc_lines)
 
     def write_results(self, data):
-        tree, max_level = self._tree(data['result_map'])
+        if [k for k, v in data['result_map'].items() if 'category_id' in v]:
+            tree, max_level = self._tree(data['result_map'])
+        else:
+            tree, max_level = self._legacy_tree(data['result_map'])
         self.worksheet3.write(3, 1, _('Tests Performed'), self.format03)
         self.worksheet3.freeze_panes(6, 0)
         self.worksheet3.set_tab_color('#DC4C00')  # Orange

=== modified file 'plainbox/plainbox/impl/unit/job.py'
--- plainbox/plainbox/impl/unit/job.py	2014-11-25 11:33:53 +0000
+++ plainbox/plainbox/impl/unit/job.py	2014-11-28 16:02:18 +0000
@@ -304,6 +304,15 @@
                 'category_id', '2013.com.canonical.plainbox::uncategorised'))
 
     @property
+    def partial_category_id(self):
+        """
+        Identifier of this job category, without the provider name
+
+        This field should not be used anymore, except for display
+        """
+        return self.get_record_value('category_id', 'uncategorised')
+
+    @property
     def estimated_duration(self):
         """
         estimated duration of this job in seconds.