Change dir

.github/workflows/cloud_chatops.yaml

@@ -25,13 +25,10 @@ jobs:
           cd cloud_chatops && pip install -r requirements.txt
 
       - name: Analyse with pylint
-        run: pylint cloud_chatops/src --rcfile=cloud_chatops/.pylintrc
-
-      - name: Run tests
-        run: cd cloud_chatops && python3 -m pytest
+        run: pylint cloud_chatops --rcfile=cloud_chatops/.pylintrc
 
       - name: Run tests and collect coverage
-        run: cd cloud_chatops && python3 -m pytest . --cov-report xml:coverage.xml --cov
+        run: cd cloud_chatops && python3 -m pytest tests --cov-report xml:coverage.xml --cov
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v4

cloud_chatops/.pylintrc

@@ -4,6 +4,5 @@
 max-line-length=120
 
 # Disable various warnings:
-# R0913: too-many-arguments, disabling this as the PR functions require a large amount of information.
 
-disable=R0913
+disable=

cloud_chatops/README.md

@@ -4,8 +4,8 @@ Using Slack's Bolt for Python library here I have developed a Slack Application
 This application is designed to help promote the closing of GitHub pull requests either by getting them approved and merged or closed when they go stale.<br>
 In principle, the app will notify authors about their pull requests until they are closed.<br>
 ### Deployment
-The entry point for is in [main.py](/cloud_chatops/src/main.py) which will run the application.<br>
-The required files (below) need to be in the [cloud_chatops](/cloud_chatops) directory.<br>
+The entry point for is in [main.py](main.py) which will run the application.<br>
+The required files (below) need to be in the [cloud_chatops](.) directory.<br>
 ### Functionality
 As of current, the application gets all open pull requests from any Cloud owned repository and will send a message to our pull-request channel about each pull request notifying the author.<br>
 The app runs on an asynchronous loop scheduling each reminder to be sent out on days of our catch-ups (Monday, Wednesday and Friday).<br>

cloud_chatops/src/get_github_prs.py → cloud_chatops/lib/get_github_prs.py

@@ -5,9 +5,9 @@
 
 from typing import List, Dict
 import requests
-from read_data import get_token
-from pr_dataclass import PrData
-from custom_exceptions import RepoNotFound, UnknownHTTPError, BadGitHubToken
+from lib.read_data import get_token
+from lib.pr_dataclass import PrData
+from lib.custom_exceptions import RepoNotFound, UnknownHTTPError, BadGitHubToken
 
 
 class GetGitHubPRs:

cloud_chatops/src/online_notif.py → cloud_chatops/lib/online_notif.py

@@ -1,7 +1,7 @@
 """This module handles the Slack Application status notifications."""
 
 from slack_sdk import WebClient
-from read_data import get_token, get_maintainer
+from lib.read_data import get_token, get_maintainer
 
 
 def online_notif() -> None:

cloud_chatops/src/pr_reminder.py → cloud_chatops/lib/pr_reminder.py

@@ -4,10 +4,10 @@
 from datetime import datetime, timedelta
 from slack_sdk import WebClient
 from slack_sdk.errors import SlackApiError
-from read_data import get_token, get_user_map, get_repos
-from get_github_prs import GetGitHubPRs
-from pr_dataclass import PrData
-from custom_exceptions import ChannelNotFound
+from lib.read_data import get_token, get_user_map, get_repos
+from lib.get_github_prs import GetGitHubPRs
+from lib.pr_dataclass import PrData
+from lib.custom_exceptions import ChannelNotFound
 
 
 class PostPRsToSlack:
@@ -16,20 +16,24 @@ class PostPRsToSlack:
     """
     This class handles the Slack posting.
     """
-    # The default channel is dev-chatops
-    def __init__(self, mention=False, channel="C06U37Y02R4"):
-        self.channel = channel
+
+    def __init__(self, mention=False):
+        self.channel = "C06U37Y02R4"  # STFC-cloud: dev-chatops
         self.thread_ts = ""
         self.mention = mention
         self.slack_ids = get_user_map()
         self.message_builder = PRMessageBuilder(self.mention)
         self.client = WebClient(token=get_token("SLACK_BOT_TOKEN"))
         self.prs = GetGitHubPRs(get_repos(), "stfc").run()
 
-    def run(self) -> None:
+    def run(self, channel=None) -> None:
         """
         This method sets class attributes then cals the reminder and thread post methods.
+        :param channel: Changes the channel to post the messages to.
         """
+        if channel:
+            self._set_channel_id(channel)
+
         self._post_reminder_message()
         self._post_thread_messages(self.prs)
 
@@ -127,12 +131,10 @@ class PRMessageBuilder:
 
     # pylint: disable=R0903
     # Disabling this as there only needs to be one entry point.
-    # The default user here is David Fairbrother
-    def __init__(self, mention, default_user_id="U01JG0LKU3W"):
+    def __init__(self, mention):
         self.client = WebClient(token=get_token("SLACK_BOT_TOKEN"))
         self.slack_ids = get_user_map()
         self.mention = mention
-        self.default_user_id = default_user_id
 
     def make_message(self, pr_data: PrData) -> str:
         """
@@ -179,7 +181,10 @@ def _github_to_slack_username(self, user: str) -> str:
         :return: Slack ID or GitHub username
         """
         if user not in self.slack_ids:
-            user = self.default_user_id
+            # If the PR author is not in the Slack ID mapping
+            # then we set the user to mention as David Fairbrother
+            # as the team lead to deal with this PR.
+            user = "U01JG0LKU3W"
         else:
             user = self.slack_ids[user]
         return user
@@ -194,7 +199,9 @@ def _check_pr_age(time_created: str) -> bool:
         opened_date = datetime.fromisoformat(time_created).replace(tzinfo=None)
         datetime_now = datetime.now().replace(tzinfo=None)
         time_cutoff = datetime_now - timedelta(days=30 * 6)
-        return opened_date < time_cutoff
+        if opened_date < time_cutoff:
+            return True
+        return False
 
     def _check_pr_info(self, info: PrData) -> PrData:
         """

cloud_chatops/src/read_data.py → cloud_chatops/lib/read_data.py

@@ -2,7 +2,7 @@
 
 from typing import List, Dict
 import json
-from custom_exceptions import RepositoriesNotGiven, UserMapNotGiven, TokensNotGiven
+from lib.custom_exceptions import RepositoriesNotGiven, UserMapNotGiven, TokensNotGiven
 
 
 def validate_required_files() -> None:
@@ -34,7 +34,7 @@ def get_token(secret: str) -> str:
     :param secret: The secret to find
     :return: A secret as string
     """
-    with open("../secrets.json", "r", encoding="utf-8") as file:
+    with open("secrets.json", "r", encoding="utf-8") as file:
         data = file.read()
     secrets = json.loads(data)
     return secrets[secret]
@@ -45,7 +45,7 @@ def get_repos() -> List[str]:
     This function reads the repo csv file and returns a list of repositories
     :return: List of repositories as strings
     """
-    with open("../repos.csv", "r", encoding="utf-8") as file:
+    with open("repos.csv", "r", encoding="utf-8") as file:
         data = file.read()
         repos = data.split(",")
         if not repos[-1]:
@@ -58,7 +58,7 @@ def get_user_map() -> Dict:
     This function gets the GitHub to Slack username mapping from the map file.
     :return: Dictionary of username mapping
     """
-    with open("../user_map.json", "r", encoding="utf-8") as file:
+    with open("user_map.json", "r", encoding="utf-8") as file:
         data = file.read()
         user_map = json.loads(data)
     return user_map
@@ -69,7 +69,7 @@ def get_maintainer() -> str:
     This function will get the maintainer user's Slack ID from the text file.
     :return: Slack Member ID
     """
-    with open("../maintainer.txt", "r", encoding="utf-8") as file:
+    with open("maintainer.txt", "r", encoding="utf-8") as file:
         data = file.read()
         if not data:
             return "U05RBU0RF4J"  # Default Maintainer: Kalibh Halford

cloud_chatops/src/slack_app.py → cloud_chatops/lib/slack_app.py

@@ -1,6 +1,6 @@
 """
 This module starts the Slack Bolt application Asynchronously running the event loop.
-Using Socket Mode the application listens for events from the Slack API client.
+Using Socket mode, the application listens for events from the Slack API client.
 Slash commands are also defined here.
 """
 
@@ -9,9 +9,9 @@
 from slack_bolt.app.async_app import AsyncApp
 from slack_bolt.adapter.socket_mode.async_handler import AsyncSocketModeHandler
 import schedule
-from pr_reminder import PostPRsToSlack
-from read_data import get_token, validate_required_files
-from online_notif import online_notif
+from lib.pr_reminder import PostPRsToSlack
+from lib.read_data import get_token, validate_required_files
+from lib.online_notif import online_notif
 
 
 logging.basicConfig(level=logging.DEBUG)
@@ -27,7 +27,7 @@ def run_pr(channel, mention=False) -> None:
         """
         This is a placeholder function for the schedule to accept.
         """
-        PostPRsToSlack(mention=mention, channel=channel).run()
+        PostPRsToSlack(mention=mention).run(channel=channel)
 
     schedule.every().monday.at("09:00").do(
         run_pr, mention=True, channel="pull-requests"

cloud_chatops/src/main.py → cloud_chatops/main.py

@@ -4,7 +4,7 @@
 """
 
 import asyncio
-from slack_app import run_app
+from lib.slack_app import run_app
 
 
 def main():

cloud_chatops/pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+pythonpath = lib
+testpaths = tests
+python_files = *.py
+python_functions = test_*

cloud_chatops/tests/test_read_data.py

@@ -1,7 +1,6 @@
 """This test file covers all tests for the read_data module."""
-
 from unittest.mock import patch, mock_open
-from src.read_data import get_token, get_repos, get_user_map, get_maintainer
+from lib.read_data import get_token, get_repos, get_user_map, get_maintainer
 
 
 def test_get_token():