feat: adds disable_descriptions flag

Author: Justintime50

.github/workflows/build.yml

@@ -23,7 +23,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: Install Dependencies
         run: make install
       - name: Check format
@@ -34,7 +34,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        pythonversion: ["3.7", "3.8", "3.9", "3.10"]
+        pythonversion: ["3.7", "3.8", "3.9", "3.10", "3.11"]
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.10"
+          python-version: "3.11"
       - name: Build package
         run: |
           make install

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v4.5.0 (2022-10-25)
+
+- Adds `--disable_descriptions` flag which will not populate the description in messages
+
 ## v4.4.0 (2022-08-08)
 
 - Adds support for team reviewers to populate in messages

pullbug/bug.py

@@ -63,6 +63,7 @@ def __init__(  # nosec - no hardcoded token here, ignore
         location: str = os.path.expanduser('~/pullbug'),
         base_url: str = DEFAULT_BASE_URL,
         log_level: str = DEFAULT_LOG_LEVEL,
+        disable_descriptions: bool = False,
     ):
         # Parameter variables
         self.github_owner = github_owner
@@ -81,6 +82,7 @@ def __init__(  # nosec - no hardcoded token here, ignore
         self.location = location
         self.base_url = base_url
         self.log_level = log_level
+        self.disable_descriptions = disable_descriptions
 
         # Internal variables
         self.github_instance = Github(login_or_token=self.github_token, base_url=self.base_url)
@@ -289,20 +291,20 @@ def iterate_pull_requests(self, pull_requests: PaginatedList.PaginatedList) -> T
                     users_who_approved=users_who_approved,
                     users_who_requested_changes=users_who_requested_changes,
                     users_who_were_dismissed=users_who_were_dismissed,
+                    disable_descriptions=self.disable_descriptions,
                 )
                 slack_message_array.append(message)
                 discord_message_array.append(discord_message)
 
         return slack_message_array, discord_message_array
 
-    @staticmethod
-    def iterate_issues(issues: PaginatedList.PaginatedList) -> Tuple[List[str], List[str]]:
+    def iterate_issues(self, issues: PaginatedList.PaginatedList) -> Tuple[List[str], List[str]]:
         """Iterate through each issue of a repo and build the message array."""
         slack_message_array = []
         discord_message_array = []
 
         for issue in issues:
-            slack_message, discord_message = Message.prepare_issues_message(issue)
+            slack_message, discord_message = Message.prepare_issues_message(issue, self.disable_descriptions)
             slack_message_array.append(slack_message)
             discord_message_array.append(discord_message)
 

pullbug/cli.py

@@ -146,6 +146,13 @@ def __init__(self):
             choices=set(get_args(LOG_LEVEL_CHOICES)),
             help='The log level used for the tool.',
         )
+        parser.add_argument(
+            '--disable_descriptions',
+            required=False,
+            action='store_true',
+            default=False,
+            help='Disables descriptions in messages.',
+        )
         parser.parse_args(namespace=self)
 
     def run(self):
@@ -166,6 +173,7 @@ def run(self):
             self.location,
             self.base_url,
             self.log_level,
+            self.disable_descriptions,
         )
         bug.run()
 

pullbug/messages.py

@@ -81,18 +81,23 @@ def prepare_pulls_message(
         users_who_approved: List[NamedUser.NamedUser],
         users_who_requested_changes: List[NamedUser.NamedUser],
         users_who_were_dismissed: List[NamedUser.NamedUser],
+        disable_descriptions: bool = False,
     ) -> Tuple[str, str]:
         """Prepares a GitHub pull request message with a single pull request's data.
         This will then be appended to an array of messages.
 
         Slack and Discord each have slightly different formatting required, both messages are returned here.
         """
         pull_request_body = pull_request.body if pull_request.body else ''
-        description = (
-            pull_request_body[:DESCRIPTION_MAX_LENGTH] + DESCRIPTION_CONTINUATION
-            if len(pull_request_body) > DESCRIPTION_MAX_LENGTH
-            else pull_request_body
-        )
+        description_message_element = ''
+
+        if disable_descriptions is False:
+            description = (
+                pull_request_body[:DESCRIPTION_MAX_LENGTH] + DESCRIPTION_CONTINUATION
+                if len(pull_request_body) > DESCRIPTION_MAX_LENGTH
+                else pull_request_body
+            )
+            description_message_element = f"\n*Description:* {description}"
 
         slack_reviewers_string = ''
         discord_reviewers_string = ''
@@ -155,33 +160,37 @@ def prepare_pulls_message(
             f"\n:arrow_heading_up: *Pull Request:* {Message._create_slack_object_link(pull_request)}"
             f"\n*Repo:* <{pull_request.base.repo.html_url}|{pull_request.base.repo.name}>"
             f"\n*Author:* <{pull_request.user.html_url}|{pull_request.user.login}>"
-            f"\n*Description:* {description}"
+            f"{description_message_element}"
             f"\n*Reviewers:*{slack_reviewers_string if slack_reviewers_string else ' NA'}\n"
         )
 
         discord_message = (
             f"\n:arrow_heading_up: **Pull Request:** {Message._create_discord_object_link(pull_request)}"
             f"\n**Repo:** {pull_request.base.repo.name} (<{pull_request.base.repo.html_url}>)"
             f"\n**Author:** {pull_request.user.html_url} (<{pull_request.user.login}>)"
-            f"\n**Description:** {description}"
+            f"{description_message_element}"
             f"\n*Reviewers:*{discord_reviewers_string if discord_reviewers_string else ' NA'}\n"
         )
 
         return slack_message, discord_message
 
     @staticmethod
-    def prepare_issues_message(issue: Issue.Issue) -> Tuple[str, str]:
+    def prepare_issues_message(issue: Issue.Issue, disable_descriptions: bool = False) -> Tuple[str, str]:
         """Prepares a GitHub issue message with a single issue's data.
         This will then be appended to an array of messages.
 
         Slack and Discord each have slightly different formatting required, both messages are returned here.
         """
         issue_body = issue.body if issue.body else ''
-        description = (
-            issue_body[:DESCRIPTION_MAX_LENGTH] + DESCRIPTION_CONTINUATION
-            if len(issue_body) > DESCRIPTION_MAX_LENGTH
-            else issue_body
-        )
+        description_message_element = ''
+
+        if disable_descriptions is False:
+            description = (
+                issue_body[:DESCRIPTION_MAX_LENGTH] + DESCRIPTION_CONTINUATION
+                if len(issue_body) > DESCRIPTION_MAX_LENGTH
+                else issue_body
+            )
+            description_message_element = f"\n*Description:* {description}"
 
         if issue.assignees:
             slack_users = []
@@ -196,14 +205,14 @@ def prepare_issues_message(issue: Issue.Issue) -> Tuple[str, str]:
         slack_message = (
             f"\n:exclamation: *Issue:* {Message._create_slack_object_link(issue)}"
             f"\n*Repo:* <{issue.repository.html_url}|{issue.repository.name}>"
-            f"\n*Description:* {description}"
+            f"{description_message_element}"
             f"\n*Assigned to:* {', '.join(slack_users)}\n"
         )
 
         discord_message = (
             f"\n:exclamation: **Issue:** {Message._create_discord_object_link(issue)}"
             f"\n**Repo:** {issue.repository.name} (<{issue.repository.html_url}>)"
-            f"\n**Description:** {description}"
+            f"{description_message_element}"
             f"\n**Assigned to:** {', '.join(discord_users)}\n"
         )
 

setup.py

@@ -28,7 +28,7 @@
 
 setuptools.setup(
     name='pullbug',
-    version='4.4.0',
+    version='4.5.0',
     description='Get bugged via Discord or Slack to merge your GitHub pull requests or close open issues.',
     long_description=long_description,
     long_description_content_type="text/markdown",

test/unit/test_messages.py

@@ -97,6 +97,7 @@ def test_prepare_pulls_message(mock_pull_request, mock_user, mock_repo):
 
     # Slack message
     assert 'Pull Request' in slack_message
+    assert 'Description' in slack_message
     assert f'{reviewer.html_url}|{reviewer.login}' in slack_message
     assert team.name in slack_message
     assert f'{approved_reviewer.html_url}|{approved_reviewer.login}' in slack_message
@@ -106,6 +107,7 @@ def test_prepare_pulls_message(mock_pull_request, mock_user, mock_repo):
 
     # Discord message
     assert 'Pull Request' in discord_message
+    assert 'Description' in discord_message
     assert f'{reviewer.login} (<{reviewer.html_url}>)' in discord_message
     assert team.name in discord_message
     assert f'{approved_reviewer.login} (<{approved_reviewer.html_url}>)' in discord_message
@@ -155,17 +157,75 @@ def test_prepare_pulls_message_no_reviewers(mock_pull_request):
     assert '*Reviewers:* NA' in discord_message
 
 
+def test_prepare_pulls_message_disabled_description(mock_pull_request, mock_user, mock_repo):
+    """Tests that we build all user strings and messages correctly when descriptions are disabled."""
+    reviewer = MagicMock(spec=NamedUser.NamedUser)
+    reviewer.login = 'reviewer'
+    reviewer.html_url = f'https://github.com/{mock_user}'
+
+    team = MagicMock(spec=Team.Team)
+    team.name = 'team'
+
+    reviewers = [reviewer, team]
+
+    approved_reviewer = MagicMock(spec=NamedUser.NamedUser)
+    approved_reviewer.login = 'approved_reviewer'
+    approved_reviewer.html_url = f'https://github.com/{mock_user}'
+    approved_reviewers = [approved_reviewer]
+
+    requested_changes_reviewer = MagicMock(spec=NamedUser.NamedUser)
+    requested_changes_reviewer.login = 'requested_changes_reviewer'
+    requested_changes_reviewer.html_url = f'https://github.com/{mock_user}'
+    requested_changes_reviewers = [requested_changes_reviewer]
+
+    dismissed_reviewer = MagicMock(spec=NamedUser.NamedUser)
+    dismissed_reviewer.login = 'dismissed_reviewer'
+    dismissed_reviewer.html_url = f'https://github.com/{mock_user}'
+    dismissed_reviewers = [dismissed_reviewer]
+
+    slack_message, discord_message = Message.prepare_pulls_message(
+        pull_request=mock_pull_request,
+        reviewers=reviewers,
+        users_who_approved=approved_reviewers,
+        users_who_requested_changes=requested_changes_reviewers,
+        users_who_were_dismissed=dismissed_reviewers,
+        disable_descriptions=True,
+    )
+
+    # Slack message
+    assert 'Pull Request' in slack_message
+    assert 'Description' not in slack_message
+    assert f'{reviewer.html_url}|{reviewer.login}' in slack_message
+    assert team.name in slack_message
+    assert f'{approved_reviewer.html_url}|{approved_reviewer.login}' in slack_message
+    assert f'{requested_changes_reviewer.html_url}|{requested_changes_reviewer.login}' in slack_message
+    assert f'{dismissed_reviewer.html_url}|{dismissed_reviewer.login}' in slack_message
+    assert f'{mock_pull_request.html_url}|{mock_pull_request.title}' in slack_message
+
+    # Discord message
+    assert 'Pull Request' in discord_message
+    assert 'Description' not in discord_message
+    assert f'{reviewer.login} (<{reviewer.html_url}>)' in discord_message
+    assert team.name in discord_message
+    assert f'{approved_reviewer.login} (<{approved_reviewer.html_url}>)' in discord_message
+    assert f'{requested_changes_reviewer.login} (<{requested_changes_reviewer.html_url}>)' in discord_message
+    assert f'{dismissed_reviewer.login} (<{dismissed_reviewer.html_url}>)' in discord_message
+    assert f'{mock_pull_request.title} (<{mock_pull_request.html_url}>)' in discord_message
+
+
 def test_prepare_issues_message(mock_issue, mock_user, mock_repo):
     """Tests that we build the issue message strings correctly when there is an assignee."""
     slack_message, discord_message = Message.prepare_issues_message(mock_issue)
 
     # Slack message
     assert 'Issue' in slack_message
+    assert 'Description' in slack_message
     assert f'{mock_issue.assignees[0].html_url}|{mock_issue.assignees[0].login}' in slack_message
     assert f'{mock_issue.html_url}|{mock_issue.title}' in slack_message
 
     # Discord message
     assert 'Issue' in discord_message
+    assert 'Description' in discord_message
     assert f'{mock_issue.assignees[0].login} (<{mock_issue.assignees[0].html_url}>)' in discord_message
     assert f'{mock_issue.title} (<{mock_issue.html_url}>)' in discord_message
 
@@ -176,3 +236,20 @@ def test_prepare_issues_message_no_assignee(mock_issue):
     slack_message, _ = Message.prepare_issues_message(mock_issue)
 
     assert '*Assigned to:* NA' in slack_message
+
+
+def test_prepare_issues_message_disable_descriptions(mock_issue, mock_user, mock_repo):
+    """Tests that we build the issue message strings correctly when descriptions are disabled."""
+    slack_message, discord_message = Message.prepare_issues_message(issue=mock_issue, disable_descriptions=True)
+
+    # Slack message
+    assert 'Issue' in slack_message
+    assert 'Description' not in slack_message
+    assert f'{mock_issue.assignees[0].html_url}|{mock_issue.assignees[0].login}' in slack_message
+    assert f'{mock_issue.html_url}|{mock_issue.title}' in slack_message
+
+    # Discord message
+    assert 'Issue' in discord_message
+    assert 'Description' not in discord_message
+    assert f'{mock_issue.assignees[0].login} (<{mock_issue.assignees[0].html_url}>)' in discord_message
+    assert f'{mock_issue.title} (<{mock_issue.html_url}>)' in discord_message