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