firefighter-incident 0.0.27__tar.gz → 0.0.28__tar.gz

{firefighter_incident-0.0.27 → firefighter_incident-0.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: firefighter-incident
-Version: 0.0.27
+Version: 0.0.28
 Summary: Incident Management tool made for Slack using Django
 Project-URL: Repository, https://github.com/ManoManoTech/firefighter-incident
 Project-URL: Documentation, https://manomanotech.github.io/firefighter-incident/latest/

{firefighter_incident-0.0.27 → firefighter_incident-0.0.28}/firefighter/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.27'
-__version_tuple__ = version_tuple = (0, 0, 27)
+__version__ = version = '0.0.28'
+__version_tuple__ = version_tuple = (0, 0, 28)
 
 __commit_id__ = commit_id = None

firefighter_incident-0.0.28/firefighter/jira_app/templates/jira/postmortem/impact.txt

@@ -0,0 +1,17 @@
+h2. Impact
+
+h3. Business Impact
+
+*{color:red}_TODO: Describe the business impact and precise the BV daily loss._{color}*
+*{color:red}_For the BV daily loss, use [this documentation|https://manomano.atlassian.net/wiki/spaces/TC/pages/4089315451/How+to+calculate+BV+loss]._{color}*
+
+h3. User Impact
+
+*{color:red}_TODO: Describe the impact on users._{color}*
+
+h3. Affected Systems
+{% if components %}
+{% for component in components %}* {{ component.name }}
+{% endfor %}
+{% else %}_No components recorded._
+{% endif %}

{firefighter_incident-0.0.27 → firefighter_incident-0.0.28}/firefighter/slack/messages/slack_messages.py

@@ -109,15 +109,36 @@ class SlackMessageIncidentPostMortemReminder(SlackMessageSurface):
                     action_id=UpdateStatusModal.open_action,
                 ),
             ),
-            SectionBlock(
-                text="2. Edit your post-mortem on Confluence",
-                accessory=ButtonElement(
-                    text="Edit post-mortem",
-                    value=self.incident.postmortem_for.page_edit_url,
-                    url=self.incident.postmortem_for.page_edit_url,
-                    action_id="open_link",
-                ),
-            ),
+        ]
+
+        # Add post-mortem editing options based on available services
+        if hasattr(self.incident, "postmortem_for") and self.incident.postmortem_for:
+            blocks.append(
+                SectionBlock(
+                    text="2. Edit your post-mortem on Confluence",
+                    accessory=ButtonElement(
+                        text="Edit post-mortem",
+                        value=self.incident.postmortem_for.page_edit_url,
+                        url=self.incident.postmortem_for.page_edit_url,
+                        action_id="open_link",
+                    ),
+                )
+            )
+        elif hasattr(self.incident, "jira_postmortem_for") and self.incident.jira_postmortem_for:
+            jira_pm = self.incident.jira_postmortem_for
+            blocks.append(
+                SectionBlock(
+                    text="2. Edit your post-mortem on Jira",
+                    accessory=ButtonElement(
+                        text=f"Edit Jira post-mortem ({jira_pm.jira_issue_key})",
+                        url=jira_pm.issue_url,
+                        action_id="open_link",
+                    ),
+                )
+            )
+
+        # Continue with remaining steps
+        blocks.extend([
             SectionBlock(
                 text=f"3. Submit the key events to {APP_DISPLAY_NAME}",
                 **accessory_kwargs,
@@ -138,7 +159,8 @@ class SlackMessageIncidentPostMortemReminder(SlackMessageSurface):
                     )
                 ]
             ),
-        ]
+        ])
+
         if POSTMORTEM_HELP_URL:
             blocks.insert(
                 4,
@@ -184,14 +206,30 @@ class SlackMessageIncidentFixedNextActions(SlackMessageSurface):
                 ),
             ),
             DividerBlock(),
-            ContextBlock(
-                elements=[
-                    MarkdownTextObject(
-                        text="A post-mortem is *not* required for this incident.\nIf you want to create one, use `/incident postmortem` to create a new post-mortem page on Confluence."
-                    )
-                ]
-            ),
         ]
+
+        # Add post-mortem context message if any post-mortem service is enabled
+        enable_confluence = getattr(settings, "ENABLE_CONFLUENCE", False)
+        enable_jira_postmortem = getattr(settings, "ENABLE_JIRA_POSTMORTEM", False)
+
+        if enable_confluence or enable_jira_postmortem:
+            postmortem_text = "A post-mortem is *not* required for this incident.\nIf you want to create one, use `/incident postmortem` to create a new post-mortem page"
+
+            if enable_confluence and enable_jira_postmortem:
+                postmortem_text += " on Confluence or Jira."
+            elif enable_confluence:
+                postmortem_text += " on Confluence."
+            elif enable_jira_postmortem:
+                postmortem_text += " on Jira."
+
+            blocks.append(
+                ContextBlock(
+                    elements=[
+                        MarkdownTextObject(text=postmortem_text)
+                    ]
+                )
+            )
+
         return blocks
 
 
@@ -612,7 +650,23 @@ class SlackMessageIncidentPostMortemCreated(SlackMessageSurface):
         return "\n".join(parts)
 
     def get_blocks(self) -> list[Block]:
-        return [SectionBlock(text=self.get_text())]
+        blocks: list[Block] = [SectionBlock(text=self.get_text())]
+
+        # Add documentation link if Jira post-mortem exists
+        if hasattr(self.incident, "jira_postmortem_for") and self.incident.jira_postmortem_for:
+            blocks.append(
+                SectionBlock(
+                    text="Need guidance on how to fill Post-Mortems in Jira? See our documentation",
+                    accessory=ButtonElement(
+                        text="Open documentation",
+                        url="https://manomano.atlassian.net/wiki/spaces/TC/pages/5639635000/How+to+fill+Post-Mortems+in+Jira",
+                        value="jira_postmortem_documentation",
+                        action_id="open_link",
+                    ),
+                )
+            )
+
+        return blocks
 
 
 class SlackMessageIncidentPostMortemCreatedAnnouncement(SlackMessageSurface):
@@ -696,7 +750,7 @@ class SlackMessagePostMortemReminder5Days(SlackMessageSurface):
         if hasattr(self.incident, "postmortem_for"):
             pm_links.append(
                 ButtonElement(
-                    text="Open Confluence Post-Mortem",
+                    text="Open Post-Mortem (Confluence)",
                     url=self.incident.postmortem_for.page_edit_url,
                     action_id="open_link",
                 )

firefighter_incident-0.0.28/firefighter/slack/views/modals/postmortem.py

@@ -0,0 +1,147 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING, Any
+
+from django.core.exceptions import ObjectDoesNotExist
+from slack_sdk.models.blocks.block_elements import ButtonElement
+from slack_sdk.models.blocks.blocks import ActionsBlock, Block, SectionBlock
+from slack_sdk.models.views import View
+
+from firefighter.confluence.models import PostMortemManager
+from firefighter.incidents.models.incident import Incident
+from firefighter.slack.utils import respond
+from firefighter.slack.views.modals.base_modal.base import SlackModal, app
+from firefighter.slack.views.modals.base_modal.mixins import (
+    IncidentSelectableModalMixin,
+)
+
+if TYPE_CHECKING:
+    from slack_bolt.context.ack.ack import Ack
+
+
+logger = logging.getLogger(__name__)
+
+
+class PostMortemModal(
+    IncidentSelectableModalMixin,
+    SlackModal,
+):
+    open_action: str = "open_modal_create_postmortem"
+    push_action: str = "push_modal_create_postmortem"
+    callback_id: str = "incident_create_postmortem"
+
+    def build_modal_fn(self, incident: Incident, **kwargs: Any) -> View:
+        blocks: list[Block] = []
+
+        # Check existing post-mortems
+        has_confluence = _safe_has_relation(incident, "postmortem_for")
+        has_jira = _safe_has_relation(incident, "jira_postmortem_for")
+
+        if has_confluence or has_jira:
+            blocks.append(
+                SectionBlock(text=f"Post-mortem(s) for incident #{incident.id}:")
+            )
+
+            if has_confluence:
+                blocks.append(
+                    SectionBlock(
+                        text=f"• Confluence: <{incident.postmortem_for.page_url}|View page>"
+                    )
+                )
+
+            if has_jira:
+                blocks.append(
+                    SectionBlock(
+                        text=f"• Jira: <{incident.jira_postmortem_for.issue_url}|{incident.jira_postmortem_for.jira_issue_key}>"
+                    )
+                )
+        elif incident.needs_postmortem:
+            blocks.append(
+                SectionBlock(
+                    text=f"Post-mortem for incident #{incident.id} will be automatically created when the incident reaches MITIGATED status."
+                )
+            )
+        else:
+            blocks.extend(
+                [
+                    SectionBlock(
+                        text="P3 incident post-mortem is not mandatory. You can still have one if you think is necessary by clicking on the button below."
+                    ),
+                    ActionsBlock(
+                        elements=[
+                            ButtonElement(
+                                text="Create post-mortem now",
+                                action_id="incident_create_postmortem_now",
+                                value=str(incident.id),
+                            )
+                        ]
+                    ),
+                ]
+            )
+
+        return View(
+            type="modal",
+            title="Postmortem"[:24],
+            submit=None,
+            callback_id=self.callback_id,
+            private_metadata=str(incident.id),
+            blocks=blocks,
+        )
+
+    @staticmethod
+    def handle_modal_fn(ack: Ack, **_kwargs: Any) -> None:
+        # This modal is now read-only (no submit button)
+        # Post-mortems are created automatically when incident reaches MITIGATED status
+        ack()
+
+
+@app.action("incident_create_postmortem_now")
+def handle_create_postmortem_action(ack: Ack, body: dict[str, Any]) -> None:
+    """Create post-mortem(s) on demand from the modal (e.g. P3+ incidents)."""
+    ack()
+
+    incident_id = str(body.get("actions", [{}])[0].get("value", "")).strip()
+    try:
+        incident = Incident.objects.get(pk=incident_id)
+    except Incident.DoesNotExist:
+        respond(body, text=":x: Incident not found.")
+        return
+
+    try:
+        confluence_pm, jira_pm = PostMortemManager.create_postmortem_for_incident(
+            incident
+        )
+    except Exception:
+        logger.exception("Failed to create post-mortem for incident #%s", incident_id)
+        respond(body, text=":x: Failed to create post-mortem. Please try again.")
+        return
+
+    created_targets: list[str] = []
+    if confluence_pm:
+        created_targets.append("Confluence")
+    if jira_pm:
+        created_targets.append("Jira")
+
+    if created_targets:
+        targets = " and ".join(created_targets)
+        respond(body, text=f":white_check_mark: {targets} post-mortem created.")
+    else:
+        respond(body, text=":warning: No post-mortem was created.")
+
+
+modal_postmortem = PostMortemModal()
+
+
+def _safe_has_relation(instance: Incident, attr: str) -> bool:
+    """Safely check if a reverse relation exists without triggering KeyError in cache.
+
+    Django's reverse OneToOne descriptor can raise KeyError when using hasattr
+    on unsaved or freshly created instances. We guard against that here.
+    """
+    try:
+        getattr(instance, attr)
+    except (AttributeError, ObjectDoesNotExist, KeyError):
+        return False
+    else:
+        return True

firefighter_incident-0.0.28/firefighter_tests/test_slack/views/modals/test_postmortem_modal.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+from types import SimpleNamespace
+
+from firefighter.slack.views.modals.postmortem import PostMortemModal
+
+
+class TestPostMortemModal:
+    @staticmethod
+    def _get_text_blocks(view_dict: dict) -> list[str]:
+        return [
+            block.get("text", {}).get("text", "")
+            for block in view_dict.get("blocks", [])
+            if block.get("type") == "section"
+        ]
+
+    @staticmethod
+    def _get_action_elements(view_dict: dict) -> list[dict]:
+        elements: list[dict] = []
+        for block in view_dict.get("blocks", []):
+            if block.get("type") == "actions":
+                elements.extend(block.get("elements", []))
+        return elements
+
+    @staticmethod
+    def test_p1_p2_shows_auto_creation_message(mocker):
+        incident = SimpleNamespace(id=123, needs_postmortem=True)
+
+        # No existing PMs
+        mocker.patch(
+            "firefighter.slack.views.modals.postmortem._safe_has_relation",
+            return_value=False,
+            create=True,
+        )
+
+        view = PostMortemModal().build_modal_fn(incident)
+        view_dict = view.to_dict()
+
+        texts = TestPostMortemModal._get_text_blocks(view_dict)
+        assert any(
+            "automatically created when the incident reaches MITIGATED" in t
+            for t in texts
+        )
+        # No manual-create button for mandatory PMs
+        action_ids = [
+            el.get("action_id")
+            for el in TestPostMortemModal._get_action_elements(view_dict)
+        ]
+        assert "incident_create_postmortem_now" not in action_ids
+
+    @staticmethod
+    def test_p3_shows_optional_message_and_button(mocker):
+        incident = SimpleNamespace(id=456, needs_postmortem=False)
+
+        # No existing PMs
+        mocker.patch(
+            "firefighter.slack.views.modals.postmortem._safe_has_relation",
+            return_value=False,
+            create=True,
+        )
+
+        view = PostMortemModal().build_modal_fn(incident)
+        view_dict = view.to_dict()
+
+        texts = TestPostMortemModal._get_text_blocks(view_dict)
+        assert any("P3 incident post-mortem is not mandatory" in t for t in texts)
+
+        action_ids = [
+            el.get("action_id")
+            for el in TestPostMortemModal._get_action_elements(view_dict)
+        ]
+        assert "incident_create_postmortem_now" in action_ids

firefighter_incident-0.0.27/firefighter/jira_app/templates/jira/postmortem/impact.txt

@@ -1,12 +0,0 @@
-h2. Impact
-
-h3. Affected Systems
-{% if components %}
-{% for component in components %}* {{ component.name }}
-{% endfor %}
-{% else %}_No components recorded._
-{% endif %}
-
-h3. User Impact
-
-*{color:red}_TODO: Describe the impact on users and business._{color}*

firefighter_incident-0.0.27/firefighter/slack/views/modals/postmortem.py

@@ -1,79 +0,0 @@
-from __future__ import annotations
-
-import logging
-from typing import TYPE_CHECKING, Any
-
-from slack_sdk.models.blocks.blocks import Block, SectionBlock
-from slack_sdk.models.views import View
-
-from firefighter.slack.views.modals.base_modal.base import SlackModal
-from firefighter.slack.views.modals.base_modal.mixins import (
-    IncidentSelectableModalMixin,
-)
-
-if TYPE_CHECKING:
-    from slack_bolt.context.ack.ack import Ack
-
-    from firefighter.incidents.models.incident import Incident
-
-
-logger = logging.getLogger(__name__)
-
-
-class PostMortemModal(
-    IncidentSelectableModalMixin,
-    SlackModal,
-):
-    open_action: str = "open_modal_create_postmortem"
-    push_action: str = "push_modal_create_postmortem"
-    callback_id: str = "incident_create_postmortem"
-
-    def build_modal_fn(self, incident: Incident, **kwargs: Any) -> View:
-        blocks: list[Block] = []
-
-        # Check existing post-mortems
-        has_confluence = hasattr(incident, "postmortem_for")
-        has_jira = hasattr(incident, "jira_postmortem_for")
-
-        if has_confluence or has_jira:
-            blocks.append(
-                SectionBlock(text=f"Post-mortem(s) for incident #{incident.id}:")
-            )
-
-            if has_confluence:
-                blocks.append(
-                    SectionBlock(
-                        text=f"• Confluence: <{incident.postmortem_for.page_url}|View page>"
-                    )
-                )
-
-            if has_jira:
-                blocks.append(
-                    SectionBlock(
-                        text=f"• Jira: <{incident.jira_postmortem_for.issue_url}|{incident.jira_postmortem_for.jira_issue_key}>"
-                    )
-                )
-        else:
-            blocks.append(
-                SectionBlock(
-                    text=f"Post-mortem for incident #{incident.id} will be automatically created when the incident reaches MITIGATED status."
-                )
-            )
-
-        return View(
-            type="modal",
-            title="Postmortem"[:24],
-            submit=None,
-            callback_id=self.callback_id,
-            private_metadata=str(incident.id),
-            blocks=blocks,
-        )
-
-    @staticmethod
-    def handle_modal_fn(ack: Ack, **_kwargs: Any) -> None:
-        # This modal is now read-only (no submit button)
-        # Post-mortems are created automatically when incident reaches MITIGATED status
-        ack()
-
-
-modal_postmortem = PostMortemModal()