hookscripts.py

"""
hookscripts - ready to use hook scripts for gitzilla.

These pick up configuration values from the environment.

"""

import os
import re
import sys
import gitzilla.hooks
import logging
import ConfigParser
import bugz

DEFAULT = 'DEFAULT'

def to_bool(v):
  if isinstance(v, str):
    return v.lower() in ["yes", "true", "t", "1"]
  else:
    return bool(v)

def get_or_default(conf, section, option, default=None):
  if conf.has_option(section, option):
    return conf.get(section, option)
  elif conf.has_option(DEFAULT, option):
    return conf.get(DEFAULT, option)
  return default


def has_option_or_default(conf, section, option):
  return conf.has_option(section, option) or conf.has_option(DEFAULT, option)


def bz_auth_from_config(config, sRepo):
  sBZUser = None
  sBZPasswd = None

  if has_option_or_default(config, sRepo, "bugzilla_user") and has_option_or_default(config, sRepo, "bugzilla_password"):
    sBZUser = get_or_default(config, sRepo, "bugzilla_user")
    sBZPasswd = get_or_default(config, sRepo, "bugzilla_password")

  return (sBZUser, sBZPasswd)



def get_bz_data(siteconfig, userconfig):
  sRepo = os.getcwd()

  bAllowDefaultAuth = False

  sBZUrl = get_or_default(siteconfig, sRepo, "bugzilla_url")
  if not sBZUrl:
    print "missing/incomplete bugzilla conf (no bugzilla_url)"
    sys.exit(1)

  sUserOption = get_or_default(siteconfig, sRepo, "user_config", "allow")
  sUserOption = {"deny": "deny", "force": "force"}.get(sUserOption, "allow")

  (sBZUser, sBZPasswd) = bz_auth_from_config(userconfig, sRepo)

  # ignore auth from site-config if "force"
  if sUserOption == "force":
    bAllowDefaultAuth = False

  # for 'allow', get the auth from user config but allow fallback
  if sUserOption == "allow":
    bAllowDefaultAuth = True

  # ignore auth from user config is "deny"
  if sUserOption == "deny":
    (sBZUser, sBZPasswd) = bz_auth_from_config(siteconfig, sRepo)
    if None in (sBZUser, sBZPasswd):
      raise ValueError("No default Bugzilla auth found. Cannot use user-auth because user_config is set to 'deny'")

  return (sBZUrl, sBZUser, sBZPasswd, bAllowDefaultAuth)



def get_logger(siteconfig):
  sRepo = os.getcwd()
  logger = None
  if has_option_or_default(siteconfig, sRepo, "logfile"):
    logger = logging.getLogger("gitzilla")
    logger.addHandler(logging.FileHandler(get_or_default(siteconfig, sRepo, "logfile")))
    # default to debug, but switch to info if asked.
    sLogLevel = get_or_default(siteconfig, sRepo, "loglevel", "debug")
    logger.setLevel({"info": logging.INFO}.get(sLogLevel, logging.DEBUG))

  return logger


def get_bug_regex(siteconfig):
  sRepo = os.getcwd()
  oBugRegex = None
  if has_option_or_default(siteconfig, sRepo, "bug_regex"):
    oBugRegex = re.compile(get_or_default(siteconfig, sRepo, "bug_regex"),
                           re.MULTILINE | re.DOTALL | re.IGNORECASE)

  return oBugRegex


def make_bz_init(siteconfig, bAllowDefaultAuth):
  # return a bz_init function which does the right thing.

  def bz_init(sBZUrl, sBZUser, sBZPasswd):
    # if username/passwd are none, then modify the Bugz instance so that
    # Bugz.get_input and getpass.getpass get the username and passwd
    # from the siteconfig.
    if sBZUrl is None:
      raise ValueError("No Bugzilla URL specified")

    sSiteUser = sBZUser
    sSitePasswd = sBZPasswd

    sRepo = os.getcwd()

    if None in (sBZUser, sBZPasswd):
      if bAllowDefaultAuth:
        # get data from siteconfig
        (sSiteUser, sSitePasswd) = bz_auth_from_config(siteconfig, sRepo)

    oBZ = bugz.bugzilla.Bugz(sBZUrl, user=sBZUser, password=sBZPasswd)

    def auth_error(*args):
      raise ValueError("no Bugzilla auth found!")

    if sSiteUser is None:
      oBZ.get_input = auth_error
    else:
      oBZ.get_input = lambda prompt: sSiteUser
    import getpass
    if sSitePasswd is None:
      getpass.getpass = auth_error
    else:
      getpass.getpass = lambda: sSitePasswd
    return oBZ

  return bz_init


def post_receive(aasPushes=None):
  """
  The gitzilla-post-receive hook script.

  The configuration is picked up from /etc/gitzillarc and ~/.gitzillarc

  The user specific configuration is allowed to override the bugzilla
  username and password.

  aasPushes is a list of (sOldRev, sNewRev, sRefName) tuples, for when these
  aren't read from stdin (gerrit integration).
  """
  siteconfig = ConfigParser.RawConfigParser()
  siteconfig.readfp(file("/etc/gitzillarc"))
  sRepo = os.getcwd()

  userconfig = ConfigParser.RawConfigParser()
  userconfig.read(os.path.expanduser("~/.gitzillarc"))

  (sBZUrl, sBZUser, sBZPasswd, bAllowDefaultAuth) = get_bz_data(siteconfig, userconfig)

  logger = get_logger(siteconfig)
  oBugRegex = get_bug_regex(siteconfig)
  sRefPrefix = get_or_default(siteconfig, sRepo, "git_ref_prefix")
  sSeparator = get_or_default(siteconfig, sRepo, "separator")
  sFormatSpec = get_or_default(siteconfig, sRepo, "formatspec")
  bIncludeDiffStat = to_bool(get_or_default(siteconfig, sRepo, "include_diffstat", True))
  bIncludeRepoName = to_bool(get_or_default(siteconfig, sRepo, "include_repository_name", False))

  bz_init = make_bz_init(siteconfig, bAllowDefaultAuth)

  gitzilla.hooks.post_receive(sBZUrl, sBZUser, sBZPasswd, sFormatSpec,
                              oBugRegex, sSeparator, logger, bz_init,
                              sRefPrefix, bIncludeDiffStat, aasPushes,
                              bIncludeRepoName)



def update():
  """
  The gitzilla-update hook script.

  The configuration is picked up from /etc/gitzillarc and ~/.gitzillarc

  The user specific configuration is allowed to override the bugzilla
  username and password.
  """
  siteconfig = ConfigParser.RawConfigParser()
  siteconfig.readfp(file("/etc/gitzillarc"))
  sRepo = os.getcwd()

  logger = get_logger(siteconfig)
  oBugRegex = get_bug_regex(siteconfig)
  sRefPrefix = get_or_default(siteconfig, sRepo, "git_ref_prefix")
  sSeparator = get_or_default(siteconfig, sRepo, "separator")

  bRequireBugNumber = to_bool(get_or_default(siteconfig, sRepo, "require_bug_ref", True))
  asAllowedStatuses = None
  if has_option_or_default(siteconfig, sRepo, "allowed_bug_states"):
    asAllowedStatuses = map(lambda x: x.strip(),
                get_or_default(siteconfig, sRepo, "allowed_bug_states").split(","))

  # and the bugzilla info.
  userconfig = ConfigParser.RawConfigParser()
  userconfig.read(os.path.expanduser("~/.gitzillarc"))
  (sBZUrl, sBZUser, sBZPasswd, bAllowDefaultAuth) = get_bz_data(siteconfig, userconfig)

  bz_init = make_bz_init(siteconfig, bAllowDefaultAuth)

  gitzilla.hooks.update(oBugRegex, asAllowedStatuses, sSeparator, sBZUrl,
                        sBZUser, sBZPasswd, logger, bz_init, sRefPrefix,
                        bRequireBugNumber)