Merge pull request #1 from port-labs/fix-no-results-in-slack-report-a…

…nd-add-verbosity
port-labs · Nov 15, 2023 · 1ee21f1 · 1ee21f1
2 parents 723d561 + 6a69d16
commit 1ee21f1
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 25 deletions.
diff --git a/.github/workflows/generate-scorecard-reminder.yaml b/.github/workflows/generate-scorecard-reminder.yaml
@@ -9,7 +9,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecards Reminders
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_reminder
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}

diff --git a/.github/workflows/generate-scorecard-report.yaml b/.github/workflows/generate-scorecard-report.yaml
@@ -8,7 +8,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecard Report
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_report
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}

diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecard Report
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_report
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}
@@ -116,7 +116,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecards Reminders
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_reminder
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}

diff --git a/docs/examples/generate-scorecard-reminder.yaml b/docs/examples/generate-scorecard-reminder.yaml
@@ -11,7 +11,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecards Reminders
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_reminder
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}

diff --git a/docs/examples/generate-scorecard-report.yaml b/docs/examples/generate-scorecard-report.yaml
@@ -11,7 +11,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Generate Scorecard Report
-              uses: port-labs/[email protected].14
+              uses: port-labs/[email protected].15
               with:
                 message_kind: scorecard_report
                 port_client_id: ${{ secrets.PORT_CLIENT_ID }}

diff --git a/generators/slack.py b/generators/slack.py
@@ -82,6 +82,9 @@ def scorecard_report(self, blueprint: str, scorecard: Dict[str, Any], entities:
                     "text": f"Here is a summary of the current {scorecard_title} scorecard status ⭐️"
                 }
             },
+        ]
+        if entities_by_level_text:
+            blocks += [
             {
                 "type": "section",
                 "text": {
@@ -95,7 +98,26 @@ def scorecard_report(self, blueprint: str, scorecard: Dict[str, Any], entities:
                     "type": "mrkdwn",
                     "text": entities_by_level_text
                 }
-            },
+            }]
+        else:
+            blocks += [
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": f"*:vertical_traffic_light: {blueprint_plural} by level*"
+                    }
+                },
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": "There are no entities with scorecard data :disappointed:"
+                    }
+                }
+            ]
+        if top_teams_text:
+            blocks += [
             {
                 "type": "section",
                 "text": {
@@ -107,10 +129,12 @@ def scorecard_report(self, blueprint: str, scorecard: Dict[str, Any], entities:
                 "type": "section",
                 "text": {
                     "type": "mrkdwn",
-                    "text": top_teams_text if top_teams_text else
-                    "There are no teams with scorecard data :disappointed:"
+                    "text": top_teams_text
                 }
             },
+            ]
+        if top_highest_scored_rules_text:
+            blocks += [
             {
                 "type": "section",
                 "text": {
@@ -124,21 +148,27 @@ def scorecard_report(self, blueprint: str, scorecard: Dict[str, Any], entities:
                     "type": "mrkdwn",
                     "text": top_highest_scored_rules_text
                 }
-            },
-            {
-                "type": "section",
-                "text": {
-                    "type": "mrkdwn",
-                    "text": "*:warning: Lowest scoring rules*"
-                }
-            },
-            {
-                "type": "section",
-                "text": {
-                    "type": "mrkdwn",
-                    "text": top_lowest_scored_rules_text
-                }
-            },
+            }
+            ]
+        if top_lowest_scored_rules_text:
+            blocks += [
+
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": "*:warning: Lowest scoring rules*"
+                    }
+                },
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": top_lowest_scored_rules_text
+                    }
+                },
+            ]
+        blocks += [
             {
                 "type": "section",
                 "text": {

diff --git a/targets/slack.py b/targets/slack.py
@@ -15,6 +15,9 @@ def __init__(self):
     def send_message(self, blocks: List[Dict[str, Any]]):
         logger.info(f"Sending message to slack channel")
         response = self.webhook.send(blocks=blocks)
-        logger.info(f"Message sent to slack channel: {response.status_code}")
+        if response.status_code > 200:
+            raise Exception(f"Failed to send Message to slack channel: {response.status_code}, {response.body}, "
+                            f"slack channel: {settings.slack_webhook_url}, blocks: {blocks}")
+        logger.info(f"Message sent to slack channel: {response.status_code}, {response.body}")
         return response.status_code