allura_issues.py

#!/usr/bin/env python
# Integrates git-cl with the Allura issue tracking tool
# Phil Holmes

import urllib
import cl_settings
import sys

settings = cl_settings.Settings()

def create_issue(subject, description, code_review_url=None):
  BEARER_TOKEN = settings.GetToken()
  allura_server = settings.GetTrackerServer()
  allura_api = add_api_string(allura_server)

  if code_review_url:
    if description:
      description += '\n\n'
    description += code_review_url

  data = {
    'access_token': BEARER_TOKEN,
    'ticket_form.summary': subject,
    'ticket_form.description': description,
    'ticket_form.status': 'Started',
    'ticket_form.custom_fields._patch': 'new',
    'ticket_form.custom_fields._type': 'Enhancement',
  }
  data_encoded = urllib.urlencode(data)
  allura_result = urllib.urlopen (allura_api + "/new", data_encoded)
  if allura_result.getcode() == 200:
    print 'Ticket created at: %s' % allura_result.geturl().replace("/rest","")
  else:
    print 'Error code %s' % (allura_result.getcode())
    print 'Failed URL was %s' % allura_api + "/new"
    print 'Failed data was %s' % data_encoded
    sys.exit(1)
  issue_id = get_issue_number(allura_result.geturl())

  # Now get text of issue back, to locate the originator
  filehandle = urllib.urlopen (allura_api + issue_id)
  if filehandle.getcode() != 200:
    print "Problem getting originator for Allura issue"
    sys.exit(1)

  issue_str = filehandle.read()
  originator = get_reporter(issue_str)

  # Now set the owner to the originator
  data = {
    'access_token': BEARER_TOKEN,
    'ticket_form.assigned_to': originator,
  }
  data_encoded = urllib.urlencode(data)

  filehandle = urllib.urlopen (allura_api + issue_id + "/save", data_encoded)
  if filehandle.getcode() != 200:
    print "Problem setting originator for Allura issue"
    sys.exit(1)

  return issue_id

def update_issue(allura_issue_id, comment, code_review_url=None):
  BEARER_TOKEN = settings.GetToken()
  allura_server = settings.GetTrackerServer()
  allura_api = add_api_string(allura_server)

  # Set patch status to new
  ## TODO: Sometimes a new code review is created for an issue that
  ## already had one.  It would be helpful to update the description
  ## field to refer to the latest code review instead of the old.
  data = {
    'access_token': BEARER_TOKEN,
    'ticket_form.status': 'Started',
    'ticket_form.custom_fields._patch': 'new',
  }
  data_encoded = urllib.urlencode(data)

  filehandle = urllib.urlopen (allura_api + str(allura_issue_id) + "/save", data_encoded)
  if filehandle.getcode() != 200:
    print "Problem setting patch status for Allura issue"
    sys.exit(1)

  if code_review_url:
    if comment:
      comment += '\n\n'
    comment += code_review_url

  # Now get the thread ID so we can add a note to the correct thread
  filehandle = urllib.urlopen (allura_api + str(allura_issue_id))
  issue_data = filehandle.read()
  thread_id = get_thread_ID(issue_data)
  data = {
    'access_token': BEARER_TOKEN,
    'text': comment,
  }

  issue_id = get_issue_number(filehandle.geturl())

  data_encoded = urllib.urlencode(data)
  allura_url = allura_api + "/_discuss/thread/"
  allura_url += thread_id + "/new"

  allura_result = urllib.urlopen (allura_url, data_encoded)
  if allura_result.getcode() != 200:
    print 'Received error code %s when attempting to update %s' % (
      allura_result.getcode(), allura_url)
    sys.exit(1)
  return issue_id

def get_issue_number(url):
  trim_url = url[0:len(url)-1]
  slash_pos = trim_url.rfind('/')
  issue = url[slash_pos+1: len(url)]
  if issue[len(issue)-1] == '/':
    issue = issue [0:len(issue)-1]
  return issue

def add_api_string(allura_server):
  p_pos = allura_server.find('/p/')
  if p_pos < 1:
    print 'Allura server has unxepected format: expect it to contain /p/ in the URL'
    print 'Please run git cl config'
    sys.exit(1)
  api_server = allura_server[0:p_pos]
  api_server += '/rest'
  api_server += allura_server [p_pos:]
  return api_server

def get_reporter(issue_text):
  reporter_pos = issue_text.index('"reported_by": "')
  reporter_str = issue_text[reporter_pos+16:]
  quote_pos = reporter_str.index('"')
  reporter_str = reporter_str[0:quote_pos]
  return reporter_str

def get_thread_ID(issue_data):
  discussion_pos = issue_data.index('"discussion_thread": ')
  discussion_data = issue_data[discussion_pos:]
  id_key = '"_id": "'
  id_key_pos = discussion_data.index(id_key)
  id_str = discussion_data[id_key_pos + len(id_key):]
  quote_pos = id_str.index('"')
  thread_id = id_str[0:quote_pos]
  return thread_id