import re
+from datetime import datetime, timezone
+from dateutil import parser
+from dateutil.tz import tzutc
+from dateutil.relativedelta import *
from errbot import BotPlugin, botcmd, webhook
from errbot.backends import xmpp
from errcron.bot import CrontabMixin
+from time import sleep
import gitlab
-from Secret import admin_token
-git_host = "gitlab.services.zz" #TODO: move this to some sort of plugin config
+def deltastr(any_delta):
+ l_delta = []
+ (days, hours, mins) = (any_delta.days, any_delta.seconds//3600, (any_delta.seconds//60)%60)
+
+ for (k,v) in {"day": days, "hour": hours, "minute": mins}.items():
+ if v == 1:
+ l_delta.append("1 " + k)
+ elif v > 1:
+ l_delta.append("{} {}s".format(v, k))
+
+ return ",".join(l_delta) + " ago"
class Marge(BotPlugin, CrontabMixin):
"""
I remind you about merge requests
- Use:
- In gitlab:
- Add a merge request webook of the form 'https://webookserver/margeboot/<rooms>' to the projects you want tracked.
- <rooms> should be a comma-separated list of rooms you want notified.
+ Use:
+ In gitlab:
+ Add a merge request webook of the form
+ 'https://webookserver/margeboot/<rooms>'
+ to the projects you want tracked. <rooms> should be a
+ comma-separated list of short room names (anything before the '@')
+ that you want notified.
In errbot:
- Add <roomname>@domain to the CHATROOM_PRESENCE list in config.py for rooms margebot should join
+ Add <roomname>@domain to the CHATROOM_PRESENCE list in config.py for
+ rooms margebot should join
"""
-
+
CRONTAB = [
- '0 11,17 * * * .crontab_hook' # 7:00AM and 1:00PM EST warnings
+ # Set in config now: '0 11,17 * * * .crontab_hook' # 7:00AM and 1:00PM EST warnings
]
-# def __init__(self, bot):
-# self.gitlab = None
-
- def configure(self, configuration):
- ## TODO: set up a connection to the gitlab API
-
- self.gitlab = gitlab.Gitlab(git_host,admin_token,verify_ssl=False)
-
-# notify_re = re.compile('notify_(.*)')
-
-# def get_mr_rooms(self, project_id):
-# """
-# Return a list of errbot room '<roomname>@domain' names which have a 'notify_<roomname>' label on the project
-# Log an error if you found a 'notify_<roomname>' but margebot isn't in a <roomname> room...
-# """
-# retval = []
-# labels = this.gitlab.getlabels(project_id)
-# for a_label in labels:
-# notify_match = self.notify_re.search(a_label['name'])
-# if notify_match:
-# roomname = notify_match.group(1)
-#
-# b_room_found = False
-# marge_rooms = xmpp.rooms()
-# for a_room in marge_rooms:
-# if a_room.node() == roomname:
-# retval.append(a_room.person()) # yeah rooms are people: person = node@domain
-# b_room_found = True
-# if not b_room_found:
-# self.log.error("Label of {} found, but margebot isn't tracking that room".format(roomname))
-# else:
-# retval.append(roomname)
-# return retval
-
- @webhook('/margebot/<rooms>/'
- def gitlab_hook(self, request):
+ def __init__(self, *args, **kwargs):
+ self.git_host = None
+ self.chatroom_host = None
+ super().__init__(*args, **kwargs)
+
+ def get_configuration_template(self):
+ """
+ GITLAB_HOST: Host name of your gitlab server
+ GITLAB_ADMIN_TOKEN: PAT from an admin's https://${GIT_HOST}/profile/personal_access_tokens page.
+ CHATROOM_HOST: Chatroom host. Usually 'chatroom' + FQDN of Jabber server
+ CRONTAB: Schedule of automated merge request checks in '%M %H %d %m %w' format
+ VERIFY_SSL : True, False, or path to CA cert to verify cert
+ CRONTAB_SOAK_HOURS : Don't send out reminders about MRs opened less than this many hours
+ """
+ return {'GITLAB_HOST': 'gitlab.example.com',
+ 'GITLAB_ADMIN_TOKEN' : 'gitlab-admin-user-private-token',
+ 'CHATROOM_HOST': 'conference.jabber.example.com',
+ 'CRONTAB' : '0 11,17 * * *',
+ 'VERIFY_SSL' : True,
+ 'CRONTAB_SOAK_HOURS' : 1}
+
+ def check_configuration(self, configuration):
+ super().check_configuration(configuration)
+
+ def activate(self):
+ if not self.config:
+ self.log.info('Margebot is not configured. Forbid activation')
+ return
+ self.git_host = self.config['GITLAB_HOST']
+ self.chatroom_host = self.config['CHATROOM_HOST']
+ Marge.CRONTAB = ['{} .crontab_hook'.format(self.config['CRONTAB']) ]
+ self.gitlab = gitlab.Gitlab(self.git_host, self.config['GITLAB_ADMIN_TOKEN'], verify_ssl=self.config['VERIFY_SSL'])
+ self.activate_crontab()
+
+ self.soak_delta = relativedelta( hours = self.config['CRONTAB_SOAK_HOURS'])
+ super().activate()
+
+ def deactivate(self):
+ super().deactivate()
+
+ @webhook('/margebot/<rooms>/')
+ def gitlab_hook(self, request, rooms):
"""
Webhook that listens on http://<server>:<port>/gitlab
"""
- # TODO: Will errbot return a json struct or not ?
+ self.log.info('margebot webhook request: {}'.format(request))
+ self.log.info('margebot webhook rooms {}'.format(rooms))
# verify it's a merge request
- if requests['object_kind'] != 'merge_request':
- self.log.error('expecting object_kind of merge_request but got {}'.format(requests['object_kind']))
+ if request['object_kind'] != 'merge_request':
+ self.log.error('expecting object_kind of merge_request but got {}'.format(request['object_kind']))
+ self.log.error('request: {}'.format(request))
elif request['object_attributes']['state'] == 'opened':
- if request['object_attributes']['work_in_progress']:
- wip = "WIP"
- else:
- wip = ""
- url = request['object_attributes']['url']
- state = request['object_attributes']['state']
- title = request['object_attributes']['title']
-
- author_id = request['object_attributes']['author_id'] # map this to user name ...
- author = self.gitlab.getuser(author_id)
- author_name = author['username']
-
- target_project_id = request['object_attributes']['target_project_id']
- iid = request['object_attributes']['iid']
-
- user_name = request['user']['username'] # will this always be Administrator ?
-
- message = "Reviews: {} has opened a new {} MR: {}\n{}".format(author_name, wip, title, url)
-
- # TODO: Maybe also check the notify_<room> labels assigned to the MR as well ?
- #mr_rooms = self.get_mr_rooms(target_project_id)
- for a_room in rooms.split(','):
- self.send( self.build_identifier(a_room), message)
-
- with self.mutable('OPEN_MRS') as open_mrs:
- open_mrs[(target_project_id,iid,rooms)] = True
-
+
+ # TODO:
+ # - check for reopened / request['object_attributes']['action'] == 'reopn'
+ # (there's no 'action': 'opened' for MRs are created...
+ # - pop open_mrs when MRs are closed (action == close / state == closed
+
+ if request['object_attributes']['work_in_progress']:
+ wip = "WIP"
+ else:
+ wip = ""
+ url = request['project']['homepage']
+ state = request['object_attributes']['state']
+ title = request['object_attributes']['title']
+
+ author_id = request['object_attributes']['author_id'] # map this to user name ...
+ author = self.gitlab.getuser(author_id)
+ author_name = author['username']
+
+ target_project_id = request['object_attributes']['target_project_id']
+ iid = request['object_attributes']['iid']
+
+ user_name = request['user']['username'] # will this always be Administrator ?
+
+ msg_template = "New Review: {} has opened a new {} MR: \"{}\"\n{}/merge_requests/{}"
+ msg = msg_template.format(author_name, wip, title, url, iid)
+
+ for a_room in rooms.split(','):
+ if self.config:
+ self.send(self.build_identifier(a_room + '@' + self.chatroom_host), msg)
+
+ if 'OPEN_MRS' not in self.keys():
+ empty_dict = {}
+ self['OPEN_MRS'] = empty_dict
+
+ with self.mutable('OPEN_MRS') as open_mrs:
+ open_mrs[(target_project_id, iid, rooms)] = True
+
return "OK"
-# def get_open_mrs(self, roomname=None, log_warnings=False):
-# mrs = []
-# for a_project in self.gitlab.getprojects():
-# for a_mr in self.gitlab.getmergerequests(a_project['id'], state='opened'):
-# rooms = self.get_mr_rooms(a_mr['target_project_id'])
-# if len(rooms) == 0 and log_warnings:
-# self.log.warning('No notify room with MRs in project: {}'.format(a_mr['target_project_id']))
-# elif not roomname:
-# mrs.append(a_mr)
-# else:
-# for a_room in rooms:
-# if a_room.startswith(roomname):
-# mrs.append(a_mr)
-# return mrs
-
- def crontab_hook(self):
+ def mr_status_msg(self, a_mr, author=None):
+ self.log.info("mr_status_msg: a_mr: {}".format(a_mr))
+
+ now = datetime.now(timezone.utc)
+ creation_time = parser.parse(a_mr['created_at'], tzinfos=tzutc)
+ self.log.info("times: {}, {}, {}".format(creation_time, self.soak_delta, now))
+ if creation_time + self.soak_delta > now:
+ info_msg = "skipping: MR <{},{}> was opened less than {} hours ago".format(project, iid, soak_hours)
+ self.log.info(info_msg)
+ return None
+
+ str_open_since = deltastr(now - creation_time)
+
+ warning = ""
+ if a_mr['work_in_progress']:
+ warning = "still WIP"
+ elif a_mr['merge_status'] != 'can_be_merged':
+ warning = "there are merge conflicts"
+
+ if author:
+ authored = (a_mr['author']['id'] == author)
+ else:
+ authored = False
+
+ # TODO: Include the count of opened MR notes (does the API show resolved state ??)
+
+ # getapprovals is only available in GitLab 8.9 EE or greater (not the open source CE version)
+ # approvals = self.gitlab.getapprovals(a_mr['id'])
+ # also_approved = ""
+ # for approved in approvals['approved_by']:
+ # also_approved += "," + approved['user']['name']
+
+ upvotes = a_mr['upvotes']
+ msg = "{} (opened {})".format(a_mr['web_url'], str_open_since)
+ if upvotes >= 2:
+ msg += ": Has 2+ upvotes / Could be merge in now"
+ if warning != "":
+ msg += " except {}".format(a_mr['web_url'], str_open_since, warning)
+ else:
+ msg += "."
+
+ elif upvotes == 1:
+ if authored:
+ msg += ": Your MR is waiting for another upvote"
+ else:
+ msg += ": Waiting for another upvote"
+ if warning != "":
+ msg += "but {}.".format(warning)
+ else:
+ msg += "."
+
+ else:
+ if authored:
+ msg += ": Your MR has no upvotes"
+ else:
+ msg += ": No upvotes, please review"
+ if warning != "":
+ msg += "but {}".format(warning)
+ else:
+ msg += "."
+
+ return((creation_time, msg))
+
+
+ def crontab_hook(self, polled_time):
"""
- Send a scheduled message to the rooms margebot is watching about open MRs the room cares about.
+ Send a scheduled message to the rooms margebot is watching
+ about open MRs the room cares about.
"""
- reminder_msg = {} # Map of reminder_msg['roomname@domain'] = msg
-
+ self.log.info("crontab_hook triggered at {}".format(polled_time))
+
+ reminder_msg = {} # Map of reminder_msg['roomname@domain'] = [(created_at,msg)]
+
# initialize the reminders
- rooms = xmpp.rooms()
+ rooms = self.rooms()
for a_room in rooms:
- reminder_msg[a_room.node()] = ''
+ reminder_msg[a_room.node] = []
+ msgs = ""
still_open_mrs = {}
# Let's walk through the MRs we've seen already:
- for (project,iid,notify_rooms) in self['OPEM_MRS']:
+ with self.mutable('OPEN_MRS') as open_mrs:
+ for (project, iid, notify_rooms) in open_mrs:
- # Lookup the MR from the project/iid
- a_mr = self.gitlab.getmergerequest(project, iid)
+ # Lookup the MR from the project/iid
+ a_mr = self.gitlab.getmergerequest(project, iid)
- # If the MR is no longer open, skip to the next MR,
- # and don't include this MR in the next check
- if a_mr['state'] != 'open':
- continue
- else:
- still_open_mrs[(project, iid, notify_rooms) = True
+ self.log.info("a_mr: {} {} {} {}".format(project, iid, notify_rooms, a_mr['state']))
- # TODO: Warn if an open MR has has conflicts (merge_status == ??)
- # TODO: Include the count of opened MR notes (does the API show resolved state ??)
+ # If the MR is no longer open, skip to the next MR,
+ # and don't include this MR in the next check
+ if a_mr['state'] != 'opened':
+ continue
+ else:
+ still_open_mrs[(project, iid, notify_rooms)] = True
- approvals = self.gitlab.getapprovals(a_mr['id'])
- also_approved = ""
- for approved in approvals['approved_by']:
- also_approved += "," + approved['user']['name']
+ msg_tuple = self.mr_status_msg(a_mr)
+ if msg_tuple is None:
+ continue
- upvotes = a_mr['upvotes']
- if upvotes >= 2:
- msg = "\n{}: Has 2+ upvotes and could be merged in now.".format(a_mr['web_url'])
- elif upvotes == 1:
- msg = "\n{}: {} already approved and is waiting for another upvote.".format(a_mr['web_url'], also_approved[1:])
- else:
- msg = '\n{}: Has no upvotes.'.format(a_mr['web_url'])
-
- for a_room in notify_rooms.split(','):
- reminder_msg[a_room] += msg
+ for a_room in notify_rooms.split(','):
+ reminder_msg[a_room].append(msg_tuple)
# Remind each of the rooms about open MRs
- for a_room, room_msg in reminder_msg.iteritems():
- if room_msg != "":
- self.send(self.build_identifier(a_room), "Heads up these MRs need some luv:{}\n You can get a list of open reviews I know about by sending me a 'Marge, reviews' command.".format(room_msg))
+ for a_room, room_msg_list in reminder_msg.items():
+ if room_msg != []:
+
+ sorted_room_msg_list = sorted(room_msg_list, key=lambda x: x[0]) # sort by the creation time
+ msgs = [x[1] for x in sorted_room_msg_list] # extract the msgs from the tuple list
+ room_msg = "\n".join(msgs) # join those msgs together.
+
+ if self.config:
+ msg_template = "These MRs need some attention:{}\n"
+ msg_template += "You can get an updated list with the '/msg MargeB !reviews' command."
+ msg = msg_template.format(room_msg)
+ self.send(self.build_identifier(a_room + '@' + self.config['CHATROOM_HOST']), msg)
self['OPEN_MRS'] = still_open_mrs
-# def callback_message(self, mess):
-# """
-# Look for messages that include an URL that looks like 'https://<gitlab_server>/<group_name>/<project_name>/merge_request/<iid>'
-# Check if gitlab mergerequest webhook already exists for this group/project, and this it reports to this room ?
-# Add the project to the OPEN_MRS list
-# """
-# TODO: compiled re check against mess.body searching for
-# https://<gitlabe_server/(group_name)/(project_name)/merge_request/(iid)
-# project = self.gitlab.getprojects(group_name+'%2F'+project_name)
-# orig_mrs = self['OPEN_MRS']
-# orig_mrs[(project['id'],iid,mess.to.node()] = True
-# self.send(mess.to, "Another MR ! YUM !")
-# return
-
- @botcmd # flags a command
+ @botcmd()
def reviews(self, msg, args): # a command callable with !mrs
"""
Returns a list of MRs that are waiting for some luv.
Also returns a list of MRs that have had enough luv but aren't merged in yet.
"""
- sender = msg.frm
+ ## Sending directly to Margbot: sender in the form sender@....
+ ## Sending to a chatroom: snder in the form room@rooms/sender
+
+ if msg.frm.domain == self.config['CHATROOM_HOST']:
+ sender = msg.frm.resource
+ else:
+ sender = msg.frm.node
+
+ if 'OPEN_MRS' not in self.keys():
+ return "No MRs to review"
- send_gitlab_id = None
+ sender_gitlab_id = None
for user in self.gitlab.getusers():
- if user['username'] == sender.node:
+ if user['username'] == sender:
sender_gitlab_id = user['id']
break
- if not send_gitlab_id:
- self.log.error('problem mapping {} to a gitlab user'.format(sender.node))
- self.send(self.build_identifier(msg.frm), "Sorry I couldn't find your gitlab ID")
- return
-
- # TODO: how to get the room the message was sent from ? I'm assuming this will either be in msg.frm or msg.to
- # TODO: weed out MRs the sender opened or otherwise indicate they've opened or have already +1'd
+ if not sender_gitlab_id:
+ self.log.error('problem mapping {} to a gitlab user'.format(sender))
+ return "Sorry, I couldn't find your gitlab account."
- roomname = msg.to.domain #???
-
- # Let's walk through the MRs we've seen already:
+ # Walk through the MRs we've seen already:
+ msg_list = []
msg = ""
still_open_mrs = {}
- for (project,iid,notify_rooms) in self['OPEM_MRS']:
+ with self.mutable('OPEN_MRS') as open_mrs:
+ for (project, iid, notify_rooms) in open_mrs:
- # Lookup the MR from the project/iid
- a_mr = self.gitlab.getmergerequest(project, iid)
-
- # If the MR is no longer open, skip to the next MR,
- # and don't include this MR in the next check
- if a_mr['state'] != 'open':
- continue
- else:
- still_open_mrs[(project, iid, notify_rooms) = True
-
- authored = (a_mr['author_id'] == sender_gitlab_id)
- already_approved = False
-
- approvals = self.gitlab.getapprovals(a_mr['id'])
- also_approved = ""
- for approved in approvals['approved_by']:
- if approved['user']['id'] == sender_gitlab_id:
- already_approved = True
- else:
- also_approved += "," + approved['user']['name']
-
- upvotes = a_mr['upvotes']
- if upvotes >= 2:
- msg = "\n{}: has 2+ upvotes from {} and could be merged in now.".format(a_mr['web_url'], also_approved[1:])
- elif upvotes == 1:
- if not authored:
- if already_approved:
- msg = "\n{}: has already been approved by you and is waiting for another upvote.".format(a_mr['web_url'])
- else:
- msg = "\n{}: has been approved by {} and is waiting for your upvote.".format(a_mr['web_url'], also_approved[1:])
+ # Lookup the MR from the project/iid
+ a_mr = self.gitlab.getmergerequest(project, iid)
+
+ # If the MR is no longer open, skip to the next MR,
+ # and don't include this MR in the next check
+ if a_mr['state'] != 'opened':
+ continue
else:
- msg = "\n{}: Your MR has approved by {} and is waiting for another upvote.".format(a_mr['web_url'], also_approved[1:])
+ still_open_mrs[(project, iid, notify_rooms)] = True
- else:
- if not authored:
- msg = '\n{}: Has no upvotes and needs your attention.'.format(a_mr['web_url'])
- else:
- msg = '\n{}: Your MR has no upvotes.'.format(a_mr['web_url'])
-
-
- if msg == "":
- response = 'I found no open merge requests for you.'
+ msg_tuple = self.mr_status_msg(a_mr, author=sender_gitlab_id)
+ if msg_tuple is None:
+ continue
+
+ msg_list.append(msg_tuple)
+
+ if msg_list == []:
+ response = 'Hi {}: {}'.format(sender, 'I found no open MRs for you.')
else:
- response = msg
-
- self.send(self.build_identifier(msg.frm), response)
+ sorted_msg_list = sorted(msg_list, key=lambda x: x[0]) # sort by the creation time
+ msgs = [x[1] for x in sorted_msg_list] # extract the msgs from the tuple list
+ msg = "\n".join(msgs) # join those msgs together.
+ response = 'Hi {}: These MRs need some attention:\n{}'.format(sender,msg)
- self['OPEN_MRS'] = still_open_mrs
+ with self.mutable('OPEN_MRS') as open_mrs:
+ open_mrs = still_open_mrs
- return
+ return response
@botcmd()
- def hello(self,msg, args):
+ def hello(self, msg, args):
return "Hi there"
+
+ @botcmd()
+ def xyzzy(self, msg, args):
+ yield "/me whispers \"All open MRs have ben merged into master.\""
+ sleep(5)
+ yield "(just kidding)"
projects / margebot.git / blobdiff