五分钟内用Python实现GitHook

2019独角兽企业重金招聘Python工程师标准>>>

githooks.png
Githook 也称 Git 钩子，是在 Git 仓库中特定事件发生时自动运行的脚本。它可以让你自定义 Git 内部的行为，在开发周期中的关键点出发自定义行为。

Git Hook 最常见的使用场景包括推行提交信息规范，根据仓库状态来改变项目环境，和接入持续集成工作流。但是因为脚本可以完全定制，你可以用 Git Hook 来自动化或者优化你开发工作流中任意部分。

Git Hook 是仓库中特定事件发生时 Git 自动运行的普通脚本。因此 Git Hook 安装和配置也非常容易。Hook 在本地或服务端仓库都可以部署，且只会在仓库中事件发生时被执行。

背景：想在每一次代码commit的时候发送一封邮件到相关人员的邮箱

前提：阅读以下文字需要有一定Git基础的朋友，请参见之前的文章：五步法掌握Git基本操作

实验环境：
Python3.5
Pycharm(最顺手的IDE而已)
Windows系统 Win7

Hook 存在于每个 Git 仓库的 .git/hooks 目录中。当你初始化仓库时，Git 自动生成这个目录和一些示例脚本。你可以在某个 .git/hooks 中，查看这些文件，如下图：

Hooks目录.png

注：本地没有git仓库的可以随意git clone一个，但是需要有权限可以做git commit，好做之后的练习。

编写脚本语言
内置的脚本大多是 shell 和 perl 语言实现的，但你也可以使用任何脚本语言，只要它们最后能编译到可执行文件。每次脚本中 #!/bin/sh 定义了你的文件将如何被解释。
这次我们采用Python语言来实现GitHook，在Linux系统下可以直接编写Python脚本，但是在Windows系统下需要做一个小小的转换。
1)新建一个shell脚本，取名为post-commit,内容如下：

#!/bin/sh
python3 .git/hooks/post-commit.py
2)新建一个post-commit.py，里面编写Hook中需要发送邮件的功能

注：上面一个文件中写的python3是因为CC先生的Windows环境中同时有python2和python3（Python2和Python3共存），此处特意表明用python3来处理，否则就直接写python即可。

内容如下：

# -*- coding: utf-8 -*-
 
import smtplib
from email.mime.text import MIMEText
from email.header import Header
from subprocess import check_output
 
#使用QQ邮箱做测试，填写QQ的smtp服务器名称
mail_host = "smtp.qq.com"
#替换成自己使用的QQ邮箱
mail_user = "***@qq.com"
#替换成自己使用的授权码(非自己的QQ密码)授权码详见；http://service.mail.qq.com/cgi-bin/help?subtype=1&&id=28&&no=1001256
mail_pass = "*****"
#使用Python中的subprocess的check_output函数来捕获运行了git命令后的标准输出
log = check_output(['git', 'log', '-1', '-p']).decode()
 
m = log.split('\n',5)[4]
#分割字符串得到最后的一个参数 email
arg = m.split(' ')[-1]
 
 
if arg[:6] == 'email:':
    receiver = arg[6:]
    print(receiver)
    sender = mail_user
    receivers = [receiver]
 
    message = MIMEText(log)
    message['From'] = Header(mail_user, 'utf-8')
    message['To'] =  Header(str(receivers), 'utf-8')
 
    subject = 'This is a commit log for you!'
    message['Subject'] = Header(subject, 'utf-8')
 
    try:
        smtpObj = smtplib.SMTP_SSL(mail_host, 465)
        smtpObj.login(mail_user,mail_pass)
        smtpObj.sendmail(sender, receivers, message.as_string())
        smtpObj.quit()
        print ("Send the diff email to:", receiver)
    except smtplib.SMTPException as e:
        print (e)
 
3.可以在git命令中尝试GitHook

随意改写一个仓库中的文件，比如README.md
$git add README.md
2)提交修改
$ git commit -m 'Update readme. email:xgengshax@msn.com'，如下图：

gitcommit.png
4.查看QQ邮箱已发送邮件（此处因为QQ邮箱的安全设置会收到发送失败的提示邮件，不过这个表示Hook已经成功，只是QQ的安全设置而已）

QQ mail.png
至此，我们已经完成了只要git commit一次，就会发送邮件的简单功能。

回顾一下使用到的知识点：

Git基础知识
Python对SMTP的使用
Python中subprocess子进程的使用
拓展：
钩子的作用域
对于任何 Git 仓库来说 Hook 都是本地的，而且它不会随着 git clone 一起复制到新的仓库。而且因为钩子是本地的，任何能接触到仓库的人都可以修改。对于开发团队来说，这有很大的影响。所以在开发团队中维护钩子是比较复杂的，因为 .git/hooks 目录不随你的项目一起拷贝，也不受版本控制影响。一个简单的解决办法是把你的 Hook 存在项目的实际目录中（在 .git 外）。这样你就可以像其他文件一样进行版本控制。为了安装 Hook ，你可以在 .git/hooks 中创建一个符号链接，或者简单地在更新后把它们复制到 .git/hooks 目录下。

本地 Hook 只影响它们所在的仓库。以下是最常用的 6 个本地 >Hook：

pre-commit
prepare-commit-msg
commit-msg
post-commit
post-checkout
pre-rebase
前四个 Hook 介入到版本提交的生命周期，后两个允许执行一些额外的操作，分别为 git checkout 和 git rebase 的安全检查。所有与带 pre- 的 Hook 代表即将发生的某个阶段，带 post- 只用于通知。
--------------------- 
作者：weixin_33695450 
来源：CSDN 
原文：https://blog.csdn.net/weixin_33695450/article/details/86909554 
版权声明：本文为博主原创文章，转载请附上博文链接！

转载于:https://my.oschina.net/u/4000302/blog/3033583