client_server_mode.md

To start SAI Challenger on top of vslib in client-server mode

In client-server mode, SAI server - syncd linked with vslib - runs in one Docker container. Whereas the client - SAI Challenger - runs in the separate Docker container. These two Docker containers can also be running on the separate physical hosts.

Build Docker image with vslib SAI implementation:

docker build -f Dockerfile.saivs.server -t saivs-server .

Build SAI Challenger Docker image with SAI tests:

docker build -f Dockerfile.client -t sai-challenger-client .

Start SAI Challenger server:

docker run --name saivs \
	--cap-add=NET_ADMIN \
	--device /dev/net/tun:/dev/net/tun \
	-d saivs-server

Start SAI Challenger client:

docker run --name sai-challenger \
	-v $(pwd):/sai-challenger \
	--cap-add=NET_ADMIN \
	--device /dev/net/tun:/dev/net/tun \
	-d sai-challenger-client

To run SAI Challenger testcases in client-server mode

Run SAI Challenger testcases:

docker exec -ti sai-challenger pytest \
	--sai-server=<saivs-server-ip> --traffic \
	-v test_l2_basic.py

Run SAI Challenger testcases and generate HTML report:

docker exec -ti sai-challenger pytest -v \
	--sai-server=<saivs-server-ip> --traffic \
	--html=report.html --self-contained-html \
	test_l2_basic.py

NOTE: The option --traffic will be ignored when running on vslib SAI implementation.