Sanic教程: 7.测试与部署

2024-01-24 17:32
文章标签 部署 教程 测试 sanic

本文主要是介绍Sanic教程: 7.测试与部署,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在项目结构那一节说过,一个服务的基本结构大概是怎么样的,这里再列出来回顾下:

pro_name	
├── docs            # 项目文档说明	
├── src or pro_name/# 项目名称	
├── tests           # 测试用例	
├── README.md       # 项目介绍	
└──requirements.txt # 该项目依赖的第三方库

一个服务编写完成后,在部署之前,你需要做的一步就是进行单元测试,首先你要确定目前的代码是可以完美运行的,然后测试用例还可以让你在下次修改代码逻辑进行版本迭代的时候,只要再跑一次对应的测试用例就可以快速地确定此次的版本依旧是完美的,大大节省时间,一般集成测试的时候都需要跑测试用例的脚本。

本次使用的例子还是继续在demo06的基础上进行演示,提醒一下诸位,在继续阅读前可以先大致看下目录中 test的代码哈。

测试

单元测试

Sanic进行单元测试的时候,官方推荐使用的是pytest,具体怎么对Sanic构建的服务进行测试呢,别急,Sanic开发团队提供了关于 pytest的插件,见pytest-sanic,使用起来也是非常简单。

让我们结合前面的例子,利用pytest-sanic测试一下demo06中的 rss api服务,先看下目录结构:

tests	
├── setting.py	
└── test_rss.py

首先在 setting.py中定好请求的数据:

# setting.py	
def rss_data():	return {	"name": "howie6879"	}

然后编写对应的测试用例,这里是关于 /v1/post/rss/的一个 POST请求测试,代码如下:

# test_rss.py	
async def test_http_rss(test_cli):	data = setting.rss_data()	response = await test_cli.post('/v1/post/rss/', data=ujson.dumps(data))	resp_json = await response.json()	assert resp_json['status'] == 1	
# 运行测试 pytest tests/test_rss.py	
"""	
================================================= test session starts ==================================================	
platform darwin -- Python 3.6.0, pytest-3.2.3, py-1.4.34, pluggy-0.4.0	
rootdir: /Users/howie/Documents/programming/python/git/Sanic-For-Pythoneer/examples/demo06/sample, inifile:	
plugins: celery-4.0.2, sanic-0.1.5	
collected 2 items	
tests/test_rss.py .s	
========================================= 1 passed, 1 skipped in 2.13 seconds ==========================================	
"""

可以看到测试通过,全部测试代码在这里,最好可以直接clone下来跑一遍,细心的朋友可能注意到了测试用例结果中的这句话 1passed,1skippedin2.13seconds,为什么会有一个测试跳过呢?

因为在实际编写项目的过程中,你的测试用例很可能会分好多种,比如在编写微服务的过程中,同样一套处理逻辑,你需要分别实现 HTTPgRPC两种调用方式,测试代码里面我就多写了一个测试 gRPC的配置,不过我设置了参数: DIS_GRPC_TEST=True,没有启用 gRPC的测试,这里只是举个例子,具体还是要看诸位的需求,用本次的例子作为参考,就算改动起来也并没什么难度。

压力测试

说完了如何对Sanic编写的服务进行单元测试,接下来稍微讲下如何进行压力测试,压力测试最好在内外网都进行测试下,当然服务器配置是你定,然后在多个服务器上部署好服务,启动起来,利用负载均衡给压测代码一个固定的ip,这样对于服务的水平扩展测试就会很方便。

压测可以考虑使用locust,看看现在 tests下的目录结构:

├── locust_rss	
│   ├── __init__.py	
│   ├── action.py	
│   ├── locust_rss_http.py	
│   ├── locustfile.py	
│   └── utils.py	
├── setting.py	
└── test_rss.py

新增了 locust_rss文件夹,首先在 action.py定义好请求地址与请求方式:

HTTP_URL = "http://0.0.0.0:8000/v1/post/rss/"	
GRPC_URL = "0.0.0.0:8990"	
def json_requests(client, data, url):	func_name = inspect.stack()[1][3]	headers = {'content-type': 'application/json'}	return post_request(client, data=json.dumps(data), url=url, func_name=func_name, headers=headers)	
def action_rss(client):	data = {	"name": "howie6879"	}	json_requests(client, data, HTTP_URL)

压测怎么个压测法,请求哪些接口,接口请求怎么分配,都在 locust_rss_http.py里定好了:

class RssBehavior(TaskSet):	@task(1)	def interface_rss(self):	action.action_rss(self.client)

然后需要发送请求给目标,还需要判断是否请求成功,这里将其封装成函数,放在 utils.py里,比如 post_request函数:

def post_request(client, data, url, func_name=None, **kw):	"""	发起post请求	"""	func_name = func_name if func_name else inspect.stack()[1][3]	with client.post(url, data=data, name=func_name, catch_response=True, timeout=2, **kw) as response:	result = response.content	res = to_json(result)	if res['status'] == 1:	response.success()	else:	response.failure("%s-> %s" % ('error', result))	return result

locustfile.py是压测的启动文件,必不可少,我们先请求一次,看看能不能请求成功,如果成功了再将其正式运行起来:

cd Sanic-For-Pythoneer/examples/demo06/sample/tests/locust_rss	
# 只想跑一次看看有没有问题 记得先将你编写的服务启动起来哦	
locust -f locustfile.py --no-web -c 1 -n 1	
# Output: 表示没毛病	
[2018-01-14 14:54:30,119] 192.168.2.100/INFO/locust.main: Shutting down (exit code 0), bye.	Name                                                          # reqs      # fails     Avg     Min     Max  |  Median   req/s	
--------------------------------------------------------------------------------------------------------------------------------------------	POST action_rss                                                    1     0(0.00%)    1756    1756    1756  |    1800    0.00	
--------------------------------------------------------------------------------------------------------------------------------------------	Total                                                              1     0(0.00%)                                       0.00	
Percentage of the requests completed within given times	Name                                                           # reqs    50%    66%    75%    80%    90%    95%    98%    99%   100%	
--------------------------------------------------------------------------------------------------------------------------------------------	POST action_rss                                                     1   1800   1800   1800   1800   1800   1800   1800   1800   1756	
--------------------------------------------------------------------------------------------------------------------------------------------

好了,没问题了,可以执行 locust-f locustfile.py,然后访问 http://0.0.0.0:8089/,如下图:

640?wx_fmt=jpeg

当然,这里只是大概讲解下如何进行压测,至于真实环境下,还是需要诸位继续摸索。

部署

千辛万苦,终于到了这一步,我们历经代码编写、单元测试、压力测试终于到了这一步,将我们的服务正式部署!

在继续阅读之前,请你万万先读一遍官方的Deploying。

好了,你现在肯定知道了Sanic服务的两种启动方式,分别如下:

  • python -m sanic server.app --host=0.0.0.0 --port=8000 --workers=4

  • gunicorn myapp:app --bind 0.0.0.0:8000 --worker-class sanic.worker.GunicornWorker

至于选哪种启动方式,我觉得都可以,看你心情了,下面直接说下如何部署:

  • Gunicorn + Supervisor + Caddy

  • Docker

对于用Gunicorn启动,可以将配置写在自己定义的配置文件中,比如 config/gunicorn.py

# gunicorn.py	
bind = '127.0.0.1:8001'	
backlog = 2048	
workers = 2	
worker_connections = 1000	
timeout = 30	
keepalive = 2	
spew = False	
daemon = False	
umask = 0

然后直接运行 gunicorn-c config/gunicorn.py--worker-classsanic.worker.GunicornWorkerserver:app就启动了。

为了方便对此服务的管理,可以使用 Supervisor来对服务进行启动、停止,比如使用如下配置:

[program:demo]	
command      = gunicorn -c config/gunicorn.py --worker-class sanic.worker.GunicornWorker server:app	
directory    = /your/path/	
user         = root	
process_name = %(program_name)s	
autostart    = true	
autorestart  = true	
startsecs    = 3	
redirect_stderr         = true	
stdout_logfile_maxbytes = 500MB	
stdout_logfile_backups  = 10	
stdout_logfile          = ~/supervisor/demo.log	
environment             = MODE="PRO"

最后,你需要对该服务(假设是一个网站)的"站点"进行配置,推荐使用Caddy服务器,Caddy是使用Go编写的Web服务器,它简单易用且支持自动化HTTPS,你只需按照官方文档编写好你自己的Caddyfile,比如目前的例子:

www.your.domain.com {	proxy / 127.0.0.1:8001	timeouts none	gzip	
}	
your.domain.com {	redir http://www.your.domain.com	
}

在利用 Supervisor守护一个Caddy的服务进程,至此,你的服务站点就搭建好了。

现在 Docker的崛起,使得我们的部署方式也发生了改变,我们完全可以将上面编写的服务 Docker化,然后构建自己的集群,一个服务器启动一个服务节点,再启动一个镜像做负载均衡,岂不是美滋滋。

这个例子中我已经写了一个Dockerfile,你可以按照如下方式进行启动:

docker build -t demo:0.1 .	
docker run -d -p 8001:8001 demo:0.1

我建议使用 daocloud来体验一下,你可以关联自己主机,不一定非要用我这个例子中的服务镜像,你大可随意下载一个镜像

说明

代码见demo06

这篇关于Sanic教程: 7.测试与部署的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/640426

相关文章

Nginx分布式部署流程分析

《Nginx分布式部署流程分析》文章介绍Nginx在分布式部署中的反向代理和负载均衡作用,用于分发请求、减轻服务器压力及解决session共享问题,涵盖配置方法、策略及Java项目应用,并提及分布式事... 目录分布式部署NginxJava中的代理代理分为正向代理和反向代理正向代理反向代理Nginx应用场景

全网最全Tomcat完全卸载重装教程小结

《全网最全Tomcat完全卸载重装教程小结》windows系统卸载Tomcat重新通过ZIP方式安装Tomcat,优点是灵活可控,适合开发者自定义配置,手动配置环境变量后,可通过命令行快速启动和管理... 目录一、完全卸载Tomcat1. 停止Tomcat服务2. 通过控制面板卸载3. 手动删除残留文件4.

Python的pandas库基础知识超详细教程

《Python的pandas库基础知识超详细教程》Pandas是Python数据处理核心库,提供Series和DataFrame结构,支持CSV/Excel/SQL等数据源导入及清洗、合并、统计等功能... 目录一、配置环境二、序列和数据表2.1 初始化2.2  获取数值2.3 获取索引2.4 索引取内容2

python依赖管理工具UV的安装和使用教程

《python依赖管理工具UV的安装和使用教程》UV是一个用Rust编写的Python包安装和依赖管理工具,比传统工具(如pip)有着更快、更高效的体验,:本文主要介绍python依赖管理工具UV... 目录前言一、命令安装uv二、手动编译安装2.1在archlinux安装uv的依赖工具2.2从github

C#实现SHP文件读取与地图显示的完整教程

《C#实现SHP文件读取与地图显示的完整教程》在地理信息系统(GIS)开发中,SHP文件是一种常见的矢量数据格式,本文将详细介绍如何使用C#读取SHP文件并实现地图显示功能,包括坐标转换、图形渲染、平... 目录概述功能特点核心代码解析1. 文件读取与初始化2. 坐标转换3. 图形绘制4. 地图交互功能缩放

linux部署NFS和autofs自动挂载实现过程

《linux部署NFS和autofs自动挂载实现过程》文章介绍了NFS(网络文件系统)和Autofs的原理与配置,NFS通过RPC实现跨系统文件共享,需配置/etc/exports和nfs.conf,... 目录(一)NFS1. 什么是NFS2.NFS守护进程3.RPC服务4. 原理5. 部署5.1安装NF

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配

通过Docker容器部署Python环境的全流程

《通过Docker容器部署Python环境的全流程》在现代化开发流程中,Docker因其轻量化、环境隔离和跨平台一致性的特性,已成为部署Python应用的标准工具,本文将详细演示如何通过Docker容... 目录引言一、docker与python的协同优势二、核心步骤详解三、进阶配置技巧四、生产环境最佳实践

Nginx部署HTTP/3的实现步骤

《Nginx部署HTTP/3的实现步骤》本文介绍了在Nginx中部署HTTP/3的详细步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录前提条件第一步:安装必要的依赖库第二步:获取并构建 BoringSSL第三步:获取 Nginx

redis-sentinel基础概念及部署流程

《redis-sentinel基础概念及部署流程》RedisSentinel是Redis的高可用解决方案,通过监控主从节点、自动故障转移、通知机制及配置提供,实现集群故障恢复与服务持续可用,核心组件包... 目录一. 引言二. 核心功能三. 核心组件四. 故障转移流程五. 服务部署六. sentinel部署