Merge ~pieq/bugit/+git/qabro:1904849-add-stage-when-issue-filed into bugit:master

[Pierre Equoy]

See description of commit for more information.

Tested on an amd64 machine by submitting issues on the Staging instance of Launchpad, and checking the right description was set.

Also tested interrupting the process (for instance pressing Ctrl+C when sosreport is generated), then changing the stage radio button, and making sure the bug description is updated as expected, and that there is only one "[Stage]" section, and not more.

[Yuan-Chen Cheng (ycheng-twn)]

The code itself looks good for me, I'll approve it.

However I myself rarely run it, so I think you still need another approval from those who use it a lot to approve it.

review: Approve

[Kristin Chuang (kristinchuang)]

+1 based on the internal discussion thread: https://chat.canonical.com/canonical/pl/jsep8xm6cfnkmkd7fa4y9yh4mh

review: Approve

diff --git a/qabro/ui.py b/qabro/ui.py
index 436eb68..6942096 100644
--- a/qabro/ui.py
+++ b/qabro/ui.py
@@ -29,6 +29,9 @@ class ReportScreen:
                    'Medium',
                    'High',
                    'Critical')
+    stage_bug_filed = ("Issue reported and logs collected right after it happened",
+                       "Device froze, issue reported and logs collected right after a reboot",
+                       "Issue reported and logs collected at a later stage")
 
     default_description = ("[Summary]\n\n"
                            "[Steps to reproduce]\n\n"
@@ -64,6 +67,9 @@ class ReportScreen:
         self._importance = []
         for i in self.importances:
             rb = urwid.RadioButton(self._importance, i, 'first True', None)
+        self._stage_bug_filed = []
+        for s in self.stage_bug_filed:
+            rb = urwid.RadioButton(self._stage_bug_filed, s, False, None)
         self._bug_features = []
         for feature in sorted(self.tags["features"]):
             cb = urwid.CheckBox(label=feature, state=False,
@@ -80,6 +86,7 @@ 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')
+        stage_bug_filed_list = urwid.LineBox(urwid.Pile(self._stage_bug_filed), 'When was the issue filed?')
         self.bug_features_list = urwid.LineBox(urwid.Pile(self._bug_features), 'Impacted Feature(s)')
         self.bug_vendors_list = urwid.LineBox(urwid.Pile(self._bug_vendors), 'Impacted Vendor(s)')
         self.footer = urwid.AttrMap(urwid.Text(self.footer_text), 'foot')
@@ -87,6 +94,7 @@ class ReportScreen:
                                              self.bug_vendors_list])
         self.pile = urwid.Pile([self._title,
                                 self._description,
+                                stage_bug_filed_list,
                                 self._project,
                                 self._series,
                                 status_list,
@@ -153,6 +161,18 @@ class ReportScreen:
     def report(self):
         tags = self._tags.base_widget.text
         options = {'include_fwts_logs': 'hwe-firmware' in tags}
+        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
+            description_list = self._description.base_widget.text.split("\n")
+            if "[Stage]" in description_list:
+                i = description_list.index("[Stage]")
+                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]
+            self._description.base_widget.set_edit_text(description)
+
         return BugReport(title=self._title.base_widget.text,
                          description=self._description.base_widget.text,
                          project=self._project.base_widget.text,