In my local development environment at home I use The Bug Genie 2 for bugtracking. The tool is quiet cool, although the german translation is totally broken (I fixed it and send it to them, let's see what happens). It comes with a module called "svn_integration" for integrating SVN into the tracker to automatically have updated issues when the SVN comments contain special keywords. That's quiet cool, too, but unfortunatly does not work for me.
I'm using Windows Vista Business x64 as os and for SVN the wonderful, free and easy VisualSVN Server. Next ugly thing on The Bug Genie is that there is no documentation for the modules. I found an entry in the forums how to use the integration in windows, but that did not work out of the box. But the code is already within the module, what is good.
So open modules/svn_integration/post_commit.phpfrom your buggenie installation directory and adjust this line with your path to the bugtracker installation dir:
Then create a batch file in the same directory called post-commit.bat. You can see the source below, copy it and adjust the following variables. I used the code from the forum post and adjusted it a little. Remember that urls with whitespaces do not work, create a symlink or rename your directories:
- Path to svnlook.exe (you see my VisualSVN Server resides in D:\VisualSVN_Server, the default location C:\Program Files (x86)\VisualSVN Server does not work because of the whitespaces) VisualSVN Server has all the svn tools in its bin directory.
- The path to your php executable. I used XAMPP, so it is in D:\xampp\php\php.exe if installed in root on drive D.
- The path to your SVN directory. This is where svn stores its data.
- The post-commit hook we create later takes two arguments from VisualSVN Server, the path and the revision. Unfortunatly VisualSVN Server uses the url as path which collides with the svnlook command we use to determine if a bug was mentioned in a revision comment, as svnlook wants the real file path.
So we have to adjust the url to a path. As there is no real substring functionality for windows batch (or I did not search long enough) we simply count the length of our SVN url. In my case VisualSVN Server listens at https://amanda:8443/svn/, so a repository would be at https://amanda:8443/svn/my_repos. The server root (https://amanda:8443/svn/)has a length length of 24. Change the 24 to the length of your url. The batch then combines the SVN_PATH and your repository path to the local path, D:\svn\myrepos in my case here.
- Once again, set the path to your installation directory of the bugtracker (replace D:\xampp\htdocs\bugs with your path):
%PHP% -f "D:\xampp\htdocs\bugs\modules\svn_integration\post-commit.php" "%AUTHOR%" "%REV%" "%COMMIT_MSG%" "%CHANGED%"
After your saved the file, open VisualSVN Server and the properties of your repository. Select the the Hooks tab and doubleclick the Post-commit hook. Enter the path to the batch file with the 2 arguments path and revision, in my case I entered "D:\xampp\htdocs\bugs\modules\svn_integration\post-commit.bat %1 %2", where %1 is the repository path and %2 the revision number.
Finally you have to install either WebSVN (which I prefer) or ViewVC and specify the path to your repository (in my case it is http://localhost/websvn/listing.php?repname=my_repos&) in The Bug Genie module settings for svn_integration.
One final and important hint: your user in the bugtracker has to have the same username as in SVN. By default, the first user in the tracker has the username "Administrator". My SVN user does not have the name "Administrator", so I logged out of the tracker, changed the property "uname" of the MySQL table "bugs2_users" for the admin to my SVN username, logged in and then everything worked fine.
As always, feel free to add comments and spread the word
And here the post-commit.bat code:
@echo off SET REV=%2 SET REPOS=%1 REM path to svnlook (remember that paths with whitespace do not work e.g. C:\Program Files --> use mklink to create a path without) SET SVNLOOK=D:\VisualSVN_Server\bin\svnlook.exe REM path to php executable SET PHP=D:\xampp\php\php.exe REM path to svn (not url!) SET SVN_PATH=D:\svn REM maps the svn url to the svn path - straightforward but the easiest way REM replace with the length of your svn url e.g. 24 for https://amanda:8443/svn/ SET REPOS=%REPOS:~24% SET REPOS=%SVN_PATH%%REPOS:/=\% %SVNLOOK% log -r %REV% "%REPOS%" > COMMIT_MSG REM SET THE COMMIT_MSG FROM THE FILE. The file is expected to contain only one line with this value FOR /F "delims=" %%A IN (COMMIT_MSG) DO SET COMMIT_MSG=%%A echo COMMIT_MSG=%COMMIT_MSG% %SVNLOOK% changed -r %REV% "%REPOS%" > CHANGED REM SET THE CHANGED FROM THE FILE. The file is expected to contain only one line with this value FOR /F %%A IN (CHANGED) DO SET CHANGED=%%A echo COMMIT_MSG=%CHANGED% %SVNLOOK% author -r %REV% "%REPOS%" > AUTHOR REM SET THE AUTHOR FROM THE FILE. The file is expected to contain only one line with this value FOR /F %%A IN (AUTHOR) DO SET AUTHOR=%%A echo COMMIT_MSG=%AUTHOR% %PHP% -r "echo urlencode($argv);" "%COMMIT_MSG%" > URL_COMMIT_MSG REM SET THE URL_COMMIT_MSG FROM THE FILE. The file is expected to contain only one line with this value FOR /F %%A IN (URL_COMMIT_MSG) DO SET URL_COMMIT_MSG=%%A echo COMMIT_MSG=%URL_COMMIT_MSG% %PHP% -f "D:\xampp\htdocs\bugs\modules\svn_integration\post-commit.php" "%AUTHOR%" "%REV%" "%COMMIT_MSG%" "%CHANGED%"