https://github.com/cdent/gabbi

Declarative HTTP Testing for Python and anything else
https://github.com/cdent/gabbi

api http python test-automation test-driven-development testing

Last synced: about 1 month ago
JSON representation

Declarative HTTP Testing for Python and anything else

• Host: GitHub
• URL: https://github.com/cdent/gabbi
• Owner: cdent
• License: other
• Created: 2014-12-12T14:46:59.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-05-30T16:02:41.000Z (7 months ago)
• Last Synced: 2024-10-29T03:39:00.267Z (about 2 months ago)
• Topics: api, http, python, test-automation, test-driven-development, testing
• Language: Python
• Homepage: http://gabbi.readthedocs.org/
• Size: 1.16 MB
• Stars: 148
• Watchers: 7
• Forks: 34
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - gabbi - Declarative HTTP Testing for Python and anything else (Python)
• best-of-web-python - GitHub - 13% open · ⏱️ 16.03.2024): (Web Testing)

README

        
.. image:: https://github.com/cdent/gabbi/workflows/tests/badge.svg

    :target: https://github.com/cdent/gabbi/actions

.. image:: https://readthedocs.org/projects/gabbi/badge/?version=latest

    :target: https://gabbi.readthedocs.io/en/latest/

    :alt: 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 3.7, 3.8, 3.9, 3.10, 3.11, 3.12 and pypy3.

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.

.. _Release Notes: https://gabbi.readthedocs.io/en/latest/release.html

.. _docs: https://gabbi.readthedocs.io/

.. _gabbi-demo: https://github.com/cdent/gabbi-demo

.. _unittest: https://gabbi.readthedocs.io/en/latest/example.html#loader

.. _pytest: http://pytest.org/

.. _loader docs: https://gabbi.readthedocs.io/en/latest/example.html#pytest

.. _gabbi-run: https://gabbi.readthedocs.io/en/latest/runner.html

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 and Developing Gabbi

----------------------------

To get started, after cloning the `repository`_, you should install the

development dependencies::

    $ pip install -r requirements-dev.txt

If you prefer to keep things isolated you can create a virtual

environment::

    $ virtualenv gabbi-venv

    $ . gabbi-venv/bin/activate

    $ pip install -r requirements-dev.txt

Gabbi is set up to be developed and tested using `tox`_ (installed via

``requirements-dev.txt``). To run the built-in tests (the YAML files

are in the directories ``gabbi/tests/gabbits_*`` and loaded by the file

``gabbi/test_*.py``), you call ``tox``::

    tox -epep8,py37

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,py37 -- test_driver test_handlers

If you wish to avoid running tests that connect to internet hosts,

set ``GABBI_SKIP_NETWORK`` to ``True``.

.. _tox: https://tox.readthedocs.io/

.. _repository: https://github.com/cdent/gabbi