Merge ~pieq/oem-qa-autosummary:fix-1930349-ignore-non-url-text into oem-qa-autosummary:master

[Pierre Equoy]

Now, when generating the summary:

- Full Test Reports and Stress Test Reports text fields from the HTML form are parsed to extract C3 submission URLs and nothing else. If user includes additional information, it will be discarded.
- HTML Report is now parsed to only return a URL and nothing else. If user has entered something like "blabla https://link.to/my-html-report useless text", all the text is trimmed apart from "https://link.to/my-html-report"

Tests:

- unit test (run $ python -m unittest discover -s tests -v)
- generated report using the carlsbad project with different content for the full, stress and HTML reports.

Note:
Please check commits individually, as one of them is a Black code formatting commit that is not related to this modification...

[StanleyHuang (stanley31)]

just a small suggestion about the regular expression pattern.

[Pierre Equoy (pieq)]

Answered inline.

[StanleyHuang (stanley31)]

OK, then this MR looks good to me.

review: Approve

diff --git a/autosummary/summary.py b/autosummary/summary.py
index 6117361..935f732 100644
--- a/autosummary/summary.py
+++ b/autosummary/summary.py
@@ -26,8 +26,12 @@ class Summary:
         self.launchpad = launchpad
         self.image_url = image_url
 
-        logging.info((f"Preparing launchpad API for {self.project_name} "
-                      f"- {self.milestone_name}"))
+        logging.info(
+            (
+                f"Preparing launchpad API for {self.project_name} "
+                f"- {self.milestone_name}"
+            )
+        )
         self.lp_project = self.launchpad.projects[self.project_name]
         self.lp_milestone = self.lp_project.getMilestone(name=self.milestone_name)
         self.series_name = self.lp_milestone.series_target.name
@@ -82,8 +86,12 @@ class Summary:
             created_before = datetime.today()
 
         new_bugs = []
-        logging.info((f"Search bugs from {created_since} to {created_before}"
-                      f" for {self.project_name} project"))
+        logging.info(
+            (
+                f"Search bugs from {created_since} to {created_before}"
+                f" for {self.project_name} project"
+            )
+        )
         bugs = self.lp_project.searchTasks(
             created_since=created_since, created_before=created_before
         )
@@ -120,8 +128,7 @@ class Summary:
         image_sha256 = ""
         buff = io.BytesIO()
         uri = os.path.join(self.get_milestone_uri(), "mail.content")
-        logging.info(
-            f"Try to get mail.content file from WebDAV server. URI: {uri}")
+        logging.info(f"Try to get mail.content file from WebDAV server. URI: {uri}")
         try:
             self.webdav_client.download_from(buff, uri)
             buff.seek(0)
@@ -135,7 +142,9 @@ class Summary:
 
             image_name = image_path.strip().split("/")[-1]
         except Exception:
-            raise MailContentNotFoundError("the mail.content file is not found on the WebDAV server")
+            raise MailContentNotFoundError(
+                "the mail.content file is not found on the WebDAV server"
+            )
 
         logging.info(f"Image: {image_name}, SHA256: {image_sha256}")
         return image_name, image_sha256
@@ -155,7 +164,9 @@ class Summary:
             content = buff.read()
             sha256 = content.decode().split()[0]
         except Exception:
-            raise Sha256FileNotFoundError("sha256sum file for a given image is not found on the WebDAV server")
+            raise Sha256FileNotFoundError(
+                "sha256sum file for a given image is not found on the WebDAV server"
+            )
 
         return sha256
 
@@ -174,9 +185,7 @@ class Summary:
             if self.series_name == "trunk":
                 uri = f"/share/{self.project_name}/releases/{self.milestone_name}/"
             else:
-                uri = (
-                    f"/share/{self.project_name}/{self.series_name}/{self.milestone_name}/"
-                )
+                uri = f"/share/{self.project_name}/{self.series_name}/{self.milestone_name}/"
         return uri
 
 
diff --git a/logging_conf.py b/logging_conf.py
index 0143717..aa9cafe 100644
--- a/logging_conf.py
+++ b/logging_conf.py
@@ -1,22 +1,22 @@
 import os
 from logging.config import dictConfig
 
-autosummary_logging_conf = dictConfig({
-    'version': 1,
-    'formatters': {
-        'default': {
-            'format': '[%(asctime)s] [%(filename)s/%(funcName)s] [%(levelname)s] %(message)s',
-            'datefmt': '%Y-%m-%dT%H:%M:%S'
+autosummary_logging_conf = dictConfig(
+    {
+        "version": 1,
+        "formatters": {
+            "default": {
+                "format": "[%(asctime)s] [%(filename)s/%(funcName)s] [%(levelname)s] %(message)s",
+                "datefmt": "%Y-%m-%dT%H:%M:%S",
+            }
         },
-    },
-    'handlers': {
-        'stdout': {
-            'class': "logging.StreamHandler",
-            'stream': 'ext://sys.stdout',
-            'formatter': 'default'
-        }
-    },
-    'root': {
-        'handlers': ['stdout'],
-        'level': os.getenv('APP_LOG_LEVEL', 'INFO')},
-})
\ No newline at end of file
+        "handlers": {
+            "stdout": {
+                "class": "logging.StreamHandler",
+                "stream": "ext://sys.stdout",
+                "formatter": "default",
+            }
+        },
+        "root": {"handlers": ["stdout"], "level": os.getenv("APP_LOG_LEVEL", "INFO")},
+    }
+)
diff --git a/tests/test_webapp.py b/tests/test_webapp.py
index d63af1c..e81949f 100644
--- a/tests/test_webapp.py
+++ b/tests/test_webapp.py
@@ -9,8 +9,10 @@ class TestWebapp(unittest.TestCase):
         Test bug links can be generated as expected
         """
         test_data = [
-            ("https://bugs.launchpad.net/project/+bug/1955391",
-             '<a href="https://bugs.launchpad.net/project/+bug/1955391/">#1955391</a>'),
+            (
+                "https://bugs.launchpad.net/project/+bug/1955391",
+                '<a href="https://bugs.launchpad.net/project/+bug/1955391/">#1955391</a>',
+            )
         ]
         for web_link, html_link in test_data:
             with self.subTest():
@@ -21,15 +23,37 @@ class TestWebapp(unittest.TestCase):
         Test bug title can be generated as expected
         """
         test_data = [
-            ('Bug #123456 in The Given project: "Actual title of the bug"',
-             "Actual title of the bug"),
-            ('Bug #123456 in The Given project: "Actual \"title\" of the bug"',
-             'Actual "title" of the bug'),
+            (
+                'Bug #123456 in The Given project: "Actual title of the bug"',
+                "Actual title of the bug",
+            ),
+            (
+                'Bug #123456 in The Given project: "Actual "title" of the bug"',
+                'Actual "title" of the bug',
+            ),
         ]
         for full_title, expected_title in test_data:
             with self.subTest():
                 self.assertEqual(webapp.bug_title(full_title), expected_title)
 
+    def test_generate_reports_list(self):
+        """
+        Test raw string of C3 submissions can be turned into a list of URLs
+        """
+        test_data = (
+            "https://certification.canonical.com/hardware/202109-29496/submission/239150/\r\nhttps"
+            "://certification.canonical.com/hardware/202109-29496/submission/238308/\r\nand another "
+            "one:\r\nhttps://certification.canonical.com/hardware/202109-29496/submission/237433/\r\nlast: "
+            "https://certification.canonical.com/hardware/202109-29496/submission/237433/ "
+        )
+        expected_list = [
+            "https://certification.canonical.com/hardware/202109-29496/submission/239150/",
+            "https://certification.canonical.com/hardware/202109-29496/submission/238308/",
+            "https://certification.canonical.com/hardware/202109-29496/submission/237433/",
+            "https://certification.canonical.com/hardware/202109-29496/submission/237433/",
+        ]
+        self.assertEqual(webapp.generate_reports_list(test_data), expected_list)
+
 
 if __name__ == "__main__":
     unittest.main()
diff --git a/webapp/__init__.py b/webapp/__init__.py
index 5eec28f..88a3941 100644
--- a/webapp/__init__.py
+++ b/webapp/__init__.py
@@ -46,6 +46,19 @@ launchpad = Launchpad.login_with(
 )
 
 
+def generate_reports_list(reports):
+    """
+    Take raw reports string from HTML textarea and generate a list of C3 submission URLs.
+    """
+    # C3 submission URL such as:
+    # https://certification.canonical.com/hardware/202109-29496/submission/239150/
+    reports_list = re.findall(
+        r"http?s://[\w.]*/hardware/[\d-]*/submission/[\d-]*/?", reports
+    )
+
+    return reports_list
+
+
 @app.template_filter("cid_to_html")
 def cid_to_html(hardware):
     rexp = r".*(?P<cid>20\d{4}-\d{5,6}).*"
@@ -78,7 +91,7 @@ def bug_link(web_link):
     # https://bugs.launchpad.net/project/+bug/123456
     bug_id = web_link.split("/")[-1]
 
-    bug_link = f"<a href=\"{web_link}/\">#{bug_id}</a>"
+    bug_link = f'<a href="{web_link}/">#{bug_id}</a>'
     return bug_link
 
 
@@ -89,8 +102,8 @@ def bug_title(title):
     """
     # `title` comes from `bug_task.title` and looks like
     # Bug #123456 in The Given project: "Actual title of the bug"
-    idx = title.find("\"")
-    bug_title = title[idx+1:-1]
+    idx = title.find('"')
+    bug_title = title[idx + 1 : -1]
     return bug_title
 
 
@@ -177,12 +190,14 @@ def generate_summary():
     # 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()
-    ]
+
+    if html_report:
+        # Split the string and return the item starting with `http` (our HTML report URL)
+        html_report = [txt for txt in html_report.split() if txt.startswith("http")][0]
+
+    full_test_reports_list = generate_reports_list(full_test_reports)
+    stress_test_reports_list = generate_reports_list(stress_test_reports)
+
     return render_template(
         "summary.html",
         report=report,
@@ -214,8 +229,9 @@ def add_test_status():
         )
         response = res.json()
         status_code = res.status_code
-        logging.info((f"Add status status code: {status_code},"
-                      f" response: {response}"))
+        logging.info(
+            (f"Add status status code: {status_code}," f" response: {response}")
+        )
     except requests.exceptions.ConnectionError:
         response = None
         logging.exception("Cannot connect to Auto Test Status Tracker Web Service")
diff --git a/webapp/templates/index.html b/webapp/templates/index.html
index d220caa..f160c65 100644
--- a/webapp/templates/index.html
+++ b/webapp/templates/index.html
@@ -49,16 +49,16 @@
       <textarea id="hardware" name="hardware" placeholder="E.ON smart speaker PVT and PVT w/ new emmc (CID: 201912-27580)"></textarea>
     </li>
     <li>
-      <label for="full_test_reports">C3 Full Test Report(s):</label>
-      <textarea id="full_test_reports" name="full_test_reports" placeholder="Link(s) to the C3 submission(s), e.g. https://certification.canonical.com/hardware/201712-26014/submission/136315/"></textarea>
+      <label for="full_test_reports">C3 Full Test Reports (one link per line):</label>
+      <textarea id="full_test_reports" name="full_test_reports" placeholder="https://certification.canonical.com/hardware/201712-26014/submission/136315/"></textarea>
     </li>
     <li>
-      <label for="stress_test_reports">C3 Stress Test Report(s):</label>
-      <textarea id="stress_test_reports" name="stress_test_reports" placeholder="Link(s) to the C3 submission(s), e.g. https://certification.canonical.com/hardware/201712-26014/submission/136315/"></textarea>
+      <label for="stress_test_reports">C3 Stress Test Reports (one link per line):</label>
+      <textarea id="stress_test_reports" name="stress_test_reports" placeholder="https://certification.canonical.com/hardware/201712-26014/submission/136315/"></textarea>
     </li>
     <li>
       <label for="html_report">HTML Report:</label>
-      <input type="text" id="html_report" name="html_report" placeholder="e.g. https://drive.google.com/file/d/1AbtuH-Q0a6kPcup4VWluz8RbZu64oOQB">
+      <input type="text" id="html_report" name="html_report" placeholder="https://drive.google.com/file/d/1AbtuH-Q0a6kPcup4VWluz8RbZu64oOQB">
     </li>
     <li>
       <label for="scope">Scope:</label>