sanic官方文档解析之ssl,debug mode模式和test(测试)

1,ssl 示例:

可选择的SSLContent

from sanic import Sanic
import ssl
context = ssl.create_default_context(purpose=ssl.Purpose.CLIENT_AUTH)  # 创建默认的连接环境
context.load_cert_chain("/path/to/cert", keyfile="/path/to/keyfile")
app = Sanic()
app.run(host="0.0.0.0", port=8443, ssl=ssl)

你也可以用字典传输本地的认证

from sanic import Sanic

app = Sanic()

ssl = {"cert": "/path/to/cert", "key": "/path/to/keyfile"}

app.run(host="0.0.0.0", port=8843, ssl=ssl)

2, debug模式

当使用debug的调试模式,Sanic将提供更详细的日志记录输出，默认情况下将启用自动重新加载功能

警告:Sanic的更多调试将降低服务器的性能，因此建议仅在开发环境中启用它

• 1.1,设置调试模式

设置Sanic调试模式的详细输出,并激活自动重新加载

from sanic import Sanic
from sanic.response import json

app = Sanic()

@app.route("/")
async def hello_world(request):
    return json({"hello": "world"})

if __name__ == '__main__':
    app.run(host="0.0.0.0", port=8000, debug=True)

• 1.2,手动设置加载

Sanic提供了手动启动或者自定关闭的关闭,自动重新加载参数将激活或停用自动重新加载

from sanic import Sanic
from sanic.response import json

app = Sanic()


@app.route("/")
async def hello_world(request):
    return json({"hello": "world"})

if __name__ == '__main__':
    app.run(host="0.0.0.0", port=8000, auto_reload=True)

3,test(测试)

Sanic使用test_client对象能够测试本地端,这取决于附加的aiohtp库

测试客户机公开了GET、POST、PUT、DELETE、PATCH、HEAD和OPTIONS方法，供您针对应用程序运行。一个简单的例子（使用pytest）如下

from external_server import app
from sanic import Sanic

app = Sanic(__name__)


def test_index_return_200():
    request, response = app.test_client.get("/")
    assert response.status == 200
    
def test_index_put_not_allowed():
    request, response = app.test_client.put("/")
    assert response.status == 405

在内部，每次调用一个测试客户机方法时，SANIC应用程序都在127.0.0.1:42101运行，并使用aiohttp针对应用程序执行测试请求。

测试客户机方法接受以下参数和关键字参数

• uri (default '/') A string representing the URI to test.
  • (uri（默认值“/”）表示要测试的uri的字符串。)
• gather_request (default True) A boolean which determines whether the original request will be returned by the function. If set to True, the return value is a tuple of (request, response), if False only the response is returned.
  • (

    _ request（默认为true）采集到原始请求是否determines布尔which will be returned by the function。返回true如果集to，the value of is a元组（request，response），if theonly is returned虚假响应

    )
• server_kwargs *(default {}) a dict of additional arguments to pass into app.run before the test request is run.
  • (server_kwargs*（默认值）运行测试请求之前传递到app.run的附加参数的dict。)
• debug (default False) A boolean which determines whether to run the server in debug mode.
  • (布尔（默认调试错误）determines which the服务器是否运行在调试模式)

from sanic import Sanic
import json
app = Sanic()


def test_get_request_includes_date():
    # 请求携带的参数
    params = {"key1": "value1", "key2": "value2"}
    # 从测试客户端get请求处理参数
    request, response = app.test_client.get("/", params=params)
    assert request.args.get("key1") == "value1"


def test_post_json_request_include_data():
    data = {"key1": "value1", "key2": "value2"}
    # 从测试客户端处理post请求
    request, response = app.test_client.post("/", data=json.dumps(data))
    assert request.json.get("ksy1") == "value1"

3.1,sanic中的pytest

pytest-sanic是pytest的插件,,他将会异步的帮助你测试代码

async def test_sanic_db_find_by_id(app):
    """
    假如,在数据库中存在一些数据
    {
        "id": "123",
        "name": "帅爆太阳的男人",
        "team": "茶π"
    }
    :param app:
    :return:
    """
    doc = await app.db["players"].find_by_id("123")
    assert doc.name == "帅爆太阳的男人"
    assert doc.team == "茶π"

pytest-sanic也提供一些有用的夹具,像环,unused端口,测试服务器,测试客户端.

import pytest
from sanic import Sanic
from sanic import response
from sanic.websocket import WebSocketProtocol

@pytest.yield_fixture
def app():
    app = Sanic("test_sanic_app")
    
    # 测试get请求的路由
    @app.route("/test_get", methods=["GET"])
    async def test_get(request):
        # 难道请求可以给数据进行测试
        return response.json({"GET": "True"})
    
    # 测试post请求的路由
    @app.route("test_post", methods=["post"])
    async def test_post(request):
        # 拿到数据可以给数据进行测试
        return response.json({"POST": "True"})
    
    yield app  # 抛出app

    
@pytest.fixture
def test_cli(loop, app, test_client):
    return loop.run_until_complete(test_client(app, protocol=WebSocketProtocol))


# 开始测试
async def test_fixture_test_client_get(test_cli):
    # get请求的测试
    resp = await test_cli.get("/test_get")  # 测试客户端的get请求
    assert resp.status == 200
    resp_json = await resp.json()
    assert resp_json == {"GET": "True"}
    
    
async def test_fixture_test_client_post(test_cli):
    # 测试客户端的post请求
    resp = await test_cli.post("/test_post")
    assert resp.status == 200
    resp_json = await resp.json()
    assert resp_json == {"POST": True}