使用python编写svn钩子

同上一篇trac中安装插件的文章的出发点一样，感觉用文档和口头制定规则在执行上会有偏差并且需要经常引导新人去熟悉规则。

所以，又费了几个小时去琢磨怎么改进svn提交代码的钩子，现有的钩子的功能比较简单，只是验证提交时的日志字数有没有超过5个，而我想将其改进为验证是不是符合“问题修复：#1234 xxxx”的这种格式，这里处理的是 版本库/hooks/pre-commit.bat  这个钩子。

话不多说，svn钩子原理和规则不表，先上原钩子代码：


@echo off
rem SVN强制写注释的hooks脚本(Windows)
rem 文件名是: pre-commit.bat,放到repository/hooks目录下
setlocal
set SVN_BINDIR=”D:\service\Subversion\bin”
set REPOS=%1
set TXN=%2
rem check that logmessage contains at least 10 characters
%SVN_BINDIR%\svnlook log “%REPOS%” -t “%TXN%” | findstr “……” > nul
if %errorlevel% gtr 0 goto err
exit 0
:err
echo 提交时必须填写说明(Message)! 1>&2
echo “%REPOS%” -t “%TXN%” 1>&2
exit 1

一开始尝试使用直接修改bat，改进findstr来支持更复杂的正则表达式，但是遇到各种问题。

  1. 首先是不太熟悉批处理的各种规则。
  2. 然后有些特殊字符在命令行上的不能使用。
  3. 再者就是使用在线工具验证过的正则表达式findstr匹配失败。

在测试过程中保留了下面这个奇葩的中间版本(不能正常工作的)。



 1 @echo off
 2 rem SVN强制写注释的hooks脚本(Windows)
 3 rem 文件名是: pre-commit.bat,放到repository/hooks目录下
 4 setlocal
 5 set SVN_BINDIR=C:\Program Files\TortoiseSVN\bin
 6 set REPOS=%1
 7 set TXN=%2
 8
 9 rem check that logmessage contains at least 10 characters
10 “%SVN_BINDIR%\svnlook” log “%REPOS%” -t “%TXN%” > t.log
11
12 :set disable=:;’^<^>,。‘【】｛｝？?《》
13 rem (#[0-9]+ )?[^#  允许带或不带ticket号开头，不支持非中文符号
14
15 findstr “^问题修复：(#[0-9]+ )…” t.log
16 @echo %errorlevel% 1>&2
17 if not %errorlevel% gtr 0 goto success
18 findstr “^功能开发：(#[0-9]+ )[^#%disable%]$” t.log > nul
19 if not %errorlevel% gtr 0 goto success
20 findstr “^功能改进：(#[0-9]+ )[^#%disable%]$” t.log > nul
21 if not %errorlevel% gtr 0 goto success
22 findstr “^功能优化：(#[0-9]+ )[^#%disable%]$” t.log > nul
23 if not %errorlevel% gtr 0 goto success
24 findstr “^代码优化：(#[0-9]+ )[^#%disable%]$” t.log > nul
25 if not %errorlevel% gtr 0 goto success
26
27 :err
28 echo 未遵循svn提交规范 1>&2
29 :echo “%REPOS%” -t “%TXN%” 1>&2
30 :rm t.log
31 exit 1
32
33 :success
34 :rm t.log
35 exit 1


不成功的中间版本

可以看到，我无奈地将一个正则表达式一分为五，并且拆分成5个之后不会使用管道同时将参数传递(也不能吧？)给findstr，关键是我那么一大串在日志中禁用标点符号不知为何不能工作，反正断断续续(经常被人打断工作，去处理其它事)耗费了我3个小时去写测试的批处理和这个钩子批处理，还是搞不定。一念下，想起python这种神器，花了几分钟找到了正则表达式的match示例，又查阅了对于stdin输入的获取方法，然后直接写了个check.py去代替findstr来匹配正则表达式(其实这思路是上午查看trac的TracTicketValidatorPlugin插件时看代码得到的)，然后再花2分钟验证之，搞定，上代码：

  • pre-commit.bat


     1 @echo off
     2 rem SVN强制写注释的hooks脚本(Windows)
     3 rem 文件名是: pre-commit.bat,放到repository/hooks目录下
     4 setlocal
     5 set SVN_BINDIR=”C:\Program Files\TortoiseSVN\bin”
     6 set REPOS=%1
     7 set TXN=%2
     8
     9 rem check that logmessage contains at least 10 characters
    10 %SVN_BINDIR%\svnlook log “%REPOS%” -t “%TXN%” | python check.py “……” 1>&2
    11 if %errorlevel% gtr 0 goto err
    12 exit 0
    13
    14 :err
    15 echo 未遵循svn提交规范! 1>&2
    16 echo “%REPOS%” -t “%TXN%” 1>&2
    17 exit 1

  • check.py (2014/04/10修正，使用unicode字符串以对全角符号进行正确匹配)


     1 # coding=gbk
     2 import re
     3 import sys
     4
     5 input_file = sys.stdin
     6
     7 # 如果不用unicode模式则在有全角字符的情况下匹配不成功
     8 restr=u‘^((问题修复)|(功能开发)|(功能改进)|(功能优化)|(代码优化))：(#[0-9]+ )?[^#:;\’<>,。‘*【】｛｝？?《》\n\r]+$‘
     9 for s in input_file:
    10     #先解码为unicode字符串
    11     u = s.decode(‘GBK‘)
    12     print(u“验证字符串:“ + u)
    13     if re.match(restr, u) != None:
    14         print(“匹配成功“)
    15         exit(0)
    16     else:
    17         exit(1)

 

ps：

哎，用几年批处理，依然被诸如：启动进程进获取打印信息，字符串截取，字符串拼装等一些简单操作给难倒，感觉每次写批处理都是在 拼凑->试一下 的无限循环，不学点新东西就落后了。

python
svn, python, 钩子