如何使用Trac& amp;来实现Post Commit Hook Windows环境中的SVN?

时间:2008-09-17 15:01:46

标签: windows svn hook trac

我在使用Trac / SVN的Windows环境中运行,我希望提交到存储库以集成到Trac并关闭SVN Comment中记录的错误。

我知道有一些帖子提交挂钩可以做到这一点,但是关于如何在Windows上执行此操作的信息并不多。

有人成功完成了吗?你实现了它的步骤是什么?

这是我需要在SVN中使用的钩子,但我不确定如何在Windows环境中执行此操作。

Trac Post Commit Hook

6 个答案:

答案 0 :(得分:4)

Benjamin的答案很接近,但在Windows上,您需要为钩子脚本文件提供可执行的扩展名,例如.bat或.cmd。我用.cmd。您可以使用模板脚本,它们是unix shell脚本,shell脚本并将它们转换为.bat / .cmd语法。

但是要回答与Trac集成的问题,请按照以下步骤操作。

  1. 确保Python.exe位于系统路径上。这将使您的生活更轻松。

  2. 在\ hooks文件夹中创建post-commit.cmd。这是Subversion将在提交后事件上执行的实际钩子脚本。

    @ECHO OFF
    
    :: POST-COMMIT HOOK
    ::
    :: The post-commit hook is invoked after a commit.  Subversion runs
    :: this hook by invoking a program (script, executable, binary, etc.)
    :: named 'post-commit' (for which this file is a template) with the 
    :: following ordered arguments:
    ::
    ::   [1] REPOS-PATH   (the path to this repository)
    ::   [2] REV          (the number of the revision just committed)
    ::
    :: The default working directory for the invocation is undefined, so
    :: the program should set one explicitly if it cares.
    ::
    :: Because the commit has already completed and cannot be undone,
    :: the exit code of the hook program is ignored.  The hook program
    :: can use the 'svnlook' utility to help it examine the
    :: newly-committed tree.
    ::
    :: On a Unix system, the normal procedure is to have 'post-commit'
    :: invoke other programs to do the real work, though it may do the
    :: work itself too.
    ::
    :: Note that 'post-commit' must be executable by the user(s) who will
    :: invoke it (typically the user httpd runs as), and that user must
    :: have filesystem-level permission to access the repository.
    ::
    :: On a Windows system, you should name the hook program
    :: 'post-commit.bat' or 'post-commit.exe',
    :: but the basic idea is the same.
    :: 
    :: The hook program typically does not inherit the environment of
    :: its parent process.  For example, a common problem is for the
    :: PATH environment variable to not be set to its usual value, so
    :: that subprograms fail to launch unless invoked via absolute path.
    :: If you're having unexpected problems with a hook program, the
    :: culprit may be unusual (or missing) environment variables.
    :: 
    :: Here is an example hook script, for a Unix /bin/sh interpreter.
    :: For more examples and pre-written hooks, see those in
    :: the Subversion repository at
    :: http://svn.collab.net/repos/svn/trunk/tools/hook-scripts/ and
    :: http://svn.collab.net/repos/svn/trunk/contrib/hook-scripts/
    
    setlocal
    
    :: Debugging setup
    :: 1. Make a copy of this file.
    :: 2. Enable the command below to call the copied file.
    :: 3. Remove all other commands
    ::call %~dp0post-commit-run.cmd %* > %1/hooks/post-commit.log 2>&1
    
    :: Call Trac post-commit hook
    call %~dp0trac-post-commit.cmd %* || exit 1
    
    endlocal
    
  3. 在\ hooks文件夹中创建trac-post-commit.cmd:

    @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
    
    setlocal
    
    :: ----------------------------------------------------------
    :: Modify paths here:
    
    :: -- this one *must* be set
    SET TRAC_ENV=D:\projects\trac\membershipdnn
    
    :: -- 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
    
    :: Resolve ticket references (fixes, closes, refs, etc.)
    Python "%~dp0trac-post-commit-resolve-ticket-ref.py" -p "%TRAC_ENV%" -r "%REV%"
    
    endlocal
    
  4. 在\ hooks文件夹中创建trac-post-commit-resolve-ticket-ref.py。我使用the same script from EdgeWall,只是我重命名它以更好地阐明其目的。

答案 1 :(得分:3)

好吧,现在我已经有了一些时间来发布我的经验,并且感谢Craig让我走上正轨。这是你需要做的事情(至少对于SVN v1.4和Trac v0.10.3):

  1. 找到要为其启用Post Commit Hook的SVN存储库。
  2. 在SVN存储库中有一个名为hooks的目录,这是你将放置post commit hook的地方。
  3. 创建一个文件post-commit.bat(这是SVN提交后自动调用的批处理文件)。
  4. 将以下代码放在post-commit.bat文件中(这将调用你的post commit cmd文件,传入SVN自动传递的参数%1是存储库,%2是已提交的修订版。
  5. %~dp0 \ trac-post-commit-hook.cmd%1%2

    1. 现在创建trac-post-commit-hook.cmd文件,如下所示:
    2.   

      @ECHO OFF
      :: :: :: Trac   post-commit-hook脚本   Windows
      ::
      ::供稿人:   markus,由cboos修改。


      ::   用法:
      ::
      :: 1)插入   post-commit.bat中的以下行   脚本
      ::
      :: call   %~dp0 \ trac-post-commit-hook.cmd%1   %2
      ::
      :: 2)选中'修改   下面的路径部分,一定要设置   至少TRAC_ENV


      ::   -------------------------------------------------- --------
      ::修改路径:

      :: -   这个必须设置为SET   TRAC_ENV = C:\ TRAC \ MySpecialProject
        
      :: - 如果Python不在,则设置   系统路径
      :: SET   PYTHON_PATH =

      :: :: - 设置为   包含trac / if的文件夹   在非标准位置
      :: SET   TRAC_PATH =
      ::   -------------------------------------------------- --------

      ::如果是trac,不要执行hook   环境不存在如果不是   EXIST%TRAC_ENV%GOTO:EOF

        设置PATH =%PYTHON_PATH%;%PATH%
      设置   PYTHONPATH =%TRAC_PATH%;%PYTHONPATH%
        
      SET REV =%2

      ::得到   作者和日志消息
      为/ F.   %% A in('svnlook author -r%REV %% 1')   为/ F设置AUTHOR = %% A
        “delims ==”%% B in('svnlook log -r   %REV %% 1')设置LOG = %% B

        打电话给PYTHON SCRIPT
      Python   “%~dp0 \ trac-post-commit-hook”-p   “%TRAC_ENV%” - r“%REV%” - u“%AUTHOR%”   -m“%LOG%”

      这里最重要的部分是设置TRAC_ENV,它是存储库根目录的路径(SET TRAC_ENV = C:\ trac \ MySpecialProject)

      本脚本中的下一个非常重要的事情是执行以下操作:

        

      ::获取作者和日志   消息
      for / F %% A in('svnlook   作者-r%REV %% 1')做了设置   AUTHOR = %% A
      for / F“delims ==”%% B   在('svnlook log -r%REV %% 1')中设置   LOG = %%乙

      如果你在上面的脚本文件中看到我正在使用svnlook(这是一个带有SVN的命令行实用程序)来获取LOG消息和提交到存储库的作者。

      然后,脚本的下一行实际上是调用Python代码来执行票证的关闭并解析日志消息。我不得不修改它来传递Log消息和作者(我在Trac中使用的用户名与SVN中的用户名匹配,这很容易)。

        

      打电话给PYTHON SCRIPT
      Python   “%~dp0 \ trac-post-commit-hook”-p   “%TRAC_ENV%” - r“%REV%” - u“%AUTHOR%”   -m“%LOG%”

      脚本中的上述行将传递给Trac环境,修订版,提交者及其评论的python脚本。

      这是我使用的Python脚本。我对常规脚本做的另一件事是我们使用自定义字段(fixed_in_ver),我们的QA团队使用它来判断他们正在验证的修复是否在他们在QA中测试的代码版本中。因此,我修改了python脚本中的代码以更新故障单上的该字段。您可以删除该代码,因为您不需要它,但它是一个很好的示例,如果您还想这样做,可以在Trac中更新自定义字段。

      我通过让用户选择在评论中包含以下内容来实现这一点:

        

      (版本2.1.2223.0)

      然后我使用python脚本与正则表达式一起使用的相同技术来获取信息。这不是太糟糕。

      无论如何,这是我使用的python脚本,希望这是一个很好的教程,正是我为了让它在windows世界中工作所做的一切,所以你们都可以在你自己的商店中利用它...

      如果您不想处理我更新自定义字段的其他代码,请从上面的Craig(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()
      

答案 2 :(得分:0)

在“hooks”目录中存在提交后挂钩,其中存储库位于服务器端。我不知道你的环境在哪里,所以这只是一个例子

e.g。 (视窗):

C:\Subversion\repositories\repo1\hooks\post-commit

e.g。 (llinux / UNIX):

/usr/local/subversion/repositories/repo1/hooks/post-commit

答案 3 :(得分:0)

有一件事我会添加“Code Monkey的答案是完美的” - 是要警惕(我的错误)

:: Modify paths here:

:: -- this one must be set
SET TRAC_ENV=d:\trac\MySpecialProject

:: -- set if Python is not in the system path
:: SET PYTHON_PATH=**d:\python**

:: -- set to the folder containing trac/ if installed in a non-standard location 
:: SET TRAC_PATH=**d:\python\Lib\site-packages\trac**

我没有设置非系统路径并花了一些时间才看到明显的:D

确定没有其他人犯同样的错误!谢谢Code Monkey! 1000000000点:D

答案 4 :(得分:0)

首先非常感谢Code Monkey!

但是,根据您的trac版本获取正确的python脚本非常重要。要获得适当的版本,SVN请查看文件夹:

http://svn.edgewall.com/repos/trac/branches/ XXX -stable /了contrib

其中 xxx 对应于您正在使用的trac版本,例如:0.11

否则,您将收到如下所示的提交后错误:

提交失败(详情如下):'/ svn / project / trunk / web / directory /'的MERGE:200 OK

答案 5 :(得分:0)

对于想要安装最新trac(0.11.5)的所有Windows用户: 按照Trac网站上名为TracOnWindows的说明进行操作。

即使您拥有64位Windows,也可下载32位1.5 Python。    注意:我在某处找到了如何编译trac以在64位系统上本地工作的说明。

当您安装所需的全部内容时,请转到存储库文件夹。有文件夹钩子。 在里面放了Code Monkey提到的文件,但是不要像他那样创建“trac-post-commit-resolve-ticket-ref.py”。从Quant Analyst那里得到建议,就像他说的那样:

“但是,根据您的trac版本获取正确的python脚本非常重要。要获得适当的版本,SVN请查看该文件夹: http://svn.edgewall.com/repos/trac/branches/ XXX-稳定/ contrib请 其中xxx对应于您正在使用的trac版本,例如:0.11“

从那里下载文件“trac-post-commit-hook”并将其放在hooks文件夹中。

在trac-post-commit.cmd中编辑这些行

  

SET PYTHON_PATH =“python安装文件夹的路径”

     

SET TRAC_ENV =“您所在文件夹的路径   做了tracd initenv“

记住没有最后的\ !!!

我已将最后一行-r“%REV%”的引号删除为-r%REV%,但我不知道是否需要这样做。现在这不起作用(至少在我的win 2008服务器上),因为hook会失败(提交就行了)。这与权限有关。默认情况下,权限受到限制,我们需要允许python或svn或trac(我不知道)改变trac信息。所以转到你的trac文件夹,项目文件夹,db文件夹,右键单击trac.db并选择属性。转到安全选项卡并编辑权限以允许每个人完全控制。这不是那么安全,但我整天浪费在这个安全问题上,我不想浪费另一个只是为了找到你应该启用权限的用户。

希望这会有所帮助......