SVN Hook + Python实现commit后自动发送邮件

原创 2013年05月04日 16:46:13

       svn 的hook机制方便了用户根据svn动作自定义一些操作,post-commithook是当用户执行commit后执行的用户自定义操作。如用户commit后,自动调用post-commit hook script群发邮件到项目组。实现过程是Commit后post-commithook 自动调用,发送邮件。

         我自己写了一个功能简单的sendmail.py来辅助发送邮件。

         现在关注一下主要的实现:post-commit, sendmail.py

        

post-commit的内容如下:

# REPOS-PATH (the path to this repository)
REPOS="$1"
# REV (the number of the revision just committed)
REV="$2"

LANG=zh_CN.GB18030
#没有这句不起作用
export LANG

HOOK_DIR=/root/gaoyj/test_repo/hooks
SVNLOOK_BIN=/usr/local/subversion/bin/svnlook
PYTHON_BIN=/usr/bin/python
${PYTHON_BIN} ${HOOK_DIR}/sendmail.py ${REPOS} ${REV}

有以下注意事项:

(1)svn调用post-commit时,传递了两个参数: REPOS-PATH(Repository路径)和REV版本号

(1)      如果收到邮件中,无法显示中文,应在post-commit中设置环境变量LANG并且export

(2)      post-commit执行时,无法获得PATH变量的值,所以script中应使用绝对路径

(3)      将Repository的hook目录下post-commit.tmpl改为post-commit(windows下改为post-commit.bat),并赋予执行权限。


sendmail.py的原理是通过调用svnlook获得提交信息(版本号、提交时间、提交者、commitlog,发生变更的文件),内容如下:

#coding: gb2312
import sys
import os
import smtplib
from email.mime.text import MIMEText

mail_host = 'smtp.example.com' #发送邮件的smtp地址
mail_user = 'example' # 发送通知邮件的用户名
mail_pass = 'example_passwd' # 用户的密码
me = 'Example' + '<' + 'example' + '@' + 'example.com' + '>' #发送邮件人的地址标识
to_list = ['person_a@example.com', 'person_b@example.com', 'person_c@example.com'] # 收件人

html_template = """
<html>
        <h2 style="color:#FFFFFF; background: #008040;">基本信息</h2>
        <div> <b>版本库:</b>
                <a href="svn:%s">%s</a>
        </div>
        <div> <b>版本号:</b>%s
        </div>
        <div>
                <b>提交者:</b>%s
        </div>
        <div>
                <b>提交时间:</b>%s
        </div>
        <h2 style="color:#FFFFFF; background: #4682B4;">提交说明</h2> <font size="4" color="#BF6000"><xmp>%s</xmp></font>
        <h2 style="color:#FFFFFF; background: #5353A8;">文件清单</h2>
        <xmp>%s</xmp>
        <hr>
        <center>
                ☆ Powered by
                <a href="http://garyelephant.me">Gary</a>
        </center>
        <center>
                ☆ Inspired by
                <a href="http://crearo-sw.blogspot.com">CREARO-SW</a>
        </center>
</html>
"""

def write_mail_content(repo, rev):
        """
        repo: repository
        rev: revision
        """
        repo_name = get_repo_name(repo)
        author = get_author(repo, rev)
        date = get_date(repo, rev)
        log = get_log(repo, rev)
        file_list = get_file_list(repo, rev)
        content = html_template % (repo, repo_name, rev, author, date, log, file_list
        return content

def get_repo_name(repo):
        return os.path.basename(repo)

def get_author(repo, rev):
        """svnlook author -r REV REPOS 获得提交者
        """
        cmd = '%s author -r %s %s' % (svnlook_bin_path, rev, repo)
        output = os.popen(cmd).read()
        return output

def get_date(repo, rev):
        """svnlook date -r REV REPOS 获得提交时间
        """
        cmd = '%s date -r %s %s' % (svnlook_bin_path, rev, repo)
        output = os.popen(cmd).read()
        return output

def get_log(repo, rev):
        """svnlook log -r REV REPOS 获得提交日志
        """
        cmd = '%s log -r %s %s' % (svnlook_bin_path, rev, repo)
        output = os.popen(cmd).read()
        return output

def get_file_list(repo, rev):
        """svnlook changed -r REV REPOS 获得发生变更的文件
        """
        cmd = '%s changed -r %s %s' % (svnlook_bin_path, rev, repo)
        output = os.popen(cmd).read()
        return output

def send_mail(msg, sender, to_list):
        try:
                s = smtplib.SMTP()
                s.connect(mail_host)
                s.login(mail_user,mail_pass)
                s.sendmail(sender, to_list, msg.as_string())
                s.close()
                return True
        except Exception, e:
                print str(e)
                return False

def write_mail(sender, to_list, sub, content):
        msg = MIMEText(content, _subtype = 'html', _charset='gb2312')
        msg['Subject'] = sub
        msg['From'] = sender
        msg['To'] = ';'.join(to_list)
        return msg

global svnlook_bin_path
if __name__ == '__main__':
        svnlook_bin_path = '/usr/local/subversion/bin/svnlook'

        subject = 'SVN Commit Notification'
        content = write_mail_content(sys.argv[1], sys.argv[2])
        msg = write_mail(me, to_list, subject, content)
        send_mail(msg, me, to_list)

有以下注意事项:

(1)发送通知邮件用户的密码是明文保存的,存在安全隐患

(2)用os.popen调用svnlook需要使用svnlook的绝对路径

 

源码托管在Github上:https://github.com/garyelephant/SVN-Hooks


References:

[1] SVN服务器与客户端Hooks脚本的使用http://scmbob.org/subversion-hooks-windows.html
[2] O'Reilly Media 出版的Subversion与版本控制,http://svnbook.red-bean.com/

[3] Subversion Hooks, http://www.worldhello.net/doc/svn_hooks/svn_hooks.mm.htm

[4] A SubversionPre-Commit Hook

  http://wordaligned.org/articles/a-subversion-pre-commit-hook

[5] Svn hookencoding problem

  http://stackoverflow.com/questions/2213670/svn-hook-encoding-problem


转载本文请注明作者和出处[Gary的影响力]http://garyelephant.me,请勿用于任何商业用途!

Author: Gary Gao( garygaowork[at]gmail.com) 关注互联网、分布式、高性能、NoSQL、自动化、软件团队

支持我的工作:  https://me.alipay.com/garygao




版权声明:本文为博主(微博@Gary的影响力)原创文章,未经博主允许不得转载。博客地址:http://garyelephant.me https://blog.csdn.net/gaoyingju/article/details/8884276

初学SVN之 用Python写SVN的钩子文件

    最近由于单位上一个工程,由于参与者来源众多,且软件经验都不足,而且由于硬件也在不断修改,结果弄得版本极度混乱,已经到不能忍受的地步了。于是只得寻找一个版本管理工具。经过一番搜索,图方便随大流的...
  • whycadi
  • whycadi
  • 2008年10月02日 15:01
  • 10067

SVN钩子(hooks)的经典使用

在实际工作中一定有人遇到过这样的问题: 我想在提交代码后立即在web上看到效果,或者是在提交代码的时候能够检查一下我的语法,等等。 其实,这些问题只要用SVN强大hooks就能非常简单的实...
  • wide288
  • wide288
  • 2013年09月12日 13:15
  • 17469

SVN1.7.14上配置post_commit hooks,实现自动发邮件功能

操作系统是centos7. SVN1.7.16 的post-commit.tmpl中提供的mailer.cf文件需要安装python,很麻烦。所以仍旧使用sendmail 发送邮件...
  • w171066
  • w171066
  • 2016年05月11日 10:16
  • 1295

SVN设置Hooks自动群发更新邮件

项目组成员不定时向SVN提交代码或数据,管理员不能确切掌握项目代码更新动态。SVN向我们提供了设置Hooks自动群发更新邮件的功能,当项目组成员向SVN提交数据时,在Hooks中指定的邮箱将会接收到S...
  • gongxifacai_believe
  • gongxifacai_believe
  • 2016年03月28日 23:09
  • 1192

svn源码同步hooks

一、安装#yum install subversion检查是否安装了svn#subversion –v创建svn库和对应的目录#mkdir /svn/www.test.com#svnadmin cre...
  • lumengabc
  • lumengabc
  • 2013年12月09日 10:59
  • 1073

python 事件 响应 钩子 event hooks

# -*- coding: utf-8 -*- import requestsdef get_key_info(response, *args, **kwargs): """callback ...
  • u013205877
  • u013205877
  • 2017年04月06日 08:17
  • 1051

利用svn钩子hooks/post-commit实现代码自动部署

配置了台svn服务器,用来保存公司项目的代码,同时svn服务器也是一台web服务器。因此希望当我本地代码commit到svn服务器时,能够触发svn服务器的钩子hooks/post-commit将新版...
  • dahuzix
  • dahuzix
  • 2015年10月11日 21:41
  • 11759

svn hook post-commit更新及后期优化

转载自: |REKFAN|系统运维| » 解决Linux下SVN访问提交速度很慢问题以前每一次的提交都会造成整个svn的更新。当svn目录越来越大,文件越来越多的时候,svn提交也会越来越慢。expo...
  • LiaoQuesg
  • LiaoQuesg
  • 2017年08月28日 11:33
  • 924

svn: Commit blocked by pre-commit hook (exit code 255) with output:报错分析及解决方法

出错原因     开始时提交的注释为: commit -m "更改otherInfos类型为Map" 提交时报错:svn: Commit blocked by pre-commit hook (e...
  • zhouxingxingzxy
  • zhouxingxingzxy
  • 2016年09月21日 13:52
  • 3075

SVN提交报错"Commit blocked by pre-commit hook"的解决办法

【问题】 Linux命令行下用 svn commit -m "
  • yasi_xi
  • yasi_xi
  • 2014年09月21日 12:56
  • 46447
收藏助手
不良信息举报
您举报文章:SVN Hook + Python实现commit后自动发送邮件
举报原因:
原因补充:

(最多只允许输入30个字)