Testing¶

gazebo.testing — a pytest plugin for asserting the OGC-ness of a service declaratively: problem/link assertions, a pagination driver, and fixtures. Requires the gazebo[test] extra.

What the plugin provides¶

Testing an OGC-style service means checking the same shapes over and over: errors are problem+json, envelopes carry the right links, pagination follows next to the end without looping. gazebo.testing packages those checks so each test states the intent instead of re-walking the JSON. It gives you three kinds of thing:

• Assertions — assert_problem, assert_has_link, and the non-asserting find_link. They check both content-type and document shape, and return the matched value for further assertions.
• A pagination driver — drive_pagination follows next links to exhaustion, accumulates the items, asserts the envelope invariants on every page, and guards against a runaway/looping link. GET and POST.
• Fixtures — opt-in gazebo_link_context (contextvar isolation) and gazebo_overrides (a fresh Overrides).

Everything is a plain importable function plus opt-in fixtures — nothing is autouse, nothing runs unless you ask for it.

Opting in¶

The helpers would work as ordinary functions, but registering gazebo.testing as a pytest plugin buys one thing you can't get otherwise: pytest rewrites the assert statements inside the helpers. A failed assert_has_link or assert_problem then shows pytest's full introspection — the actual links present, the actual status — not just a hand-written message string.

It does not auto-register (an entry-point plugin would import gazebo, and impose its fixtures, on every downstream pytest session). Opt in with one line in your top-level conftest.py:

pytest_plugins = ['gazebo.testing']

That enables the fixtures and the assertion rewriting. (Confirm with pytest --fixtures | grep gazebo.) The assertion functions are importable and usable without opting in — you just miss the rewritten failure output.

In this section¶

• Assertions — assert_problem, assert_has_link, find_link.
• Pagination driver — drive_pagination and its invariants.
• Fixtures — gazebo_link_context, gazebo_overrides.

The garden example uses all of these in its own test suite.

Reference¶

See gazebo.testing.