Как реализовать крюк фиксации Post с Trac & SVN в среде Windows?

Я работаю в среде windows с Trac / SVN, и я хочу, чтобы фиксации в репозитории интегрировались в Trac и закрывали ошибки, которые были отмечены в комментарии SVN.

Я знаю, что для этого есть несколько крючков фиксации сообщений, но нет большой информации о том, как это сделать в windows.

кто-нибудь делал это успешно? И какие шаги Вы предприняли, чтобы достичь этого?

вот крюк, который мне нужно поставить на место в SVN, но я не совсем уверен как это сделать в среде Windows.

Trac Post Commit Hook

6 ответов


ответ Бенджамина близок, но в Windows вам нужно дать файлам скриптов hook исполняемое расширение, такое как .летучая мышь или. УМК. Я использую .УМК. Вы можете взять сценарии шаблонов, которые являются сценариями оболочки unix, сценариями оболочки и преобразовать их.летучая мышь./синтаксис УМК.

но чтобы ответить на вопрос об интеграции с Trac, выполните следующие действия.

  1. убедитесь, что Python.exe находится на системном пути. Это сделает твою жизнь лучше. облегчающий.

  2. создать post-commit.cmd в папке \hooks. Это фактический сценарий крючка, который 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. создать trac-post-commit.cmd в папке \hooks:

    @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. создать trac-post-commit-resolve-ticket-ref.py в папке \hooks. Я использовал тот же сценарий от EdgeWall, только я переименовал его, чтобы лучше прояснить свою цель.


хорошо, теперь, когда у меня есть некоторое время, чтобы опубликовать мой опыт после выяснения всего этого, и спасибо Крейгу за то, что я на правильном пути. Вот что вам нужно сделать (по крайней мере, с SVN v1.4 и Trac v0.10.3):

  1. найдите репозиторий SVN, для которого вы хотите включить крюк фиксации Post.
  2. внутри репозитория SVN есть каталог под названием hooks, здесь вы будете размещать крюк фиксации post.
  3. создать файл после фиксации.bat (это пакетный файл, который автоматически вызывается SVN post commit).
  4. поместите следующий код внутри post-commit.файл bat (это вызовет передачу файла post commit cmd в параметрах, которые SVN автоматически передает %1-это репозиторий, %2-это зафиксированная версия.

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

  1. Теперь создайте Trac-post-commit-hook.cmd-файл следующего содержания:

@ECHO OFF
::
:: Trac сценарий post-commit-hook для Окна
::
:: вклад Маркус, модифицированный cboos.

:: Использование:
::
:: 1) вставить следующая строка в вашем post-commit.летучая мышь скрипт
::
:: звоните %~dp0\trac-post-commit-hook.cmd %1 %2
::
:: 2) Проверьте ' изменить раздел путей ниже, обязательно установите по крайней мере TRAC_ENV


:: ----------------------------------------------------------
:: изменения маршрутов:

:: -- вот этот!--39-->должны устанавливается
установить TRAC_ENV=C:\trac\MySpecialProject

:: -- установить, если Python не в системный путь
:: набор PYTHON_PATH=

:: -- установить папка, содержащая trac/ if установлена в нестандартном месте
:: набор TRAC_PATH=
:: ----------------------------------------------------------

:: не выполнять крючок, если trac окружающая среда не существует
ЕСЛИ НЕТ EXIST %TRAC_ENV% GOTO: EOF

set PATH=%PYTHON_PATH%;%PATH%
установить PYTHONPATH=%TRAC_PATH%;%PYTHONPATH%

УСТАНОВИТЬ REV=%2

:: ПОЛУЧИТЬ АВТОР И СООБЩЕНИЕ ЖУРНАЛА
для /F %%A in ('svnlook author-r %REV% %1') установить AUTHOR=%%a
для /F "delims==" %%B in ('svnlook log -р %REV% %1') Установите LOG=%%B

:: ВЫЗОВИТЕ СКРИПТ PYTHON
Python "%~dp0\trac-post-commit-hook" - p "%TRAC_ENV% "- r "%REV% "- u " %автор%" - m " %LOG%"

наиболее важные части здесь-установить TRAC_ENV, который является путем к корню репозитория (установить TRAC_ENV=C:\trac\MySpecialProject)

следующая чрезвычайно важная вещь в этом скрипте-сделать следующее:

:: ПОЛУЧИТЬ АВТОРА И БРЕВНО Сообщение
for / F %%A in ('svnlook автор-r %REV% %1') установить AUTHOR=%%A
для / F "delims==" %%B в ('svnlook log-r %REV% %1') Установите LOG=%%B

Если вы видите в файле сценария выше, я использую svnlook (который является утилитой командной строки с SVN), чтобы получить сообщение журнала и автора, который сделал фиксацию в репозитории.

затем следующая строка скрипта фактически вызывает код Python для выполнения закрытия билеты и разбор сообщения журнала. Мне пришлось изменить это, чтобы передать сообщение журнала и автора (имена пользователей, которые я использую в Trac, соответствуют именам пользователей в SVN, так что это было легко).

ВЫЗОВИТЕ СКРИПТ PYTHON
Python "%~dp0\trac-post-commit-hook" - p "%TRAC_ENV% "- r "%REV% "- u " %автор%" - m " %LOG%"

вышеуказанная строка в скрипте передаст в скрипт python среду Trac, ревизию, человека, который сделал совершают, и их комментарий.

вот скрипт Python, который я использовал. Одна вещь, которую я сделал дополнительно к обычному скрипту, - мы используем настраиваемое поле (fixed_in_ver), которое используется нашей командой QA, чтобы сказать, является ли исправление, которое они проверяют, в версии кода, которую они тестируют в QA. Итак, я изменил код в скрипте python, чтобы обновить это поле в билете. Вы можете удалить этот код, поскольку он вам не понадобится, но это хороший пример того, что вы можете сделать для обновления пользовательских полей в Trac, если вы тоже хотите это сделать.

Я сделал это, попросив пользователей дополнительно включить в свой комментарий что-то вроде:

(версия 2.1.2223.0)

затем я использую тот же метод, который скрипт python использует с регулярными выражениями для получения информации. Все было не так уж плохо.

в любом случае, вот скрипт python, который я использовал, надеюсь, это хороший учебник о том, что я сделал, чтобы заставить его работать в мире windows, так что вы можете использовать это в вашем собственном магазине...

Если вы не хотите иметь дело с моим дополнительным кодом для обновления настраиваемого поля, получите базовый скрипт из этого места, как упоминалось Крейгом выше (Скрипт От 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=""
# REV=""
# 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()

Post commit hooks живут в каталоге "hooks", где когда-либо у вас есть репозиторий, живущий на стороне сервера. Я не знаю, где они у вас есть в вашей среде, так что это просто пример

например (windows):

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

например (llinux / unix):

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

одна вещь, которую я добавлю: "ответ обезьяны кода идеален" - это опасаться этого (моя ошибка)

:: 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!

однако важно получить правильный скрипт python в зависимости от вашей версии trac. Чтобы получить соответствующую версию, SVN проверьте папку:

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

здесь xxx соответствует используемой версии trac, например: 0.11

в противном случае вы получите ошибку post-commit, которая выглядит вот так:

ошибка фиксации (подробности следуют): слияние ' / svn / project / trunk/web / directory/': 200 OK


для всех пользователей Windows, которые хотят установить новейший trac (0.11.5): Следуйте инструкциям на сайте Trac с именем TracOnWindows.

загрузите 32bit 1.5 Python, даже если у вас есть 64bit Windows. примечание. Я где-то видел инструкции по компиляции trac для работы в 64-битной системе.

когда вы устанавливаете все, что требуется, перейдите в папку репозитория. Есть крючки папку. Внутри него помещены файлы с кодом Monkey, но не создавайте "trac-post-commit-resolve-ticket-ref.py-как и он. Примите совет от Quant Analyst и сделайте, как он сказал:

" однако важно получить правильный скрипт python в зависимости от вашей версии trac. Чтобы получить соответствующую версию, 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= " путь к папке, в которой вы сделал initenv tracd"

помните, не последний !!!

Я удалил кавычки из последней строки-r " %REV%", чтобы быть-r %REV%, но я не знаю, нужно ли это. Это не будет работать сейчас ( по крайней мере, на моем сервере win 2008), потому что hook потерпит неудачу ( commit пойдет ОК). Это связано с разрешениями. По умолчанию разрешения ограничены, и нам нужно разрешить python или svn или trac (все, что я не знаю ) изменять информацию trac. Поэтому перейдите в папку trac, папку проекта, папку db, щелкните правой кнопкой мыши trac.дБ и выберите Свойства. Перейти на вкладку Безопасность и измените разрешения, чтобы разрешить всем полный контроль. Это не так безопасно, но я потратил весь день на этот вопрос безопасности, и я не хочу тратить еще один, чтобы найти, для какого пользователя вы должны включить разрешения.

надеюсь, что это помогает....