openstack/deb-python-gabbi
Code Issues Proposed changes
RETIRED, further work has moved to Debian project infrastructure
588 Commits 37 Branches 100 Tags 890 KiB
Python 98.7%
Shell 0.8%
Makefile 0.5%
493c58f76d
Go to file
Chris Dent 493c58f76d Handle exceptions when starting fixtures 
Some test runners will swallow exceptions and tracebacks that happen
during the start_fixture method of a Fixture. This can lead to a
great deal of confusion when creating new fixtures. This change
ensures that the traceback is made available by forcing an error to
be reported on the first test in the test suite using the fixture.
Additional detail can be found in the comment associated with the
change.

The added test_suite file tests this change by creating a suite with
two tests that use a fixture that will raise an exception in
start_fixture. The test confirms that the right test is errored,
that both are skipped and that the traceback includes expected
information.

Fixes #199
2017-01-17 14:17:16 +00:00
docs Add a bit of test running arcana to the faq 2017-01-12 13:44:48 +00:00
gabbi Handle exceptions when starting fixtures 2017-01-17 14:17:16 +00:00
.coveragerc Improve coverage testing and handling 2016-12-01 10:49:55 +00:00
.gitignore Improve coverage testing and handling 2016-12-01 10:49:55 +00:00
.testr.conf Add the concept of an inner fixture 2016-09-26 20:39:25 +01:00
.travis.yml Add optional testing of current gabbi with current gnocchi 2017-01-02 14:27:30 +00:00
CONTRIBUTING.md Make pep8 rules more clear in CONTRIBUTING.md 2015-10-11 13:01:21 +01:00
LICENSE clean up some copyright strays 2016-03-05 11:46:26 +00:00
Makefile Force removal of the .tox when doing make clean 2017-01-06 16:19:03 +00:00
README.rst Add testing infrastructure for python 3.6 2017-01-02 12:07:59 +00:00
requirements.txt Use testtools.TestCase instead of TestCaseWithFixtures 2016-09-29 11:02:41 +01:00
setup.cfg Add testing infrastructure for python 3.6 2017-01-02 12:07:59 +00:00
setup.py clean up some copyright strays 2016-03-05 11:46:26 +00:00
test-failskip.sh Fix cookie tests and pep8 2016-05-31 18:14:33 +01:00
test-limit.sh Allow test_loader_name to override test class module (#171) 2016-09-20 19:28:48 +01:00
test-requirements.txt Improve coverage testing and handling 2016-12-01 10:49:55 +00:00
tox.ini Add optional testing of current gabbi with current gnocchi 2017-01-02 14:27:30 +00:00

README.rst

image

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 2.7, 3.4, 3.5, 3.6 and pypy.

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

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

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

tox -epep8,py27,py34 -- test_driver test_handlers

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