openstack/deb-python-gabbi
Code Issues Proposed changes
RETIRED, further work has moved to Debian project infrastructure
290 Commits 37 Branches 100 Tags 890 KiB
Python 98.7%
Shell 0.8%
Makefile 0.5%
8c13ab59d4
Go to file
Chris Dent 8c13ab59d4 Allow envivonment variables to set verbose color 
This is starting to get a bit out of hand now, but is a useful
feature. That is, if we're going to have the general feature of
colored output, then being able to choose, from the calling harness
(often shell scripts) is useful.

Probably useful to merge this soon so that it is out there for
feedback.
2015-08-19 17:08:34 +01:00
docs Clarify query_parameters documentation 2015-08-07 16:45:39 +02:00
gabbi Allow envivonment variables to set verbose color 2015-08-19 17:08:34 +01:00
.gitignore Documentation Updates 2015-06-08 08:39:21 -05:00
.testr.conf Update gabbi driver to reflect new test handling 2014-12-27 18:50:05 +00:00
.travis.yml Ensure the unexpected success works in python3 2015-07-31 14:13:14 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md to give some pull request guidance 2015-08-06 14:23:16 +01:00
LICENSE Use the apache license by reference 2015-07-20 21:23:20 +01:00
Makefile Clean up the clean targets so they get more stuff 2015-05-26 22:29:42 +01:00
README.rst Fix typo 2015-07-14 12:00:25 +02:00
requirements.txt Proof of concept colorization of gabbi-run output 2015-08-06 17:35:33 +01:00
setup.cfg Add a command line to to run yaml-tests from stdin. 2015-04-15 12:55:56 +01:00
setup.py Automate test and build a bit more 2014-12-31 17:01:51 +00:00
test-failskip.sh Make sure all response content marked as JSON is decoded 2015-07-31 15:38:41 +01:00
test-limit.sh Make the test-limit test more robust 2015-02-10 17:09:23 +00:00
test-requirements.txt Adding a tox environment for docs 2015-06-03 15:28:55 -04:00
tox.ini Ensure the unexpected success works in python3 2015-07-31 14:13:14 +01:00

README.rst

image

Documentation Status

Gabbi

Gabbi is a tool for running HTTP tests where requests and responses are represented in a declarative YAML-based form. See the docs for more details on features and formats.

Gabbi is tested with Python 2.7, 3.4 and pypy and pypy3.

Tests can be run using unittest style test runners 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

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,py34

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