History

Kim De Mey dbc1ae86e2 Vendor bumps + related fixes + warning fixes (#1985 ) - Vendor bump of stew, nim-eth, chronos, nimbus-eth2 and libp2p - Bump related fixes + fixes of deprecation warnings - Several other warnings fixed.		2024-01-24 16:28:03 +01:00
..
docker	Cleanup utp_test and make the code more flexible to change amounts (#1972 )	2024-01-15 17:29:29 +01:00
README.md	Cleanup utp_test and make the code more flexible to change amounts (#1972 )	2024-01-15 17:29:29 +01:00
utp_rpc_types.nim	Bump nim-web3 and others	2024-01-14 10:41:23 +07:00
utp_test.nim	Cleanup utp_test and make the code more flexible to change amounts (#1972 )	2024-01-15 17:29:29 +01:00
utp_test_app.nim	Vendor bumps + related fixes + warning fixes (#1985 )	2024-01-24 16:28:03 +01:00
utp_test_rpc_calls.nim	Improve utp test app (#947 )	2022-01-31 18:40:00 +01:00
utp_test_rpc_client.nim	Cleanup utp_test and make the code more flexible to change amounts (#1972 )	2024-01-15 17:29:29 +01:00

README.md

uTP testing infrastructure

Testing infrastructure which enables to test uTP implementation over different network conditions on a local machine.

Uses following tools developed to test the QUIC protocol:

quic-interop-runner

quic-network-simulator

Prerequisities

Machine with Docker installed
nimbus-eth1 set-up to run make utp_test

How it works

Test setup uses Docker Compose to start 3 Docker containers:

uTP client - which is an instance of the utp_test_app
uTP server - which is an instance of the utp_test_app
sim - which is an instance of the ns3 network simulator with several pre-compiled scenarios

The networking is set up in such way that network traffic is routed from client to server and server to client through the simulator. The simulator decides what to do with packets passing through based on the selected scneario.

Explanation from quic-network-simulator:

The framework uses two networks on the host machine: `leftnet` (IPv4
193.167.0.0/24, IPv6 fd00:cafe:cafe:0::/64) and `rightnet` (IPv4
193.167.100.0/24, IPv6 fd00:cafe:cafe:100::/64). `leftnet` is connected to the
client docker image, and `rightnet` is connected to the server. The ns-3
simulation sits in the middle and forwards packets between `leftnet` and
`rightnet`

Practicalities

For now the process is semi-manual (TODO automate this as much as possible)

To run integration testing scenarios with different network conditions:

1. cd nimbus-eth1/
2. docker build -t test-utp --build-arg BRANCH_NAME={branch-name} fluffy/tools/utp_testing/docker
3. SCENARIO="scenario_details" docker-compose -f fluffy/tools/utp_testing/docker/docker-compose.yml up

For example:
SCENARIO="drop-rate --delay=15ms --bandwidth=10Mbps --queue=25 --rate_to_client=0 --rate_to_server=0" docker-compose -f fluffy/tools/utp_testing/docker/docker-compose.yml up
would start `drop-rate` scenario with specified delay, bandwith, and different drop rates
4. make utp-test

All scenarios are specified in: scenarios