Fixtures to use with testsuite.
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. | |
namespace | pytest_userver.plugins.ydb |
pytest plugin that provides YDB fixtures for functional tests with testsuite; see YDB 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, _original_service_config, choose_free_port) |
Returns the main listener port number of the service set by command line --service-port option. | |
int | pytest_userver.plugins.base.monitor_port (pytestconfig, _original_service_config, choose_free_port) |
Returns the monitor listener port number of the service set by command line --monitor-port option. | |
Callable[[Optional[int]], int] | pytest_userver.plugins.base.choose_free_port () |
Returns a function that chooses a free port based on the hint given in the parameter. | |
InvalidationState | pytest_userver.plugins.caches.cache_invalidation_state () |
A fixture for notifying the service of changes in cache data sources. | |
CacheControl | pytest_userver.plugins.caches.userver_cache_control (_userver_cache_control_context, _userver_cache_fixtures, request) |
Userver cache control handler. | |
pathlib.Path | pytest_userver.plugins.config.service_config_path (pytestconfig, service_binary) |
Returns the path to service.yaml file set by command line --service-config option. | |
pathlib.Path | pytest_userver.plugins.config.db_dump_schema_path (service_binary, service_tmpdir) |
Runs the service binary with --dump-db-schema argument, dumps the 0_db_schema.sql file with database schema and returns path to it. | |
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. | |
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. | |
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, service_config_yaml, service_config_vars) |
Dumps the contents of the service_config_yaml and service_config_vars into a static config for testsuite and returns the path to the config file. | |
dict | pytest_userver.plugins.config.service_config_yaml (_service_config_hooked) |
Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any). | |
dict | pytest_userver.plugins.config.service_config_vars (_service_config_hooked) |
Returns the static config variables (config_vars.yaml) values after the USERVER_CONFIG_HOOKS were applied (if any). | |
Callable[[Any, dict], Any] | pytest_userver.plugins.config.substitute_config_vars (service_env) |
A function that takes config_yaml , config_vars and applies all substitutions just like the service would. | |
dict | pytest_userver.plugins.config.service_config (service_config_yaml, service_config_vars, substitute_config_vars) |
Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any) and with all the '$', environment and fallback variables substituted. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_substitutions (_service_config_substitution_vars) |
Replaces substitution vars in all strings within config_vars using string.Template.substitute. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_http_server (service_port, monitor_port) |
Returns a function that adjusts the static configuration file for testsuite. | |
List[str] | pytest_userver.plugins.config.allowed_url_prefixes_extra () |
By default, userver HTTP client is only allowed to talk to mockserver when running in testsuite. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_http_client (mockserver_info, mockserver_ssl_info, allowed_url_prefixes_extra) |
Returns a function that adjusts the static configuration file for testsuite. | |
str | pytest_userver.plugins.config.userver_default_log_level () |
Default log level to use in userver if no command line option was provided. | |
str | pytest_userver.plugins.config.userver_log_level (pytestconfig, userver_default_log_level) |
Returns –service-log-level value if provided, otherwise returns userver_default_log_level() value from fixture. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_logging (userver_log_level, _service_logfile_path) |
Returns a function that adjusts the static configuration file for testsuite. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_logging_otlp () |
Returns a function that adjusts the static configuration file for testsuite. | |
ServiceConfigPatch | pytest_userver.plugins.config.userver_config_testsuite (pytestconfig, mockserver_info) |
Returns a function that adjusts the static configuration file for testsuite. | |
ServiceConfigPatch | 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. | |
pytest_userver.plugins.dumps.read_latest_dump (userver_dumps_root) | |
Read the latest dump produced by a specified dumper. | |
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, object_substitute, cache_invalidation_state, _dynamic_config_defaults_storage, config_service_defaults, dynamic_config_changelog, _dynconf_load_json_cached, dynconf_cache_names) |
Fixture that allows to control dynamic config values used by the service. | |
ConfigDict | pytest_userver.plugins.dynamic_config.dynamic_config_fallback_patch () |
Override this fixture to replace some dynamic config values specifically for testsuite tests: | |
ConfigDict | pytest_userver.plugins.dynamic_config.config_service_defaults (config_fallback_path, dynamic_config_fallback_patch) |
Fixture that returns default values for dynamic config. | |
pytest_userver.plugins.dynamic_config.userver_config_dynconf_cache (service_tmpdir) | |
Returns a function that adjusts the static configuration file for the testsuite. | |
pytest_userver.plugins.dynamic_config.userver_config_dynconf_fallback (config_service_defaults) | |
Returns a function that adjusts the static configuration file for the testsuite. | |
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, DynamicConfig dynamic_config, _Changelog dynamic_config_changelog) |
Adds a mockserver handler that forwards dynamic_config to service's dynamic-config-client component. | |
Optional[int] | pytest_userver.plugins.grpc.client.grpc_service_port (service_config) |
Returns the gRPC listener port number of the service that is set in the static configuration file. | |
int | pytest_userver.plugins.grpc.client.grpc_service_port_fallback () |
Returns the gRPC port that should be used in service runner mode in case no port is specified in the source config_yaml. | |
str | pytest_userver.plugins.grpc.client.grpc_service_endpoint (service_config, 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 . | |
Callable[[grpc.aio.ClientCallDetails, MessageOrStream], Awaitable[None]] | pytest_userver.plugins.grpc.client.grpc_client_prepare (service_client, asyncexc_check) |
Returns the function that will be called in before each gRPC request, client-side. | |
pytest_userver.plugins.grpc.client.grpc_channel (service_client, grpc_service_endpoint, grpc_service_timeout, grpc_session_channel, _grpc_channel_interceptor, grpc_client_prepare, _grpc_channel_interceptor_asyncexc, asyncexc_check) | |
Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture. | |
Optional[pathlib.Path] | pytest_userver.plugins.grpc.client.grpc_socket_path () |
Path for the UNIX socket over which testsuite will talk to the gRPC service, if it chooses to use a UNIX socket. | |
pytest_userver.plugins.grpc.client.userver_config_grpc_endpoint (pytestconfig, grpc_service_port_fallback, substitute_config_vars, request, choose_free_port) | |
Returns a function that adjusts the static config for testsuite. | |
str | pytest_userver.plugins.grpc.mockserver.grpc_mockserver_endpoint (pytestconfig, get_free_port) |
Returns the gRPC endpoint to start the mocking server that is set by command line --grpc-mockserver-host and --grpc-mockserver-port options. | |
pytest_userver.grpc.MockserverSession | pytest_userver.plugins.grpc.mockserver.grpc_mockserver_session (grpc_mockserver_endpoint) |
Returns the gRPC mocking server. | |
pytest_userver.grpc.Mockserver | pytest_userver.plugins.grpc.mockserver.grpc_mockserver (grpc_mockserver_session, asyncexc_append, _grpc_mockserver_ignore_errors) |
Returns the gRPC mocking server. | |
pytest_userver.plugins.grpc.mockserver.userver_config_grpc_mockserver (grpc_mockserver_endpoint) | |
Returns a function that adjusts the static config for testsuite. | |
List[str] | pytest_userver.plugins.kafka.kafka_components () |
Should contain manually listed names of kafka producer and consumer components. | |
dict | pytest_userver.plugins.kafka.kafka_secdist (_bootstrap_servers, kafka_components) |
Automatically generates secdist config from user static config. | |
pytest_userver.plugins.mongo.userver_mongo_config (mongo_connection_info) | |
Returns a function that adjusts the static configuration file for the testsuite. | |
pytest_userver.plugins.postgresql.userver_pg_config (pgsql_local) | |
Returns a function that adjusts the static configuration file for the testsuite. | |
typing.Generator[sql.RegisteredTrx, None, None] | pytest_userver.plugins.postgresql.userver_pg_trx (testpoint) |
The fixture maintains transaction fault injection state using RegisteredTrx class. | |
typing.Generator[RegisteredNtrx, None, None] | pytest_userver.plugins.postgresql.userver_pg_ntrx (testpoint) |
The fixture maintains single query fault injection state using RegisteredNtrx class. | |
pytest_userver.plugins.service.service_env () | |
Override this to pass extra environment variables to the service. | |
Optional[str] | pytest_userver.plugins.service.service_http_ping_url (service_config, 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) |
Returns a health checks info. | |
pytest_userver.plugins.service.service_daemon_scope (create_daemon_scope, daemon_scoped_mark, service_env, service_http_ping_url, service_config_path_temp, service_binary, service_non_http_health_checks) | |
Prepares the start of the service daemon. | |
None | pytest_userver.plugins.service.extra_client_deps () |
Service client dependencies hook. | |
None | pytest_userver.plugins.service.auto_client_deps (request) |
Ensures that the following fixtures, if available, are run before service start: | |
pytest_userver.plugins.service.builtin_client_deps (testpoint, cleanup_userver_dumps, userver_log_capture, dynamic_config, mock_configs_service) | |
Service client dependencies hook, like extra_client_deps. | |
DaemonInstance | pytest_userver.plugins.service.service_daemon_instance (ensure_daemon_started, service_daemon_scope, builtin_client_deps, auto_client_deps, extra_client_deps) |
Calls ensure_daemon_started on service_daemon_scope to actually start the service. | |
Optional[Dict[str, Any]] | pytest_userver.plugins.service.daemon_scoped_mark (request) |
Depend on this fixture directly or transitively to make your fixture a per-daemon fixture. | |
client.Client | pytest_userver.plugins.service_client.service_client (service_daemon_instance, service_baseurl, service_client_options, userver_service_client_options, userver_client_cleanup, client.TestsuiteClientConfig _testsuite_client_config) |
Main fixture that provides access to userver based service. | |
typing.Callable[[client.Client], typing.AsyncGenerator] | pytest_userver.plugins.service_client.userver_client_cleanup (request, service_logs_update_position, servicelogs_register_flusher, _dynamic_config_defaults_storage, _check_config_marks, dynamic_config) |
Contains the pre-test and post-test setup that depends on service_client. | |
pytest_userver.plugins.service_client.websocket_client (service_client, service_port) | |
Fixture that provides access to userver based websocket service. | |
client.ClientMonitor | pytest_userver.plugins.service_client.monitor_client (service_client, userver_monitor_client_options, monitor_baseurl) |
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. | |
pytest_userver.plugins.testpoint.userver_config_testpoint (mockserver_info) | |
Returns a function that adjusts the static configuration file for the testsuite. | |
client.YdbClient | pytest_userver.plugins.ydb.ydbsupport.ydb (_ydb_client, _ydb_init) |
YDB client fixture. | |
pathlib.Path | pytest_userver.plugins.ydb.ydbsupport.ydb_migration_dir (service_source_dir) |
Directory with migration files. | |
pathlib.Path | pytest_userver.plugins.ydb.ydbsupport.goose_binary_path () |
Path to 'goose' migration tool. | |
pathlib.Path | pytest_userver.plugins.ydb.ydbsupport.ydb_cli () |
Path to YDB CLI executable. | |
sql.RegisteredTrx | pytest_userver.plugins.ydb.ydbsupport.userver_ydb_trx (testpoint) |
The fixture maintains transaction fault injection state using RegisteredTrx class. | |
pytest_userver.plugins.ydb.ydbsupport.userver_config_ydb (ydb_service_settings) | |
Returns a function that adjusts the static configuration file for testsuite. | |
List[str] pytest_userver.plugins.config.allowed_url_prefixes_extra | ( | ) |
By default, userver HTTP client is only allowed to talk to mockserver when running in testsuite.
This makes tests repeatable and encapsulated.
Override this fixture to whitelist some additional URLs. It is still strongly advised to only talk to localhost in tests.
None pytest_userver.plugins.service.auto_client_deps | ( | request | ) |
Ensures that the following fixtures, if available, are run before service start:
pgsql
mongodb
clickhouse
rabbitmq
kafka_producer
, kafka_consumer
)redis_store
mysql
To add other dependencies prefer overriding the extra_client_deps fixture.
Definition at line 176 of file service.py.
pathlib.Path pytest_userver.plugins.base.build_dir | ( | pytestconfig | ) |
pytest_userver.plugins.service.builtin_client_deps | ( | testpoint, | |
cleanup_userver_dumps, | |||
userver_log_capture, | |||
dynamic_config, | |||
mock_configs_service ) |
Service client dependencies hook, like extra_client_deps.
Feel free to override globally in a more specific pytest plugin (one that comes after userver plugins), but make sure to depend on the original fixture:
Definition at line 232 of file service.py.
InvalidationState pytest_userver.plugins.caches.cache_invalidation_state | ( | ) |
Callable[[Optional[int]], int] pytest_userver.plugins.base.choose_free_port | ( | ) |
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 | ) |
ConfigDict pytest_userver.plugins.dynamic_config.config_service_defaults | ( | config_fallback_path, | |
dynamic_config_fallback_patch ) |
Fixture that returns default values for dynamic config.
You may override it in your local conftest.py or fixture:
Definition at line 436 of file dynamic_config.py.
Optional[Dict[str, Any]] pytest_userver.plugins.service.daemon_scoped_mark | ( | request | ) |
Depend on this fixture directly or transitively to make your fixture a per-daemon fixture.
Example:
For tests marked with @pytest.mark.uservice_oneshot(...)
, the service will be restarted, and all the per-daemon fixtures will be recreated.
This fixture returns kwargs passed to the uservice_oneshot
mark (which may be an empty dict). For normal tests, this fixture returns None
.
Definition at line 283 of file service.py.
pathlib.Path pytest_userver.plugins.config.db_dump_schema_path | ( | service_binary, | |
service_tmpdir ) |
DynamicConfig pytest_userver.plugins.dynamic_config.dynamic_config | ( | request, | |
search_path, | |||
object_substitute, | |||
cache_invalidation_state, | |||
_dynamic_config_defaults_storage, | |||
config_service_defaults, | |||
dynamic_config_changelog, | |||
_dynconf_load_json_cached, | |||
dynconf_cache_names ) |
Fixture that allows to control dynamic config values used by the service.
Example:
HTTP and gRPC client requests call update_server_state
automatically before each request.
For main dynamic config documentation:
See also other related fixtures:
Definition at line 322 of file dynamic_config.py.
ConfigDict pytest_userver.plugins.dynamic_config.dynamic_config_fallback_patch | ( | ) |
Override this fixture to replace some dynamic config values specifically for testsuite tests:
Definition at line 419 of file dynamic_config.py.
None pytest_userver.plugins.service.extra_client_deps | ( | ) |
Service client dependencies hook.
Feel free to override, e.g.:
Definition at line 161 of file service.py.
pathlib.Path pytest_userver.plugins.ydb.ydbsupport.goose_binary_path | ( | ) |
Path to 'goose' migration tool.
Override this fixture to change the way 'goose' binary is discovered.
Definition at line 175 of file ydbsupport.py.
pytest_userver.plugins.grpc.client.grpc_channel | ( | service_client, | |
grpc_service_endpoint, | |||
grpc_service_timeout, | |||
grpc_session_channel, | |||
_grpc_channel_interceptor, | |||
grpc_client_prepare, | |||
_grpc_channel_interceptor_asyncexc, | |||
asyncexc_check ) |
Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture.
Callable[[grpc.aio.ClientCallDetails, MessageOrStream], Awaitable[None]] pytest_userver.plugins.grpc.client.grpc_client_prepare | ( | service_client, | |
asyncexc_check ) |
pytest_userver.grpc.Mockserver pytest_userver.plugins.grpc.mockserver.grpc_mockserver | ( | grpc_mockserver_session, | |
asyncexc_append, | |||
_grpc_mockserver_ignore_errors ) |
Returns the gRPC mocking server.
In order for gRPC clients in your service to work, mock handlers need to be installed for them using this fixture.
Example:
Alternatively, you can create a shorthand for mocking frequently-used services:
Mocks are only active within tests after their respective handler functions are created, not between tests. If the service needs the mock during startup, add the fixture that defines your mock to extra_client_deps.
To return an error status instead of response, use context
(see ServicerContext docs):
To trigger special exceptions in the service's gRPC client, raise these mocked errors from the mock handler:
Definition at line 62 of file mockserver.py.
str pytest_userver.plugins.grpc.mockserver.grpc_mockserver_endpoint | ( | pytestconfig, | |
get_free_port ) |
Returns the gRPC endpoint to start the mocking server that is set by command line --grpc-mockserver-host
and --grpc-mockserver-port
options.
For port 0, picks some free port.
Override this fixture to customize the endpoint used by gRPC mockserver.
Definition at line 24 of file mockserver.py.
pytest_userver.grpc.MockserverSession pytest_userver.plugins.grpc.mockserver.grpc_mockserver_session | ( | grpc_mockserver_endpoint | ) |
Returns the gRPC mocking server.
Definition at line 45 of file mockserver.py.
str pytest_userver.plugins.grpc.client.grpc_service_endpoint | ( | service_config, | |
grpc_service_port ) |
Optional[int] pytest_userver.plugins.grpc.client.grpc_service_port | ( | service_config | ) |
int pytest_userver.plugins.grpc.client.grpc_service_port_fallback | ( | ) |
float pytest_userver.plugins.grpc.client.grpc_service_timeout | ( | pytestconfig | ) |
Optional[pathlib.Path] pytest_userver.plugins.grpc.client.grpc_socket_path | ( | ) |
Path for the UNIX socket over which testsuite will talk to the gRPC service, if it chooses to use a UNIX socket.
List[str] pytest_userver.plugins.kafka.kafka_components | ( | ) |
dict pytest_userver.plugins.kafka.kafka_secdist | ( | _bootstrap_servers, | |
kafka_components ) |
Automatically generates secdist config from user static config.
_bootstrap_servers
is testsuite's fixture that determines current bootstrap servers list depends on Kafka testsuite plugin's settings.
None pytest_userver.plugins.dynamic_config.mock_configs_service | ( | mockserver, | |
DynamicConfig | dynamic_config, | ||
_Changelog | dynamic_config_changelog ) |
Adds a mockserver handler that forwards dynamic_config to service's dynamic-config-client
component.
Definition at line 596 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 233 of file service_client.py.
client.ClientMonitor pytest_userver.plugins.service_client.monitor_client | ( | service_client, | |
userver_monitor_client_options, | |||
monitor_baseurl ) |
Main fixture that provides access to userver monitor listener.
Definition at line 127 of file service_client.py.
int pytest_userver.plugins.base.monitor_port | ( | pytestconfig, | |
_original_service_config, | |||
choose_free_port ) |
Returns the monitor listener port number of the service set by command line --monitor-port
option.
If no port is specified in the command line option, keeps the original port specified in the static config.
Override this fixture to change the way the monitor listener port number is detected by testsuite.
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 220 of file service_client.py.
pathlib.Path pytest_userver.plugins.base.service_binary | ( | pytestconfig | ) |
client.Client pytest_userver.plugins.service_client.service_client | ( | service_daemon_instance, | |
service_baseurl, | |||
service_client_options, | |||
userver_service_client_options, | |||
userver_client_cleanup, | |||
client.TestsuiteClientConfig | _testsuite_client_config ) |
Main fixture that provides access to userver based service.
Definition at line 19 of file service_client.py.
dict pytest_userver.plugins.config.service_config | ( | service_config_yaml, | |
service_config_vars, | |||
substitute_config_vars ) |
pathlib.Path pytest_userver.plugins.config.service_config_path | ( | pytestconfig, | |
service_binary ) |
pathlib.Path pytest_userver.plugins.config.service_config_path_temp | ( | service_tmpdir, | |
service_config, | |||
service_config_yaml, | |||
service_config_vars ) |
dict pytest_userver.plugins.config.service_config_vars | ( | _service_config_hooked | ) |
Returns the static config variables (config_vars.yaml) values after the USERVER_CONFIG_HOOKS were applied (if any).
Prefer using pytest_userver.plugins.config.service_config
Optional[pathlib.Path] pytest_userver.plugins.config.service_config_vars_path | ( | pytestconfig | ) |
dict pytest_userver.plugins.config.service_config_yaml | ( | _service_config_hooked | ) |
Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any).
Prefer using pytest_userver.plugins.config.service_config
DaemonInstance pytest_userver.plugins.service.service_daemon_instance | ( | ensure_daemon_started, | |
service_daemon_scope, | |||
builtin_client_deps, | |||
auto_client_deps, | |||
extra_client_deps ) |
Calls ensure_daemon_started
on service_daemon_scope to actually start the service.
Makes sure that all the dependencies are prepared before the service starts.
Definition at line 258 of file service.py.
pytest_userver.plugins.service.service_daemon_scope | ( | create_daemon_scope, | |
daemon_scoped_mark, | |||
service_env, | |||
service_http_ping_url, | |||
service_config_path_temp, | |||
service_binary, | |||
service_non_http_health_checks ) |
Prepares the start of the service daemon.
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.
Definition at line 102 of file service.py.
pytest_userver.plugins.service.service_env | ( | ) |
Override this to pass extra environment variables to the service.
Definition at line 54 of file service.py.
Optional[str] pytest_userver.plugins.service.service_http_ping_url | ( | service_config, | |
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 65 of file service.py.
net.HealthChecks pytest_userver.plugins.service.service_non_http_health_checks | ( | service_config | ) |
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 84 of file service.py.
int pytest_userver.plugins.base.service_port | ( | pytestconfig, | |
_original_service_config, | |||
choose_free_port ) |
Returns the main listener port number of the service set by command line --service-port
option.
If no port is specified in the command line option, keeps the original port specified in the static config.
Override this fixture to change the way the main listener port number is detected by the testsuite.
Optional[pathlib.Path] pytest_userver.plugins.config.service_secdist_path | ( | pytestconfig | ) |
pathlib.Path pytest_userver.plugins.base.service_source_dir | ( | pytestconfig | ) |
pytest_userver.plugins.config.service_tmpdir | ( | service_binary, | |
tmp_path_factory ) |
Callable[[Any, dict], Any] pytest_userver.plugins.config.substitute_config_vars | ( | service_env | ) |
A function that takes config_yaml
, config_vars
and applies all substitutions just like the service would.
Useful when patching the service config. It's a good idea to pass a component's config instead of the whole config_yaml
to avoid unnecessary work.
CacheControl pytest_userver.plugins.caches.userver_cache_control | ( | _userver_cache_control_context, | |
_userver_cache_fixtures, | |||
request ) |
Userver cache control handler.
To install per cache handler use USERVER_CACHE_CONTROL_HOOKS variable in your pytest plugin:
typing.Callable[[client.Client], typing.AsyncGenerator] pytest_userver.plugins.service_client.userver_client_cleanup | ( | request, | |
service_logs_update_position, | |||
servicelogs_register_flusher, | |||
_dynamic_config_defaults_storage, | |||
_check_config_marks, | |||
dynamic_config ) |
Contains the pre-test and post-test setup that depends on service_client.
Feel free to override, but in that case make sure to call the original userver_client_cleanup
fixture instance.
Definition at line 48 of file service_client.py.
pytest_userver.plugins.dynamic_config.userver_config_dynconf_cache | ( | service_tmpdir | ) |
Returns a function that adjusts the static configuration file for the testsuite.
Sets dynamic-config.fs-cache-path
to a file that is reset after the tests to avoid leaking dynamic config values between test sessions.
Definition at line 496 of file dynamic_config.py.
pytest_userver.plugins.dynamic_config.userver_config_dynconf_fallback | ( | config_service_defaults | ) |
Returns a function that adjusts the static configuration file for the testsuite.
Removes dynamic-config.defaults-path
. Updates dynamic-config.defaults
with config_service_defaults
.
Definition at line 524 of file dynamic_config.py.
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 560 of file dynamic_config.py.
pytest_userver.plugins.grpc.client.userver_config_grpc_endpoint | ( | pytestconfig, | |
grpc_service_port_fallback, | |||
substitute_config_vars, | |||
request, | |||
choose_free_port ) |
Returns a function that adjusts the static config for testsuite.
grpc-server.port
, and that port is taken, then adjusts it to a free port;grpc-server.unix-socket-path
, then adjusts it to a tmp path (see grpc_socket_path);pytest_userver.plugins.grpc.mockserver.userver_config_grpc_mockserver | ( | grpc_mockserver_endpoint | ) |
Returns a function that adjusts the static config for testsuite.
Finds grpc-client-middleware-pipeline
in config_yaml and enables grpc-client-middleware-testsuite
.
Definition at line 107 of file mockserver.py.
ServiceConfigPatch pytest_userver.plugins.config.userver_config_http_client | ( | mockserver_info, | |
mockserver_ssl_info, | |||
allowed_url_prefixes_extra ) |
ServiceConfigPatch pytest_userver.plugins.config.userver_config_http_server | ( | 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.
ServiceConfigPatch pytest_userver.plugins.config.userver_config_logging | ( | userver_log_level, | |
_service_logfile_path ) |
ServiceConfigPatch pytest_userver.plugins.config.userver_config_logging_otlp | ( | ) |
ServiceConfigPatch 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.
ServiceConfigPatch pytest_userver.plugins.config.userver_config_substitutions | ( | _service_config_substitution_vars | ) |
Replaces substitution vars in all strings within config_vars
using string.Template.substitute.
Substitution vars can be used as a shorthand for writing a full-fledged config hook in many common cases.
Unlike normal config_vars
, substitution vars can also apply to a part of a string. For example, for config_vars
entry
a possible patching result is as follows:
Currently, the following substitution vars are supported:
mockserver
- mockserver urlgrpc_mockserver
- grpc mockserver endpoint 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.
ServiceConfigPatch pytest_userver.plugins.config.userver_config_testsuite | ( | pytestconfig, | |
mockserver_info ) |
Returns a function that adjusts the static configuration file for testsuite.
Sets up testsuite-support
component, which:
Sets the testsuite-enabled
in config_vars.yaml to True
; sets the tests-control.testpoint-url
to mockserver URL.
pytest_userver.plugins.ydb.ydbsupport.userver_config_ydb | ( | ydb_service_settings | ) |
Returns a function that adjusts the static configuration file for testsuite.
For all ydb.databases
, sets endpoint
and database
to the local test YDB instance.
Definition at line 339 of file ydbsupport.py.
str pytest_userver.plugins.config.userver_default_log_level | ( | ) |
pathlib.Path pytest_userver.plugins.dumps.userver_dumps_root | ( | tmp_path_factory | ) |
str pytest_userver.plugins.config.userver_log_level | ( | pytestconfig, | |
userver_default_log_level ) |
Returns –service-log-level value if provided, otherwise returns userver_default_log_level() value from fixture.
pytest_userver.plugins.mongo.userver_mongo_config | ( | mongo_connection_info | ) |
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 73 of file postgresql.py.
typing.Generator[RegisteredNtrx, None, None] pytest_userver.plugins.postgresql.userver_pg_ntrx | ( | testpoint | ) |
The fixture maintains single query fault injection state using RegisteredNtrx class.
Definition at line 151 of file postgresql.py.
typing.Generator[sql.RegisteredTrx, None, None] pytest_userver.plugins.postgresql.userver_pg_trx | ( | testpoint | ) |
The fixture maintains transaction fault injection state using RegisteredTrx class.
Definition at line 126 of file postgresql.py.
sql.RegisteredTrx pytest_userver.plugins.ydb.ydbsupport.userver_ydb_trx | ( | testpoint | ) |
The fixture maintains transaction fault injection state using RegisteredTrx class.
Definition at line 316 of file ydbsupport.py.
pytest_userver.plugins.service_client.websocket_client | ( | service_client, | |
service_port ) |
Fixture that provides access to userver based websocket service.
Definition at line 99 of file service_client.py.
client.YdbClient pytest_userver.plugins.ydb.ydbsupport.ydb | ( | _ydb_client, | |
_ydb_init ) |
YDB client fixture.
Definition at line 28 of file ydbsupport.py.
pathlib.Path pytest_userver.plugins.ydb.ydbsupport.ydb_cli | ( | ) |
Path to YDB CLI executable.
Override this fixture to change the way YDB CLI is discovered.
Definition at line 227 of file ydbsupport.py.
pathlib.Path pytest_userver.plugins.ydb.ydbsupport.ydb_migration_dir | ( | service_source_dir | ) |
Directory with migration files.
Definition at line 137 of file ydbsupport.py.