Merge ~pieq/oem-qa-autosummary:fix-1929019-double-quote into oem-qa-autosummary:master

[Pierre Equoy]

Cleaned up some helper functions, one of which was creating a bug when generating summaries that contained bugs with double quotes in their titles.

In the process, I rewrote two help functions and added unit tests for them.

Test done:

A. Current version
------------------
1. Run the current version of autosummary
2. Find a project that can be used to generate an autosummary (I used Havana gm3-uc20 milestone)
3. Find a bug in that project that would be displayed in the generated summary
4. Update the title of that bug to include some double quotes ("blabla")
5. Generate the summary

→ The title of the chosen bug is truncated or even completely empty

B. Version in this MR
---------------------
1. Run it locally
2. Find a project that can be used to generate an autosummary (I used Havana gm3-uc20 milestone)
3. Find a bug in that project that would be displayed in the generated summary
4. Update the title of that bug to include some double quotes ("blabla")
5. Generate the summary

→ The title appears as expected

C. Run unit tests with version in this MR
-----------------------------------------

(venv)$ python -m unittest discover -s tests -v
ERROR:root:the mail.content file is not found on the WebDAV server
ERROR:root:sha256sum file for a given image is not found on the WebDAV server
test_get_available_projects (test_summary.TestSummary) ... ok
test_get_date_from_image_name (test_summary.TestSummary)
Test datetimes can be retrieved from image names ... ok
test_bug_link (test_webapp.TestWebapp)
Test bug links can be generated as expected ... ok
test_bug_title (test_webapp.TestWebapp)
Test bug title can be generated as expected ... ok

----------------------------------------------------------------------
Ran 4 tests in 0.004s

OK

[Nara Huang (narahuang)]

LGTM +1

review: Approve

diff --git a/README.md b/README.md
index 1961190..ba79920 100644
--- a/README.md
+++ b/README.md
@@ -92,7 +92,7 @@ Unit tests are written with the standard unittest module, and can be launched
 like this:
 
 ```
-(venv) $ python -m unittest discover -s tests
+(venv) $ python -m unittest discover -s tests -v
 ```
 
 [Flask]: (https://palletsprojects.com/p/flask/)
diff --git a/tests/test_webapp.py b/tests/test_webapp.py
 new file mode 100644
index 0000000..d63af1c
--- /dev/null
+++ b/tests/test_webapp.py
@@ -0,0 +1,35 @@
+import unittest
+
+import webapp
+
+
+class TestWebapp(unittest.TestCase):
+    def test_bug_link(self):
+        """
+        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>'),
+        ]
+        for web_link, html_link in test_data:
+            with self.subTest():
+                self.assertEqual(webapp.bug_link(web_link), html_link)
+
+    def test_bug_title(self):
+        """
+        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'),
+        ]
+        for full_title, expected_title in test_data:
+            with self.subTest():
+                self.assertEqual(webapp.bug_title(full_title), expected_title)
+
+
+if __name__ == "__main__":
+    unittest.main()
diff --git a/webapp/__init__.py b/webapp/__init__.py
index befaea5..329fec0 100644
--- a/webapp/__init__.py
+++ b/webapp/__init__.py
@@ -70,24 +70,27 @@ def pluralize(number, singular="", plural="s"):
 
 
 @app.template_filter("bug_link")
-def bug_link(bug_task):
-    # a bug_task.title looks like
-    # Bug #123456 in The Given project: "Actual title of the bug"
-    rexp = r"Bug #(?P<id>\d*) .*\"(?P<title>.*)\""
-    info = re.search(rexp, bug_task.title).groupdict()
-
-    bug_link = f"<a href=\"{bug_task.web_link}/\">#{info['id']}</a>"
+def bug_link(web_link):
+    """
+    Extract bug ID from a Launchpad Web link and return an HTML link
+    """
+    # `web_link` comes from `bug_task.web_link` and looks like
+    # https://bugs.launchpad.net/project/+bug/123456
+    bug_id = web_link.split("/")[-1]
+
+    bug_link = f"<a href=\"{web_link}/\">#{bug_id}</a>"
     return bug_link
 
 
 @app.template_filter("bug_title")
-def bug_title(bug_task):
-    # a bug_task.title looks like
+def bug_title(title):
+    """
+    Extract the bug title from a Launchpad bug task
+    """
+    # `title` comes from `bug_task.title` and looks like
     # Bug #123456 in The Given project: "Actual title of the bug"
-    rexp = r"Bug #(?P<id>\d*) .*\"(?P<title>.*)\""
-    info = re.search(rexp, bug_task.title).groupdict()
-
-    bug_title = info["title"]
+    idx = title.find("\"")
+    bug_title = title[idx+1:-1]
     return bug_title
 
 
diff --git a/webapp/templates/summary.html b/webapp/templates/summary.html
index c409720..d51ef18 100644
--- a/webapp/templates/summary.html
+++ b/webapp/templates/summary.html
@@ -16,7 +16,7 @@
     {% for importance, bugs in report_bug_list|groupby("importance") if importance in ["Critical", "High"] %}
         <dt>{{ importance }}</dt>
         {% for bug in bugs %}
-        <dd>{{ bug|bug_link|safe }} {{ bug|bug_title }}</dd>
+        <dd>{{ bug.web_link|bug_link|safe }} {{ bug.title|bug_title }}</dd>
         {% endfor %}
     {% else %}
         <dt>Critical/High</dt>
@@ -24,7 +24,7 @@
     {% endfor %}
         <dt>Other</dt>
         {% for bug in report_bug_list if bug.importance not in ["Critical", "High"] %}
-        <dd>{{ bug|bug_link|safe }} {{ bug|bug_title }}</dd>
+        <dd>{{ bug.web_link|bug_link|safe }} {{ bug.title|bug_title }}</dd>
         {% else %}
         <dd><em>None</em></dd>
         {% endfor %}