如何在 Windows 环境中使用 Trac 和 SVN 实现 Post Commit Hook?
题
我在带有 Trac / SVN 的 Windows 环境中运行,我希望提交到存储库以集成到 Trac 并关闭 SVN 注释中指出的错误。
我知道有一些提交后挂钩可以做到这一点,但关于如何在 Windows 上执行此操作的信息不多。
有谁做过成功的吗?为了实现这一目标,您采取了哪些步骤?
这是我需要在 SVN 中放置的钩子,但我不太确定如何在 Windows 环境中执行此操作。
解决方案 2
好吧,现在我有时间在弄清楚这一切后发布我的经验,并感谢克雷格让我走上正确的轨道。以下是您需要执行的操作(至少对于 SVN v1.4 和 Trac v0.10.3):
- 找到您想要启用提交后挂钩的 SVN 存储库。
- 在 SVN 存储库内有一个名为 hooks 的目录,您将在其中放置提交后挂钩。
- 创建一个文件 post-commit.bat (这是 SVN 提交后自动调用的批处理文件)。
- 将以下代码放入 post-commit.bat 文件中(这将调用您的提交后 cmd 文件,并传入 SVN 自动传递的参数,%1 是存储库,%2 是已提交的修订版。
%~dp0 rac-post-commit-hook.cmd %1 %2
- 现在创建 trac-post-commit-hook.cmd 文件,如下所示:
@回声关闭
::
::Windows的TRAC邮递脚本
::
::由马库斯(Markus)贡献,由CBoos修改。
::用法:
::
::1)在您的commit.bat脚本中插入以下行
::
::致电%〜DP0 TRAC-POST-COMMIT-HOK.CMD%1%2
::
::2)检查下面的“修改路径”部分,请确保至少设置TRAC_ENV
:: ----------------------------------------------------------
::此处修改路径:
::- 这个 必须 被设置
设置trac_env = c: trac myspecialproject
::- 设置如果Python不在系统路径中
::设置python_path =
::- 设置为包含TRAC/的文件夹/如果安装在非标准位置
::设置trac_path =
:: ----------------------------------------------------------
::如果不存在TRAC环境,请勿执行挂钩
如果不存在%trac_env%goto:eof
设置路径=%PYTHON_PATH%;%PATH%
设置pythonpath =%trac_path%;%pythonpath%
设置转速=%2
::获取作者和日志消息
for /f %% a in('svnlook作者-r%rev%1')do seet witer = %% a
for /f“ delims ==” %% b in('svnlook log -r%rev%1')确实设置log = %% b
::调用 Python 脚本
Python“%〜DP0 TRAC -POST -COMMIT -HOK” -P“%TRAC_ENV%” -R“%Rev%” -U“ -U”%fureter%“ -m”%log%“”
这里最重要的部分是设置 TRAC_ENV,它是存储库根目录的路径 (SET TRAC_ENV=C: rac\MySpecialProject)
此脚本中的下一个非常重要的事情是执行以下操作:
::获取作者和日志消息
for /f %% a in('svnlook作者-r%rev%1')do seet witer = %% a
for /f“ delims ==” %% b in('svnlook log -r%rev%1')确实设置log = %% b
如果您在上面的脚本文件中看到我正在使用 svnlook(这是 SVN 的命令行实用程序)来获取 LOG 消息以及提交到存储库的作者。
然后,脚本的下一行实际上是调用 Python 代码来执行票证关闭并解析日志消息。我必须修改它以传递日志消息和作者(我在 Trac 中使用的用户名与 SVN 中的用户名匹配,所以这很容易)。
调用 Python 脚本
Python“%〜DP0 TRAC -POST -COMMIT -HOK” -P“%TRAC_ENV%” -R“%Rev%” -U“ -U”%fureter%“ -m”%log%“”
脚本中的上述行将把 Trac 环境、修订版本、提交者及其评论传递到 python 脚本中。
这是我使用的 Python 脚本。除了常规脚本之外,我做的一件事是我们使用自定义字段 (fixed_in_ver),我们的 QA 团队使用该字段来判断他们正在验证的修复是否位于他们在 QA 中测试的代码版本中。因此,我修改了 python 脚本中的代码来更新票证上的该字段。您可以删除该代码,因为您不需要它,但它是一个很好的示例,说明您可以在 Trac 中更新自定义字段(如果您也想这样做)。
我通过让用户选择在他们的评论中包含类似以下内容来做到这一点:
(版本2.1.2223.0)
然后,我使用 Python 脚本与正则表达式相同的技术来获取信息。还不错。
无论如何,这是我使用的 python 脚本,希望这是一个很好的教程,讲述了我如何让它在 Windows 世界中工作,这样你们都可以在自己的商店中利用它......
如果您不想处理我用于更新自定义字段的附加代码,请从此位置获取基本脚本,如上面 Craig 提到的(来自 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()
其他提示
本杰明的答案很接近,但在 Windows 上,您需要为挂钩脚本文件提供可执行扩展名,例如 .bat 或 .cmd。我使用.cmd。您可以采用模板脚本(unix shell 脚本、shell 脚本)并将它们转换为 .bat/.cmd 语法。
但要回答与 Trac 集成的问题,请按照以下步骤操作。
确保 Python.exe 位于系统路径上。这将使您的生活更轻松。
在 \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
在 \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
在 \hooks 文件夹中创建 trac-post-commit-resolve-ticket-ref.py。我用了 EdgeWall 中的相同脚本, ,只是我将其重命名以更好地阐明其目的。
提交后挂钩位于服务器端存储库所在的“hooks”目录中。我不知道你的环境中哪里有它们,所以这只是一个例子
例如(视窗):
C:\Subversion\repositories\repo1\hooks\post-commit
例如(llinux/unix):
/usr/local/subversion/repositories/repo1/hooks/post-commit
我要添加的一件事是“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
只要匹配,确保没有其他人犯同样的错误!感谢代码猴子!1000000000 点 :D
首先非常感谢Code Monkey!
但是,根据您的 trac 版本获取正确的 python 脚本非常重要。要获取适当的版本,SVN 检查文件夹:
http://svn.edgewall.com/repos/trac/branches/xxx-稳定/贡献
在哪里 xxx 对应于您正在使用的 trac 版本,例如:0.11
否则,您将收到如下所示的提交后错误:
提交失败(详细信息如下):合并“/svn/project/trunk/web/directory/”:200 好
对于所有想要安装最新 trac (0.11.5) 的 Windows 用户:按照名为 TracOnWindows 的 Trac 网站上的说明进行操作。
即使您有 64 位 Windows,也请下载 32 位 1.5 Python。笔记:我在某处看到了如何编译 trac 以在 64 位系统上本地工作的说明。
当您安装所需的所有内容时,请转到存储库文件夹。有文件夹挂钩。里面放了 Code Monkey 提到的文件,但不要像他那样创建“trac-post-commit-resolve-ticket-ref.py”。听取量化分析师的建议并按照他说的去做:
“但是,根据您的 trac 版本获取正确的 python 脚本非常重要。要获取适当的版本,SVN 检查文件夹:http://svn.edgewall.com/repos/trac/branches/xxx stable/conter xxx对应于您正在使用的TRAC版本,例如:0.11"
从那里下载文件“trac-post-commit-hook”并将其放入 hooks 文件夹中。
在 trac-post-commit.cmd 中编辑这些行
SET PYTHON_PATH="python 安装文件夹的路径"
设置TRAC_ENV =“通往文件夹的路径,您在哪里进行tracD启动”
切记不要最后\!!!
我已将最后一行 -r "%REV%" 中的引号删除为 -r %REV% 但我不知道是否需要这样做。这现在不起作用(至少在我的 win 2008 服务器上),因为钩子将失败(提交将正常)。这与权限有关。默认情况下,权限受到限制,我们需要允许 python 或 svn 或 trac (无论我不知道什么)更改 trac 信息。因此,转到 trac 文件夹、项目文件夹、db 文件夹,右键单击 trac.db 并选择属性。转到安全选项卡并编辑权限以允许每个人完全控制。这不是那么安全,但我在这个安全问题上浪费了一整天,我不想浪费另一天只是为了找到应该为哪个用户启用权限。
希望这可以帮助....