使用GitHub和Python实现持续部署的方法


Posted in Python onMay 09, 2019

借助 GitHub 的网络钩子webhook,开发者可以创建很多有用的服务。从触发一个 Jenkins 实例上的 CI(持续集成) 任务到配置云中的机器,几乎有着无限的可能性。这篇教程将展示如何使用 Python 和 Flask 框架来搭建一个简单的持续部署(CD)服务。

在这个例子中的持续部署服务是一个简单的 Flask 应用,其带有接受 GitHub 的网络钩子webhook请求的 REST 端点endpoint。在验证每个请求都来自正确的 GitHub 仓库后,服务器将拉取pull更改到仓库的本地副本。这样每次一个新的提交commit推送到远程 GitHub 仓库,本地仓库就会自动更新。

Flask web 服务

用 Flask 搭建一个小的 web 服务非常简单。这里可以先看看项目的结构。

├── app
│  ├── __init__.py
│  └── webhooks.py
├── requirements.txt
└── wsgi.py

首先,创建应用。应用代码在 app 目录下。

两个文件(__init__.py 和 webhooks.py)构成了 Flask 应用。前者包含有创建 Flask 应用并为其添加配置的代码。后者有端点endpoint逻辑。这是该应用接收 GitHub 请求数据的地方。

这里是 app/__init__.py 的内容:

import os
from flask import Flask
from .webhooks import webhook
def create_app():
 """ Create, configure and return the Flask application """
 app = Flask(__name__)
 app.config['GITHUB_SECRET'] = os.environ.get('GITHUB_SECRET')
 app.config['REPO_PATH'] = os.environ.get('REPO_PATH')
 app.register_blueprint(webhook)
 return(app)

该函数创建了两个配置变量:

GITHUB_SECRET 保存一个密码,用来认证 GitHub 请求。

REPO_PATH 保存了自动更新的仓库路径。

这份代码使用Flask 蓝图Flask Blueprints来组织应用的端点endpoint。使用蓝图可以对 API 进行逻辑分组,使应用程序更易于维护。通常认为这是一种好的做法。

这里是 app/webhooks.py 的内容:

import hmac
from flask import request, Blueprint, jsonify, current_app 
from git import Repo
webhook = Blueprint('webhook', __name__, url_prefix='')
@webhook.route('/github', methods=['POST']) 
def handle_github_hook(): 
 """ Entry point for github webhook """
 signature = request.headers.get('X-Hub-Signature') 
 sha, signature = signature.split('=')
 secret = str.encode(current_app.config.get('GITHUB_SECRET'))
 hashhex = hmac.new(secret, request.data, digestmod='sha1').hexdigest()
 if hmac.compare_digest(hashhex, signature): 
  repo = Repo(current_app.config.get('REPO_PATH')) 
  origin = repo.remotes.origin 
  origin.pull('--rebase')
  commit = request.json['after'][0:6]
  print('Repository updated with commit {}'.format(commit))
 return jsonify({}), 200

首先代码创建了一个新的蓝图 webhook。然后它使用 Flask route 为蓝图添加了一个端点。任何请求 /GitHub URL 端点的 POST 请求都将调用这个路由。

验证请求

当服务在该端点上接到请求时,首先它必须验证该请求是否来自 GitHub 以及来自正确的仓库。GitHub 在请求头的 X-Hub-Signature 中提供了一个签名。该签名由一个密码(GITHUB_SECRET),请求体的 HMAC 十六进制摘要,并使用 sha1 哈希生成。

为了验证请求,服务需要在本地计算签名并与请求头中收到的签名做比较。这可以由 hmac.compare_digest 函数完成。

自定义钩子逻辑

在验证请求后,现在就可以处理了。这篇教程使用 GitPython 模块来与 git 仓库进行交互。GitPython 模块中的 Repo 对象用于访问远程仓库 origin。该服务在本地拉取 origin 仓库的最新更改,还用 --rebase 选项来避免合并的问题。

调试打印语句显示了从请求体收到的短提交哈希。这个例子展示了如何使用请求体。更多关于请求体的可用数据的信息,请查询 GitHub 文档。

最后该服务返回了一个空的 JSON 字符串和 200 的状态码。这用于告诉 GitHub 的网络钩子服务已经收到了请求。

部署服务

为了运行该服务,这个例子使用 gunicorn web 服务器。首先安装服务依赖。在支持的 Fedora 服务器上,以 sudo 运行这条命令:

sudo dnf install python3-gunicorn python3-flask python3-GitPython

现在编辑 gunicorn 使用的 wsgi.py 文件来运行该服务:

from app import create_app
application = create_app()

为了部署服务,使用以下命令克隆这个 git 仓库或者使用你自己的 git 仓库:

git clone https://github.com/cverna/github_hook_deployment.git /opt/

下一步是配置服务所需的环境变量。运行这些命令:

export GITHUB_SECRET=asecretpassphraseusebygithubwebhook
export REPO_PATH=/opt/github_hook_deployment/

这篇教程使用网络钩子服务的 GitHub 仓库,但你可以使用你想要的不同仓库。最后,使用这些命令开启该 web 服务:

cd /opt/github_hook_deployment/
gunicorn --bind 0.0.0.0 wsgi:application --reload

这些选项中绑定了 web 服务的 IP 地址为 0.0.0.0,意味着它将接收来自任何的主机的请求。选项 --reload 确保了当代码更改时重启 web 服务。这就是持续部署的魔力所在。每次接收到 GitHub 请求时将拉取仓库的最近更新,同时 gunicore 检测这些更改并且自动重启服务。

*注意: *为了能接收到 GitHub 请求,web 服务必须部署到具有公有 IP 地址的服务器上。做到这点的简单方法就是使用你最喜欢的云提供商比如 DigitalOcean,AWS,Linode等。

配置 GitHub

这篇教程的最后一部分是配置 GitHub 来发送网络钩子请求到 web 服务上。这是持续部署的关键。

从你的 GitHub 仓库的设置中,选择 Webhook 菜单,并且点击“Add Webhook”。输入以下信息:

“Payload URL”: 服务的 URL,比如<http://public_ip_address:8000/github>

“Content type”: 选择 “application/json”

“Secret”: 前面定义的 GITHUB_SECRET 环境变量

然后点击“Add Webhook” 按钮。

使用GitHub和Python实现持续部署的方法

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python实现2014火车票查询代码分享
Jan 10 Python
Python中实现从目录中过滤出指定文件类型的文件
Feb 02 Python
Python中使用PyQt把网页转换成PDF操作代码实例
Apr 23 Python
Python获取linux主机ip的简单实现方法
Apr 18 Python
Python实现对百度云的文件上传(实例讲解)
Oct 21 Python
python进行两个表格对比的方法
Jun 27 Python
Python3实现的回文数判断及罗马数字转整数算法示例
Mar 27 Python
Python3 列表,数组,矩阵的相互转换的方法示例
Aug 05 Python
Python中实现输入超时及如何通过变量获取变量名
Jan 18 Python
Python龙贝格法求积分实例
Feb 29 Python
Python getsizeof()和getsize()区分详解
Nov 20 Python
使用scrapy实现增量式爬取方式
Jun 21 Python
在win10和linux上分别安装Python虚拟环境的方法步骤
May 09 #Python
Python Excel处理库openpyxl使用详解
May 09 #Python
python3实现小球转动抽奖小游戏
Apr 15 #Python
Django保护敏感信息的方法示例
May 09 #Python
Python基于scipy实现信号滤波功能
May 08 #Python
python实现抽奖小程序
Apr 15 #Python
Python常见数据类型转换操作示例
May 08 #Python
You might like
PHP一些有意思的小区别
2006/12/06 PHP
PHP eval函数使用介绍
2013/12/08 PHP
php中url函数介绍及使用示例
2014/02/13 PHP
wampserver改变默认网站目录的办法
2015/08/05 PHP
PHP基于mssql扩展远程连接MSSQL的简单实现方法
2016/10/08 PHP
PHP实现对数组分页处理实例详解
2017/02/07 PHP
ThinkPHP框架下微信支付功能总结踩坑笔记
2019/04/10 PHP
PHP数组基本用法与知识点总结
2020/06/02 PHP
JavaScript 轻松搞定快捷留言功能 只需一行代码
2010/04/01 Javascript
JS实现局部选择打印和局部不选择打印
2014/04/03 Javascript
jQuery+css实现炫目的动态块漂移效果
2016/01/28 Javascript
解决JS组件bootstrap table分页实现过程中遇到的问题
2016/04/21 Javascript
jQuery 移动端拖拽(模块化开发,触摸事件,webpack)
2016/10/28 Javascript
原生js实现键盘控制div移动且解决停顿问题
2016/12/05 Javascript
前端构建工具之gulp的语法教程
2017/06/12 Javascript
JS使用正则表达式找出最长连续子串长度
2017/10/26 Javascript
修改UA在PC中访问只能在微信中打开的链接方法
2017/11/27 Javascript
解决在vue+webpack开发中出现两个或多个菜单公用一个组件问题
2017/11/28 Javascript
Element-UI 使用el-row 分栏布局的教程
2020/10/26 Javascript
Python中的推导式使用详解
2015/06/03 Python
Python多线程原理与用法实例剖析
2019/01/22 Python
Django框架首页和登录页分离操作示例
2019/05/28 Python
讲解Python3中NumPy数组寻找特定元素下标的两种方法
2019/08/04 Python
Laravel框架表单验证格式化输出的方法
2019/09/25 Python
关于ResNeXt网络的pytorch实现
2020/01/14 Python
GUESS Factory加拿大:牛仔裤、服装及配饰
2019/09/20 全球购物
thinkphp5 redis缓存新增方法实例讲解
2021/03/24 PHP
董事长秘书岗位职责
2013/11/29 职场文书
制药工程专业毕业生推荐信
2013/12/24 职场文书
人力资源部培训专员岗位职责
2014/01/02 职场文书
移风易俗倡议书
2014/04/15 职场文书
最常使用的求职信
2014/05/25 职场文书
爱心募捐感谢信
2015/01/22 职场文书
劳动仲裁撤诉申请书
2015/05/18 职场文书
创业开店,这样方式更合理
2019/08/26 职场文书
win10拖拽文件时崩溃怎么解决?win10文件不能拖拽问题解决方法
2022/08/14 数码科技