testsuite Namespace Reference

Detailed Description

Testsuite integration.

Namespaces
namespace	logcapture
	Logcapture allows to intercepts service logs on demand with context manager.

Classes
class	CacheControl
	Testsuite interface for caches and cache-like components. More...
class	CacheResetRegistration
	RAII helper for testsuite registration. More...
class	DumpControl
	Dumper control interface for testsuite. More...
class	Dumper
	Testsuite-facing API of a dump manager. More...
class	ExceptionsHandlingMiddleware
class	GrpcControl
	Testsuite overrides for gRPC client timeouts and TLS. More...
class	HttpAllowedUrlsExtra
	Testsuite extra allowed HTTP client URLs. More...
class	PeriodicTaskControl
	Periodic task control interface for testsuite. More...
class	PeriodicTaskRegistrationHolder
	RAII helper for testsuite registration. More...
class	PostgresControl
	Testsuite overrides for PostgreSQL query timeouts. More...
struct	RedisControl
	Testsuite minimum Redis client timeouts. More...
class	TaskAlreadyRunning
class	TaskNotFound
class	TestpointClientBase
	Base testpoint client. Used to report TESTPOINT executions to testsuite. More...
class	TestpointControl
	Testpoint control interface for testsuite. More...
class	TestsuiteTasks
	Testsuite tasks support. More...

Typedefs
using	ExceptionsHandlingMiddlewareFactory
using	TestpointCallback = utils::function_ref<void(const formats::json::Value&)>

Functions
CacheControl &	FindCacheControl (const components::ComponentContext &context)
template<typename Component>
void	RegisterCacheScope (const components::ComponentContext &context, Component *self, void(Component::*reset_method)())
	Registers a cache resetter bound to the component lifetime.
template<typename Component>
CacheResetRegistration	RegisterCache (const components::ComponentContext &context, Component *self, void(Component::*reset_method)())
TestsuiteTasks &	GetTestsuiteTasks (const components::ComponentContext &component_context)
	Get reference to TestsuiteTasks instance.
bool	AreTestpointsAvailable () noexcept
	Returns true if testpoints are available in runtime.

Typedef Documentation

ExceptionsHandlingMiddlewareFactory

using testsuite::ExceptionsHandlingMiddlewareFactory

Initial value:

server::middlewares::SimpleHttpMiddlewareFactory<
   ExceptionsHandlingMiddleware>

Definition at line 24 of file middlewares.hpp.

TestpointCallback

using testsuite::TestpointCallback = utils::function_ref<void(const formats::json::Value&)>

Definition at line 20 of file testpoint.hpp.

Function Documentation

FindCacheControl()

CacheControl & testsuite::FindCacheControl

(

const components::ComponentContext &

context

)

The method for acquiring testsuite::CacheControl in the component system.

See also

testsuite::RegisterCacheScope

GetTestsuiteTasks()

TestsuiteTasks & testsuite::GetTestsuiteTasks

(

const components::ComponentContext &

component_context

)

Get reference to TestsuiteTasks instance.

Parameters

component_context

Examples

samples/s3api/src/s3api_client.cpp, and samples/testsuite-support/src/tasks.cpp.

RegisterCache()

template<typename Component>

CacheResetRegistration testsuite::RegisterCache	(	const components::ComponentContext &	context,
		Component *	self,
		void(Component::*	reset_method )() )

Deprecated

Use RegisterCacheScope instead. The returned handle must be kept alive to keep supporting cache resetting.

Warning

The function should be called in the component's constructor after all FindComponent calls. This ensures that reset will first be called for dependencies, then for dependent components.

Definition at line 235 of file cache_control.hpp.

RegisterCacheScope()

template<typename Component>

void testsuite::RegisterCacheScope	(	const components::ComponentContext &	context,
		Component *	self,
		void(Component::*	reset_method )() )

Registers a cache resetter bound to the component lifetime.

The resetter is registered after the component constructor finishes and is unregistered just before the destructor runs.

Typical usage:

testsuite::RegisterCacheScope(context, this, &MyCache::ResetCache);

Warning

The function should be called in the component's constructor after all FindComponent calls. This ensures that reset will first be called for dependencies, then for dependent components.

Definition at line 216 of file cache_control.hpp.