https://github.com/yohanboniface/pytest-falcon
Pytest helpers for testing Falcon applications
https://github.com/yohanboniface/pytest-falcon
falcon pytest
Last synced: 7 months ago
JSON representation
Pytest helpers for testing Falcon applications
- Host: GitHub
- URL: https://github.com/yohanboniface/pytest-falcon
- Owner: yohanboniface
- Created: 2015-11-09T14:29:34.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-15T08:59:25.000Z (about 3 years ago)
- Last Synced: 2024-10-12T22:10:58.951Z (about 1 year ago)
- Topics: falcon, pytest
- Language: Python
- Size: 49.8 KB
- Stars: 16
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/yohanboniface/pytest-falcon) [](https://pypi.python.org/pypi/pytest-falcon)
# 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:
```python
import falcon
import pytest
application = falcon.API()
application.req_options.auto_parse_form_urlencoded = True
@pytest.fixture
def app():
return application
```
## Fixtures
### client
Allows you to test your API:
```python
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…)
## Contributing
As a general rule, please make sure any changes pass all tests and that
any new contribution which fixes a bug or provides a new feature
also has a new test paired with it. The tests are all found under the
`tests` folder.
Additionally, there is an optional dependency on `falcon_multipart` and
tests to check for compatibility with that package. This package can
be checked out within the github repo under:
https://github.com/yohanboniface/falcon-multipart
Additionally, the optional dependency is included within
`requirements-dev.txt`. To install locally, run:
$ pip -r requirements-dev.txt
### Style
Pytest-falcon uses `isort` and `flake8` to manage style within this
project. There are tests that will fail if these styles are violated.
### Testing Pytest-Falcon
Pytest-Falcon testing is supported by `tox` and `tox` is integrated into
travis.
The expected mechanism for running a test is to simply run `pytest`
within a `virtualenv`:
$ pip install -r requirements-dev.txt
$ pytest
A safer, more robust way of testing is to use `tox`:
$ pip install -r requirements-dev.txt
$ tox