Merge branch 'release/2.10.0'

Author: hlavanant

README.md

@@ -49,6 +49,9 @@ Since data is pulled from YWH platform to your server, only regular outbound web
 
 ## Changelog
 
+- v2.10: 
+    - added support for new ask for fix process
+    - added support for report transfer log 
 - v2.9:
     - prevented issue synchronization to fail when tracker file upload is unsuccessful
 - v2.8:

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ywh2bt"
-version = "2.9.0"
+version = "2.10.0"
 description = "ywh2bt - YesWeHack to Bug Tracker"
 readme = "README.md"
 authors = ["m.honel <m.honel@yeswehack.com>"]
@@ -68,7 +68,7 @@ frozenlist = [
     { version="^1.3.0", python = "<3.8" },
     { version="^1.4.0", python = ">=3.8" },
 ]
-yeswehack = ">=0.8.3"
+yeswehack = ">=0.8.7"
 
 [tool.poetry.extras]
 gui = ["pyside6"]

pyproject.toml

@@ -127,6 +127,10 @@ class Log:
     tracker_id: Optional[str]
     tracker_token: Optional[str]
     fix_verified: bool
+    old_program: Optional[Dict[str, Any]]
+    program: Optional[Dict[str, Any]]
+    old_ask_for_fix_verification_status: Optional[str]
+    new_ask_for_fix_verification_status: Optional[str]
 
 
 class Report:
@@ -165,6 +169,7 @@ class Report:
     title: Optional[str]
     tracking_status: str
     vulnerable_part: str
+    ask_for_fix_verification_status: str
 
     def __init__(
         self,
@@ -221,6 +226,13 @@ class Report:
         attachments: Optional[List[str]] = None,
     ) -> List[Log]: ...
 
+    def put_ask_for_fix_verification_status(
+        self,
+        status: str,
+        message: Optional[str] = None,
+        attachments: Optional[List[str]] = None,
+    ) -> List[Log]: ...
+
 
 class Program:
     ywh_api: YesWeHack

stubs/yeswehack/api.pyi

@@ -11,8 +11,10 @@
 from typing_extensions import Protocol
 
 from ywh2bt.core.api.models.report import (
+    REPORT_ASK_FOR_FIX_VERIFICATION_STATUS_TRANSLATIONS,
     REPORT_PROPERTY_LABELS,
     REPORT_STATUS_TRANSLATIONS,
+    AskForFixverificationStatusLog,
     CloseLog,
     CommentLog,
     CvssUpdateLog,
@@ -23,6 +25,7 @@
     Report,
     RewardLog,
     StatusUpdateLog,
+    TransferLog,
 )
 
 
@@ -54,6 +57,8 @@ class ReportMessageFormatter(ABC):
     _details_update_log_template: Template
     _details_update_log_line_template: Template
     _priority_update_log_template: Template
+    _transfer_log_template: Template
+    _ask_for_fix_verification_status_log_template: Template
     _reward_log_template: Template
     _value_transformer: _ValueTransformer
 
@@ -71,6 +76,8 @@ def __init__(
         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,
         value_transformer: Optional[_ValueTransformer] = None,
     ):
         """
@@ -89,6 +96,8 @@ def __init__(
             details_update_log_line_template: a template for entries of a DetailsUpdateLog
             priority_update_log_template: a template for a PriorityUpdateLog
             reward_log_template: a template for a RewardLog
+            transfer_log_template: a template for a TransferLog
+            ask_for_fix_verification_status_log_template: a template for a AskForFixVerificationStatusLog
             value_transformer: a transformer for values
         """
         self._report_title_template = report_title_template
@@ -104,6 +113,8 @@ def __init__(
         self._priority_update_log_template = priority_update_log_template
         self._reward_log_template = reward_log_template
         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
 
     def _transform_value(
         self,
@@ -300,6 +311,36 @@ def _transform_fix_verified_log(
             ),
         )
 
+    @_transform_log.register
+    def _transform_transfer_log(
+        self,
+        log: TransferLog,
+    ) -> str:
+        return self._transfer_log_template.substitute(
+            old_program=(log.old_program or {}).get("title") or "",
+            program=(log.program or {}).get("title") or "",
+            comment=self.transform_html(
+                html=log.message_html,
+            ),
+        )
+
+    @_transform_log.register
+    def _transform_ask_for_fix_verification_log(
+        self,
+        log: AskForFixverificationStatusLog,
+    ) -> str:
+        return self._ask_for_fix_verification_status_log_template.substitute(
+            old_ask_for_fix_verification_status=self._translate_ask_for_fix_verification_status(
+                status=log.old_ask_for_fix_verification_status or "",
+            ),
+            new_ask_for_fix_verification_status=self._translate_ask_for_fix_verification_status(
+                status=log.new_ask_for_fix_verification_status or "",
+            ),
+            comment=self.transform_html(
+                html=log.message_html,
+            ),
+        )
+
     @_transform_log.register
     def _transform_close_log(
         self,
@@ -323,6 +364,12 @@ def _translate_status(
     ) -> 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,

ywh2bt/core/api/formatter/formatter.py

@@ -85,6 +85,20 @@
 REWARD_LOG_TEMPLATE = """
 **Comment from reward**:
 
+${comment}
+"""
+TRANSFER_LOG_TEMPLATE = """
+**Report transferred**:
+
+${old_program} -> ${program}
+"""
+ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE = """
+**Fix verification**:
+
+${new_ask_for_fix_verification_status}
+
+**Comment**:
+
 ${comment}
 """
 
@@ -113,6 +127,8 @@ def __init__(self) -> None:
             details_update_log_line_template=Template(DETAILS_UPDATE_LOG_LINE_TEMPLATE),
             priority_update_log_template=Template(PRIORITY_UPDATE_LOG_TEMPLATE),
             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),
             value_transformer=_html_transformer,
         )
 

ywh2bt/core/api/formatter/markdown.py

@@ -17,6 +17,7 @@
 from yeswehack.api import Report as YesWeHackRawApiReport
 
 from ywh2bt.core.api.models.report import (
+    AskForFixverificationStatusLog,
     Attachment,
     Author,
     BugType,
@@ -36,6 +37,7 @@
     TrackerMessageLog,
     TrackerUpdateLog,
     TrackingStatusLog,
+    TransferLog,
 )
 from ywh2bt.core.html import (
     cleanup_attachments_and_urls_from_html,
@@ -129,6 +131,7 @@ def map_raw_report(
             context=context,
             raw_program=raw_report.program or {},
         ),
+        ask_for_fix_verification_status=raw_report.ask_for_fix_verification_status,
     )
 
 
@@ -452,6 +455,30 @@ def map_raw_log(
             attachments=attachments,
             verified=raw_log.fix_verified,
         )
+    if raw_log.type == "transfer":
+        return TransferLog(
+            created_at=created_at,
+            log_id=log_id,
+            log_type=log_type,
+            private=private,
+            author=author,
+            message_html=message_html,
+            attachments=attachments,
+            program=raw_log.program,
+            old_program=raw_log.old_program,
+        )
+    if raw_log.type == "ask-for-fix-verification-status":
+        return AskForFixverificationStatusLog(
+            created_at=created_at,
+            log_id=log_id,
+            log_type=log_type,
+            private=private,
+            author=author,
+            message_html=message_html,
+            attachments=attachments,
+            new_ask_for_fix_verification_status=raw_log.new_ask_for_fix_verification_status,
+            old_ask_for_fix_verification_status=raw_log.old_ask_for_fix_verification_status,
+        )
     return Log(
         created_at=created_at,
         log_id=log_id,

ywh2bt/core/api/mapping.py

@@ -48,6 +48,14 @@
         "auto_close": "Auto Close",
     }
 )
+REPORT_ASK_FOR_FIX_VERIFICATION_STATUS_TRANSLATIONS = MappingProxyType(
+    {
+        "pending": "Pending fix verification",
+        "confirmed": "Fix confirmed",
+        "rejected": "Fix rejected",
+        "cancelled": "Fix verification cancelled",
+    }
+)
 
 
 @dataclass
@@ -73,6 +81,7 @@ class Report:
     status: str
     tracking_status: str
     program: ReportProgram
+    ask_for_fix_verification_status: str
     priority: Optional[Priority] = None
 
     def get_last_tracking_status_update_log(
@@ -330,6 +339,22 @@ class FixVerifiedLog(Log):
     verified: bool
 
 
+@dataclass
+class TransferLog(Log):
+    """A transfer log."""
+
+    old_program: Optional[Dict[str, Any]]
+    program: Optional[Dict[str, Any]]
+
+
+@dataclass
+class AskForFixverificationStatusLog(Log):
+    """A ask-for-fix-verification-status log."""
+
+    new_ask_for_fix_verification_status: Optional[str]
+    old_ask_for_fix_verification_status: Optional[str]
+
+
 class _LogFilterProtocol(Protocol):
     def __call__(
         self,

ywh2bt/core/api/models/report.py

@@ -90,6 +90,20 @@
 REWARD_LOG_TEMPLATE = """
 *Comment from reward*:
 
+${comment}
+"""
+TRANSFER_LOG_TEMPLATE = """
+*Report transferred*:
+
+${old_program} -> ${program}
+"""
+ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE = """
+*Fix verification*:
+
+${new_ask_for_fix_verification_status}
+
+*Comment*:
+
 ${comment}
 """
 
@@ -152,6 +166,8 @@ def __init__(self) -> None:
             details_update_log_line_template=Template(DETAILS_UPDATE_LOG_LINE_TEMPLATE),
             priority_update_log_template=Template(PRIORITY_UPDATE_LOG_TEMPLATE),
             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),
         )
 
     def transform_report_description_html(

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

@@ -80,6 +80,18 @@
 Comment from reward:
 ${comment}
 """
+TRANSFER_LOG_TEMPLATE = """
+Report transferred:
+    - ${old_program}
+    - ${program}
+"""
+ASK_FOR_FIX_VERIFICATION_STATUS_LOG_TEMPLATE = """
+Fix verification:
+${new_ask_for_fix_verification_status}
+
+Comment:
+${comment}
+"""
 
 
 class ServiceNowReportMessageFormatter(ReportMessageFormatter):
@@ -100,6 +112,8 @@ def __init__(self) -> None:
             details_update_log_line_template=Template(DETAILS_UPDATE_LOG_LINE_TEMPLATE),
             priority_update_log_template=Template(PRIORITY_UPDATE_LOG_TEMPLATE),
             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),
         )
 
     def transform_report_description_html(