♻️ Slack Service Refactor

bin/alarm_for_old_poc_repositories.py

@@ -3,16 +3,7 @@
 
 from services.github_service import GithubService
 from services.slack_service import SlackService
-from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE, SLACK_CHANNEL
-
-def construct_message(repositories):
-    intro = "The following POC GitHub Repositories persist:\n\n"
-
-    core_content = "\n".join([f"https://github.com/ministryofjustice/{repo} - {age} days old" for repo, age in repositories.items()])
-
-    action = "\n\nConsider if they are still required. If not, please archive them by removing them from the Terraform configuration: https://github.com/ministryofjustice/operations-engineering/tree/main/terraform/github/repositories/ministryofjustice"
-
-    return intro + core_content + action
+from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE
 
 
 def alert_for_old_poc_repositories():
@@ -33,7 +24,7 @@ def alert_for_old_poc_repositories():
     old_poc_repositories = github_service.get_old_poc_repositories()
 
     if old_poc_repositories:
-        slack_service.send_message_to_plaintext_channel_name(construct_message(old_poc_repositories), SLACK_CHANNEL)
+        slack_service.send_alert_for_poc_repositories(old_poc_repositories)
 
 
 if __name__ == "__main__":

bin/alert_on_low_gandi_funds.py

@@ -2,23 +2,7 @@
 import sys
 from services.gandi_service import GandiService
 from services.slack_service import SlackService
-from config.constants import SLACK_CHANNEL
-
-GANDI_FUND_THRESHOLD = 500
-
-
-def low_gandi_funds_message(remaining_gandi_funds):
-    msg = (
-        f"Hi all, \n\n"
-        f"This is an alert do inform you that Gandi funds are low. \n\n"
-        f"*:warning: We currently have £{remaining_gandi_funds} left out of £{GANDI_FUND_THRESHOLD}*\n\n"
-        f"Please read the following runbook for next steps:\n"
-        f"https://runbooks.operations-engineering.service.justice.gov.uk/documentation/certificates/manual-ssl-certificate-processes.html#regenerating-certificates\n\n"
-        f"Have a swell day, \n\n"
-        "The GitHub Organisation Monitoring Bot"
-    )
-
-    return msg
+from config.constants import GANDI_FUND_THRESHOLD
 
 
 def alert_on_low_gandi_funds():
@@ -39,8 +23,7 @@ def alert_on_low_gandi_funds():
     remaining_gandi_funds = gandi_service.get_current_account_balance_from_org(organisation_id)
 
     if remaining_gandi_funds < GANDI_FUND_THRESHOLD:
-        SlackService(slack_token).send_message_to_plaintext_channel_name(
-            low_gandi_funds_message(remaining_gandi_funds), SLACK_CHANNEL)
+        SlackService(slack_token).send_low_gandi_funds_alert(remaining_gandi_funds, GANDI_FUND_THRESHOLD)
 
 
 if __name__ == "__main__":

bin/alert_on_low_github_actions_quota.py

@@ -2,11 +2,7 @@
 import sys
 from services.github_service import GithubService
 from services.slack_service import SlackService
-from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE, SLACK_CHANNEL
-
-
-def low_threshold_triggered_message(percentage_used):
-    return f"Warning:\n\n {round(100 - percentage_used, 1)}% of the Github Actions minutes quota remains.\n\n What to do next: https://runbooks.operations-engineering.service.justice.gov.uk/documentation/internal/low-github-actions-minutes-procedure.html#low-github-actions-minutes-procedure"
+from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE
 
 
 def alert_on_low_quota():
@@ -25,7 +21,7 @@ def alert_on_low_quota():
     check_result = github_service.check_if_gha_minutes_quota_is_low()
 
     if check_result is not False:
-        slack_service.send_message_to_plaintext_channel_name(low_threshold_triggered_message(check_result['percentage_used']), SLACK_CHANNEL)
+        slack_service.send_low_github_actions_quota_alert(check_result['percentage_used'])
         github_service.modify_gha_minutes_quota_threshold(check_result['threshold'] + 10)
 
 

bin/alert_on_low_github_licences.py

@@ -1,37 +1,11 @@
-"""
-GitHub License Monitoring Script
-
-Purpose:
---------
-This script monitors the number of available licenses in a GitHub Enterprise account.
-It is designed to provide alerts when the license count falls below a
-specified threshold.
-"""
-
 import os
 import sys
-from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE, SLACK_CHANNEL
+from config.constants import ENTERPRISE, MINISTRY_OF_JUSTICE, GITHUB_LICENSE_THRESHOLD
 from services.github_service import GithubService
 from services.slack_service import SlackService
 
 
-def low_threshold_triggered_message(remaining_licences):
-    msg = (
-        f"Hi team 👋, \n\n"
-        f"There are only {remaining_licences} \
-    GitHub licences remaining in the enterprise account. \n\n"
-        f"Please add more licences using the instructions outlined here: \n"
-        f"https://runbooks.operations-engineering.service.justice.gov.uk/documentation/internal/low-github-seats-procedure.html \n\n"
-
-        f"Thanks, \n\n"
-
-        "The GitHub Licence Alerting Bot"
-    )
-
-    return msg
-
-
-def alert_on_low_github_licences(threshold):
+def alert_on_low_github_licenses():
     github_token = os.environ.get("ADMIN_GITHUB_TOKEN")
     if github_token is None:
         print("No GITHUB_TOKEN environment variable set")
@@ -41,18 +15,16 @@ def alert_on_low_github_licences(threshold):
         print("No SLACK_TOKEN environment variable set")
         sys.exit(1)
 
-    remaining_licences = GithubService(
+    remaining_licenses = GithubService(
         github_token, MINISTRY_OF_JUSTICE, ENTERPRISE).get_remaining_licences()
-    trigger_alert = remaining_licences < threshold
+    trigger_alert = remaining_licenses < GITHUB_LICENSE_THRESHOLD
 
     if trigger_alert:
         print(
-            f"Low number of GitHub licences remaining, only {remaining_licences} remaining")
+            f"Low number of GitHub licenses remaining, only {remaining_licenses} remaining")
 
-        SlackService(slack_token). \
-            send_message_to_plaintext_channel_name(
-                low_threshold_triggered_message(remaining_licences), SLACK_CHANNEL)
+        SlackService(slack_token).send_low_github_licenses_alert(remaining_licenses)
 
 
 if __name__ == "__main__":
-    alert_on_low_github_licences(20)
+    alert_on_low_github_licenses()

bin/check_for_new_github_owners.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime, timedelta
-from config.constants import MINISTRY_OF_JUSTICE, SLACK_CHANNEL
+from config.constants import MINISTRY_OF_JUSTICE
 
 from services.github_service import GithubService
 from services.slack_service import SlackService
@@ -13,25 +13,6 @@ def _calculate_date(in_last_days: int) -> str:
     return date.strftime(timestamp_format)
 
 
-def new_owner_detected_message(new_owner, date_added, added_by, org, audit_log_url):
-    msg = (
-        f"Hi all, \n\n"
-        f"A new owner has been detected in the `{org}` GitHub org. \n\n"
-        f"*New owner:* {new_owner}\n"
-        f"*Date added:* {date_added}\n"
-        f"*By who:* {added_by}\n\n"
-
-        f"Please review the audit log for more details: {audit_log_url}\n\n"
-
-
-        f"Thanks, \n\n"
-
-        "The GitHub Organisation Monitoring Bot"
-    )
-
-    return msg
-
-
 def check_for_new_organisation_owners(in_last_days: int):
     audit_log_url = f"https://github.com/organizations/{MINISTRY_OF_JUSTICE}/settings/audit-log?q=action%3Aorg.add_member++action%3Aorg.update_member"
 
@@ -46,10 +27,7 @@ def check_for_new_organisation_owners(in_last_days: int):
 
     if changes:
         for change in changes:
-            message = new_owner_detected_message(
-                change["userLogin"], change["createdAt"], change["actorLogin"], MINISTRY_OF_JUSTICE, audit_log_url)
-            slack.send_message_to_plaintext_channel_name(
-                message, SLACK_CHANNEL)
+            slack.send_new_github_owners_alert(change["userLogin"], change["createdAt"], change["actorLogin"], MINISTRY_OF_JUSTICE, audit_log_url)
 
 
 if __name__ == "__main__":

bin/fetch_github_joiner_metrics.py

@@ -1,6 +1,6 @@
 import os
 from datetime import datetime, timedelta
-from config.constants import MINISTRY_OF_JUSTICE, SLACK_CHANNEL, OPERATIONS_ENGINEERING_GITHUB_USERNAMES
+from config.constants import MINISTRY_OF_JUSTICE, OPERATIONS_ENGINEERING_GITHUB_USERNAMES
 
 from services.github_service import GithubService
 from services.slack_service import SlackService
@@ -26,23 +26,6 @@ def _calculate_date(in_last_days: int) -> str:
     return date.strftime(timestamp_format)
 
 
-def new_members_detected_message(new_members_added_by_oe, new_members_added_externally, percentage, total_new_members, org, audit_log_url, time_delta_in_days):
-    msg = (
-        f"Hi all, \n\n"
-        f"Here are the {total_new_members} new joiners added in the last {time_delta_in_days} days within the '{org}' GitHub org. \n\n"
-        f"*Added by Operations Engineering:*\n"
-        f"{new_members_added_by_oe}\n\n"
-        f"*Added externally:*\n"
-        f"{new_members_added_externally}\n\n"
-        f"{percentage}% of the new joiners were added by operations engineering.\n\n"
-        f"Please review the audit log for more details: {audit_log_url}\n\n"
-        f"Have a swell day, \n\n"
-        "The GitHub Organisation Monitoring Bot"
-    )
-
-    return msg
-
-
 def main():
     audit_log_url = f"https://github.com/organizations/{MINISTRY_OF_JUSTICE}/settings/audit-log?q=action%3Aorg.add_member"
 
@@ -67,8 +50,8 @@ def main():
                 new_members_added_externally += individual_message
         percentage = round((total_members_added_by_oe / len(new_members)) * 100)
 
-        slack_service.send_message_to_plaintext_channel_name(
-            new_members_detected_message(new_members_added_by_oe, new_members_added_externally, percentage, total_new_members, MINISTRY_OF_JUSTICE, audit_log_url, time_delta_in_days), SLACK_CHANNEL)
+        slack_service.send_new_github_joiner_metrics_alert(
+            new_members_added_by_oe, new_members_added_externally, percentage, total_new_members, MINISTRY_OF_JUSTICE, audit_log_url, time_delta_in_days)
 
 
 if __name__ == "__main__":

bin/generate_pat_token_report.py

@@ -1,5 +1,5 @@
 import os
-from config.constants import MINISTRY_OF_JUSTICE, SLACK_CHANNEL
+from config.constants import MINISTRY_OF_JUSTICE
 
 from services.github_service import GithubService
 from services.slack_service import SlackService
@@ -18,21 +18,6 @@ def get_environment_variables() -> tuple:
     return slack_token, github_token
 
 
-def expired_tokens_message():
-    msg = (
-        "Hi team 👋, \n\n"
-        "Some expired PAT(s) have been detected. \n\n"
-        "Please review the current list here: \n"
-        "https://github.com/organizations/ministryofjustice/settings/personal-access-tokens/active \n\n"
-
-        "Have a swell day, \n\n"
-
-        "The GitHub PAT Bot"
-    )
-
-    return msg
-
-
 def count_expired_tokens(pat_tokens):
     expired_count = 0
     for token in pat_tokens:
@@ -50,7 +35,7 @@ def generate_pat_token_report():
     pat_tokens = github_service.get_new_pat_creation_events_for_organization()
 
     if count_expired_tokens(pat_tokens) > 0:
-        slack_service.send_message_to_plaintext_channel_name(expired_tokens_message(), SLACK_CHANNEL)
+        slack_service.send_pat_report_alert()
 
 
 if __name__ == "__main__":

bin/identify_dormant_github_users.py

@@ -16,7 +16,6 @@
 CSV_FILE_NAME = "dormant.csv"
 MOJ_ORGANISATION = "ministryofjustice"
 AP_ORGANISATION = "moj-analytical-services"
-SLACK_CHANNEL = "operations-engineering-alerts"
 # These are the users that are deemed acceptable to be dormant.
 # They are either bots or service accounts and will be revisited regularly.
 ALLOWED_BOT_USERS = [
@@ -143,12 +142,8 @@ def filter_out_active_auth0_users(dormant_users_according_to_github: list) -> li
     return dormant_users_not_in_auth0
 
 
-def message_to_slack_channel(dormant_users: list) -> str:
-    msg = (
-        "Hello 🤖, \n\n"
-        "Here is a list of dormant GitHub users that have not been seen in Auth0 logs:\n\n"
-    )
-
+def _create_dormant_user_list(dormant_users: list) -> str:
+    msg = ""
     for user in dormant_users:
         msg += f"{user.name} | {user.email}\n"
 
@@ -187,14 +182,12 @@ def identify_dormant_github_users():
     githubs_list_of_dormant_users = get_dormant_users_from_github_csv(
         moj_github_org, ap_github_org)
 
-    dormant_users_accoding_to_github_and_auth0 = filter_out_active_auth0_users(
+    dormant_users_according_to_github_and_auth0 = filter_out_active_auth0_users(
         githubs_list_of_dormant_users
     )
 
-    SlackService(env.get("ADMIN_SLACK_TOKEN")).send_message_to_plaintext_channel_name(
-        message_to_slack_channel(dormant_users_accoding_to_github_and_auth0),
-        SLACK_CHANNEL,
-    )
+    SlackService(env.get("ADMIN_SLACK_TOKEN")).send_dormant_user_list(
+        _create_dormant_user_list(dormant_users_according_to_github_and_auth0))
 
 
 if __name__ == "__main__":

config/constants.py

@@ -1,4 +1,6 @@
 # class Constants:
+GANDI_FUND_THRESHOLD = 500
+GITHUB_LICENSE_THRESHOLD = 20
 MINISTRY_OF_JUSTICE = "ministryofjustice"
 MOJ_ANALYTICAL_SERVICES = "moj-analytical-services"
 MISSING_EMAIL_ADDRESS = "-"