douile/net-replay-test

WIP: Capture and replay network packet integration tests for use with gamedig

net-replay-test

A testing tool for capturing network traffic to a specific server during a query, then replaying the packets and validating the output matches.

Requirements

libpcap (for capture)

See rust-pcap for installation help.

cap_net_raw,cap_net_admin=eip (for capture)

In order to capture packets the binary requires special permissions on linux, to set use:

$ sudo setcap cap_net_raw,cap_net_admin=eip ./net-replay-test

Usage (CLI)

Build

$ cargo build --bin net-replay-test --all-features --release

Capturing

$ ./net-replay-test --implementation node capture --device eth0 csgo 127.0.0.1 27015

A new JSON file named with the date, game, and hostname will be created in the current directory if the capture was successful.

Replay

$ ./net-replay-test --implementation node replay ./replay-...json

Usage (test lib)

TODO

net-replay-test's Issues

Document public functions

Add CI

Add CI to clippy + fmt + check

Compare output

Output from replay needs to be compared

Add username censorship

Add option to censor usernames in final output

Add capture option to replay

Capture pcap during replay could help debug problems

Programify output

Lots of the output at the moment is printed to stdout. Instead any important data should be returned to the caller with the option of debug printing via a (feature?) flag.

Document library usage

Out of order packets

In the current implementation packets are sent in the order they were captured, an enhancement might be storing sets of request -> replies, then when server receives a given request it sends all the replies. Related #4

Capture streams

Capture TCP streams so that the server implementation knows when it should accept/close connections, useful for #3

Support UDP+TCP captures

The current implementation can only replay captures that use one of TCP or UDP, this could be made agnostic by simply having a server that has both UDP and TCP listeners open.