#include <userver/server/handlers/tests_control.hpp>

Detailed Description

Handler that allows to control the behavior of server from tests, and functional tests with testsuite in particular.

It is highly recommended to disable this handle in production via the load-enabled: false option.

The component must be configured in service config.

Static options:

Aside from common handler options component has the following options:

Name	Description	Default value
testpoint-url	an URL that should be notified in the TESTPOINT_CALLBACK and TESTPOINT_CALLBACK_NONCORO macros	-
skip-unregistered-testpoints	do not send testpoints data for paths that were not registered by `testpoint-url`	false
testpoint-timeout	timeout to use while working with testpoint-url	1s

Static configuration example:

# yaml
    tests-control:
        skip-unregistered-testpoints: true
        testpoint-timeout: 10s
        testpoint-url: https://localhost:7891/testpoint
 
        # Some options from server::handlers::HttpHandlerBase
        path: /tests/{action}
        method: POST
        task_processor: main-task-processor

Scheme

Main user of the scheme is the pytest_userver.client.Client python class. In particular:

{
    "action": "run_periodic_task" | "suspend_periodic_tasks" | "write_cache_dumps" | "read_cache_dumps" | "metrics_portability"
    "testpoints": [<list of testpoints to register>]
    "reset_metrics": true | false
    "mock_now": <time in utils::datetime::Stringtime() acceptable format>
    "invalidate_caches": <...>
    "socket_logging_duplication": true | false
    <...>
}

See also: Functional service tests (testsuite)

Examples: grpc-generic-proxy/main.cpp, postgresql/functional_tests/basic_chaos/postgres_service.cpp, samples/postgres_service/main.cpp, and samples/tcp_full_duplex_service/main.cpp.

Definition at line 64 of file tests_control.hpp.

Inheritance diagram for server::handlers::TestsControl:

Public Member Functions
	TestsControl (const components::ComponentConfig &config, const components::ComponentContext &component_context)

formats::json::Value	HandleRequestJsonThrow (const http::HttpRequest &request, const formats::json::Value &request_body, request::RequestContext &context) const override

std::string	HandleRequestThrow (const http::HttpRequest &request, request::RequestContext &context) const final
	Same as `HandleRequest`.

void	PrepareAndHandleRequest (http::HttpRequest &request, request::RequestContext &context) const override

void	ReportMalformedRequest (http::HttpRequest &request) const final

virtual const std::string &	HandlerName () const

const std::vector< http::HttpMethod > &	GetAllowedMethods () const

virtual logging::Level	GetLogLevelForResponseStatus (http::HttpStatus status) const

std::string	GetResponseDataForLoggingChecked (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const

void	HandleCustomHandlerException (const http::HttpRequest &request, const CustomHandlerException &ex) const

void	HandleUnknownException (const http::HttpRequest &request, const std::exception &ex) const

void	LogUnknownException (const std::exception &ex, std::optional< logging::Level > log_level_override={}) const
	Helper function to log an unknown exception.

const std::optional< logging::Level > &	GetLogLevel () const
	Returns the default log level for the handler.

bool	IsMonitor () const
	Returns whether this is a monitoring handler.

const HandlerConfig &	GetConfig () const
	Returns handler config.

ComponentHealth	GetComponentHealth () const override

void	OnLoadingCancelled () override

void	OnAllComponentsLoaded () override

void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "tests-control"
	The default name of server::handlers::TestsControl.

Protected Types
using	HandlerErrorCode = handlers::HandlerErrorCode

using	InternalMessage = handlers::InternalMessage

using	ExternalBody = handlers::ExternalBody

using	ClientError = handlers::ClientError

using	InternalServerError = handlers::InternalServerError

using	LoggableComponentBase = ComponentBase

Protected Member Functions
void	ParseRequestData (const http::HttpRequest &request, request::RequestContext &context) const override

void	ThrowUnsupportedHttpMethod (const http::HttpRequest &request) const

virtual std::string	HandleRequest (http::HttpRequest &request, request::RequestContext &context) const

virtual void	HandleStreamRequest (server::http::HttpRequest &, server::request::RequestContext &, server::http::ResponseBodyStream &) const

virtual bool	IsStreamed () const

virtual bool	IsMethodStatisticIncluded () const

virtual bool	NeedCheckAuth () const

virtual std::string	GetRequestBodyForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &request_body) const
	Override it if you need a custom request body logging.

virtual std::string	GetResponseDataForLogging (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const
	Override it if you need a custom response data logging.

virtual std::string	GetMetaType (const http::HttpRequest &) const

Static Protected Member Functions
static const formats::json::Value *	GetRequestJson (const request::RequestContext &context)

static const formats::json::Value *	GetResponseJson (const request::RequestContext &context)

Member Typedef Documentation

◆ ClientError

using server::handlers::HandlerBase::ClientError = handlers::ClientError

protectedinherited

Definition at line 80 of file handler_base.hpp.

◆ ExternalBody

using server::handlers::HandlerBase::ExternalBody = handlers::ExternalBody

protectedinherited

Definition at line 78 of file handler_base.hpp.

◆ HandlerErrorCode

using server::handlers::HandlerBase::HandlerErrorCode = handlers::HandlerErrorCode

protectedinherited

Definition at line 76 of file handler_base.hpp.

◆ InternalMessage

using server::handlers::HandlerBase::InternalMessage = handlers::InternalMessage

protectedinherited

Definition at line 77 of file handler_base.hpp.

◆ InternalServerError

using server::handlers::HandlerBase::InternalServerError = handlers::InternalServerError

protectedinherited

Definition at line 81 of file handler_base.hpp.

◆ LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Deprecated: use components::ComponentBase instead.

Definition at line 67 of file component_base.hpp.

Member Function Documentation

◆ GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning: The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Reimplemented in server::handlers::Restart.

Definition at line 35 of file component_base.hpp.

◆ GetLogLevelForResponseStatus()

virtual logging::Level server::handlers::HttpHandlerBase::GetLogLevelForResponseStatus ( http::HttpStatus status ) const

virtualinherited

Override it if you need a custom logging level for messages about finish of request handling for some http statuses.

◆ GetRequestBodyForLogging()

virtual std::string server::handlers::HttpHandlerBase::GetRequestBodyForLogging	(	const http::HttpRequest &	request,
		request::RequestContext &	context,
		const std::string &	request_body ) const

protectedvirtualinherited

Override it if you need a custom request body logging.

Reimplemented in server::handlers::HttpHandlerFlatbufBase< InputType, ReturnType >.

◆ GetRequestJson()

static const formats::json::Value * server::handlers::HttpHandlerJsonBase::GetRequestJson ( const request::RequestContext & context )

staticprotectedinherited

Returns: A pointer to json request if it was parsed successfully or nullptr otherwise.

◆ GetResponseDataForLogging()

virtual std::string server::handlers::HttpHandlerBase::GetResponseDataForLogging	(	const http::HttpRequest &	request,
		request::RequestContext &	context,
		const std::string &	response_data ) const

protectedvirtualinherited

Override it if you need a custom response data logging.

Reimplemented in server::handlers::HttpHandlerFlatbufBase< InputType, ReturnType >.

◆ GetResponseJson()

static const formats::json::Value * server::handlers::HttpHandlerJsonBase::GetResponseJson ( const request::RequestContext & context )

staticprotectedinherited

Returns: a pointer to json response if it was returned successfully by HandleRequestJsonThrow() or nullptr otherwise.

◆ HandleCustomHandlerException()

void server::handlers::HttpHandlerBase::HandleCustomHandlerException	(	const http::HttpRequest &	request,
		const CustomHandlerException &	ex ) const

inherited

Takes the exception and formats it into response, as specified by exception.

◆ HandleRequest()

virtual std::string server::handlers::HttpHandlerBase::HandleRequest	(	http::HttpRequest &	request,
		request::RequestContext &	context ) const

protectedvirtualinherited

The core method for HTTP request handling. request arg contains HTTP headers, full body, etc. The method should return response body.

Note: It is used only if IsStreamed() returned false.

Examples: samples/http_caching/main.cpp.

◆ HandleRequestJsonThrow()

formats::json::Value server::handlers::TestsControl::HandleRequestJsonThrow	(	const http::HttpRequest &	request,
		const formats::json::Value &	request_body,
		request::RequestContext &	context ) const

overridevirtual

Implements server::handlers::HttpHandlerJsonBase.

◆ HandleRequestThrow()

std::string server::handlers::HttpHandlerJsonBase::HandleRequestThrow	(	const http::HttpRequest &	request,
		request::RequestContext &	context ) const

finalvirtualinherited

Same as HandleRequest.

Reimplemented from server::handlers::HttpHandlerBase.

◆ HandleStreamRequest()

virtual void server::handlers::HttpHandlerBase::HandleStreamRequest	(	server::http::HttpRequest &	,
		server::request::RequestContext &	,
		server::http::ResponseBodyStream &	) const

protectedvirtualinherited

The core method for HTTP request handling. request arg contains HTTP headers, full body, etc. The response body is passed in parts to ResponseBodyStream. Stream transmission is useful when: 1) The body size is unknown beforehand. 2) The client may take advantage of early body transmission (e.g. a Web Browser may start rendering the HTML page or downloading dependant resources). 3) The body size is huge and we want to have only a part of it in memory.

Note: It is used only if IsStreamed() returned true.

◆ HandleUnknownException()

void server::handlers::HttpHandlerBase::HandleUnknownException	(	const http::HttpRequest &	request,
		const std::exception &	ex ) const

inherited

Takes the exception and formats it into response as an internal server error.

◆ IsMethodStatisticIncluded()

virtual bool server::handlers::HttpHandlerBase::IsMethodStatisticIncluded ( ) const

inlineprotectedvirtualinherited

Override it to show per HTTP-method statistics besides statistics for all methods

Definition at line 156 of file http_handler_base.hpp.

◆ IsMonitor()

bool server::handlers::HandlerBase::IsMonitor ( ) const

inlineinherited

Returns whether this is a monitoring handler.

Definition at line 67 of file handler_base.hpp.

◆ IsStreamed()

virtual bool server::handlers::HttpHandlerBase::IsStreamed ( ) const

inlineprotectedvirtualinherited

If IsStreamed() returns true, call HandleStreamRequest() for request handling, HandleRequest() is not called. If it returns false, HandleRequest() is called instead, and HandleStreamRequest() is not called.

Note: The default implementation returns the cached value of "response-body-streamed" value from static config.

Definition at line 152 of file http_handler_base.hpp.

◆ NeedCheckAuth()

virtual bool server::handlers::HttpHandlerBase::NeedCheckAuth ( ) const

inlineprotectedvirtualinherited

Override it if you want to disable auth checks in handler by some condition

Definition at line 160 of file http_handler_base.hpp.

◆ OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server, and urabbitmq::ConsumerComponentBase.

Definition at line 58 of file component_base.hpp.

◆ OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in components::Server, server::handlers::Ping, and urabbitmq::ConsumerComponentBase.

Definition at line 51 of file component_base.hpp.

◆ OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 42 of file component_base.hpp.

◆ ParseRequestData()

void server::handlers::HttpHandlerJsonBase::ParseRequestData	(	const http::HttpRequest &	,
		request::RequestContext &	) const

overrideprotectedvirtualinherited

For internal use. You don't need to override it. This method is overridden in format-specific base handlers.

Reimplemented from server::handlers::HttpHandlerBase.

◆ PrepareAndHandleRequest()

void server::handlers::HttpHandlerBase::PrepareAndHandleRequest	(	http::HttpRequest &	request,
		request::RequestContext &	context ) const

overridevirtualinherited

Parses request, executes processing routines, and fills response accordingly. Does not throw.

Implements server::handlers::HandlerBase.

◆ ReportMalformedRequest()

void server::handlers::HttpHandlerBase::ReportMalformedRequest ( http::HttpRequest & ) const

finalvirtualinherited

Produces response to a request unrecognized by the protocol based on provided generic response. Does not throw.

Reimplemented from server::handlers::HandlerBase.

The documentation for this class was generated from the following file:

userver/server/handlers/tests_control.hpp

Detailed Description

Static options:

Static configuration example:

Scheme

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Member Typedef Documentation

◆ ClientError

◆ ExternalBody

◆ HandlerErrorCode

◆ InternalMessage

◆ InternalServerError

◆ LoggableComponentBase

Member Function Documentation

◆ GetComponentHealth()

◆ GetLogLevelForResponseStatus()

◆ GetRequestBodyForLogging()

◆ GetRequestJson()

◆ GetResponseDataForLogging()

◆ GetResponseJson()

◆ HandleCustomHandlerException()

◆ HandleRequest()

◆ HandleRequestJsonThrow()

◆ HandleRequestThrow()

◆ HandleStreamRequest()

◆ HandleUnknownException()

◆ IsMethodStatisticIncluded()

◆ IsMonitor()

◆ IsStreamed()

◆ NeedCheckAuth()

◆ OnAllComponentsAreStopping()

◆ OnAllComponentsLoaded()

◆ OnLoadingCancelled()

◆ ParseRequestData()

◆ PrepareAndHandleRequest()

◆ ReportMalformedRequest()