Skip to main content

Declarative HTTP testing library

Project description

https://travis-ci.org/cdent/gabbi.svg?branch=master Documentation Status

gabbi

Gabbi is a tool for running HTTP tests where requests and responses are represented in a declarative form.

It is under active development. See the YAML files for examples of working tests and the docs for more details on features and formats.

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

To run the built in tests (the YAML files are in the directories gabbi/gabbits_* and loaded by the file gabbi/test_*.py), you can use tox:

tox -epep8,py27,py33

Or 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

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-0.3.3.tar.gz (138.3 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: gabbi-0.3.3.tar.gz
  • Upload date:
  • Size: 138.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gabbi-0.3.3.tar.gz
Algorithm Hash digest
SHA256 3653865f521846dbcebe743db554f0e10077fc3119e61cb530b60cb385b70c5f
MD5 1dcfcc7b306f7c2ee2177e3f61967a32
BLAKE2b-256 9592058e4e7ab8e1026ab3f1a7bdcd7b7cd471123ee35ce6abdb9a79ba87ba72

See more details on using hashes here.

Provenance

Supported by

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