Merge ~stanley31/bugit/+git/bugit:add-failed-tests into bugit:master

[StanleyHuang]

Add 'affected test cases' section in bug report

[HanhsuanLee (hanhsuan)]

Does this change not be included in ReopenReportScreen ?

[StanleyHuang (stanley31)]

> Does this change not be included in ReopenReportScreen ?

The ReopenReportScreen will not modify the bug description, but add a comment. So user need to add the failed test cases in the description fields manually in current implementation.

[HanhsuanLee (hanhsuan)]

LGTM

[HanhsuanLee (hanhsuan)]

LGTM to approve

review: Approve

diff --git a/bugit/ui.py b/bugit/ui.py
index 986621d..f6a1e08 100644
--- a/bugit/ui.py
+++ b/bugit/ui.py
@@ -40,7 +40,9 @@ class SelectionScreen:
         self.build_ui()
 
     def build_ui(self):
-        button = urwid.Button(label="None", on_press=self.item_chosen, user_data="None")
+        button = urwid.Button(
+            label="None", on_press=self.item_chosen, user_data="None"
+        )
         _ui_items = [button]
         self.header = urwid.AttrMap(urwid.Text(self._header_text), "header")
         self.footer = urwid.AttrMap(urwid.Text(self.footer_text), "foot")
@@ -55,7 +57,10 @@ class SelectionScreen:
         self.main_view = urwid.Frame(
             urwid.Filler(
                 urwid.Padding(
-                    self.pile, align="center", width=("relative", 5), min_width=50
+                    self.pile,
+                    align="center",
+                    width=("relative", 5),
+                    min_width=50,
                 ),
                 "top",
             ),
@@ -92,8 +97,10 @@ class SessionsScreen(SelectionScreen):
 
         header_text = (
             "The following Checkbox sessions are available on this device.\n\n"
-            "You can select a failed job from one of these, and bugit will automatically get the output from this job.\n"
-            "Please select the Checkbox session to use (or 'None' if you want to fill the description yourself):\n\n"
+            "You can select a failed job from one of these,"
+            " and bugit will automatically get the output from this job.\n"
+            "Please select the Checkbox session to use"
+            " (or 'None' if you want to fill the description yourself):\n\n"
             "(Note: the sessions are sorted with the most recent on top.)"
         )
         super().__init__(items=items, header_text=header_text)
@@ -104,7 +111,8 @@ class JobsScreen(SelectionScreen):
 
         header_text = (
             "The following jobs are available in this session.\n\n"
-            "You can select a failed job from one of these, and bugit will automatically get the output from this job.\n"
+            "You can select a failed job from one of these,"
+            " and bugit will automatically get the output from this job.\n"
             "Please select the job to use:\n\n"
         )
         super().__init__(items=items, header_text=header_text)
@@ -128,10 +136,19 @@ class ReportScreen:
 
     statuses = ("New", "Confirmed")
     importances = {
-        'launchpad': ("Undecided", "Wishlist", "Low", "Medium", "High", "Critical"),
-        'jira': ("Lowest", "Low", "Medium", "High", "Highest")
+        "launchpad": (
+            "Undecided",
+            "Wishlist",
+            "Low",
+            "Medium",
+            "High",
+            "Critical",
+        ),
+        "jira": ("Lowest", "Low", "Medium", "High", "Highest"),
     }
-    STAGE_IMMEDIATE = "Issue reported and logs collected right after it happened"
+    STAGE_IMMEDIATE = (
+        "Issue reported and logs collected right after it happened"
+    )
     STAGE_FROZEN_DEVICE = (
         "Device froze, issue reported and logs collected right after a reboot"
     )
@@ -167,10 +184,12 @@ class ReportScreen:
         template="Launchpad",
     ):
         if job_id and job_output:
+            self.default_description += f"[Affected test cases]\n{job_id}\n\n"
             self.default_description += f"[Checkbox job `{job_id}` output]\n\n"
             if job_output["comments"]:
                 self.default_description += (
-                    "Tester comments\n---------------\n" f"{job_output['comments']}\n\n"
+                    "Tester comments\n---------------\n"
+                    f"{job_output['comments']}\n\n"
                 )
             if not job_output["stdout"] and not job_output["stderr"]:
                 self.default_description += "No output found for this job.\n\n"
@@ -182,17 +201,17 @@ class ReportScreen:
                 self.default_description += (
                     "stderr\n------\n" f"{job_output['stderr']}\n"
                 )
+        else:
+            self.default_description += "[Affected test cases]\n\n"
 
         # Adding standard info (CPU, BIOS, GPU, etc.)  to the description
         std_info = AttachmentAssistant.get_standard_info()
         std_info_str = "\n".join(
             ["{}: {}".format(elt, std_info[elt]) for elt in std_info]
         )
-        cid_str = "\nCID: {}".format(cid)
-        sku_str = "\nSKU: {}".format(sku)
         self.default_description += (
-            "[Additional information]" + cid_str + sku_str + "\n" + std_info_str
-        )
+            "[Additional information]\nCID: {}\nSKU: {}\n{}"
+        ).format(cid, sku, std_info_str)
 
         self._title = urwid.LineBox(urwid.Edit(), "Bug Title")
         self._description = urwid.LineBox(
@@ -233,7 +252,9 @@ class ReportScreen:
         )
         self._tags = urwid.LineBox(urwid.Edit(edit_text=tags), "Tags")
         status_list = urwid.LineBox(urwid.Pile(self._status), "Status")
-        importance_list = urwid.LineBox(urwid.Pile(self._importance), "Importance")
+        importance_list = urwid.LineBox(
+            urwid.Pile(self._importance), "Importance"
+        )
         stage_bug_filed_list = urwid.LineBox(
             urwid.Pile(self._stage_bug_filed), "When was the issue filed?"
         )
@@ -261,13 +282,19 @@ class ReportScreen:
                 self.bug_tags_lists,
             ]
         )
-        self.main_view = urwid.Frame(urwid.Filler(self.pile, "top"), footer=self.footer)
+        self.main_view = urwid.Frame(
+            urwid.Filler(self.pile, "top"), footer=self.footer
+        )
         self.error_text = urwid.Text("")
         self.ok_button = urwid.Padding(
-            urwid.Button("OK", on_press=self.close_dialog), align="center", width=6
+            urwid.Button("OK", on_press=self.close_dialog),
+            align="center",
+            width=6,
         )
         self.error_dialog = urwid.AttrMap(
-            urwid.LineBox(urwid.Pile([self.error_text, self.ok_button]), "Error"),
+            urwid.LineBox(
+                urwid.Pile([self.error_text, self.ok_button]), "Error"
+            ),
             "error",
         )
         self.error_view = urwid.Overlay(
@@ -287,8 +314,8 @@ class ReportScreen:
         else:
             # if checkbox is unticked
             for tag in tags:
-                self._tags.base_widget.edit_text = self._tags.base_widget.edit_text.replace(
-                    tag, ""
+                self._tags.base_widget.edit_text = (
+                    self._tags.base_widget.edit_text.replace(tag, "")
                 )
         # clean up the list of tags to
         # - remove unwanted white spaces
@@ -338,7 +365,9 @@ class ReportScreen:
         if "ihv-nvidia" in tags and any([i in tags for i in check_tags]):
             options.update({"include_nvidia-bug-report": True})
 
-        stage_bug_filed = [rb.label for rb in self._stage_bug_filed if rb.state]
+        stage_bug_filed = [
+            rb.label for rb in self._stage_bug_filed if rb.state
+        ]
         if stage_bug_filed:
             # If the bug description already contains a "[Stage]" section,
             # remove it since it will be updated and re-filled below
@@ -348,10 +377,14 @@ class ReportScreen:
                 description_list.pop(i)  # Remove the [Stage] line
                 description_list.pop(i)  # Remove the line after [Stage]
             description = (
-                "\n".join(description_list) + "\n\n[Stage]\n" + stage_bug_filed[0]
+                "\n".join(description_list)
+                + "\n\n[Stage]\n"
+                + stage_bug_filed[0]
             )
             self._description.base_widget.set_edit_text(description)
-            options["device_froze"] = self.STAGE_FROZEN_DEVICE in stage_bug_filed[0]
+            options["device_froze"] = (
+                self.STAGE_FROZEN_DEVICE in stage_bug_filed[0]
+            )
             options["collect_log"] = self.STAGE_LATER not in stage_bug_filed[0]
 
         return BugReport(
@@ -380,7 +413,7 @@ class ReopenReportScreen(ReportScreen):
         importance="",
         job_id="",
         job_output=None,
-        template="Launchpad"
+        template="Launchpad",
     ):
         if job_id and job_output:
             job_pattern = ["comments", "stdout", "stderr"]
@@ -390,11 +423,10 @@ class ReopenReportScreen(ReportScreen):
                     prefix_str = "Job {}".format(key)
                     self.default_description += "{}\n{}\n{}\n\n".format(
                         prefix_str,
-                        '-'*len(prefix_str),
-                        job_output[key].strip()
+                        "-" * len(prefix_str),
+                        job_output[key].strip(),
                     )
-            if not job_output["stdout"].strip() and \
-               not job_output["stderr"]:
+            if not job_output["stdout"].strip() and not job_output["stderr"]:
                 self.default_description += "No output found for this job\n\n"
 
         # Adding standard info (CPU, BIOS, GPU, etc.)  to the description
@@ -403,10 +435,7 @@ class ReopenReportScreen(ReportScreen):
             ["{}: {}".format(elt, std_info[elt]) for elt in std_info]
         )
         self.default_description += (
-            "[Additional information]\n"
-            "CID: {}\n"
-            "SKU: {}\n"
-            "{}"
+            "[Additional information]\nCID: {}\nSKU: {}\n{}"
         ).format(cid, sku, std_info_str)
 
         self._title = urwid.LineBox(urwid.Text(title), "Bug Title")
@@ -423,8 +452,11 @@ class ReopenReportScreen(ReportScreen):
         self._importance = []
         for i in self.importances[template]:
             rb = urwid.RadioButton(self._importance, i, "first True", None)
-        [rb.set_state(True) for rb in self._importance
-                                if rb.label == importance]
+        [
+            rb.set_state(True)
+            for rb in self._importance
+            if rb.label == importance
+        ]
 
         self._stage_bug_filed = []
         for s in self.stage_bug_filed:
@@ -441,7 +473,7 @@ class ReopenReportScreen(ReportScreen):
         bug_state_lists = urwid.Columns(
             [
                 urwid.LineBox(urwid.Pile(self._status), "Status"),
-                urwid.LineBox(urwid.Pile(self._importance), "Importance")
+                urwid.LineBox(urwid.Pile(self._importance), "Importance"),
             ]
         )
 
@@ -457,15 +489,18 @@ class ReopenReportScreen(ReportScreen):
             ]
         )
         self.main_view = urwid.Frame(
-            urwid.Filler(self.pile, "top"), footer=self.footer)
+            urwid.Filler(self.pile, "top"), footer=self.footer
+        )
         self.error_text = urwid.Text("")
         self.ok_button = urwid.Padding(
             urwid.Button("OK", on_press=self.close_dialog),
-            align="center", width=6
+            align="center",
+            width=6,
         )
         self.error_dialog = urwid.AttrMap(
             urwid.LineBox(
-                urwid.Pile([self.error_text, self.ok_button]), "Error"),
+                urwid.Pile([self.error_text, self.ok_button]), "Error"
+            ),
             "error",
         )
         self.error_view = urwid.Overlay(
@@ -480,7 +515,9 @@ class ReopenReportScreen(ReportScreen):
     def report(self):
         options = {}
 
-        stage_bug_filed = [rb.label for rb in self._stage_bug_filed if rb.state]
+        stage_bug_filed = [
+            rb.label for rb in self._stage_bug_filed if rb.state
+        ]
         if stage_bug_filed:
             # If the bug description already contains a "[Stage]" section,
             # remove it since it will be updated and re-filled below
@@ -490,10 +527,14 @@ class ReopenReportScreen(ReportScreen):
                 description_list.pop(i)  # Remove the [Stage] line
                 description_list.pop(i)  # Remove the line after [Stage]
             description = (
-                "\n".join(description_list) + "\n\n[Stage]\n" + stage_bug_filed[0]
+                "\n".join(description_list)
+                + "\n\n[Stage]\n"
+                + stage_bug_filed[0]
             )
             self._description.base_widget.set_edit_text(description)
-            options["device_froze"] = self.STAGE_FROZEN_DEVICE in stage_bug_filed[0]
+            options["device_froze"] = (
+                self.STAGE_FROZEN_DEVICE in stage_bug_filed[0]
+            )
             options["collect_log"] = self.STAGE_LATER not in stage_bug_filed[0]
 
         return BugReport(