748eac9d8a
This may not be fully adequate but is a reasonable start. The main point was to indicate the different loader method and the need to yield the generated tests.
2.5 KiB
Test Example
What follows is a commented example of some tests in a single file
demonstrating many of the format features. See Loader,
below, for the Python needed to integrate with a testing harness.
example.yaml
Loader
To run the tests they must be generated in some fashion and then run.
This is accomplished by a test loader. Initially gabbi only supported
those test harnesses that supported the load_tests protocol
in UnitTest. It now possible to also build and run tests with pytest with some limitations described
below.
UnitTest Style Loader
To run the tests with a load_tests style loader a test
file containing a load_tests method is required. That will
look a bit like:
example.py
For details on the arguments available when building tests see ~gabbi.driver.build_tests.
Once the test loader has been created, it needs to be run. There are
many options. Which is appropriate depends very much on your
environment. Here are some examples using unittest or
testtools that require minimal knowledge to get
started.
By file:
python -m testtools.run -v test/test_loader.pyBy module:
python -m testttols.run -v test.test_loader
python -m unittest -v test.test_loaderUsing test discovery to locate all tests in a directory tree:
python -m testtools.run discover
python -m unittest discover testSee the source
distribution and the
tutorial repo for more advanced options, including using
testrepository and subunit.
pytest
Since pytest does not support the load_tests system, a
different way of generating tests is required. A test file must be
created that calls ~gabbi.driver.py_test_generator and yields the
generated tests. That will look a bit like this:
pytest-example.py
This can then be run with the usual pytest commands. For example:
py.test -svx pytest-example.pyWarning
When using the unittest runners, it is possible to select just one test from a YAML file and cause it and all its prior tests to run. This does not work when using pytest. It will traverse the prior tests and then exit after the first one has run. Fixing this is desirable.