Merge ~pieq/oem-qa-autosummary:fix-1928768-reports-lists into ~pieq/oem-qa-autosummary:master

[Pierre Equoy]

See commit description for more info.

Tested locally using a given project and milestone, with the following parameters:

1.
- empty "Hardware Used for Testing"
- empty "C3 Full Test Report(s)"
- empty "C3 Stress Test Report(s)"

2.
- "Hardware Used for Testing": lots of empty lines
- "C3 Full Test Report(s)": several C3 submissions links
- empty "C3 Stress Test Report(s)"

3.
- "Hardware Used for Testing": names of devices with CID numbers.
- empty "C3 Full Test Report(s)"
- "C3 Stress Test Report(s)": several C3 submissions links

Worked fine in every cases.

[Vic Liu (zongminl)]

I tested this MR with the following scenarios
1. Summary got generated without problem
- empty "Hardware Used for Testing"
- empty "C3 Full Test Report(s)"
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

2. Summary got generated without problem
- "Hardware Used for Testing": CID with a few empty lines and spaces at the fron
- empty "C3 Full Test Report(s)"
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

3. Summary got generated without problem
- empty "Hardware Used for Testing"
- "C3 Full Test Report(s)": Submission link with a few empty lines and spaces at the front
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

4.
- empty "Hardware Used for Testing"
- empty "C3 Full Test Report(s)"
- "C3 Stress Test Report(s)": Some lines with spaces and a submission link with a few spaces at the front (as below)
" "
" "
" "
" https://certification.canonical.com/hardware/202103-28798/submission/212779/"
- empty "HTML Report"
- empty "Scope"

Some empty lines with bullet points showed up in the "C3 Stress Test Reports:" field in the summary generated.
Maybe we can add a .strip() at the end of .splitlines() for each line?

review: Needs Fixing

[Vic Liu (zongminl)]

Ah, I made a mistake, did not aware of the attribute of .splitlines() is a list and .strip() is not applicable on lists.

[Vic Liu (zongminl)]

Adding a .strip() to the end of "if line" could fix this problem

[Pierre Equoy (pieq)]

Good catch, Vic, thanks!

I use line.strip() twice in the comprehension lists:
- the first is to remove the spaces in non-emtpy lines (so that " https://blabla/ " becomes "https://blabla/")
- the second is to have lines with only space replaced by "", and therefore ignored when calling splitlines()

[Vic Liu (zongminl)]

I tested all my 4 scenarios again with the updated commit:

1. Summary got generated without problem
- empty "Hardware Used for Testing"
- empty "C3 Full Test Report(s)"
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

2. Summary got generated without problem
- "Hardware Used for Testing": CID with a few empty lines and spaces at the fron
- empty "C3 Full Test Report(s)"
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

3. Summary got generated without problem
- empty "Hardware Used for Testing"
- "C3 Full Test Report(s)": Submission link with a few empty lines and spaces at the front
- empty "C3 Stress Test Report(s)"
- empty "HTML Report"
- empty "Scope"

4. Summary got generated without problem
- empty "Hardware Used for Testing"
- empty "C3 Full Test Report(s)"
- "C3 Stress Test Report(s)": Some lines with spaces and a submission link with a few spaces at the front (as below)
" "
" "
" "
" https://certification.canonical.com/hardware/202103-28798/submission/212779/"
- empty "HTML Report"
- empty "Scope"

review: Approve

diff --git a/autosummary/summary.py b/autosummary/summary.py
index ec6158e..9d3b2b9 100644
--- a/autosummary/summary.py
+++ b/autosummary/summary.py
@@ -81,10 +81,15 @@ class Summary:
         for bug in bugs:
             if bug.owner in team.members:
                 # To exclude checkbox-related bugs from summary report
-                if any(pattern not in bug.title.lower() for pattern in check_pattern) and \
-                   "checkbox" not in bug.bug.tags:
+                if (
+                    any(pattern not in bug.title.lower() for pattern in check_pattern)
+                    and "checkbox" not in bug.bug.tags
+                ):
                     if bug.milestone:
-                        if bug.milestone.series_target == self.lp_milestone.series_target:
+                        if (
+                            bug.milestone.series_target
+                            == self.lp_milestone.series_target
+                        ):
                             new_bugs.append(bug)
                     else:
                         # No milestone/series defined yet, assuming it should be part of
diff --git a/webapp/__init__.py b/webapp/__init__.py
index 721ecc3..93f4e0d 100644
--- a/webapp/__init__.py
+++ b/webapp/__init__.py
@@ -168,21 +168,21 @@ def generate_summary():
             html_report=html_report,
             scope=scope,
         )
-    if hardware:
-        # Splitting each line and removing empty lines
-        hardware = [line for line in hardware.splitlines() if line]
-    if full_test_reports:
-        full_test_reports = [line for line in full_test_reports.splitlines() if line]
-    if stress_test_reports:
-        stress_test_reports = [
-            line for line in stress_test_reports.splitlines() if line
-        ]
+    # Splitting each line, removing empty lines or lines with only spaces and
+    # stripping non-empty lines to remove spaces at the beginning/end.
+    hardware_list = [line.strip() for line in hardware.splitlines() if line.strip()]
+    full_test_reports_list = [
+        line.strip() for line in full_test_reports.splitlines() if line.strip()
+    ]
+    stress_test_reports_list = [
+        line.strip() for line in stress_test_reports.splitlines() if line.strip()
+    ]
     return render_template(
         "summary.html",
         report=report,
-        hardware=hardware,
-        full_test_reports=full_test_reports,
-        stress_test_reports=stress_test_reports,
+        hardware=hardware_list,
+        full_test_reports=full_test_reports_list,
+        stress_test_reports=stress_test_reports_list,
         html_report=html_report,
         scope=scope,
         nb_critical_bugs=nb_critical_bugs,
@@ -203,7 +203,9 @@ def add_test_status():
         "c3_links": request.form.getlist("c3_links"),
     }
     try:
-        res = requests.post(f"{AUTO_TEST_STATUS_URL}:{AUTO_TEST_STATUS_PORT}/api/v1/status", json=status)
+        res = requests.post(
+            f"{AUTO_TEST_STATUS_URL}:{AUTO_TEST_STATUS_PORT}/api/v1/status", json=status
+        )
         response = res.json()
         status_code = res.status_code
     except requests.exceptions.ConnectionError:
@@ -219,5 +221,3 @@ def add_test_status():
         auto_test_status_url=AUTO_TEST_STATUS_URL,
         auto_test_status_port=AUTO_TEST_STATUS_PORT,
     )
-
-