测试

SANIC端点可以使用测试客户机对象在本地进行测试,该对象依赖于附加的请求异步库,它实现了一个反映请求库的API。

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

# Import the Sanic app, usually created with Sanic(__name__)
from external_server import app

def test_index_returns_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运行,并使用异步请求对应用程序执行测试请求。

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

  • uri(默认值“/”)表示要测试的uri的字符串。

  • 收集请求(默认为真)一个布尔值,用于确定函数是否返回原始请求。如果设置为true,则返回值是(请求、响应)的元组,如果为false,则仅返回响应。

  • server_kwargs*(默认值)运行测试请求之前传递到app.run的附加参数的dict。

  • debug(默认为false)确定是否在调试模式下运行服务器的布尔值。

该函数进一步采用 *request_args and * *请求关卡,直接传递给请求。

例如,要向GET请求提供数据,请执行以下操作:

def test_get_request_includes_data():
    params = {'key1': 'value1', 'key2': 'value2'}
    request, response = app.test_client.get('/', params=params)
    assert request.args.get('key1') == 'value1'

并向JSON POST请求提供数据:

def test_post_json_request_includes_data():
    data = {'key1': 'value1', 'key2': 'value2'}
    request, response = app.test_client.post('/', data=json.dumps(data))
    assert request.json.get('key1') == 'value1'

有关异步请求的可用参数的详细信息,请参阅请求文档。

使用随机端口

如果需要使用内核选择的自由非特权端口(而不是sanictestclient的默认端口)进行测试,可以通过指定port=none来进行测试。在大多数系统上,端口将在1024到65535之间。

# Import the Sanic app, usually created with Sanic(__name__)
from external_server import app
from sanic.testing import SanicTestClient

def test_index_returns_200():
    request, response = SanicTestClient(app, port=None).get('/')
    assert response.status == 200

pytest-sanic

pytest-sanic 是一个pytest插件,它可以帮助您异步测试代码。只需编写测试,

async def test_sanic_db_find_by_id(app):
    """
    Let's assume that, in db we have,
        {
            "id": "123",
            "name": "Kobe Bryant",
            "team": "Lakers",
        }
    """
    doc = await app.db["players"].find_by_id("123")
    assert doc.name == "Kobe Bryant"
    assert doc.team == "Lakers"

pytest-sanic还提供一些有用的功能,比如循环、未使用的端口、测试服务器、测试客户机。

@pytest.yield_fixture
def app():
    app = Sanic("test_sanic_app")

    @app.route("/test_get", methods=['GET'])
    async def test_get(request):
        return response.json({"GET": True})

    @app.route("/test_post", methods=['POST'])
    async def test_post(request):
        return response.json({"POST": True})

    yield app


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


#########
# Tests #
#########

async def test_fixture_test_client_get(test_cli):
    """
    GET request
    """
    resp = await test_cli.get('/test_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 request
    """
    resp = await test_cli.post('/test_post')
    assert resp.status == 200
    resp_json = await resp.json()
    assert resp_json == {"POST": True}