airship/gerrit-to-github-bot
Code Issues Proposed changes
master
gerrit-to-github-bot/gerrit_to_github_issues/engine.py
siraj.yasin 272078ce19 Disable issue reopen on gerrit activity 
* Few issues identified in BOT in reopening the issue on gerrit activity
  => When an old PS (tagged with issue number) is abandoned, BOT reopens
     the issue considering some activity on the issue in gerrit.
  => When a PS is merged and closed by BOT, in the next run if it identifies some
     event due to Post/Promote Job, then the issue is immediately re-opened.

Relates-To: #502
Change-Id: Id8516fb10c812873f1b4e4c3f2794845e29824d6
2021-04-19 17:31:38 +00:00

206 lines
8.6 KiB
Python
Raw Permalink Blame History

# Licensed under the Apache License, Version 2.0 (the 'License');
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an 'AS IS' BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import datetime
import logging
import github
import pytz as pytz
from github.Repository import Repository
from github.Project import Project
from github.Issue import Issue
from gerrit_to_github_issues import gerrit
from gerrit_to_github_issues import github_issues
LOG = logging.getLogger(__name__)
def update(gerrit_url: str, gerrit_repo_name: str, github_project_id: int,
github_repo_name: str, github_user: str, github_password: str, github_token: str,
change_age: str = None, skip_approvals: bool = False):
gh = github_issues.get_client(github_user, github_password, github_token)
repo = gh.get_repo(github_repo_name)
project_board = gh.get_project(github_project_id)
change_list = gerrit.get_changes(gerrit_url, gerrit_repo_name, change_age=change_age)
issue_map = {}
for change in change_list:
issue_numbers_dict = github_issues.parse_issue_number(change['commitMessage'])
issue_numbers_dict = github_issues.remove_duplicated_issue_numbers(issue_numbers_dict)
add_comments(gh, change, issue_numbers_dict, repo, skip_approvals)
# accumulate the affected issues for later when adding labels
for _, issue_list in issue_numbers_dict.items():
for issue_number in issue_list:
if issue_number in issue_map:
issue_map[issue_number] += [change]
else:
issue_map[issue_number] = [change]
for issue in issue_map:
add_labels(gh, issue, issue_map[issue], repo, project_board)
# Handle the incoming issue assignment requests
github_issues.assign_issues(repo)
# add_labels iterates over all of the changes that affect this issue and verifies that
# it has the correct label
def add_labels(gh: github.Github, issue_number: int, affecting_changes: list,
repo: Repository, project_board: Project):
try:
issue = repo.get_issue(issue_number)
except github.GithubException:
LOG.warning(f'Issue #{issue_number} not found for project')
return
# Assume these conditions and prove otherwise by iterating over affecting changes
is_wip = False
is_closed = True
for change in affecting_changes:
if 'WIP' in change['commitMessage'] or 'DNM' in change['commitMessage']:
is_wip = True
if change['status'] == 'NEW':
is_closed = False
if is_closed:
LOG.debug(f'Issue #{issue_number} is closed, removing labels.')
remove_label(issue, 'wip')
remove_label(issue, 'ready for review')
elif is_wip:
Log.debug(f'Issue #{issue_number} is WIP, adding the "wip" label and removing ' \
f'the "ready for review" label.')
remove_label(issue, 'ready for review')
add_label(issue, 'wip')
move_issue(project_board, issue, 'In Progress')
else:
Log.debug(f'Issue #{issue_number} is ready to be reviewed, adding the "ready ' \
f'for review" label and removing the "wip" label.')
remove_label(issue, 'wip')
add_label(issue, 'ready for review')
move_issue(project_board, issue, 'Submitted on Gerrit')
# remove_label removes the label from issue if it exists
def remove_label(issue: github.Issue, label: str):
try:
LOG.debug(f'Removing `{label}` label from issue #{issue_number}')
issue.remove_from_labels(label)
except github.GithubException:
LOG.debug(f'`{label}` tag does not exist on issue #{issue_number}')
# add_comments iterates over all of the issues affected by this change and verifies they
# have the appropriate comments. If the bot hasn't created a comment related to this
# change on an issue, it will create a new comment, otherwise it will edit its prior
# comment.
def add_comments(gh: github.Github, change: dict, affected_issues: dict,
repo: Repository, skip_approvals: bool = False):
for key, issues_list in affected_issues.items():
for issue_number in issues_list:
try:
issue = repo.get_issue(issue_number)
except github.GithubException:
LOG.warning(f'Issue #{issue_number} not found for project')
return
comment_msg = get_issue_comment(change, key, skip_approvals)
# Disable this feature to reopen issue on any gerrit activity on closed issue
# Issues identified:
# 1. When an old PS (tagged with closed issue number) is abandoned, it reopens the issue
# 2. post/promote job events are also considered as some gerrit activity on a
# closed issue and is reopened in the next immediate run of bot
#if issue.state == 'closed':
# LOG.debug(f'Issue #{issue_number} was closed, reopening...')
# NOTE(howell): Reopening a closed issue will move it from the
# "Done" column to the "In Progress" column on the project
# board via Github automation.
# issue.edit(state='open')
# comment_msg += '\n\nIssue reopened due to new activity on Gerrit.'
bot_comment = github_issues.get_bot_comment(issue, gh.get_user().login, change['number'])
if not bot_comment:
LOG.debug(f'Comment to post on #{issue_number}: {comment_msg}')
issue.create_comment(comment_msg)
LOG.info(f'Comment posted to issue #{issue_number}')
else:
LOG.debug(f'Comment to edit on #{issue_number}: {comment_msg}')
bot_comment.edit(comment_msg)
LOG.info(f'Comment edited to issue #{issue_number}')
def get_issue_comment(change: dict, key: str, skip_approvals: bool = False) -> str:
comment_str = f'## Related Change [#{change["number"]}]({change["url"]})\n\n' \
f'**Subject:** {change["subject"]}\n' \
f'**Link:** {change["url"]}\n' \
f'**Status:** {change["status"]}\n' \
f'**Owner:** {change["owner"]["name"]} ({change["owner"]["email"]})\n\n'
if key == 'closes':
comment_str += 'This change will close this issue when merged.\n\n'
if not skip_approvals:
comment_str += '### Approvals\n' \
'```diff\n'
approval_dict = {
'Code-Review': [],
'Verified': [],
'Workflow': []
}
if 'approvals' in change['currentPatchSet']:
for approval in change['currentPatchSet']['approvals']:
if approval['type'] in approval_dict:
approval_dict[approval['type']].append((approval['by']['name'], approval['value']))
else:
LOG.warning(f'Approval type "{approval["type"]}" is not a known approval type')
for key in ['Code-Review', 'Verified', 'Workflow']:
comment_str += f'{key}\n'
if approval_dict[key]:
for approval in approval_dict[key]:
if int(approval[1]) > 0:
comment_str += '+'
comment_str += f'{approval[1]} {approval[0]}\n'
else:
comment_str += '! None\n'
comment_str += '```'
dt = datetime.datetime.now(pytz.timezone('America/Chicago')).strftime('%Y-%m-%d %H:%M:%S %Z').strip()
comment_str += f'\n\n*Last Updated: {dt}*'
return comment_str
def move_issue(project_board: Project, issue: Issue, to_col_name: str):
to_col, card = None, None
for col in project_board.get_columns():
if col.name == to_col_name:
to_col = col
else:
for c in col.get_cards():
if c.get_content() == issue:
card = c
if not to_col:
LOG.warning(f'Column with name "{to_col_name}" could not be found for project "{project_board.name}"')
return
if not card:
LOG.warning(f'Issue with name "{issue.title}" could not be found for project "{project_board.name}"')
return
if card.move("top", to_col):
LOG.info(f'Moved issue "{issue.title}" to column "{to_col_name}"')
else:
LOG.warning(f'Failed to move issue "{issue.title}" to column "{to_col_name}"')
View Git Blame Copy Permalink