Detailed Description

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)
	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)
	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.

typing.Callable[[DaemonInstance], 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.

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.

	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)
	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_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).

dict	pytest_userver.plugins.config.service_config (service_config_yaml, service_config_vars, service_env)
	Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any) and with all the '$', environment and fallback variables substituted.

	pytest_userver.plugins.config.userver_config_http_server (service_port, monitor_port)
	Returns a function that adjusts the static configuration file for testsuite.

typing.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.

	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 caoomand 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.

	pytest_userver.plugins.config.userver_config_logging (userver_log_level, _service_logfile_path)
	Returns a function that adjusts the static configuration file for testsuite.

	pytest_userver.plugins.config.userver_config_logging_otlp ()
	Returns a function that adjusts the static configuration file for testsuite.

	pytest_userver.plugins.config.userver_config_testsuite (pytestconfig, mockserver_info)
	Returns a function that adjusts the static configuration file for testsuite.

	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.

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.

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], Awaitable[None]]	pytest_userver.plugins.grpc.client.grpc_client_prepare (service_client, client.TestsuiteClientConfig _testsuite_client_config)
	Returns the function that will be called in before each gRPC request, client-side.

	pytest_userver.plugins.grpc.client.grpc_channel (grpc_service_endpoint, grpc_service_deps, grpc_service_timeout, grpc_session_channel, _grpc_channel_interceptor, grpc_client_prepare)
	Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture.

	pytest_userver.plugins.grpc.client.grpc_service_deps (service_client)
	gRPC service dependencies hook.

	pytest_userver.plugins.grpc.client.userver_config_grpc_mockserver (grpc_mockserver_endpoint)
	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.

grpc.aio.Server	pytest_userver.plugins.grpc.mockserver.grpc_mockserver (grpc_mockserver_endpoint)
	Returns the gRPC mocking server.

	pytest_userver.plugins.grpc.mockserver.create_grpc_mock ()
	Creates the gRPC mock server for the provided type.

str	pytest_userver.plugins.kafka.kafka_secdist (_bootstrap_servers, service_config)
	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.

typing.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 (pytestconfig, create_daemon_scope, service_env, service_http_ping_url, service_config_path_temp, service_config, service_binary, service_non_http_health_checks)
	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, kafka, redis_store, ydb, and mysql dependencies.

client.Client	pytest_userver.plugins.service_client.service_client (ensure_daemon_started, service_daemon, dynamic_config, mock_configs_service, cleanup_userver_dumps, userver_client_cleanup, client.TestsuiteClientConfig _testsuite_client_config, _service_client_base, _service_client_testsuite, extra_client_deps, auto_client_deps)
	Main fixture that provides access to userver based service.

typing.Callable[[client.Client], typing.AsyncGenerator]	pytest_userver.plugins.service_client.userver_client_cleanup (request, _userver_logging_plugin, _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, 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.

	pytest_userver.plugins.testpoint.userver_config_testpoint (mockserver_info)
	Returns a function that adjusts the static configuration file for the testsuite.

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.

Function Documentation

◆ allowed_url_prefixes_extra()

typing.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.

Definition at line 392 of file config.py.

◆ auto_client_deps()

None pytest_userver.plugins.service_client.auto_client_deps ( request )

Service client dependencies hook that knows about pgsql, mongodb, clickhouse, rabbitmq, kafka, redis_store, ydb, and mysql dependencies.

To add some other dependencies prefer overriding the extra_client_deps() fixture.

Definition at line 37 of file service_client.py.

◆ build_dir()

pathlib.Path pytest_userver.plugins.base.build_dir ( pytestconfig )

Returns the build directory set by command line --build-dir option.

Override this fixture to change the way the build directory is detected by the testsuite.

Definition at line 67 of file base.py.

◆ cache_invalidation_state()

InvalidationState pytest_userver.plugins.caches.cache_invalidation_state ( )

A fixture for notifying the service of changes in cache data sources.

Intended to be used by other fixtures that represent those data sources, not by tests directly.

Definition at line 154 of file caches.py.

◆ cleanup_userver_dumps()

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.

See also: userver::dump::Dumper

Definition at line 55 of file dumps.py.

◆ config_fallback_path()

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.

Override this fixture to change the way path to dynamic config fallback is provided.

Definition at line 180 of file config.py.

◆ config_service_defaults()

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:

@pytest.fixture(scope='session')
def config_service_defaults():
    with open('defaults.json') as fp:
        return json.load(fp)

Definition at line 405 of file dynamic_config.py.

◆ create_grpc_mock()

pytest_userver.plugins.grpc.mockserver.create_grpc_mock ( )

Creates the gRPC mock server for the provided type.

Definition at line 109 of file mockserver.py.

◆ db_dump_schema_path()

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.

Override this fixture to change the way to dump the database schema.

Definition at line 131 of file config.py.

◆ dynamic_config()

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.

After change to the config, be sure to call:

await service_client.update_server_state()

HTTP client requests call it automatically before each request.

Definition at line 307 of file dynamic_config.py.

◆ dynamic_config_fallback_patch()

ConfigDict pytest_userver.plugins.dynamic_config.dynamic_config_fallback_patch ( )

Override this fixture to replace some dynamic config values specifically for testsuite tests:

@pytest.fixture(scope='session')
def dynamic_config_fallback_patch():
    return {"MY_CONFIG_NAME": 42}

Definition at line 388 of file dynamic_config.py.

◆ extra_client_deps()

None pytest_userver.plugins.service_client.extra_client_deps ( )

Service client dependencies hook.

Feel free to override, e.g.:

@pytest.fixture
def extra_client_deps(some_fixtures_to_wait_before_service_start):
    pass

Definition at line 23 of file service_client.py.

◆ goose_binary_path()

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 170 of file ydbsupport.py.

◆ grpc_channel()

pytest_userver.plugins.grpc.client.grpc_channel	(	grpc_service_endpoint,
		grpc_service_deps,
		grpc_service_timeout,
		grpc_session_channel,
		_grpc_channel_interceptor,
		grpc_client_prepare )

Returns the gRPC channel configured by the parameters from the grpc_service_endpoint fixture.

Definition at line 107 of file client.py.

◆ grpc_client_prepare()

Callable[[grpc.aio.ClientCallDetails], Awaitable[None]] pytest_userver.plugins.grpc.client.grpc_client_prepare	(		service_client,
		client.TestsuiteClientConfig	_testsuite_client_config )

Returns the function that will be called in before each gRPC request, client-side.

Definition at line 77 of file client.py.

◆ grpc_mockserver()

grpc.aio.Server pytest_userver.plugins.grpc.mockserver.grpc_mockserver ( grpc_mockserver_endpoint )

Returns the gRPC mocking server.

Definition at line 78 of file mockserver.py.

◆ grpc_mockserver_endpoint()

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 57 of file mockserver.py.

◆ grpc_service_deps()

pytest_userver.plugins.grpc.client.grpc_service_deps ( service_client )

gRPC service dependencies hook.

Feel free to override it.

Definition at line 135 of file client.py.

◆ grpc_service_endpoint()

str pytest_userver.plugins.grpc.client.grpc_service_endpoint	(		service_config,
			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 42 of file client.py.

◆ grpc_service_port()

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.

Override this fixture to change the way the gRPC listener port number is retrieved by the testsuite for tests.

Definition at line 25 of file client.py.

◆ grpc_service_timeout()

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 63 of file client.py.

◆ kafka_secdist()

str pytest_userver.plugins.kafka.kafka_secdist	(		_bootstrap_servers,
			service_config )

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.

@pytest.fixture(scope='session')
def service_env(kafka_secdist) -> dict:
    """
    Note: kafka_secist fixture generates the secdist config
 
    Expected secdist format is:
    "kafka_settings": {
        "<kafka-component-name>": {
            "brokers": "<brokers comma-separated endpoint list>",
            "username": "SASL2 username (may be empty if use PLAINTEXT)",
            "password": "SASL2 password (may be empty if use PLAINTEXT)"
        }
    }
    """
 
    return {'SECDIST_CONFIG': kafka_secdist}

Definition at line 31 of file kafka.py.

◆ mock_configs_service()

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 561 of file dynamic_config.py.

◆ monitor_baseurl()

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 278 of file service_client.py.

◆ monitor_client()

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.

async def test_engine_metrics(service_client, monitor_client):
    metric = await monitor_client.single_metric(
        'engine.task-processors.tasks.finished',
        labels={'task_processor': 'main-task-processor'},
    )
    assert metric.value > 0
    assert metric.labels == {'task_processor': 'main-task-processor'}
 
    metrics_dict = await monitor_client.metrics(
        prefix='http.', labels={'http_path': '/ping'},
    )
 
    assert metrics_dict
    assert 'http.handler.cancelled-by-deadline' in metrics_dict
 
    assert (
        metrics_dict.value_at(
            'http.handler.in-flight',
            labels={
                'http_path': '/ping',
                'http_handler': 'handler-ping',
                'version': '2',
            },
        )
        == 0
    )

Definition at line 192 of file service_client.py.

◆ monitor_port()

int pytest_userver.plugins.base.monitor_port	(		pytestconfig,
			_original_service_config )

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.

Definition at line 112 of file base.py.

◆ read_latest_dump()

pytest_userver.plugins.dumps.read_latest_dump ( userver_dumps_root )

Read the latest dump produced by a specified dumper.

See also: userver::dump::Dumper

Definition at line 26 of file dumps.py.

◆ service_baseurl()

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 265 of file service_client.py.

◆ service_binary()

pathlib.Path pytest_userver.plugins.base.service_binary ( pytestconfig )

Returns the path to service binary set by command line --service-binary option.

Override this fixture to change the way the path to service binary is detected by the testsuite.

Definition at line 80 of file base.py.

◆ service_client()

client.Client pytest_userver.plugins.service_client.service_client	(		ensure_daemon_started,
			service_daemon,
			dynamic_config,
			mock_configs_service,
			cleanup_userver_dumps,
			userver_client_cleanup,
		client.TestsuiteClientConfig	_testsuite_client_config,
			_service_client_base,
			_service_client_testsuite,
			extra_client_deps,
			auto_client_deps )

Main fixture that provides access to userver based service.

async def test_ping(service_client):
    response = await service_client.get('/ping')
    assert response.status == 200

Definition at line 81 of file service_client.py.

◆ service_config()

dict pytest_userver.plugins.config.service_config	(	service_config_yaml,
		service_config_vars,
		service_env )

Returns the static config values after the USERVER_CONFIG_HOOKS were applied (if any) and with all the '$', environment and fallback variables substituted.

Definition at line 298 of file config.py.

◆ service_config_path()

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.

Override this fixture to change the way path to service.yaml is provided.

Definition at line 112 of file config.py.

◆ service_config_path_temp()

pathlib.Path pytest_userver.plugins.config.service_config_path_temp	(	service_tmpdir,
		service_config,
		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.

Definition at line 208 of file config.py.

◆ 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

Definition at line 243 of file config.py.

◆ service_config_vars_path()

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.

Override this fixture to change the way path to config_vars.yaml is provided.

Definition at line 152 of file config.py.

◆ service_config_yaml()

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

Definition at line 231 of file config.py.

◆ service_daemon()

pytest_userver.plugins.service.service_daemon	(	pytestconfig,
		create_daemon_scope,
		service_env,
		service_http_ping_url,
		service_config_path_temp,
		service_config,
		service_binary,
		service_non_http_health_checks )

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 103 of file service.py.

◆ service_env()

pytest_userver.plugins.service.service_env ( )

Override this to pass extra environment variables to the service.

@pytest.fixture(scope='session')
def service_env(redis_sentinels):
    secdist_config = {
        'redis_settings': {
            'taxi-tmp': {
                'password': '',
                'sentinels': redis_sentinels,
                'shards': [{'name': 'test_master0'}],
            },
        },
    }
 
    return {'SECDIST_CONFIG': json.dumps(secdist_config)}

Definition at line 53 of file service.py.

◆ service_http_ping_url()

typing.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 64 of file service.py.

◆ service_non_http_health_checks()

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 85 of file service.py.

◆ service_port()

int pytest_userver.plugins.base.service_port	(		pytestconfig,
			_original_service_config )

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.

Definition at line 94 of file base.py.

◆ service_secdist_path()

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.

Override this fixture to change the way path to secure_data.json is provided.

Definition at line 166 of file config.py.

◆ service_source_dir()

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.

Override this fixture to change the way the path to the service source directory is detected by testsuite.

Definition at line 53 of file base.py.

◆ service_tmpdir()

pytest_userver.plugins.config.service_tmpdir	(		service_binary,
			tmp_path_factory )

Returns the path for temporary files.

The path is the same for the whole session and files are not removed (at least by this fixture) between tests.

Definition at line 194 of file config.py.

◆ userver_cache_control()

typing.Callable[[DaemonInstance], 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:

USERVER_CACHE_CONTROL_HOOKS = {
    'my-cache-name': 'my_cache_cc',
}
 
@pytest.fixture
def my_cache_cc(my_cache_context):
    def cache_control(request, state):
        new_state = my_cache_context.get_state()
        if state == new_state:
            # Cache is already up to date, no need to update
            request.exclude()
        else:
            # Request incremental update, if you cache supports it
            request.incremental()
        return new_state
    return cache_control

Definition at line 185 of file caches.py.

◆ userver_client_cleanup()

typing.Callable[[client.Client], typing.AsyncGenerator] pytest_userver.plugins.service_client.userver_client_cleanup	(	request,
		_userver_logging_plugin,
		_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 116 of file service_client.py.

◆ userver_config_dynconf_cache()

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 464 of file dynamic_config.py.

◆ userver_config_dynconf_fallback()

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 492 of file dynamic_config.py.

◆ userver_config_dynconf_url()

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 531 of file dynamic_config.py.

◆ userver_config_grpc_mockserver()

pytest_userver.plugins.grpc.client.userver_config_grpc_mockserver ( grpc_mockserver_endpoint )

Returns a function that adjusts the static config for testsuite.

Walks through config_vars values equal to $grpc_mockserver, and replaces them with grpc_mockserver_endpoint.

Definition at line 144 of file client.py.

◆ userver_config_http_client()

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.

Sets increased timeout and limits allowed URLs for http-client component.

Definition at line 406 of file config.py.

◆ userver_config_http_server()

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.

Definition at line 366 of file config.py.

◆ userver_config_logging()

pytest_userver.plugins.config.userver_config_logging	(		userver_log_level,
			_service_logfile_path )

Returns a function that adjusts the static configuration file for testsuite.

Sets the logging.loggers.default to log to @stderr with level set from --service-log-level pytest configuration option.

Definition at line 461 of file config.py.

◆ userver_config_logging_otlp()

pytest_userver.plugins.config.userver_config_logging_otlp ( )

Returns a function that adjusts the static configuration file for testsuite.

Sets the otlp-logger.load-enabled to false to disable OTLP logging and leave the default file logger.

Definition at line 492 of file config.py.

◆ userver_config_secdist()

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.

Definition at line 569 of file config.py.

◆ userver_config_testpoint()

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.

◆ userver_config_testsuite()

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:

increases timeouts for userver drivers
disables periodic cache updates
enables testsuite tasks

Sets the testsuite-enabled in config_vars.yaml to True; sets the tests-control.testpoint-url to mockserver URL.

Definition at line 510 of file config.py.

◆ userver_config_ydb()

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 335 of file ydbsupport.py.

◆ userver_default_log_level()

str pytest_userver.plugins.config.userver_default_log_level ( )

Default log level to use in userver if no caoomand line option was provided.

Returns 'debug'.

Definition at line 436 of file config.py.

◆ userver_dumps_root()

pathlib.Path pytest_userver.plugins.dumps.userver_dumps_root ( tmp_path_factory )

The directory which the service will use for cache dumps.

Dumps of individual components will be stored in {userver_dumps_root}/{component-name}/{datetime}-v{format-version}

See also: userver::dump::Dumper

Definition at line 12 of file dumps.py.

◆ userver_log_level()

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.

Definition at line 448 of file config.py.

◆ userver_mongo_config()

pytest_userver.plugins.mongo.userver_mongo_config ( mongo_connection_info )

Returns a function that adjusts the static configuration file for the testsuite.

Sets the dbconnection to the testsuite started MongoDB credentials if the dbconnection starts with mongodb://. Additionally increases MongoDB connection timeouts to 30 seconds.

Definition at line 20 of file mongo.py.

◆ userver_pg_config()

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 71 of file postgresql.py.

◆ userver_pg_ntrx()

typing.Generator[RegisteredNtrx, None, None] pytest_userver.plugins.postgresql.userver_pg_ntrx ( testpoint )

The fixture maintains single query fault injection state using RegisteredNtrx class.

See also: pytest_userver.plugins.postgresql.RegisteredNtrx

async def test_ntrx_fail(service_client, pgsql, userver_pg_ntrx):
    response = await service_client.delete('/v1/key-value?key=foo')
    assert response.status == 200
 
    response = await service_client.post('/v1/key-value?key=foo&value=bar')
    assert response.status == 201
 
    with userver_pg_ntrx.mock_failure('sample_select_value'):
        response = await service_client.get('/v1/key-value?key=foo')
        assert response.status == 500
 
    response = await service_client.get('/v1/key-value?key=foo')
    assert response.status == 200
    assert response.content == b'bar'
 

Definition at line 151 of file postgresql.py.

◆ userver_pg_trx()

typing.Generator[sql.RegisteredTrx, None, None] pytest_userver.plugins.postgresql.userver_pg_trx ( testpoint )

The fixture maintains transaction fault injection state using RegisteredTrx class.

See also: pytest_userver.sql.RegisteredTrx

async def test_trx_fail(service_client, pgsql, userver_pg_trx):
    response = await service_client.delete('/v1/key-value?key=foo')
    assert response.status == 200
 
    userver_pg_trx.enable_failure('sample_transaction_insert_key_value')
 
    response = await service_client.post('/v1/key-value?key=foo&value=bar')
    assert response.status == 500
 
    response = await service_client.get('/v1/key-value?key=foo')
    assert response.status == 404

Definition at line 126 of file postgresql.py.

◆ userver_ydb_trx()

sql.RegisteredTrx pytest_userver.plugins.ydb.ydbsupport.userver_ydb_trx ( testpoint )

The fixture maintains transaction fault injection state using RegisteredTrx class.

See also: pytest_userver.sql.RegisteredTrx

async def test_trx_fail(service_client, pgsql, userver_pg_trx):
    response = await service_client.delete('/v1/key-value?key=foo')
    assert response.status == 200
 
    userver_pg_trx.enable_failure('sample_transaction_insert_key_value')
 
    response = await service_client.post('/v1/key-value?key=foo&value=bar')
    assert response.status == 500
 
    response = await service_client.get('/v1/key-value?key=foo')
    assert response.status == 404

Definition at line 312 of file ydbsupport.py.

◆ websocket_client()

pytest_userver.plugins.service_client.websocket_client	(		service_client,
			service_port )

Fixture that provides access to userver based websocket service.

Definition at line 166 of file service_client.py.

◆ ydb_cli()

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 222 of file ydbsupport.py.

◆ ydb_migration_dir()

pathlib.Path pytest_userver.plugins.ydb.ydbsupport.ydb_migration_dir ( service_source_dir )

Directory with migration files.

Definition at line 129 of file ydbsupport.py.

Detailed Description

Namespaces

Functions

Function Documentation

◆ allowed_url_prefixes_extra()

◆ auto_client_deps()

◆ build_dir()

◆ cache_invalidation_state()

◆ cleanup_userver_dumps()

◆ config_fallback_path()

◆ config_service_defaults()

◆ create_grpc_mock()

◆ db_dump_schema_path()

◆ dynamic_config()

◆ dynamic_config_fallback_patch()

◆ extra_client_deps()

◆ goose_binary_path()

◆ grpc_channel()

◆ grpc_client_prepare()

◆ grpc_mockserver()

◆ grpc_mockserver_endpoint()

◆ grpc_service_deps()

◆ grpc_service_endpoint()

◆ grpc_service_port()

◆ grpc_service_timeout()

◆ kafka_secdist()

◆ mock_configs_service()

◆ monitor_baseurl()

◆ monitor_client()

◆ monitor_port()

◆ read_latest_dump()

◆ service_baseurl()

◆ service_binary()

◆ service_client()

◆ service_config()

◆ service_config_path()

◆ service_config_path_temp()

◆ service_config_vars()

◆ service_config_vars_path()

◆ service_config_yaml()

◆ service_daemon()

◆ service_env()

◆ service_http_ping_url()

◆ service_non_http_health_checks()

◆ service_port()

◆ service_secdist_path()

◆ service_source_dir()

◆ service_tmpdir()

◆ userver_cache_control()

◆ userver_client_cleanup()

◆ userver_config_dynconf_cache()

◆ userver_config_dynconf_fallback()

◆ userver_config_dynconf_url()

◆ userver_config_grpc_mockserver()

◆ userver_config_http_client()

◆ userver_config_http_server()

◆ userver_config_logging()

◆ userver_config_logging_otlp()

◆ userver_config_secdist()

◆ userver_config_testpoint()

◆ userver_config_testsuite()

◆ userver_config_ydb()

◆ userver_default_log_level()

◆ userver_dumps_root()

◆ userver_log_level()

◆ userver_mongo_config()

◆ userver_pg_config()

◆ userver_pg_ntrx()

◆ userver_pg_trx()

◆ userver_ydb_trx()

◆ websocket_client()

◆ ydb_cli()

◆ ydb_migration_dir()