Skip to main content

Declarative HTTP testing library

Project description

https://github.com/cdent/gabbi/workflows/tests/badge.svg Documentation Status

Gabbi

Release Notes

Gabbi is a tool for running HTTP tests where requests and responses are represented in a declarative YAML-based form. The simplest test looks like this:

tests:
- name: A test
  GET: /api/resources/id

See the docs for more details on the many features and formats for setting request headers and bodies and evaluating responses.

Gabbi is tested with Python 3.9, 3.10, 3.11, 3.12, 3.13 and pypy3.10.

Tests can be run using unittest style test runners, pytest or from the command line with a gabbi-run script.

There is a gabbi-demo repository which provides a tutorial via its commit history. The demo builds a simple API using gabbi to facilitate test driven development.

Purpose

Gabbi works to bridge the gap between human readable YAML files that represent HTTP requests and expected responses and the obscured realm of Python-based, object-oriented unit tests in the style of the unittest module and its derivatives.

Each YAML file represents an ordered list of HTTP requests along with the expected responses. This allows a single file to represent a process in the API being tested. For example:

  • Create a resource.

  • Retrieve a resource.

  • Delete a resource.

  • Retrieve a resource again to confirm it is gone.

At the same time it is still possible to ask gabbi to run just one request. If it is in a sequence of tests, those tests prior to it in the YAML file will be run (in order). In any single process any test will only be run once. Concurrency is handled such that one file runs in one process.

These features mean that it is possible to create tests that are useful for both humans (as tools for improving and developing APIs) and automated CI systems.

Testing and Developing Gabbi

To get started, after cloning the repository, you should install the development dependencies:

$ pip install -r requirements-dev.txt

If you prefer to keep things isolated you can create a virtual environment:

$ virtualenv gabbi-venv
$ . gabbi-venv/bin/activate
$ pip install -r requirements-dev.txt

Gabbi is set up to be developed and tested using tox (installed via requirements-dev.txt). To run the built-in tests (the YAML files are in the directories gabbi/tests/gabbits_* and loaded by the file gabbi/test_*.py), you call tox:

tox -epep8,py311

If you have the dependencies installed (or a warmed up virtualenv) you can run the tests by hand and exit on the first failure:

python -m subunit.run discover -f gabbi | subunit2pyunit

Testing can be limited to individual modules by specifying them after the tox invocation:

tox -epep8,py311 -- test_driver test_handlers

If you wish to avoid running tests that connect to internet hosts, set GABBI_SKIP_NETWORK to True.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gabbi-4.1.1.tar.gz (223.4 kB view details)

Uploaded Source

Built Distribution

gabbi-4.1.1-py3-none-any.whl (216.1 kB view details)

Uploaded Python 3

File details

Details for the file gabbi-4.1.1.tar.gz.

File metadata

  • Download URL: gabbi-4.1.1.tar.gz
  • Upload date:
  • Size: 223.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.16

File hashes

Hashes for gabbi-4.1.1.tar.gz
Algorithm Hash digest
SHA256 0df4135681ff26487ff4e76ae7fa8260ebdc82100e5ba52a6a9645ef8a5bfce0
MD5 9b77832edcb9256d0d1d8b031e74a594
BLAKE2b-256 03e5736b73c0a205aedfd5d271ae1b49d25f2af5214b5c2afc58882032dbf845

See more details on using hashes here.

File details

Details for the file gabbi-4.1.1-py3-none-any.whl.

File metadata

  • Download URL: gabbi-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 216.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.16

File hashes

Hashes for gabbi-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72fd65f52e8602df294b64af10330a601f87f36f57128b8c949031262cb22426
MD5 26150a663c51f424db7f1ef5cce83b41
BLAKE2b-256 13228494e040a07f1dc734fbc90633f76a6e04debaafdf6f6693398fd6fd7bba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page