Pytest-Falcon

Pytest helpers for the Falcon framework.

Install

pip install pytest-falcon

Usage

You must create an app fixture to expose the Falcon application you want to test:

import falcon
import pytest


application = falcon.API()

@pytest.fixture
def app():
    return application

Fixtures

client

Allows you to test your API:

class Resource:

    def on_post(self, req, resp, **kwargs):
        resp.body = json.dumps(req.params)

application.add_route('/route', Resource())

def test_post(client):
    resp = client.post('/route', {'myparam': 'myvalue'})
    assert resp.status == falcon.HTTP_OK
    assert resp.json['myparam'] == 'myvalue'

Response properties:

• body the body as str
• json the body parsed as json when the response content-type is 'application/json'
• headers the response headers
• status the response status, as str ('200 OK', '405 Method Not Allowed'…)
• status_code the response status code, as int (200, 201…)