[Implement #78] Add support for triage status log

Author: Fabien LUCAS

stubs/yeswehack/api.pyi

@@ -131,6 +131,8 @@ class Log:
     program: Optional[Dict[str, Any]]
     old_ask_for_fix_verification_status: Optional[str]
     new_ask_for_fix_verification_status: Optional[str]
+    old_triage_status: Optional[str]
+    new_triage_status: Optional[str]
 
 
 class Report:

ywh2bt/core/api/formatter/formatter.py

@@ -14,6 +14,7 @@
     REPORT_ASK_FOR_FIX_VERIFICATION_STATUS_TRANSLATIONS,
     REPORT_PROPERTY_LABELS,
     REPORT_STATUS_TRANSLATIONS,
+    REPORT_TRIAGE_STATUS_TRANSLATIONS,
     AskForFixverificationStatusLog,
     CloseLog,
     CommentLog,
@@ -26,6 +27,7 @@
     RewardLog,
     StatusUpdateLog,
     TransferLog,
+    TriageStatusLog,
 )
 
 
@@ -57,9 +59,10 @@ class ReportMessageFormatter(ABC):
     _details_update_log_template: Template
     _details_update_log_line_template: Template
     _priority_update_log_template: Template
+    _reward_log_template: Template
     _transfer_log_template: Template
     _ask_for_fix_verification_status_log_template: Template
-    _reward_log_template: Template
+    _triage_status_log_template: Template
     _value_transformer: _ValueTransformer
 
     def __init__(
@@ -78,6 +81,7 @@ def __init__(
         reward_log_template: Template,
         transfer_log_template: Template,
         ask_for_fix_verification_status_log_template: Template,
+        triage_status_log_template: Template,
         value_transformer: Optional[_ValueTransformer] = None,
     ):
         """
@@ -115,6 +119,7 @@ def __init__(
         self._value_transformer = value_transformer or _identity_transformer
         self._transfer_log_template = transfer_log_template
         self._ask_for_fix_verification_status_log_template = ask_for_fix_verification_status_log_template
+        self._triage_status_log_template = triage_status_log_template
 
     def _transform_value(
         self,
@@ -362,18 +367,6 @@ def _transform_close_log(
             ),
         )
 
-    def _translate_status(
-        self,
-        status: str,
-    ) -> str:
-        return REPORT_STATUS_TRANSLATIONS.get(status, "")
-
-    def _translate_ask_for_fix_verification_status(
-        self,
-        status: str,
-    ) -> str:
-        return REPORT_ASK_FOR_FIX_VERIFICATION_STATUS_TRANSLATIONS.get(status.lower(), "")
-
     @_transform_log.register
     def _transform_details_update_log(
         self,
@@ -418,3 +411,38 @@ def _format_reward_log(
                 html=log.message_html,
             ),
         )
+
+    @_transform_log.register
+    def _transform_triage_status_log(
+        self,
+        log: TriageStatusLog,
+    ) -> str:
+        return self._triage_status_log_template.substitute(
+            new_triage_status=self._translate_triage_status(
+                status=log.new_triage_status or "",
+            ),
+            old_triage_status=self._translate_triage_status(
+                status=log.old_triage_status or "",
+            ),
+            comment=self.transform_html(
+                html=log.message_html,
+            ),
+        )
+
+    def _translate_status(
+        self,
+        status: str,
+    ) -> str:
+        return REPORT_STATUS_TRANSLATIONS.get(status, "")
+
+    def _translate_ask_for_fix_verification_status(
+        self,
+        status: str,
+    ) -> str:
+        return REPORT_ASK_FOR_FIX_VERIFICATION_STATUS_TRANSLATIONS.get(status.lower(), "")
+
+    def _translate_triage_status(
+        self,
+        status: str,
+    ) -> str:
+        return REPORT_TRIAGE_STATUS_TRANSLATIONS.get(status.lower(), "")

ywh2bt/core/api/formatter/markdown.py

@@ -42,6 +42,15 @@
 COMMENT_LOG_TEMPLATE = """
 **Comment**:
 
+${comment}
+"""
+TRIAGE_STATUS_LOG_TEMPLATE = """
+**Triage status updated**:
+
+${old_triage_status} -> ${new_triage_status}
+
+**Comment**:
+
 ${comment}
 """
 CVSS_UPDATE_LOG_TEMPLATE = """
@@ -131,6 +140,7 @@ def __init__(self) -> None:
             reward_log_template=Template(REWARD_LOG_TEMPLATE),
             transfer_log_template=Template(TRANSFER_LOG_TEMPLATE),
             ask_for_fix_verification_status_log_template=Template(ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE),
+            triage_status_log_template=Template(TRIAGE_STATUS_LOG_TEMPLATE),
             value_transformer=_html_transformer,
         )
 

ywh2bt/core/api/mapping.py

@@ -38,6 +38,7 @@
     TrackerUpdateLog,
     TrackingStatusLog,
     TransferLog,
+    TriageStatusLog,
 )
 from ywh2bt.core.html import (
     cleanup_attachments_and_urls_from_html,
@@ -332,6 +333,22 @@ def map_raw_log(
             old_status=raw_log.old_status,
             new_status=raw_log.status,
         )
+    if (
+        (raw_log.type == "comment" or raw_log.type == "assign")
+        and raw_log.old_triage_status
+        and raw_log.new_triage_status
+    ):
+        return TriageStatusLog(
+            created_at=created_at,
+            log_id=log_id,
+            log_type=log_type,
+            private=private,
+            author=author,
+            message_html=message_html,
+            attachments=attachments,
+            old_triage_status=raw_log.old_triage_status,
+            new_triage_status=raw_log.new_triage_status,
+        )
     if raw_log.type == "comment" or (raw_log.type == "assign" and message_html):
         return CommentLog(
             created_at=created_at,

ywh2bt/core/api/models/report.py

@@ -58,6 +58,15 @@
         "cancelled": "Fix verification cancelled",
     }
 )
+REPORT_TRIAGE_STATUS_TRANSLATIONS = MappingProxyType(
+    {
+        "not_available": "Not available",
+        "in_progress": "In progress",
+        "awaiting_info": "Awaiting info",
+        "assessed": "Assessed",
+        "done": "Done",
+    }
+)
 
 
 @dataclass
@@ -359,6 +368,14 @@ class AskForFixverificationStatusLog(Log):
     old_ask_for_fix_verification_status: Optional[str]
 
 
+@dataclass
+class TriageStatusLog(Log):
+    """A triage status log."""
+
+    old_triage_status: str
+    new_triage_status: str
+
+
 class _LogFilterProtocol(Protocol):
     def __call__(
         self,

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

@@ -49,6 +49,15 @@
 COMMENT_LOG_TEMPLATE = """
 *Comment*:
 
+${comment}
+"""
+TRIAGE_STATUS_LOG_TEMPLATE = """
+**Triage status updated**:
+
+${old_triage_status} -> ${new_triage_status}
+
+**Comment**:
+
 ${comment}
 """
 CVSS_UPDATE_LOG_TEMPLATE = """
@@ -170,6 +179,7 @@ def __init__(self) -> None:
             reward_log_template=Template(REWARD_LOG_TEMPLATE),
             transfer_log_template=Template(TRANSFER_LOG_TEMPLATE),
             ask_for_fix_verification_status_log_template=Template(ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE),
+            triage_status_log_template=Template(TRIAGE_STATUS_LOG_TEMPLATE),
         )
 
     def transform_report_description_html(

ywh2bt/core/api/trackers/servicenow/formatter.py

@@ -41,6 +41,15 @@
 """
 COMMENT_LOG_TEMPLATE = """
 Comment:
+${comment}
+"""
+TRIAGE_STATUS_LOG_TEMPLATE = """
+**Triage status updated**:
+
+${old_triage_status} -> ${new_triage_status}
+
+**Comment**:
+
 ${comment}
 """
 CVSS_UPDATE_LOG_TEMPLATE = """
@@ -116,6 +125,7 @@ def __init__(self) -> None:
             reward_log_template=Template(REWARD_LOG_TEMPLATE),
             transfer_log_template=Template(TRANSFER_LOG_TEMPLATE),
             ask_for_fix_verification_status_log_template=Template(ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE),
+            triage_status_log_template=Template(TRIAGE_STATUS_LOG_TEMPLATE),
         )
 
     def transform_report_description_html(

ywh2bt/core/configuration/yeswehack.py

@@ -96,6 +96,12 @@ class SynchronizeOptions(AttributesContainer):
         description="Upload the report transfer updates into the bug tracker",
         default=False,
     )
+    upload_triage_status_updates: BoolAttributeType = Attribute.create(
+        value_type=bool,
+        short_description="Upload triage status updates",
+        description="Upload the report triage status updates into the bug tracker",
+        default=False,
+    )
     recreate_missing_issues: BoolAttributeType = Attribute.create(
         value_type=bool,
         short_description="Recreate missing issues",
@@ -117,6 +123,7 @@ def __init__(
         upload_rewards: Optional[bool] = None,
         upload_status_updates: Optional[bool] = None,
         upload_transfer_updates: Optional[bool] = None,
+        upload_triage_status_updates: Optional[bool] = None,
         recreate_missing_issues: Optional[bool] = None,
         **kwargs: Any,
     ):
@@ -146,6 +153,7 @@ def __init__(
         self.upload_rewards = upload_rewards
         self.upload_status_updates = upload_status_updates
         self.upload_transfer_updates = upload_transfer_updates
+        self.upload_triage_status_updates = upload_triage_status_updates
         self.recreate_missing_issues = recreate_missing_issues
 
 

ywh2bt/core/synchronizer/synchronizer.py

@@ -33,6 +33,7 @@
     TrackerUpdateLog,
     TrackingStatusLog,
     TransferLog,
+    TriageStatusLog,
 )
 from ywh2bt.core.api.tracker import (
     SendLogsResult,
@@ -576,6 +577,7 @@ def _is_synchronizable_log(
                     and synchronize_options.upload_status_updates
                 ),
                 isinstance(log, TransferLog) and synchronize_options.upload_transfer_updates,
+                isinstance(log, TriageStatusLog) and synchronize_options.upload_triage_status_updates,
             )
         )