pytest-easy-server - Pytest plugin for easy testing against servers¶
The pytest-easy-server package is a Pytest plugin that provides a
Pytest fixture fixture es_server()
that resolves
to the set of servers the tests should run against.
The set of servers is defined in a server file (aka “easy-server file”) and the secrets to access the servers are defined in a vault file that is referenced by the server file, in the formats defined by the easy-server package.
The files to use and the server or group nickname to select for the test, as well as a schema file for validating the user-defined structure of certain properties in the server and vault files, can be specified in pytest options added by the plugin:
--es-file=FILE
Path name of the easy-server file to be used.
Default: es_server.yml in current directory.
--es-nickname=NICKNAME
Nickname of the server or server group to test against.
Default: The default from the server file.
--es-schema-file=FILE
Path name of the schema file to be used for validating the structure of
user-defined properties in the easy-server server and vault files.
Default: No validation.
--es-encrypted Require that the vault file (if specified) is encrypted and error out otherwise.
Default: Tolerate unencrypted vault file.
- 1. Usage
- 1.1. Supported environments
- 1.2. Installation
- 1.3. Server file and vault file
- 1.4. Using the es_server fixture
- 1.5. Example pytest runs
- 1.6. Controlling which servers to test against
- 1.7. Requiring that the vault file is encrypted
- 1.8. Validating user-defined extensions in server and vault files
- 1.9. Running pytest as a developer
- 1.10. Running pytest in a CI/CD system
- 1.11. Security aspects
- 1.12. Derived Pytest fixtures
- 2. API Reference
- 3. Development
- 4. Appendix
- 5. Change log