.. _fbf.plugs.extra.jira: jira ~~~~ .. automodule:: fbf.plugs.extra.jira :show-inheritance: :members: :undoc-members: CODE ---- :: # fbf/plugs/socket/jira.py """ jira.py - fbfbot module for performing lookups on a jira server Copyright 2011, Richard Bateman Special thanks to Sean B. Palmer for his phenny module; many of the ideas for this were adapted from that plugin http://inamidst.com/phenny/ BHJTW - adapted for FBFBOT on 15-09-2012 """ .. _fbf.plugs.extra.jira_fbf_imports: fbf imports -------------- :: from fbf.lib.callbacks import callbacks from fbf.lib.commands import cmnds from fbf.lib.persist import PlugPersist from fbf.lib.examples import examples from fbf.plugs.extra.tinyurl import get_tinyurl .. _fbf.plugs.extra.jira_basic_imports: basic imports ---------------- :: import logging import xmlrpc.client import re import time #import modules.activecollab .. _fbf.plugs.extra.jira_defines_: defines ---------- :: recent_tickets = {} min_age = 60 * 5 rpc_clients = {} cfg = PlugPersist('jira', {}) .. _fbf.plugs.extra.jira_getServerInfo_function: getServerInfo function ------------------------- :: def getServerInfo(server, auth): try: server_statuses = server.jira1.getStatuses(auth) statusMap = {} for status in server_statuses: statusMap[status['id']] = status['name'] server_priorities = server.jira1.getPriorities(auth) priorityMap = {} for priority in server_priorities: priorityMap[priority['id']] = priority['name'] info = server.jira1.getServerInfo(auth) jira_baseurl = info['baseUrl'] return { "statusMap": statusMap, "priorityMap": priorityMap, "baseUrl": jira_baseurl } except xmlrpc.client.Error as v: print("XMLRPC ERROR: ", end=' ') def getRpcClient(sInfo): base_url = "%s/rpc/xmlrpc" % sInfo["url"] server = xmlrpc.client.ServerProxy(base_url) username, password = sInfo["username"], sInfo["password"] auth = server.jira1.login(username, password) sInfo["serverInfo"] = getServerInfo(server, auth) logging.info("Server info: %s" % sInfo) return (server, auth) def getJiraIssue(s, ticket): server, auth = getRpcClient(s) try: info = server.jira1.getIssue(auth, ticket) return info except xmlrpc.client.Error as v: print("XMLRPC ERROR:", v) return None def getJiraIssueMessage(s, ticket): """docstring for ticket_lookup""" info = getJiraIssue(s, ticket) logging.info("jira ticket: %s is %s" % (ticket, info)) if info: outInfo = [] outInfo.append("%s: Summary: %s" % (info['key'], info['summary'])) if 'assignee' in info: outInfo.append( "%s: Assigned To: %s" % (info['key'], info['assignee'])) else: outInfo.append( "%s: Assigned To: Unassigned" % (info['key'])) data = (info["key"], s["serverInfo"]["priorityMap"][info['priority']], s["serverInfo"]["statusMap"][info['status']], s["serverInfo"]["baseUrl"], info["key"]) outInfo.append( "%s: Priority: %s, Status: %s, %s/browse/%s" % data) logging.info("Jira ticket text: %s" % outInfo) return outInfo def getMatchRegEx(prefixList): prefixLookup = "(%s)" % "|".join(prefixList) test = re.compile(".*(%s-[0-9]+).*" % prefixLookup) return test def containsJiraTag(bot, ievent): if ievent.how == "backgound": return 0 if not cfg.data.servers: return 0 prefixList = set() for server, serverData in cfg.data["servers"].items(): if ievent.channel in serverData["channels"]: prefixList.update(serverData["channels"][ievent.channel]) test = getMatchRegEx(prefixList) fnd = test.match(ievent.txt) if fnd: return 1 return 0 def doLookup(bot, ievent): if not cfg.data.servers: logging.warn("servers is not defined in config.") ; return 0 prefixList = set() serversForPrefix = {} for server, serverData in cfg.data["servers"].items(): if ievent.channel in serverData["channels"]: for prefix in serverData["channels"][ievent.channel]: serversForPrefix[prefix] = server prefixList.add(prefix) test = getMatchRegEx(prefixList) fnd = test.match(ievent.txt) if fnd: ticket = fnd.group(1) prefix = fnd.group(2) if not ticket: logging.warn("ticket missing: %s" % str(fnd)) ; return if not prefix: logging.warn("prefix missing: %s" % str(fnd)) ; return logging.info("Found: %s %s" % (ticket, prefix)) logging.info("servers: %s" % cfg.data["servers"]) try: server = serversForPrefix[prefix] except KeyError: return logging.warn("server is %s" % server) msg = getJiraIssueMessage(cfg.data["servers"][server], ticket) for line in msg: bot.say(ievent.channel, line) callbacks.add('PRIVMSG', doLookup, containsJiraTag, threaded=True) callbacks.add('CONSOLE', doLookup, containsJiraTag, threaded=True) callbacks.add('MESSAGE', doLookup, containsJiraTag, threaded=True) callbacks.add('DISPATCH', doLookup, containsJiraTag, threaded=True) callbacks.add('TORNADO', doLookup, containsJiraTag, threaded=True) .. _fbf.plugs.extra.jira_add_jira_server_command: add_jira_server command -------------------------- :: def handle_add_jira_server(bot, ievent): """ configure a new jira server; syntax: add_jira_server [server name] [url] [username] [password] """ if len(ievent.args) != 4: ievent.reply("syntax: add_jira_server [server name] [url] [username] [password]") return server = { "name": ievent.args[0], "url": ievent.args[1].strip("/"), "username": ievent.args[2], "password": ievent.args[3], "channels": {}, "serverInfo": {}, } if "servers" not in cfg.data: cfg.data["servers"] = {} cfg.data["servers"][server["name"]] = server cfg.save() ievent.reply("Added jira server %s" % server["name"]) cmnds.add("add_jira_server", handle_add_jira_server, ["OPER"]) examples.add("add_jira_server", "add a jira server", "add_jira_server FireBreath http://jira.firebreath.org myuser mypassword") .. _fbf.plugs.extra.jira_del_jira_server_command: del_jira_server command -------------------------- :: def handle_del_jira_server(bot, ievent): """ remove a jira server; syntax: del_jira_server """ if len(ievent.args) != 1: ievent.reply("syntax: del_jira_server [server name]") return serverName = ievent.args[0] if "servers" not in cfg.data: cfg.data["servers"] = {} if serverName in cfg.data["servers"]: del cfg.data["servers"][serverName] cfg.save() ievent.reply("Deleted jira server %s" % serverName) else: ievent.reply("Unknown jira server %s" % serverName) cmnds.add("del_jira_server", handle_del_jira_server, ["OPER"]) examples.add("del_jira_server", "del a jira server", "del_jira_server FireBreath http://jira.firebreath.org myuser mypassword") .. _fbf.plugs.extra.jira_jira_issue_lookup_enable_command: jira_issue_lookup_enable command ----------------------------------- :: def handle_jira_issue_lookup_enable(bot, ievent): """ enable lookups for jira issues in the current channel; syntax: jira_issue_lookup_enable [server] [prefix] """ if len(ievent.args) != 2: ievent.reply("syntax: jira_issue_lookup_enable [server] [prefix]") return serverName, prefix = ievent.args if not "servers" in cfg.data or not serverName in cfg.data["servers"]: ievent.reply("Unknown server %s" % serverName) return prefixSet = set(cfg.data["prefixes"]) if "prefixes" in cfg.data else set() server = cfg.data["servers"][serverName] if ievent.channel not in server["channels"]: server["channels"][ievent.channel] = [] if not prefix in server["channels"][ievent.channel]: server["channels"][ievent.channel].append(prefix) prefixSet.add(prefix) cfg.data["prefixes"] = list(prefixSet) cfg.save() ievent.reply("enabled lookups of %s-* jira tickets in this channel on server %s" % (prefix, serverName)) cmnds.add("jira_issue_lookup_enable", handle_jira_issue_lookup_enable, ["OPER"]) examples.add("jira_issue_lookup_enable", "enable lookups of jira tickets in the channel", "jira_issue_lookup_enable jiraserver FIREBREATH") .. _fbf.plugs.extra.jira_jira_issue_lookup_disable_command: jira_issue_lookup_disable command ------------------------------------ :: def handle_jira_issue_lookup_disable(bot, ievent): """ enable lookups for jira issues in the current channel for a given server; syntax: jira_issue_lookup_disable [server] """ if len(ievent.args) != 1: ievent.reply("syntax: jira_issue_lookup_disable [server]") return serverName = ievent.args[0] if not "servers" in cfg.data or not serverName in cfg.data["servers"]: ievent.reply("Unknown server %s" % serverName) return server = cfg.data["servers"][serverName] if ievent.channel in server["channels"]: server["channels"].remove(ievent.channel) ievent.reply("disabled lookups of jira tickets on server %s from this server" % serverName)