Question

I’m running in a windows environment with Trac / SVN and I want commits to the repository to integrate to Trac and close the bugs that were noted in the SVN Comment.

I know there’s some post commit hooks to do that, but there’s not much information about how to do it on windows.

Anyone done it successfully? And what were the steps you followed to achive it?

Here’s the hook I need to put in place in SVN, but I’m not exactly sure how to do this in the Windows environment.

Trac Post Commit Hook

Answer 1

Alright, now that I’ve got some time to post my experience after figuring this all out, and thanks to Craig for getting me on the right track. Here’s what you need to do (at least with SVN v1.4 and Trac v0.10.3):

1. Locate your SVN repository that you want to enable the Post Commit Hook for.
2. inside the SVN repository there’s a directory called hooks, this is where you’ll be placing the post commit hook.
3. create a file post-commit.bat (this is the batch file that’s automatically called by SVN post commit).
4. Place the following code inside the post-commit.bat file ( this will call your post commit cmd file passing in the parameters that SVN automatically passes %1 is the repository, %2 is the revision that was committed.

%~dp0\trac-post-commit-hook.cmd %1 %2

5. Now create the trac-post-commit-hook.cmd file as follows:

@ECHO OFF
::
:: Trac post-commit-hook script for Windows
::
:: Contributed by markus, modified by cboos.

:: Usage:
::
:: 1) Insert the following line in your post-commit.bat script
::
:: call %~dp0\trac-post-commit-hook.cmd %1 %2
::
:: 2) Check the ‘Modify paths’ section below, be sure to set at least TRAC_ENV

:: ———————————————————-
:: Modify paths here:

:: — this one must be set
SET TRAC_ENV=C:\trac\MySpecialProject

:: — set if Python is not in the system path
:: SET PYTHON_PATH=

:: — set to the folder containing trac/ if installed in a non-standard location
:: SET TRAC_PATH=
:: ———————————————————-

:: Do not execute hook if trac environment does not exist
IF NOT EXIST %TRAC_ENV% GOTO :EOF

set PATH=%PYTHON_PATH%;%PATH%
set PYTHONPATH=%TRAC_PATH%;%PYTHONPATH%

SET REV=%2

:: GET THE AUTHOR AND THE LOG MESSAGE
for /F %%A in (‘svnlook author -r %REV% %1’) do set AUTHOR=%%A
for /F ‘delims==’ %%B in (‘svnlook log -r %REV% %1’) do set LOG=%%B

:: CALL THE PYTHON SCRIPT
Python ‘%~dp0\trac-post-commit-hook’ -p ‘%TRAC_ENV%’ -r ‘%REV%’ -u ‘%AUTHOR%’ -m ‘%LOG%’

The most important parts here are to set your TRAC_ENV which is the path to the repository root (SET TRAC_ENV=C:\trac\MySpecialProject)

The next MAJORLY IMPORTANT THING in this script is to do the following:

:: GET THE AUTHOR AND THE LOG MESSAGE
for /F %%A in (‘svnlook author -r %REV% %1’) do set AUTHOR=%%A
for /F ‘delims==’ %%B in (‘svnlook log -r %REV% %1’) do set LOG=%%B

if you see in the script file above I’m using svnlook (which is a command line utility with SVN) to get the LOG message and the author that made the commit to the repository.

Then, the next line of the script is actually calling the Python code to perform the closing of the tickets and parse the log message. I had to modify this to pass in the Log message and the author (which the usernames I use in Trac match the usernames in SVN so that was easy).

CALL THE PYTHON SCRIPT
Python ‘%~dp0\trac-post-commit-hook’ -p ‘%TRAC_ENV%’ -r ‘%REV%’ -u ‘%AUTHOR%’ -m ‘%LOG%’

The above line in the script will pass into the python script the Trac Environment, the revision, the person that made the commit, and their comment.

Here’s the Python script that I used. One thing that I did additional to the regular script is we use a custom field (fixed_in_ver) which is used by our QA team to tell if the fix they’re validating is in the version of code that they’re testing in QA. So, I modified the code in the python script to update that field on the ticket. You can remove that code as you won’t need it, but it’s a good example of what you can do to update custom fields in Trac if you also want to do that.

I did that by having the users optionally include in their comment something like:

(version 2.1.2223.0)

I then use the same technique that the python script uses with regular expressions to get the information out. It wasn’t too bad.

Anyway, here’s the python script I used, Hopefully this is a good tutorial on exactly what I did to get it to work in the windows world so you all can leverage this in your own shop…

If you don’t want to deal with my additional code for updating the custom field, get the base script from this location as mentioned by Craig above (Script From Edgewall)

#!/usr/bin/env python  # trac-post-commit-hook # ---------------------------------------------------------------------------- # Copyright (c) 2004 Stephen Hansen  # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the 'Software'), to # deal in the Software without restriction, including without limitation the # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or # sell copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # #   The above copyright notice and this permission notice shall be included in #   all copies or substantial portions of the Software.  # # THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. # ----------------------------------------------------------------------------  # This Subversion post-commit hook script is meant to interface to the # Trac (http://www.edgewall.com/products/trac/) issue tracking/wiki/etc  # system. #  # It should be called from the 'post-commit' script in Subversion, such as # via: # # REPOS='$1' # REV='$2' # LOG=`/usr/bin/svnlook log -r $REV $REPOS` # AUTHOR=`/usr/bin/svnlook author -r $REV $REPOS` # TRAC_ENV='/somewhere/trac/project/' # TRAC_URL='http://trac.mysite.com/project/' # # /usr/bin/python /usr/local/src/trac/contrib/trac-post-commit-hook \ #  -p '$TRAC_ENV'  \ #  -r '$REV'       \ #  -u '$AUTHOR'    \ #  -m '$LOG'       \ #  -s '$TRAC_URL' # # It searches commit messages for text in the form of: #   command #1 #   command #1, #2 #   command #1 & #2  #   command #1 and #2 # # You can have more then one command in a message. The following commands # are supported. There is more then one spelling for each command, to make # this as user-friendly as possible. # #   closes, fixes #     The specified issue numbers are closed with the contents of this #     commit message being added to it.  #   references, refs, addresses, re  #     The specified issue numbers are left in their current status, but  #     the contents of this commit message are added to their notes.  # # A fairly complicated example of what you can do is with a commit message # of: # #    Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12. # # This will close #10 and #12, and add a note to #12.  import re import os import sys import time   from trac.env import open_environment from trac.ticket.notification import TicketNotifyEmail from trac.ticket import Ticket from trac.ticket.web_ui import TicketModule # TODO: move grouped_changelog_entries to model.py from trac.util.text import to_unicode from trac.web.href import Href  try:     from optparse import OptionParser except ImportError:     try:         from optik import OptionParser     except ImportError:         raise ImportError, 'Requires Python 2.3 or the Optik option parsing library.'  parser = OptionParser() parser.add_option('-e', '--require-envelope', dest='env', default='',                   help='Require commands to be enclosed in an envelope. If -e[], '                        'then commands must be in the form of [closes #4]. Must '                        'be two characters.') parser.add_option('-p', '--project', dest='project',                   help='Path to the Trac project.') parser.add_option('-r', '--revision', dest='rev',                   help='Repository revision number.') parser.add_option('-u', '--user', dest='user',                   help='The user who is responsible for this action') parser.add_option('-m', '--msg', dest='msg',                   help='The log message to search.') parser.add_option('-c', '--encoding', dest='encoding',                   help='The encoding used by the log message.') parser.add_option('-s', '--siteurl', dest='url',                   help='The base URL to the project\'s trac website (to which '                        '/ticket/## is appended).  If this is not specified, '                        'the project URL from trac.ini will be used.')  (options, args) = parser.parse_args(sys.argv[1:])  if options.env:     leftEnv = '\\' + options.env[0]     rghtEnv = '\\' + options.env[1] else:     leftEnv = ''     rghtEnv = ''  commandPattern = re.compile(leftEnv + r'(?P<action>[A-Za-z]*).?(?P<ticket>#[0-9]+(?:(?:[, &]*|[ ]?and[ ]?)#[0-9]+)*)' + rghtEnv) ticketPattern = re.compile(r'#([0-9]*)') versionPattern = re.compile(r'\(version[ ]+(?P<version>([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+))\)')  class CommitHook:     _supported_cmds = {'close':      '_cmdClose',                        'closed':     '_cmdClose',                        'closes':     '_cmdClose',                        'fix':        '_cmdClose',                        'fixed':      '_cmdClose',                        'fixes':      '_cmdClose',                        'addresses':  '_cmdRefs',                        're':         '_cmdRefs',                        'references': '_cmdRefs',                        'refs':       '_cmdRefs',                        'see':        '_cmdRefs'}      def __init__(self, project=options.project, author=options.user,                  rev=options.rev, msg=options.msg, url=options.url,                  encoding=options.encoding):         msg = to_unicode(msg, encoding)         self.author = author         self.rev = rev         self.msg = '(In [%s]) %s' % (rev, msg)         self.now = int(time.time())          self.env = open_environment(project)         if url is None:             url = self.env.config.get('project', 'url')         self.env.href = Href(url)         self.env.abs_href = Href(url)          cmdGroups = commandPattern.findall(msg)           tickets = {}          for cmd, tkts in cmdGroups:             funcname = CommitHook._supported_cmds.get(cmd.lower(), '')              if funcname:                  for tkt_id in ticketPattern.findall(tkts):                     func = getattr(self, funcname)                     tickets.setdefault(tkt_id, []).append(func)          for tkt_id, cmds in tickets.iteritems():             try:                 db = self.env.get_db_cnx()                  ticket = Ticket(self.env, int(tkt_id), db)                 for cmd in cmds:                     cmd(ticket)                  # determine sequence number...                  cnum = 0                 tm = TicketModule(self.env)                 for change in tm.grouped_changelog_entries(ticket, db):                     if change['permanent']:                         cnum += 1                  # get the version number from the checkin... and update the ticket with it.                 version = versionPattern.search(msg)                 if version != None and version.group('version') != None:                     ticket['fixed_in_ver'] = version.group('version')                  ticket.save_changes(self.author, self.msg, self.now, db, cnum+1)                 db.commit()                  tn = TicketNotifyEmail(self.env)                 tn.notify(ticket, newticket=0, modtime=self.now)             except Exception, e:                 # import traceback                 # traceback.print_exc(file=sys.stderr)                 print>>sys.stderr, 'Unexpected error while processing ticket ' \                                    'ID %s: %s' % (tkt_id, e)       def _cmdClose(self, ticket):         ticket['status'] = 'closed'         ticket['resolution'] = 'fixed'      def _cmdRefs(self, ticket):         pass   if __name__ == '__main__':     if len(sys.argv) < 5:         print 'For usage: %s --help' % (sys.argv[0])     else:         CommitHook()