2. API Reference

This section describes the API of the pytest-easy-server package. The API is kept stable using the compatibility rules defined for semantic versioning. An exception to this rule are fixes for security issues.

Any functions not described in this section are considered internal and may change incompatibly without warning.

2.1. es_server fixture

pytest_easy_server.es_server(request)[source]

Pytest fixture representing a server item from an ‘easy-server’ file as a easy_server.Server object.

Pytest invokes testcases using this fixture for all servers to test against.

The servers are defined in a Server file and vault file. The servers to test against are controlled with pytest command line options as described in Controlling which servers to test against.

Returns

Server item for each server to test against.

Return type

easy_server.Server

2.2. Package version

pytest_easy_server.__version__ = '0.8.0'

The full version of this package including any development levels, as a string.

Possible formats for this version string are:

  • “M.N.P.dev1”: Development level 1 of a not yet released version M.N.P

  • “M.N.P”: A released version M.N.P