Handler that allows to control the behavior of server from tests, and functional tests with testsuite in particular. More...
#include <userver/server/handlers/tests_control.hpp>
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 |
![]() | |
HttpHandlerJsonBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false) | |
std::string | HandleRequestThrow (const http::HttpRequest &request, request::RequestContext &context) const final |
virtual formats::json::Value | HandleRequestJsonThrow (const http::HttpRequest &request, const formats::json::Value &request_json, request::RequestContext &context) const =0 |
![]() | |
HttpHandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false) | |
void | HandleRequest (request::RequestBase &request, request::RequestContext &context) const override |
void | ReportMalformedRequest (request::RequestBase &request) const final |
virtual const std::string & | HandlerName () const |
const std::vector< http::HttpMethod > & | GetAllowedMethods () const |
virtual logging::Level | GetLogLevelForResponseStatus (http::HttpStatus status) const |
virtual FormattedErrorData | GetFormattedExternalErrorBody (const CustomHandlerException &exc) const |
std::string | GetResponseDataForLoggingChecked (const http::HttpRequest &request, request::RequestContext &context, const std::string &response_data) const |
![]() | |
HandlerBase (const components::ComponentConfig &config, const components::ComponentContext &component_context, bool is_monitor=false) | |
virtual void | HandleRequest (request::RequestBase &request, request::RequestContext &context) const =0 |
virtual void | ReportMalformedRequest (request::RequestBase &) const |
bool | IsMonitor () const |
Returns whether this is a monitoring handler. | |
const HandlerConfig & | GetConfig () const |
Returns handler config. | |
![]() | |
LoggableComponentBase (const ComponentConfig &, const ComponentContext &) | |
LoggableComponentBase (LoggableComponentBase &&)=delete | |
LoggableComponentBase (const LoggableComponentBase &)=delete | |
~LoggableComponentBase () override=default | |
ComponentHealth | GetComponentHealth () const override |
void | OnLoadingCancelled () override |
void | OnAllComponentsLoaded () override |
void | OnAllComponentsAreStopping () override |
Static Public Member Functions | |
static yaml_config::Schema | GetStaticConfigSchema () |
![]() | |
static yaml_config::Schema | GetStaticConfigSchema () |
![]() | |
static yaml_config::Schema | GetStaticConfigSchema () |
![]() | |
static yaml_config::Schema | GetStaticConfigSchema () |
![]() | |
static yaml_config::Schema | GetStaticConfigSchema () |
Static Public Attributes | |
static constexpr std::string_view | kName = "tests-control" |
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.
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 |
Main user of the scheme is the pytest_userver.client.Client python class. In particular:
Definition at line 64 of file tests_control.hpp.
|
overridevirtual |
Implements server::handlers::HttpHandlerJsonBase.
|
staticconstexpr |
Definition at line 70 of file tests_control.hpp.