Merge branch 'release/2.9.0'

Author: Matthieu Honel

README.md

@@ -49,6 +49,8 @@ Since data is pulled from YWH platform to your server, only regular outbound web
 
 ## Changelog
 
+- v2.9:
+    - prevented issue synchronization to fail when tracker file upload is unsuccessful
 - v2.8:
     - improved Python versions support (>=3.7 to <=3.12)
     - removed the GUI from the default installation (use `pip install 'ywh2bt[gui]'` to include the GUI)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ywh2bt"
-version = "2.8.2"
+version = "2.9.0"
 description = "ywh2bt - YesWeHack to Bug Tracker"
 readme = "README.md"
 authors = ["m.honel <m.honel@yeswehack.com>"]

tox.ini

@@ -2,7 +2,7 @@
 isolated_build = True
 isolated_build_env = .pkg
 toxworkdir={env:TOX_WORK_DIR:.tox}
-envlist = py37, py38, py39, py310, py311, py312
+envlist = py38, py39, py310, py311, py312
 
 [testenv]
 parallel_show_output = True

ywh2bt/core/api/trackers/gitlab.py

@@ -48,6 +48,8 @@
 _TITLE_MAX_SIZE = 255
 _TEXT_MAX_SIZE = 1000000
 
+AttachmentUploadResult = Tuple[Attachment, Optional[str], Optional[str]]
+
 
 class GitLabTrackerClientError(TrackerClientError):
     """A GitLab tracker client error."""
@@ -423,36 +425,57 @@ def _get_gitlab_issue(
 
     def _replace_attachments_references(
         self,
-        uploads: List[Tuple[Attachment, str]],
+        uploads: List[AttachmentUploadResult],
         referencing_texts: List[str],
     ) -> List[str]:
-        for attachment, upload_url in uploads:
-            referencing_texts = [
-                text.replace(
-                    attachment.url,
-                    f"{self.configuration.url}/{self.configuration.project}{upload_url}",
-                )
-                for text in referencing_texts
-            ]
+        for attachment, upload_url, error_message in uploads:
+            if upload_url:
+                referencing_texts = [
+                    text.replace(
+                        attachment.url,
+                        f"{self.configuration.url}/{self.configuration.project}{upload_url}",
+                    )
+                    for text in referencing_texts
+                ]
+            elif error_message:
+                referencing_texts = [
+                    text.replace(
+                        attachment.url,
+                        error_message,
+                    )
+                    for text in referencing_texts
+                ]
         return referencing_texts
 
     def _upload_attachments(
         self,
         gitlab_project: Project,
         attachments: List[Attachment],
-    ) -> List[Tuple[Attachment, str]]:
-        try:
-            return [
-                (
-                    attachment,
-                    gitlab_project.upload(attachment.original_name, attachment.data)["url"],
+    ) -> List[AttachmentUploadResult]:
+        uploads: List[AttachmentUploadResult] = []
+        for attachment in attachments:
+            try:
+                upload = gitlab_project.upload(attachment.original_name, attachment.data)
+            except GitlabError as e:
+                uploads.append(
+                    (
+                        attachment,
+                        None,
+                        (
+                            f'(Attachment "{attachment.original_name}" not available due to upload error: '
+                            f'{getattr(e, "error_message", "Unknown error")})'
+                        ),
+                    ),
                 )
-                for attachment in attachments
-            ]
-        except GitlabError as e:
-            raise GitLabTrackerClientError(
-                f"Unable to upload attachments for project {self.configuration.project} to GitLab",
-            ) from e
+            else:
+                uploads.append(
+                    (
+                        attachment,
+                        upload["url"],
+                        None,
+                    ),
+                )
+        return uploads
 
     def _get_attachments_list_description(
         self,

ywh2bt/core/api/trackers/jira/tracker.py

@@ -42,6 +42,8 @@
 _TITLE_MAX_SIZE = 255
 _TEXT_MAX_SIZE = 32767
 
+AttachmentUploadResult = Tuple[Attachment, Optional[str], Optional[str]]
+
 
 class JiraTrackerClientError(TrackerClientError):
     """A Jira tracker client error."""
@@ -488,45 +490,47 @@ def _add_comment(
 
     def _replace_attachments_references(
         self,
-        uploads: List[Tuple[Attachment, str]],
+        uploads: List[AttachmentUploadResult],
         referencing_texts: List[str],
         unique_name_prefix: str,
     ) -> List[str]:
-        for attachment, upload_url in uploads:
-            referencing_texts = [
-                (
-                    text
-                    # use the unique attachment name for thumbnails otherwise jira is much confused
-                    .replace(
-                        f"[{attachment.original_name}|{attachment.url}]",
-                        (
-                            f"[{self._make_attachment_unique_name(prefix=unique_name_prefix, attachment=attachment)}"
-                            f"|{attachment.url}]"
-                        ),
-                    )
-                    .replace(
-                        f"!{attachment.original_name}|{attachment.url}!",
-                        (
-                            f"!{self._make_attachment_unique_name(prefix=unique_name_prefix, attachment=attachment)}"
-                            f"|{attachment.url}!"
-                        ),
-                    )
+        for attachment, upload_url, error_message in uploads:
+            # use the unique attachment name for thumbnails otherwise jira is much confused
+            unique_name = self._make_attachment_unique_name(prefix=unique_name_prefix, attachment=attachment)
+            if upload_url:
+                referencing_texts = [
+                    text.replace(f"[{attachment.original_name}|{attachment.url}]", f"[{unique_name}|{attachment.url}]")
+                    .replace(f"[{attachment.original_name}]({attachment.url})", f"[{unique_name}|{attachment.url}]")
+                    .replace(f"!{attachment.original_name}|{attachment.url}!", f"!{unique_name}|{attachment.url}!")
                     .replace(
                         attachment.url,
                         upload_url,
                     )
-                )
-                for text in referencing_texts
-            ]
+                    for text in referencing_texts
+                ]
+            elif error_message:
+                referencing_texts = [
+                    (
+                        text
+                        # replace attachment with the error message
+                        .replace(f"[{unique_name}|{attachment.url}]", error_message)
+                        .replace(f"[{unique_name}]({attachment.url})", error_message)
+                        .replace(f"!{unique_name}|{attachment.url}!", error_message)
+                        .replace(f"[{attachment.original_name}|{attachment.url}]", error_message)
+                        .replace(f"[{attachment.original_name}]({attachment.url})", error_message)
+                        .replace(f"!{attachment.original_name}|{attachment.url}!", error_message)
+                    )
+                    for text in referencing_texts
+                ]
         return referencing_texts
 
     def _upload_attachments(
         self,
         issue: JIRAIssue,
         attachments: List[Attachment],
         unique_name_prefix: str,
-    ) -> List[Tuple[Attachment, str]]:
-        uploads = []
+    ) -> List[AttachmentUploadResult]:
+        uploads: List[AttachmentUploadResult] = []
         for attachment in attachments:
             # give each attachment a unique name so there's no confusion when jira displays a thumbnail
             filename = self._make_attachment_unique_name(prefix=unique_name_prefix, attachment=attachment)
@@ -537,19 +541,28 @@ def _upload_attachments(
                     attachment=CustomBytesIO(buffer=attachment.data),  # using CustomBytesIO despite jira expectations
                 )
             except JIRAError as e:
-                raise JiraTrackerClientError(
-                    f"Unable to upload attachments for project {self.configuration.project} to JIRA",
-                ) from e
-            issue_attachment_url = quote(
-                issue_attachment.content,
-                safe=":/?&=",
-            )
-            uploads.append(
-                (
-                    attachment,
-                    issue_attachment_url,
-                ),
-            )
+                uploads.append(
+                    (
+                        attachment,
+                        None,
+                        (
+                            f'(Attachment "{attachment.original_name}" not available due to upload error: '
+                            f'{getattr(e, "text", "Unknown error")})'
+                        ),
+                    ),
+                )
+            else:
+                url = quote(
+                    issue_attachment.content,
+                    safe=":/?&=",
+                )
+                uploads.append(
+                    (
+                        attachment,
+                        url,
+                        None,
+                    )
+                )
         return uploads
 
     @classmethod