feat: add color coding, close #45

Author: EreminAnton

src/config.py

@@ -58,6 +58,11 @@ class Config(BaseSettings):
 
     max_number_of_symbols_in_permission_set_name: int = 26
 
+    good_result_emoji: str = ":large_green_circle:"
+    waiting_result_emoji: str = ":large_yellow_circle:"
+    bad_result_emoji: str = ":red_circle:"
+    discarded_result_emoji: str = ":white_circle:"
+
     class Config:
         frozen = True
 

src/main.py

@@ -122,11 +122,26 @@ def handle_button_click(body: dict, client: WebClient, context: BoltContext) ->
     cache_for_dublicate_requests["permission_set_name"] = payload.request.permission_set_name
 
     if payload.action == entities.ApproverAction.Discard:
-        slack_helpers.remove_buttons(payload, client, approver)
+        blocks = slack_helpers.HeaderSectionBlock.set_color_coding(
+            blocks=payload.message["blocks"],
+            color_coding_emoji=cfg.bad_result_emoji,
+        )
+
+        blocks = slack_helpers.remove_blocks(blocks, block_ids=["buttons"])
+        blocks.append(slack_helpers.button_click_info_block(payload.action, approver.id).to_dict())
+
+        text = f"Request was discarded by<@{approver.id}> "
+        client.chat_update(
+            channel=payload.channel_id,
+            ts=payload.thread_ts,
+            blocks=blocks,
+            text=text,
+        )
+
         cache_for_dublicate_requests.clear()
         return client.chat_postMessage(
             channel=payload.channel_id,
-            text=f"Request was discarded by<@{approver.id}> ",
+            text=text,
             thread_ts=payload.thread_ts,
         )
 
@@ -147,7 +162,21 @@ def handle_button_click(body: dict, client: WebClient, context: BoltContext) ->
             text=f"<@{approver.id}> you can not approve this request",
             thread_ts=payload.thread_ts,
         )
-    slack_helpers.remove_buttons(payload, client, approver)
+
+    text = f"Permissions granted to <@{requester.id}> by <@{approver.id}>."
+    blocks = slack_helpers.HeaderSectionBlock.set_color_coding(
+        blocks=payload.message["blocks"],
+        color_coding_emoji=cfg.good_result_emoji,
+    )
+
+    blocks = slack_helpers.remove_blocks(blocks, block_ids=["buttons"])
+    blocks.append(slack_helpers.button_click_info_block(payload.action, approver.id).to_dict())
+    client.chat_update(
+        channel=payload.channel_id,
+        ts=payload.thread_ts,
+        blocks=blocks,
+        text=text,
+    )
 
     access_control.execute_decision(
         decision=decision,
@@ -161,7 +190,7 @@ def handle_button_click(body: dict, client: WebClient, context: BoltContext) ->
     cache_for_dublicate_requests.clear()
     return client.chat_postMessage(
         channel=payload.channel_id,
-        text=f"Permissions granted to <@{requester.id}> by <@{approver.id}>.",
+        text=text,
         thread_ts=payload.thread_ts,
     )
 
@@ -211,6 +240,7 @@ def handle_request_for_access_submittion(
             reason=request.reason,
             permission_duration=request.permission_duration,
             show_buttons=show_buttons,
+            color_coding_emoji=cfg.waiting_result_emoji,
         ),
         channel=cfg.slack_channel_id,
         text=f"Request for access to {account.name} account from {requester.real_name}",
@@ -236,19 +266,35 @@ def handle_request_for_access_submittion(
     match decision.reason:
         case access_control.DecisionReason.ApprovalNotRequired:
             text = "Approval for this Permission Set & Account is not required. Request will be approved automatically."
+            color_coding_emoji = cfg.good_result_emoji
         case access_control.DecisionReason.SelfApproval:
             text = "Self approval is allowed and requester is an approver. Request will be approved automatically."
+            color_coding_emoji = cfg.good_result_emoji
         case access_control.DecisionReason.RequiresApproval:
             approvers = [slack_helpers.get_user_by_email(client, email) for email in decision.approvers]
             mention_approvers = " ".join(f"<@{approver.id}>" for approver in approvers)
             text = f"{mention_approvers} there is a request waiting for the approval."
+            color_coding_emoji = cfg.waiting_result_emoji
         case access_control.DecisionReason.NoApprovers:
             text = "Nobody can approve this request."
+            color_coding_emoji = cfg.bad_result_emoji
         case access_control.DecisionReason.NoStatements:
             text = "There are no statements for this Permission Set & Account."
+            color_coding_emoji = cfg.bad_result_emoji
 
     client.chat_postMessage(text=text, thread_ts=slack_response["ts"], channel=cfg.slack_channel_id)
 
+    blocks = slack_helpers.HeaderSectionBlock.set_color_coding(
+        blocks=slack_response["message"]["blocks"],
+        color_coding_emoji=color_coding_emoji,
+    )
+    client.chat_update(
+        channel=cfg.slack_channel_id,
+        ts=slack_response["ts"],
+        blocks=blocks,
+        text=text,
+    )
+
     access_control.execute_decision(
         decision=decision,
         permission_set_name=request.permission_set_name,

src/revoker.py

@@ -340,19 +340,25 @@ def handle_discard_buttons_event(
     for block in message["blocks"]:
         if slack_helpers.get_block_id(block) == "buttons":
             blocks = slack_helpers.remove_blocks(message["blocks"], block_ids=["buttons"])
+            text = f"Request expired after {cfg.request_expiration_hours} hour(s)."
             blocks.append(
                 slack_helpers.SectionBlock(
                     block_id="footer",
                     text=slack_helpers.MarkdownTextObject(
-                        text=f"Request expired after {cfg.request_expiration_hours} hour(s).",
+                        text=text,
                     ),
                 )
             )
+            blocks = slack_helpers.HeaderSectionBlock.set_color_coding(
+            blocks=blocks,
+            color_coding_emoji=cfg.discarded_result_emoji,
+            )
+
             slack_client.chat_update(
                 channel=event.channel_id,
                 ts=message["ts"],
                 blocks=blocks,
-                text="Request expired",
+                text=text,
             )
             logger.info("Buttons were removed", extra={"event": event})
             return

src/slack_helpers.py

@@ -23,7 +23,6 @@
     StaticSelectElement,
 )
 from slack_sdk.models.views import View
-from slack_sdk.web.slack_response import SlackResponse
 
 import config
 import entities
@@ -231,11 +230,12 @@ def build_approval_request_message_blocks(  # noqa: PLR0913
     account: entities.aws.Account,
     role_name: str,
     reason: str,
+    color_coding_emoji: str,
     permission_duration: timedelta,
     show_buttons: bool = True,
 ) -> list[Block]:
     blocks: list[Block] = [
-        SectionBlock(block_id="header", text=MarkdownTextObject(text="AWS account access request.")),
+        HeaderSectionBlock.new(color_coding_emoji),
         SectionBlock(
             block_id="content",
             fields=[
@@ -270,6 +270,23 @@ def build_approval_request_message_blocks(  # noqa: PLR0913
     return blocks
 
 
+class HeaderSectionBlock:
+    block_id = "header"
+
+    @classmethod
+    def new(cls, color_coding_emoji: str) -> SectionBlock:
+        return SectionBlock(
+            block_id=cls.block_id, text=MarkdownTextObject(text=f"{color_coding_emoji} | AWS account access request | {color_coding_emoji}")
+        )
+
+    @staticmethod
+    def set_color_coding(blocks: list[dict], color_coding_emoji: str) -> list[dict]:
+        blocks = remove_blocks(blocks, block_ids=[HeaderSectionBlock.block_id])
+        b = HeaderSectionBlock.new(color_coding_emoji)
+        blocks.insert(0, b.to_dict())
+        return blocks
+
+
 def button_click_info_block(action: entities.ApproverAction, approver_slack_id: str) -> SectionBlock:
     return SectionBlock(
         block_id="footer",
@@ -352,15 +369,14 @@ def get_user_by_email(client: WebClient, email: str) -> entities.slack.User:
         raise e
 
 
-def remove_buttons(payload: ButtonClickedPayload, client: WebClient, approver: entities.slack.User) -> SlackResponse:
-    blocks = remove_blocks(payload.message["blocks"], block_ids=["buttons"])
-    blocks.append(button_click_info_block(payload.action, approver.id))
-    return client.chat_update(
-        channel=payload.channel_id,
-        ts=payload.thread_ts,
-        blocks=blocks,
-        text="Buttons were removed.",
-    )
+def remove_buttons_from_message_blocks(
+    slack_message_blocks: list[Block],
+    action: entities.ApproverAction,
+    approver: entities.slack.User,
+) -> list[Block]:
+    blocks = remove_blocks(slack_message_blocks, block_ids=["buttons"])
+    blocks.append(button_click_info_block(action, approver.id))
+    return blocks
 
 
 def create_slack_mention_by_principal_id(