使用GitHub和Python实现持续部署

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

[[226125]]

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

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

Flask web 服务

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

  1. ├── app
  2. ├── __init__.py
  3. └── webhooks.py
  4. ├── requirements.txt
  5. └── wsgi.py

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

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

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

  1. import os
  2. from flask import Flask
  3.  
  4. from .webhooks import webhook
  5.  
  6. def create_app():
  7. """ Create, configure and return the Flask application """
  8.  
  9. app = Flask(__name__)
  10. app.config['GITHUB_SECRET'] = os.environ.get('GITHUB_SECRET')
  11. app.config['REPO_PATH'] = os.environ.get('REPO_PATH')
  12. app.register_blueprint(webhook)
  13.  
  14. return(app)

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

  • GITHUB_SECRET 保存一个密码,用来认证 GitHub 请求。
  • REPO_PATH 保存了自动更新的仓库路径。

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

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

  1. import hmac
  2. from flask import request, Blueprint, jsonify, current_app
  3. from git import Repo
  4.  
  5. webhook = Blueprint('webhook', __name__, url_prefix='')
  6.  
  7. @webhook.route('/github', methods=['POST'])
  8. def handle_github_hook():
  9. """ Entry point for github webhook """
  10.  
  11. signature = request.headers.get('X-Hub-Signature')
  12. sha, signature = signature.split('=')
  13.  
  14. secret = str.encode(current_app.config.get('GITHUB_SECRET'))
  15.  
  16. hashhex = hmac.new(secret, request.data, digestmod='sha1').hexdigest()
  17. if hmac.compare_digest(hashhex, signature):
  18. repo = Repo(current_app.config.get('REPO_PATH'))
  19. origin = repo.remotes.origin
  20. origin.pull('--rebase')
  21.  
  22. commit = request.json['after'][0:6]
  23. print('Repository updated with commit {}'.format(commit))
  24. 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 运行这条命令:

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

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

  1. from app import create_app
  2. application = create_app()

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

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

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

  1. export GITHUB_SECRET=asecretpassphraseusebygithubwebhook
  2. export REPO_PATH=/opt/github_hook_deployment/

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

  1. cd /opt/github_hook_deployment/
  2. 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 将向服务发送请求。 

总结

这篇教程向你展示了如何写一个基于 Flask 的用于接收 GitHub 的网络钩子请求,并实现持续集成的 web 服务。现在你应该能以本教程作为起点来搭建对自己有用的服务。

责任编辑:庞桂玉 来源: Linux中国
相关推荐

2021-05-13 21:21:50

React应用GitHub

2022-11-15 17:07:40

开发自动化前端

2017-02-27 18:28:45

持续交付部署

2017-03-17 08:59:55

持续部署Microservic架构

2023-05-12 15:07:40

测试开发

2019-11-26 08:00:00

GitHubGitHub ActiAzure

2024-01-24 18:50:21

WebFTP服务器

2012-08-28 10:52:58

IBMdW

2012-08-24 08:51:27

IBMdW

2021-05-07 08:03:15

微服务JenkinsGitHub项目

2017-02-27 18:35:23

集成交付部署

2016-08-05 17:19:37

持续集成持续交付系统运维

2012-06-26 09:40:14

部署开发管理

2020-01-02 19:00:05

AnsibleGitHubGitLab

2011-09-15 09:21:46

持续集成

2023-10-19 07:33:41

KubeVelaapiserver

2018-11-20 08:00:00

持续集成持续部署Git代码仓库

2016-03-22 13:25:14

2015-07-01 13:29:11

2022-12-02 10:14:56

智慧城市物联网
点赞
收藏

51CTO技术栈公众号