gabbi Package¶
case
Module¶
driver
Module¶
suitemaker
Module¶
fixture
Module¶
Manage fixtures for gabbi at the test suite level.
-
class
gabbi.fixture.
GabbiFixture
¶ Bases:
object
A context manager that operates as a fixture.
Subclasses must implement
start_fixture
andstop_fixture
, each of which contain the logic for stopping and starting whatever the fixture is. What a fixture is is left as an exercise for the implementor.These context managers will be nested so any actual work needs to happen in
start_fixture
andstop_fixture
and not in__init__
. Otherwise exception handling will not work properly.-
start_fixture
()¶ Implement the actual workings of starting the fixture here.
-
stop_fixture
()¶ Implement the actual workings of stopping the fixture here.
-
-
exception
gabbi.fixture.
GabbiFixtureError
¶ Bases:
exceptions.Exception
Generic exception for GabbiFixture.
-
class
gabbi.fixture.
SkipAllFixture
¶ Bases:
gabbi.fixture.GabbiFixture
A fixture that skips all the tests in the current suite.
-
start_fixture
()¶
-
-
gabbi.fixture.
nest
(*args, **kwds)¶ Nest a series of fixtures.
This is duplicated from
nested
in the stdlib, which has been deprecated because of issues with how exceptions are difficult to handle during__init__
. Gabbi needs to nest an unknown number of fixtures dynamically, so thewith
syntax that replacesnested
will not work.
handlers
Module¶
Handlers for processing the body of a response in various ways.
-
class
gabbi.handlers.
ForbiddenHeadersResponseHandler
(test_class)¶ Bases:
gabbi.handlers.ResponseHandler
Test that listed headers are not in the response.
-
action
(test, forbidden, value=None)¶
-
test_key_suffix
= 'forbidden_headers'¶
-
test_key_value
= []¶
-
-
class
gabbi.handlers.
HeadersResponseHandler
(test_class)¶ Bases:
gabbi.handlers.ResponseHandler
Compare expected headers with actual headers.
If a header value is wrapped in
/
it is treated as a raw regular expression.Headers values are always treated as strings.
-
action
(test, header, value=None)¶
-
test_key_suffix
= 'headers'¶
-
test_key_value
= {}¶
-
-
class
gabbi.handlers.
JSONResponseHandler
(test_class)¶ Bases:
gabbi.handlers.ResponseHandler
Test for matching json paths in the json_data.
-
action
(test, path, value=None)¶ Test json_paths against json data.
-
test_key_suffix
= 'json_paths'¶
-
test_key_value
= {}¶
-
-
class
gabbi.handlers.
ResponseHandler
(test_class)¶ Bases:
object
Add functionality for making assertions about an HTTP response.
A subclass may implement two methods:
action
andpreprocess
.preprocess
takes one argument, theTestCase
. It is called exactly once for each test before looping across the assertions. It is used, rarely, to copy thetest.output
into a useful form (such as a parsed DOM).action
takes two or three arguments. Iftest_key_value
is a listaction
is called with the test case and a single list item. Iftest_key_value
is a dict thenaction
is called with the test case and a key and value pair.-
action
(test, item, value=None)¶ Test an individual entry for this response handler.
If the entry is a key value pair the key is in item and the value in value. Otherwise the entry is considered a single item from a list.
-
preprocess
(test)¶ Do any pre-single-test preprocessing.
-
test_key_suffix
= ''¶
-
test_key_value
= []¶
-
-
class
gabbi.handlers.
StringResponseHandler
(test_class)¶ Bases:
gabbi.handlers.ResponseHandler
Test for matching strings in the the response body.
-
action
(test, expected, value=None)¶
-
test_key_suffix
= 'strings'¶
-
test_key_value
= []¶
-
suite
Module¶
A TestSuite for containing gabbi tests.
This suite has two features: the contained tests are ordered and there are suite-level fixtures that operate as context managers.
-
class
gabbi.suite.
GabbiSuite
(tests=())¶ Bases:
unittest.suite.TestSuite
A TestSuite with fixtures.
The suite wraps the tests with a set of nested context managers that operate as fixtures.
If a fixture raises unittest.case.SkipTest during setup, all the tests in this suite will be skipped.
-
run
(result, debug=False)¶ Override TestSuite run to start suite-level fixtures.
To avoid exception confusion, use a null Fixture when there are no fixtures.
-
start
(result)¶ Start fixtures when using pytest.
-
stop
()¶ Stop fixtures when using pytest.
-
-
gabbi.suite.
noop
(*args)¶ A noop method used to disable collected tests.
runner
Module¶
reporter
Module¶
utils
Module¶
Utility functions grab bag.
-
gabbi.utils.
create_url
(base_url, host, port=None, prefix='', ssl=False)¶ Given pieces of a path-based url, return a fully qualified url.
-
gabbi.utils.
decode_response_content
(header_dict, content)¶ Decode content to a proper string.
-
gabbi.utils.
extract_content_type
(header_dict, default='application/binary')¶ Extract parsed content-type from headers.
-
gabbi.utils.
get_colorizer
(stream)¶ Return a function to colorize a string.
Only if stream is a tty .
-
gabbi.utils.
host_info_from_target
(target, prefix=None)¶ Turn url or host:port and target into test destination.
-
gabbi.utils.
load_yaml
(handle=None, yaml_file=None)¶ Read and parse any YAML file or filehandle.
Let exceptions flow where they may.
If no file or handle is provided, read from STDIN.
-
gabbi.utils.
not_binary
(content_type)¶ Decide if something is content we’d like to treat as a string.
-
gabbi.utils.
parse_content_type
(content_type, default_charset='utf-8')¶ Parse content type value for media type and charset.
exception
Module¶
Gabbi specific exceptions.
-
exception
gabbi.exception.
GabbiFormatError
¶ Bases:
exceptions.ValueError
An exception to encapsulate poorly formed test data.
-
exception
gabbi.exception.
GabbiSyntaxWarning
¶ Bases:
exceptions.SyntaxWarning
A warning about syntax that is not desirable.