trac-pre-commit-hook.py

   1 #!/usr/bin/env python
   2 # -*- coding: iso8859-1 -*-
   3 #
   4 # Author: Jonas Borgström <jonas@edgewall.com>
   5 #
   6 # This script will enforce the following policy:
   7 #
   8 #  "A checkin must reference an open ticket."
   9 #
  10 # This script should be invoked from the subversion pre-commit hook like this:
  11 #
  12 #  REPOS="$1"
  13 #  TXN="$2"
  14 #  TRAC_ENV="/somewhere/trac/project/"
  15 #  LOG=`/usr/bin/svnlook log -t "$TXN" "$REPOS"`
  16 #  /usr/bin/python /some/path/trac-pre-commit-hook "$TRAC_ENV" "$LOG" || exit 1
  17 #
  18 import os
  19 import re
  20 import sys
  21
  22 from trac.env import open_environment
  23
  24 def main():
  25     if len(sys.argv) != 3:
  26        print >> sys.stderr, 'Usage: %s <trac_project> <log_message>' % sys.argv[0]
  27        sys.exit(1)
  28
  29     env_path = sys.argv[1]
  30     log = sys.argv[2].lower()
  31
  32     # Stephen: exempt 'No ticket'
  33     if re.search('no ticket', log) or re.search('initialized merge tracking', log):
  34         sys.exit(0)
  35
  36     tickets = []
  37     for tmp in re.findall('(?:refs|re|qa).?(#[0-9]+(?:(?:[, &]+| *and *)#[0-9]+)*)', log):
  38         tickets += re.findall('#([0-9]+)', tmp)
  39
  40     # At least one ticket has to be mentioned in the log message
  41     if tickets == []:
  42         print >> sys.stderr, 'At least one open ticket must be mentioned in the log message.'
  43         sys.exit(1)
  44
  45     env = open_environment(env_path)
  46     db = env.get_db_cnx()
  47
  48     cursor = db.cursor()
  49     # Stephen: let the tickets be closed for now
  50     # cursor.execute("SELECT COUNT(id) FROM ticket WHERE status <> 'closed' AND id IN (%s)" % ','.join(tickets))
  51     cursor.execute("SELECT COUNT(id) FROM ticket WHERE id IN (%s)" % ','.join(tickets))
  52     row = cursor.fetchone()
  53     if not row or row[0] < 1:
  54         print >> sys.stderr, 'At least one open ticket must be mentioned in the log message.'
  55         sys.exit(1)
  56     else:
  57         sys.exit(0)
  58
  59 if __name__ == '__main__':
  60     main()
  61
  62
  63