Preacher: Web API Verification without Coding
Preacher verifies API servers, which requests to the servers and verify the responses along to given scenarios.
Test scenarios are written only in YAML declaratively, without coding. In spite of that, Preacher can validate your web API flexibly, which enables you to test using real (neither mocks nor sandboxes) backends.
- Responses are analyzed jq or XPath queries
- Validation rules are based on Hamcrest (implemented by PyHamcrest).
The full documentation is available at preacher.readthedocs.io.
Targets
- Flexible validation to test with real backends: neither mocks nor sandboxes.
- Matcher-based validation.
- CI Friendly to automate easily.
- A CLI application and YAML-based scenarios.
Usage
First, install Preacher.
The most basic way to install Preacher is using pip. Supports only Python 3.7+.
$ pip install preacher
$ preacher-cli --version
Instead of pip, Docker images are also available on
Docker Hub
as ymoch/preacher.
By default, the container working directory is /work,
and the host directory may be mounted here.
$ docker pull ymock/preacher
$ docker run -v $PWD:/work ymoch/preacher preacher-cli --version
Second, write your own scenario.
# scenario.yml
label: An example of a scenario
cases:
- label: An example of a case
request: /path/to/foo
response:
status_code: 200
body:
- describe: .foo
should:
equal: bar
Then, run preacher-cli command.
$ preacher-cli -u http://your.domain.com/base scenario.yml
For more information such as grammer of scenarios, see the full documentation.
License
Copyright (c) 2019 Yu MOCHIZUKI
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file preacher-0.14.9.tar.gz.
File metadata
- Download URL: preacher-0.14.9.tar.gz
- Upload date:
- Size: 35.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.0.9 CPython/3.7.8 Linux/4.15.0-1077-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3883ce08ada3f91b0b6ace96472f9a8e44bce89eaa7f22c546abc57f264eb8a
|
|
| MD5 |
0b2478ccc437efac22f25731e5c9bd84
|
|
| BLAKE2b-256 |
5d716213b9895bb85b3f4afd61c9c2b398c1ce3d8aaa1afd36bfbaaf107bdc52
|
File details
Details for the file preacher-0.14.9-py3-none-any.whl.
File metadata
- Download URL: preacher-0.14.9-py3-none-any.whl
- Upload date:
- Size: 61.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/1.0.9 CPython/3.7.8 Linux/4.15.0-1077-aws
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6e2f810d1b5675268c1b47dcab8d8fca3f625ceb636daf151daab6c827ba2ef6
|
|
| MD5 |
71d13ad7fcf5b19ba98e79f1fa1198d5
|
|
| BLAKE2b-256 |
9fbf56eb1390aebdf1db789e41a095ab02bf92319badb1dc59508fce3f4d9509
|
