Fixtures to use with testsuite. More...
Namespaces | |
namespace | pytest_userver.plugins.core |
Python plugin that provides core fixtures for functional tests with testsuite; see Functional service tests (testsuite) for an introduction. | |
namespace | pytest_userver.plugins.grpc |
Python plugin that provides gRPC fixtures for functional tests with testsuite; see Functional service tests (testsuite) for an introduction. | |
Functions | |
pathlib.Path | pytest_userver.plugins.base.service_source_dir (pytestconfig) |
Returns the path to the service source directory that is set by command line --service-source-dir option. | |
pathlib.Path | pytest_userver.plugins.base.build_dir (pytestconfig) |
Returns the build directory set by command line --build-dir option. | |
pathlib.Path | pytest_userver.plugins.base.service_binary (pytestconfig) |
Returns the path to service binary set by command line --service-binary option. | |
int | pytest_userver.plugins.base.service_port (pytestconfig) |
Returns the main listener port number of the service set by command line --service-port option. | |
int | pytest_userver.plugins.base.monitor_port (pytestconfig) |
Returns the monitor listener port number of the service set by command line --monitor-port option. | |
InvalidationState | pytest_userver.plugins.caches.cache_invalidation_state () |
A fixture for notifying the service of changes in cache data sources. | |
pathlib.Path | pytest_userver.plugins.config.service_config_path (pytestconfig) |
Returns the path to service.yaml file set by command line --service-config option. | |
typing.Optional[pathlib.Path] | pytest_userver.plugins.config.service_config_vars_path (pytestconfig) |
Returns the path to config_vars.yaml file set by command line --service-config-vars option. | |
typing.Optional[pathlib.Path] | pytest_userver.plugins.config.service_secdist_path (pytestconfig) |
Returns the path to secure_data.json file set by command line --service-secdist option. | |
pathlib.Path | pytest_userver.plugins.config.config_fallback_path (pytestconfig) |
Returns the path to dynamic config fallback file set by command line --config-fallback option. | |
def | pytest_userver.plugins.config.service_tmpdir (service_binary, tmp_path_factory) |
Returns the path for temporary files. | |
pathlib.Path | pytest_userver.plugins.config.service_config_path_temp (service_tmpdir, service_config_yaml) |
Dumps the contents of the service_config_yaml into a static config for testsuite and returns the path to the config file. | |
dict | pytest_userver.plugins.config.service_config_yaml (_service_config) |
Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any). | |
dict | pytest_userver.plugins.config.service_config_vars (_service_config) |
Returns the static config variables (config_vars.yaml) values after the USERVER_CONFIG_HOOKS were applied (if any). | |
def | pytest_userver.plugins.config.userver_config_base (service_port, monitor_port) |
Returns a function that adjusts the static configuration file for testsuite. | |
def | pytest_userver.plugins.config.userver_config_logging (pytestconfig) |
Returns a function that adjusts the static configuration file for testsuite. | |
def | pytest_userver.plugins.config.userver_config_testsuite (mockserver_info) |
Returns a function that adjusts the static configuration file for testsuite. | |
def | pytest_userver.plugins.config.userver_config_secdist (service_secdist_path) |
Returns a function that adjusts the static configuration file for testsuite. | |
pathlib.Path | pytest_userver.plugins.dumps.userver_dumps_root (tmp_path_factory) |
The directory which the service will use for cache dumps. | |
def | pytest_userver.plugins.dumps.read_latest_dump (userver_dumps_root) |
Read the latest dump produced by a specified dumper. | |
def | pytest_userver.plugins.dumps.cleanup_userver_dumps (userver_dumps_root, request) |
To avoid leaking dumps between tests, cache_dump_dir must be cleaned after each test. | |
DynamicConfig | pytest_userver.plugins.dynamic_config.dynamic_config (request, search_path, load_json, object_substitute, config_service_defaults, cache_invalidation_state) |
Fixture that allows to control dynamic config values used by the service. | |
typing.Dict[str, typing.Any] | pytest_userver.plugins.dynamic_config.config_service_defaults (config_fallback_path) |
Fixture that returns default values for dynamic config. | |
def | pytest_userver.plugins.dynamic_config.userver_config_dynconf_fallback (pytestconfig, config_fallback_path) |
Returns a function that adjusts the static configuration file for the testsuite. | |
def | pytest_userver.plugins.dynamic_config.userver_config_dynconf_url (mockserver_info) |
Returns a function that adjusts the static configuration file for the testsuite. | |
None | pytest_userver.plugins.dynamic_config.mock_configs_service (mockserver, dynamic_config) |
Adds a mockserver handler that forwards dynamic_config to service's dynamic-config-client component. | |
int | pytest_userver.plugins.grpc_client.grpc_service_port (service_config_yaml) |
Returns the gRPC listener port number of the service that is set in the static configuration file. | |
str | pytest_userver.plugins.grpc_client.grpc_service_endpoint (grpc_service_port) |
Returns the gRPC endpoint of the service. | |
float | pytest_userver.plugins.grpc_client.grpc_service_timeout (pytestconfig) |
Returns the gRPC timeout for the service that is set by the command line option --service-timeout . | |
def | pytest_userver.plugins.grpc_client.grpc_channel (grpc_service_endpoint, grpc_service_deps, grpc_service_timeout, _grpc_session_channel) |
Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture. | |
def | pytest_userver.plugins.grpc_client.grpc_service_deps (service_client) |
gRPC service dependencies hook. | |
str | pytest_userver.plugins.grpc_mockserver.grpc_mockserver_endpoint (pytestconfig, _grpc_mockserver_and_port) |
Returns the gRPC endpoint to start the mocking server that is set by command line --grpc-mockserver-host and --grpc-mockserver-port options. | |
def | pytest_userver.plugins.grpc_mockserver.grpc_mockserver (_grpc_mockserver_and_port) |
Returns the gRPC mocking server. | |
def | pytest_userver.plugins.grpc_mockserver.create_grpc_mock () |
Creates the gRPC mock server for the provided type. | |
def | pytest_userver.plugins.mongo.userver_mongo_config (mongo_connection_info) |
Returns a function that adjusts the static configuration file for the testsuite. | |
def | pytest_userver.plugins.postgresql.userver_pg_config (pgsql_local) |
Returns a function that adjusts the static configuration file for the testsuite. | |
def | pytest_userver.plugins.service.service_env () |
Override this to pass extra environment variables to the service. | |
typing.Optional[str] | pytest_userver.plugins.service.service_http_ping_url (service_config_yaml, service_baseurl) |
Returns the service HTTP ping URL that is used by the testsuite to detect that the service is ready to work. | |
net.HealthChecks | pytest_userver.plugins.service.service_non_http_health_checks (service_config_yaml) |
Returns a health checks info. | |
def | pytest_userver.plugins.service.service_daemon (pytestconfig, create_daemon_scope, service_env, service_http_ping_url, service_config_path_temp, service_config_yaml, service_binary, service_non_http_health_checks, testsuite_logger, _userver_log_handler) |
Configures the health checking to use service_http_ping_url fixture value if it is not None; otherwise uses the service_non_http_health_checks info. | |
None | pytest_userver.plugins.service_client.extra_client_deps () |
Service client dependencies hook. | |
None | pytest_userver.plugins.service_client.auto_client_deps (request) |
Service client dependencies hook that knows about pgsql, mongodb, clickhouse, rabbitmq, redis_store dependencies. | |
client.Client | pytest_userver.plugins.service_client.service_client (ensure_daemon_started, service_daemon, mock_configs_service, cleanup_userver_dumps, extra_client_deps, auto_client_deps, client.TestsuiteClientConfig _testsuite_client_config, _service_client_base, _service_client_testsuite) |
Main fixture that provides access to userver based service. | |
client.ClientMonitor | pytest_userver.plugins.service_client.monitor_client (service_client, service_client_options, mockserver, str monitor_baseurl, client.TestsuiteClientConfig _testsuite_client_config) |
Main fixture that provides access to userver monitor listener. | |
str | pytest_userver.plugins.service_client.service_baseurl (service_port) |
Returns the main listener URL of the service. | |
str | pytest_userver.plugins.service_client.monitor_baseurl (monitor_port) |
Returns the main monitor URL of the service. | |
def | pytest_userver.plugins.testpoint.userver_config_testpoint (mockserver_info) |
Returns a function that adjusts the static configuration file for the testsuite. | |
Fixtures to use with testsuite.
None pytest_userver.plugins.service_client.auto_client_deps | ( | request | ) |
Service client dependencies hook that knows about pgsql, mongodb, clickhouse, rabbitmq, redis_store dependencies.
To add some other dependencies prefer overriding the client_deps() fixture.
Definition at line 32 of file service_client.py.
pathlib.Path pytest_userver.plugins.base.build_dir | ( | pytestconfig | ) |
InvalidationState pytest_userver.plugins.caches.cache_invalidation_state | ( | ) |
def pytest_userver.plugins.dumps.cleanup_userver_dumps | ( | userver_dumps_root, | |
request | |||
) |
To avoid leaking dumps between tests, cache_dump_dir must be cleaned after each test.
To observe the dumps, add a final time.sleep(1000000)
to your test locally. The returned function may also be used to clean dumps manually as appropriate.
pathlib.Path pytest_userver.plugins.config.config_fallback_path | ( | pytestconfig | ) |
typing.Dict[str, typing.Any] pytest_userver.plugins.dynamic_config.config_service_defaults | ( | config_fallback_path | ) |
Fixture that returns default values for dynamic config.
You may override it in your local conftest.py or fixture:
Definition at line 126 of file dynamic_config.py.
def pytest_userver.plugins.grpc_mockserver.create_grpc_mock | ( | ) |
Creates the gRPC mock server for the provided type.
Definition at line 104 of file grpc_mockserver.py.
DynamicConfig pytest_userver.plugins.dynamic_config.dynamic_config | ( | request, | |
search_path, | |||
load_json, | |||
object_substitute, | |||
config_service_defaults, | |||
cache_invalidation_state | |||
) |
Fixture that allows to control dynamic config values used by the service.
After change to the config, be sure to call:
HTTP client requests call it automatically before each request.
Definition at line 83 of file dynamic_config.py.
None pytest_userver.plugins.service_client.extra_client_deps | ( | ) |
Service client dependencies hook.
Feel free to override, e.g.:
Definition at line 18 of file service_client.py.
def pytest_userver.plugins.grpc_client.grpc_channel | ( | grpc_service_endpoint, | |
grpc_service_deps, | |||
grpc_service_timeout, | |||
_grpc_session_channel | |||
) |
Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture.
Definition at line 67 of file grpc_client.py.
def pytest_userver.plugins.grpc_mockserver.grpc_mockserver | ( | _grpc_mockserver_and_port | ) |
Returns the gRPC mocking server.
Override this fixture to change the way the gRPC mocking server is started by the testsuite.
Definition at line 82 of file grpc_mockserver.py.
str pytest_userver.plugins.grpc_mockserver.grpc_mockserver_endpoint | ( | pytestconfig, | |
_grpc_mockserver_and_port | |||
) |
Returns the gRPC endpoint to start the mocking server that is set by command line --grpc-mockserver-host
and --grpc-mockserver-port
options.
Override this fixture to change the way the gRPC endpoint is detected by the testsuite.
Definition at line 59 of file grpc_mockserver.py.
def pytest_userver.plugins.grpc_client.grpc_service_deps | ( | service_client | ) |
gRPC service dependencies hook.
Feel free to override it.
Definition at line 93 of file grpc_client.py.
str pytest_userver.plugins.grpc_client.grpc_service_endpoint | ( | grpc_service_port | ) |
Returns the gRPC endpoint of the service.
Override this fixture to change the way the gRPC endpoint is retrieved by the testsuite for tests.
Definition at line 34 of file grpc_client.py.
int pytest_userver.plugins.grpc_client.grpc_service_port | ( | service_config_yaml | ) |
Returns the gRPC listener port number of the service that is set in the static configuration file.
Override this fixture to change the way the gRPC listener port number is retrieved by the testsuite for tests.
Definition at line 17 of file grpc_client.py.
float pytest_userver.plugins.grpc_client.grpc_service_timeout | ( | pytestconfig | ) |
Returns the gRPC timeout for the service that is set by the command line option --service-timeout
.
Override this fixture to change the way the gRPC timeout is set.
Definition at line 47 of file grpc_client.py.
None pytest_userver.plugins.dynamic_config.mock_configs_service | ( | mockserver, | |
dynamic_config | |||
) |
Adds a mockserver handler that forwards dynamic_config to service's dynamic-config-client
component.
Definition at line 225 of file dynamic_config.py.
str pytest_userver.plugins.service_client.monitor_baseurl | ( | monitor_port | ) |
Returns the main monitor URL of the service.
Override this fixture to change the main monitor URL that the testsuite uses for tests.
Definition at line 173 of file service_client.py.
client.ClientMonitor pytest_userver.plugins.service_client.monitor_client | ( | service_client, | |
service_client_options, | |||
mockserver, | |||
str | monitor_baseurl, | ||
client.TestsuiteClientConfig | _testsuite_client_config | ||
) |
Main fixture that provides access to userver monitor listener.
Definition at line 96 of file service_client.py.
int pytest_userver.plugins.base.monitor_port | ( | pytestconfig | ) |
def pytest_userver.plugins.dumps.read_latest_dump | ( | userver_dumps_root | ) |
str pytest_userver.plugins.service_client.service_baseurl | ( | service_port | ) |
Returns the main listener URL of the service.
Override this fixture to change the main listener URL that the testsuite uses for tests.
Definition at line 160 of file service_client.py.
pathlib.Path pytest_userver.plugins.base.service_binary | ( | pytestconfig | ) |
client.Client pytest_userver.plugins.service_client.service_client | ( | ensure_daemon_started, | |
service_daemon, | |||
mock_configs_service, | |||
cleanup_userver_dumps, | |||
extra_client_deps, | |||
auto_client_deps, | |||
client.TestsuiteClientConfig | _testsuite_client_config, | ||
_service_client_base, | |||
_service_client_testsuite | |||
) |
Main fixture that provides access to userver based service.
Definition at line 68 of file service_client.py.
pathlib.Path pytest_userver.plugins.config.service_config_path | ( | pytestconfig | ) |
pathlib.Path pytest_userver.plugins.config.service_config_path_temp | ( | service_tmpdir, | |
service_config_yaml | |||
) |
dict pytest_userver.plugins.config.service_config_vars | ( | _service_config | ) |
typing.Optional[pathlib.Path] pytest_userver.plugins.config.service_config_vars_path | ( | pytestconfig | ) |
dict pytest_userver.plugins.config.service_config_yaml | ( | _service_config | ) |
def pytest_userver.plugins.service.service_daemon | ( | pytestconfig, | |
create_daemon_scope, | |||
service_env, | |||
service_http_ping_url, | |||
service_config_path_temp, | |||
service_config_yaml, | |||
service_binary, | |||
service_non_http_health_checks, | |||
testsuite_logger, | |||
_userver_log_handler | |||
) |
Configures the health checking to use service_http_ping_url fixture value if it is not None; otherwise uses the service_non_http_health_checks info.
Starts the service daemon.
Definition at line 132 of file service.py.
def pytest_userver.plugins.service.service_env | ( | ) |
Override this to pass extra environment variables to the service.
Definition at line 84 of file service.py.
typing.Optional[str] pytest_userver.plugins.service.service_http_ping_url | ( | service_config_yaml, | |
service_baseurl | |||
) |
Returns the service HTTP ping URL that is used by the testsuite to detect that the service is ready to work.
Returns None if there's no such URL.
By default attempts to find server::handlers::Ping component by "handler-ping" name in static config. Override this fixture to change the behavior.
Definition at line 95 of file service.py.
net.HealthChecks pytest_userver.plugins.service.service_non_http_health_checks | ( | service_config_yaml | ) |
Returns a health checks info.
By default returns pytest_userver.utils.net.get_health_checks_info().
Override this fixture to change the way testsuite detects the tested service being alive.
Definition at line 116 of file service.py.
int pytest_userver.plugins.base.service_port | ( | pytestconfig | ) |
typing.Optional[pathlib.Path] pytest_userver.plugins.config.service_secdist_path | ( | pytestconfig | ) |
pathlib.Path pytest_userver.plugins.base.service_source_dir | ( | pytestconfig | ) |
def pytest_userver.plugins.config.service_tmpdir | ( | service_binary, | |
tmp_path_factory | |||
) |
def pytest_userver.plugins.config.userver_config_base | ( | service_port, | |
monitor_port | |||
) |
Returns a function that adjusts the static configuration file for testsuite.
Sets the server.listener.port
to listen on service_port fixture value; sets the server.listener-monitor.port
to listen on monitor_port fixture value.
def pytest_userver.plugins.dynamic_config.userver_config_dynconf_fallback | ( | pytestconfig, | |
config_fallback_path | |||
) |
Returns a function that adjusts the static configuration file for the testsuite.
Sets the fallback-path
of the dynamic-config-fallbacks
and dynamic-config-fallbacks
to the value of config_fallback_path fixture.
Definition at line 174 of file dynamic_config.py.
def pytest_userver.plugins.dynamic_config.userver_config_dynconf_url | ( | mockserver_info | ) |
Returns a function that adjusts the static configuration file for the testsuite.
Sets the dynamic-config-client.config-url
to the value of mockserver configs-service, so that the mock_configs_service fixture could work.
Definition at line 203 of file dynamic_config.py.
def pytest_userver.plugins.config.userver_config_logging | ( | pytestconfig | ) |
def pytest_userver.plugins.config.userver_config_secdist | ( | service_secdist_path | ) |
Returns a function that adjusts the static configuration file for testsuite.
Sets the default-secdist-provider.config
to the value of service_secdist_path fixture.
def pytest_userver.plugins.testpoint.userver_config_testpoint | ( | mockserver_info | ) |
Returns a function that adjusts the static configuration file for the testsuite.
Sets the tests-control.skip-unregistered-testpoints
to True
.
Definition at line 53 of file testpoint.py.
def pytest_userver.plugins.config.userver_config_testsuite | ( | mockserver_info | ) |
pathlib.Path pytest_userver.plugins.dumps.userver_dumps_root | ( | tmp_path_factory | ) |
def pytest_userver.plugins.mongo.userver_mongo_config | ( | mongo_connection_info | ) |
def pytest_userver.plugins.postgresql.userver_pg_config | ( | pgsql_local | ) |
Returns a function that adjusts the static configuration file for the testsuite.
Sets the dbconnection
to the testsuite started PostgreSQL credentials if there's only one dbconnection
in static config.
Definition at line 19 of file postgresql.py.