pytest_userver.chaos.BaseGate Class Reference

Detailed Description

This base class maintain endpoints of two types:

Server-side endpoints to receive messages from clients. Address of this endpoint is described by (host_for_client, port_for_client).

Client-side endpoints to forward messages to server. Server must listen on (host_to_server, port_to_server).

Asynchronously concurrently passes data from client to server and from server to client, allowing intercepting the data, injecting delays and dropping connections.

Warning

Do not use this class itself. Use one of the specifications TcpGate or UdpGate

See also

Chaos Testing

Definition at line 478 of file chaos.py.

Inheritance diagram for pytest_userver.chaos.BaseGate:

Public Member Functions
None	__init__ (self, GateRoute route, typing.Optional[EvLoop] loop=None)
'BaseGate'	__aenter__ (self)
None	__aexit__ (self, exc_type, exc_value, traceback)
	start (self)
	Open the socket and start accepting tasks.
None	start_accepting (self)
	Start accepting tasks.
None	stop_accepting (self)
	Stop accepting tasks without closing the accepting socket.
None	stop (self)
	Stop accepting tasks, close all the sockets.
None	sockets_close (self, *, typing.Optional[int] count=None)
	Close all the connection going through the gate.
Address	get_sockname_for_clients (self)
	Returns the client socket address that the gate listens on.
str	info (self)
	Print info on open sockets.
callinfo.AsyncCallQueue	set_to_server_interceptor (self, Interceptor interceptor)
	Replace existing interceptor of client to server data with a custom.
callinfo.AsyncCallQueue	set_to_client_interceptor (self, Interceptor interceptor)
	Replace existing interceptor of server to client data with a custom.
callinfo.AsyncCallQueue	to_server_pass (self)
	Pass data as is.
callinfo.AsyncCallQueue	to_client_pass (self)
	Pass data as is.
callinfo.AsyncCallQueue	to_server_noop (self)
	Do not read data, causing client to keep multiple data.
callinfo.AsyncCallQueue	to_client_noop (self)
	Do not read data, causing server to keep multiple data.
callinfo.AsyncCallQueue	to_server_drop (self)
	Read and discard data.
callinfo.AsyncCallQueue	to_client_drop (self)
	Read and discard data.
callinfo.AsyncCallQueue	to_server_delay (self, float delay)
	Delay data transmission.
callinfo.AsyncCallQueue	to_client_delay (self, float delay)
	Delay data transmission.
callinfo.AsyncCallQueue	to_server_close_on_data (self)
	Close on first bytes of data from client.
callinfo.AsyncCallQueue	to_client_close_on_data (self)
	Close on first bytes of data from server.
callinfo.AsyncCallQueue	to_server_corrupt_data (self)
	Corrupt data received from client.
callinfo.AsyncCallQueue	to_client_corrupt_data (self)
	Corrupt data received from server.
callinfo.AsyncCallQueue	to_server_limit_bps (self, float bytes_per_second)
	Limit bytes per second transmission by network from client.
callinfo.AsyncCallQueue	to_client_limit_bps (self, float bytes_per_second)
	Limit bytes per second transmission by network from server.
callinfo.AsyncCallQueue	to_server_limit_time (self, float timeout, float jitter)
	Limit connection lifetime on receive of first bytes from client.
callinfo.AsyncCallQueue	to_client_limit_time (self, float timeout, float jitter)
	Limit connection lifetime on receive of first bytes from server.
callinfo.AsyncCallQueue	to_server_smaller_parts (self, int max_size, *, float sleep_per_packet=0)
	Pass data to server in smaller parts.
callinfo.AsyncCallQueue	to_client_smaller_parts (self, int max_size, *, float sleep_per_packet=0)
	Pass data to client in smaller parts.
callinfo.AsyncCallQueue	to_server_concat_packets (self, int packet_size)
	Pass data in bigger parts.
callinfo.AsyncCallQueue	to_client_concat_packets (self, int packet_size)
	Pass data in bigger parts.
callinfo.AsyncCallQueue	to_server_limit_bytes (self, int bytes_limit)
	Drop all connections each bytes_limit of data sent by network.
callinfo.AsyncCallQueue	to_client_limit_bytes (self, int bytes_limit)
	Drop all connections each bytes_limit of data sent by network.
callinfo.AsyncCallQueue	to_server_substitute (self, str pattern, str repl)
	Apply regex substitution to data from client.
callinfo.AsyncCallQueue	to_client_substitute (self, str pattern, str repl)
	Apply regex substitution to data from server.

Protected Member Functions
typing.List[Socket]	_create_accepting_sockets (self)
None	_collect_garbage (self)
None	_do_accept (self, Socket accept_sock)
	This task should wait for connections and create SocketPair.

Protected Attributes
	_route = route
	_loop = loop
Interceptor	_to_server_intercept = _intercept_ok
Interceptor	_to_client_intercept = _intercept_ok
list	_accept_sockets = []
list	_accept_tasks = []
typing.Set[_SocketsPaired]	_sockets = set()

Static Protected Attributes
str	_NOT_IMPLEMENTED_MESSAGE = 'Do not use BaseGate itself, use one of specializations TcpGate or UdpGate'

Constructor & Destructor Documentation

__init__()

None pytest_userver.chaos.BaseGate.__init__	(		self,
		GateRoute	route,
		typing.Optional[EvLoop]	loop = None )

Definition at line 502 of file chaos.py.

Member Function Documentation

__aenter__()

'BaseGate' pytest_userver.chaos.BaseGate.__aenter__

(

self

)

Definition at line 516 of file chaos.py.

__aexit__()

None pytest_userver.chaos.BaseGate.__aexit__	(		self,
			exc_type,
			exc_value,
			traceback )

Definition at line 520 of file chaos.py.

_collect_garbage()

None pytest_userver.chaos.BaseGate._collect_garbage ( self )

protected

Definition at line 617 of file chaos.py.

_create_accepting_sockets()

typing.List[Socket] pytest_userver.chaos.BaseGate._create_accepting_sockets ( self )

protected

Definition at line 523 of file chaos.py.

_do_accept()

None pytest_userver.chaos.BaseGate._do_accept ( self, Socket accept_sock )

protected

This task should wait for connections and create SocketPair.

Reimplemented in pytest_userver.chaos.TcpGate, and pytest_userver.chaos.UdpGate.

Definition at line 620 of file chaos.py.

get_sockname_for_clients()

Address pytest_userver.chaos.BaseGate.get_sockname_for_clients

(

self

)

Returns the client socket address that the gate listens on.

This function allows to use 0 in GateRoute.port_for_client and retrieve the actual port and host.

Definition at line 600 of file chaos.py.

info()

str pytest_userver.chaos.BaseGate.info

(

self

)

Print info on open sockets.

Definition at line 610 of file chaos.py.

set_to_client_interceptor()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.set_to_client_interceptor	(		self,
		Interceptor	interceptor )

Replace existing interceptor of server to client data with a custom.

Definition at line 635 of file chaos.py.

set_to_server_interceptor()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.set_to_server_interceptor	(		self,
		Interceptor	interceptor )

Replace existing interceptor of client to server data with a custom.

Definition at line 626 of file chaos.py.

sockets_close()

None pytest_userver.chaos.BaseGate.sockets_close	(		self,
		*	,
		typing.Optional[int]	count = None )

Close all the connection going through the gate.

Definition at line 590 of file chaos.py.

start()

pytest_userver.chaos.BaseGate.start

(

self

)

Open the socket and start accepting tasks.

Definition at line 526 of file chaos.py.

start_accepting()

None pytest_userver.chaos.BaseGate.start_accepting

(

self

)

Start accepting tasks.

Definition at line 550 of file chaos.py.

stop()

None pytest_userver.chaos.BaseGate.stop

(

self

)

Stop accepting tasks, close all the sockets.

Definition at line 570 of file chaos.py.

stop_accepting()

None pytest_userver.chaos.BaseGate.stop_accepting

(

self

)

Stop accepting tasks without closing the accepting socket.

Definition at line 562 of file chaos.py.

to_client_close_on_data()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_close_on_data

(

self

)

Close on first bytes of data from server.

Definition at line 709 of file chaos.py.

to_client_concat_packets()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_concat_packets	(		self,
		int	packet_size )

Pass data in bigger parts.

Parameters

packet_size

minimal size of the resulting packet

Reimplemented in pytest_userver.chaos.UdpGate.

Definition at line 800 of file chaos.py.

to_client_corrupt_data()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_corrupt_data

(

self

)

Corrupt data received from server.

Definition at line 719 of file chaos.py.

to_client_delay()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_delay	(		self,
		float	delay )

Delay data transmission.

Definition at line 691 of file chaos.py.

to_client_drop()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_drop

(

self

)

Read and discard data.

Definition at line 673 of file chaos.py.

to_client_limit_bps()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_limit_bps	(		self,
		float	bytes_per_second )

Limit bytes per second transmission by network from server.

Definition at line 732 of file chaos.py.

to_client_limit_bytes()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_limit_bytes	(		self,
		int	bytes_limit )

Drop all connections each bytes_limit of data sent by network.

Definition at line 813 of file chaos.py.

to_client_limit_time()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_limit_time	(		self,
		float	timeout,
		float	jitter )

Limit connection lifetime on receive of first bytes from server.

Definition at line 749 of file chaos.py.

to_client_noop()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_noop

(

self

)

Do not read data, causing server to keep multiple data.

Definition at line 663 of file chaos.py.

to_client_pass()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_pass

(

self

)

Pass data as is.

Definition at line 653 of file chaos.py.

to_client_smaller_parts()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_smaller_parts	(		self,
		int	max_size,
		*	,
		float	sleep_per_packet = 0 )

Pass data to client in smaller parts.

Parameters

max_size	Max packet size to send to client
sleep_per_packet	Optional sleep interval per packet, seconds

Reimplemented in pytest_userver.chaos.UdpGate.

Definition at line 775 of file chaos.py.

to_client_substitute()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_client_substitute	(		self,
		str	pattern,
		str	repl )

Apply regex substitution to data from server.

Definition at line 827 of file chaos.py.

to_server_close_on_data()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_close_on_data

(

self

)

Close on first bytes of data from client.

Definition at line 704 of file chaos.py.

to_server_concat_packets()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_concat_packets	(		self,
		int	packet_size )

Pass data in bigger parts.

Parameters

packet_size

minimal size of the resulting packet

Reimplemented in pytest_userver.chaos.UdpGate.

Definition at line 792 of file chaos.py.

to_server_corrupt_data()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_corrupt_data

(

self

)

Corrupt data received from client.

Definition at line 714 of file chaos.py.

to_server_delay()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_delay	(		self,
		float	delay )

Delay data transmission.

Definition at line 678 of file chaos.py.

to_server_drop()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_drop

(

self

)

Read and discard data.

Definition at line 668 of file chaos.py.

to_server_limit_bps()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_limit_bps	(		self,
		float	bytes_per_second )

Limit bytes per second transmission by network from client.

Definition at line 724 of file chaos.py.

to_server_limit_bytes()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_limit_bytes	(		self,
		int	bytes_limit )

Drop all connections each bytes_limit of data sent by network.

Definition at line 808 of file chaos.py.

to_server_limit_time()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_limit_time	(		self,
		float	timeout,
		float	jitter )

Limit connection lifetime on receive of first bytes from client.

Definition at line 740 of file chaos.py.

to_server_noop()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_noop

(

self

)

Do not read data, causing client to keep multiple data.

Definition at line 658 of file chaos.py.

to_server_pass()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_pass

(

self

)

Pass data as is.

Definition at line 648 of file chaos.py.

to_server_smaller_parts()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_smaller_parts	(		self,
		int	max_size,
		*	,
		float	sleep_per_packet = 0 )

Pass data to server in smaller parts.

Parameters

max_size	Max packet size to send to server
sleep_per_packet	Optional sleep interval per packet, seconds

Reimplemented in pytest_userver.chaos.UdpGate.

Definition at line 758 of file chaos.py.

to_server_substitute()

callinfo.AsyncCallQueue pytest_userver.chaos.BaseGate.to_server_substitute	(		self,
		str	pattern,
		str	repl )

Apply regex substitution to data from client.

Definition at line 818 of file chaos.py.

Member Data Documentation

_accept_sockets

list pytest_userver.chaos.BaseGate._accept_sockets = []

protected

Definition at line 511 of file chaos.py.

_accept_tasks

pytest_userver.chaos.BaseGate._accept_tasks = []

protected

Definition at line 512 of file chaos.py.

_loop

pytest_userver.chaos.BaseGate._loop = loop

protected

Definition at line 506 of file chaos.py.

_NOT_IMPLEMENTED_MESSAGE

pytest_userver.chaos.BaseGate._NOT_IMPLEMENTED_MESSAGE = 'Do not use BaseGate itself, use one of specializations TcpGate or UdpGate'

staticprotected

Definition at line 500 of file chaos.py.

_route

pytest_userver.chaos.BaseGate._route = route

protected

Definition at line 503 of file chaos.py.

_sockets

pytest_userver.chaos.BaseGate._sockets = set()

protected

Definition at line 514 of file chaos.py.

_to_client_intercept

pytest_userver.chaos.BaseGate._to_client_intercept = _intercept_ok

protected

Definition at line 509 of file chaos.py.

_to_server_intercept

pytest_userver.chaos.BaseGate._to_server_intercept = _intercept_ok

protected

Definition at line 508 of file chaos.py.

---

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

• /data/code/userver/testsuite/pytest_plugins/pytest_userver/chaos.py