ChillerDragon/teeworlds_network
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Fix server side integration tests

Browse source
This commit is contained in:
ChillerDragon 2024-01-22 23:38:31 +08:00
parent 55549eaa60
commit ec90f185e4
3 changed files with 97 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
.github/workflows/integration.yml vendored
View file

@ -19,24 +19,33 @@ jobs:
- name: Prepare - name: Prepare
run: | run: |
sudo apt-get update -y sudo apt-get update -y
sudo apt-get install -y shellcheck teeworlds-server sudo apt-get install -y shellcheck teeworlds-server teeworlds teeworlds-data
sudo apt install -y build-essential glslang-tools libavcodec-extra libavdevice-dev libavfilter-dev libavformat-dev libavutil-dev libcurl4-openssl-dev libfreetype6-dev libglew-dev libnotify-dev libogg-dev libopus-dev libopusfile-dev libpng-dev libsdl2-dev libsqlite3-dev libssl-dev libvulkan-dev libwavpack-dev libx264-dev
gem install bundler gem install bundler
gem install rubocop:1.31.2 gem install rubocop:1.31.2
bundle install --jobs 4 --retry 3 bundle install --jobs 4 --retry 3
wget https://github.com/ChillerDragon/teeworlds/releases/download/v0.7.5-headless/teeworlds-0.7.5-linux_x86_64.tar.gz wget https://github.com/ChillerDragon/teeworlds/releases/download/v0.7.5-headless/teeworlds-0.7.5-linux_x86_64.tar.gz
tar -xvzf teeworlds-0.7.5-linux_x86_64.tar.gz tar -xvzf teeworlds-0.7.5-linux_x86_64.tar.gz
sudo mkdir -p /usr/local/bin/ sudo mkdir -p /usr/local/bin/
sudo mv teeworlds-0.7.5-linux_x86_64/teeworlds /usr/local/bin/teeworlds-headless sudo mv teeworlds-0.7.5-linux_x86_64/teeworlds /usr/local/bin/teeworlds-headless
rm -rf teeworlds-0.7.5-linux_x86_64* rm -rf teeworlds-0.7.5-linux_x86_64*
wget https://github.com/ChillerDragon/ddnet/releases/download/v16.5-headless/DDNet-headless.zip wget https://github.com/ChillerDragon/ddnet/releases/download/v16.5-headless/DDNet-headless.zip
unzip DDNet-headless.zip unzip DDNet-headless.zip
sudo mv DDNet-headless /usr/local/bin sudo mv DDNet-headless /usr/local/bin
rm DDNet-headless.zip rm DDNet-headless.zip
wget https://github.com/ChillerDragon/ddnet/releases/download/v17.4.2-headless-0.7/DDNet7-headless.zip
unzip DDNet7-headless.zip wget https://github.com/ChillerDragon/ddnet/releases/download/v17.4.2-headless-0.7/DDNet7-headless-linux.zip
unzip DDNet7-headless-linux.zip
chmod +x DDNet7-headless chmod +x DDNet7-headless
sudo mv DDNet7-headless /usr/local/bin sudo mv DDNet7-headless /usr/local/bin
rm DDNet7-headless.zip rm DDNet7-headless-linux.zip
echo 'TODO: remove this ugly hack!'
mkdir -p ~/.teeworlds/downloadedmaps
cd ~/.teeworlds/downloadedmaps
wget https://heinrich5991.de/teeworlds/maps/maps/dm1_64548818.map
- name: '[CLIENT] Test sending chat messages' - name: '[CLIENT] Test sending chat messages'
run: | run: |
./integration_test/run.sh client/chat.rb ./integration_test/run.sh client/chat.rb

113
integration_test/run.sh
View file

@ -9,16 +9,18 @@ kill_marker=kill_me_d5af0410
server_port=8377 server_port=8377
srvcfg="sv_rcon_password rcon;sv_port $server_port;$kill_marker" srvcfg="sv_rcon_password rcon;sv_port $server_port;$kill_marker"
cl_fifo="$PWD/$tmpdir/client.fifo" cl_fifo="$PWD/$tmpdir/client.fifo"
clcfg="cl_input_fifo $cl_fifo;connect 127.0.0.1:$server_port;$kill_marker" clcfg="cl_input_fifo $cl_fifo;connect 127.0.0.1:$server_port;player_name test_client;$kill_marker"
tw_srv_running=0 tw_srv_running=0
ruby_logfile=ruby_client.txt ruby_logfile=ruby_client.txt
ruby_logfile_err=ruby_client_stderr.txt
_client_pid=''
_kill_pids=() _kill_pids=()
mkdir -p logs mkdir -p logs
mkdir -p tmp mkdir -p tmp
function start_tw_server() { start_tw_server() {
if [[ -x "$(command -v teeworlds_srv)" ]] if [[ -x "$(command -v teeworlds_srv)" ]]
then then
teeworlds_srv "$srvcfg" &> "$logdir/server.txt" teeworlds_srv "$srvcfg" &> "$logdir/server.txt"
@ -37,7 +39,7 @@ function start_tw_server() {
tw_srv_running=1 tw_srv_running=1
} }
function connect_tw_client() { connect_tw_client() {
if [[ -x "$(command -v teeworlds-headless)" ]] if [[ -x "$(command -v teeworlds-headless)" ]]
then then
teeworlds-headless "$clcfg" teeworlds-headless "$clcfg"
@ -53,7 +55,7 @@ function connect_tw_client() {
fi fi
} }
function connect_ddnet7_client() { connect_ddnet7_client() {
local clcfg_dd7 local clcfg_dd7
clcfg_dd7="$(echo "$clcfg" | sed 's/127.0.0.1/tw-0.7+udp:\/\/127.0.0.1/')" clcfg_dd7="$(echo "$clcfg" | sed 's/127.0.0.1/tw-0.7+udp:\/\/127.0.0.1/')"
if [[ -x "$(command -v DDNet7-headless)" ]] if [[ -x "$(command -v DDNet7-headless)" ]]
@ -68,10 +70,10 @@ function connect_ddnet7_client() {
fi fi
} }
function get_test_names() { get_test_names() {
(find client -name "*.rb";find server -name "*.rb") | tr '\n' ' ' (find client -name "*.rb";find server -name "*.rb") | tr '\n' ' '
} }
function invalid_test() { invalid_test() {
local name="$1" local name="$1"
echo "Error: invalid test name '$name'" echo "Error: invalid test name '$name'"
echo " valid tests: $(get_test_names)" echo " valid tests: $(get_test_names)"
@ -95,11 +97,13 @@ fi
if [[ "$testname" =~ ^client/ ]] if [[ "$testname" =~ ^client/ ]]
then then
ruby_logfile="$logdir/ruby_client.txt" ruby_logfile="$logdir/ruby_client.txt"
ruby_logfile_err="$logdir/ruby_client_stderr.txt"
else else
ruby_logfile="$logdir/ruby_server.txt" ruby_logfile="$logdir/ruby_server.txt"
ruby_logfile_err="$logdir/ruby_server_stderr.txt"
fi fi
function kill_all_jobs() { kill_all_jobs() {
local i local i
local kill_pid local kill_pid
for i in "${!_kill_pids[@]}" for i in "${!_kill_pids[@]}"
@ -114,7 +118,7 @@ function kill_all_jobs() {
pkill -f "$kill_marker" pkill -f "$kill_marker"
} }
function cleanup() { cleanup() {
if [ "$tw_srv_running" == "1" ] if [ "$tw_srv_running" == "1" ]
then then
echo "[*] shutting down server ..." echo "[*] shutting down server ..."
@ -127,7 +131,7 @@ function cleanup() {
trap cleanup EXIT trap cleanup EXIT
function fail() { fail() {
local msg="$1" local msg="$1"
if [ ! -f "$tmpdir/fail.txt" ] if [ ! -f "$tmpdir/fail.txt" ]
then then
@ -139,35 +143,42 @@ function fail() {
# maybe a sleep does as well # maybe a sleep does as well
# or I still did not get flushing # or I still did not get flushing
tail "$ruby_logfile" &>/dev/null tail "$ruby_logfile" &>/dev/null
tail "$ruby_logfile_err" &>/dev/null
if [[ "$testname" =~ ^client/ ]] if [[ "$testname" =~ ^client/ ]]
then then
echo "[-] end of ruby client log:" echo "[-] end of ruby client log:"
tail "$ruby_logfile" tail -n 10 "$ruby_logfile"
echo "[-] end of server log:" echo "[-] end of server log:"
tail "$logdir/server.txt" tail "$logdir/server.txt"
else else
echo "[-] end of ruby server log:" echo "[-] end of ruby server log:"
tail "$ruby_logfile" tail -n 10 "$ruby_logfile"
echo "[-] end of client log:" echo "[-] end of client log:"
tail "$logdir/client.txt" cat "$logdir/client.txt"
fi
if [ ! -s "$ruby_logfile_err" ]
then
echo "[-] got ruby stderr $ruby_logfile_err"
cat "$ruby_logfile_err"
fi fi
fi fi
echo "$msg" echo "[-][FATAL] $msg"
exit 1 exit 1
} }
function timeout() { timeout() {
local seconds="$1" local seconds="$1"
sleep "$seconds" sleep "$seconds"
echo "[-] Timeout -> killing: $testname" echo "[-] Timeout -> killing: $testname"
touch "$tmpdir/timeout.txt" touch "$tmpdir/timeout.txt"
kill_all_jobs kill_all_jobs
fail "[-] Timeout" fail "Timeout"
} }
echo "[*] running test '$testname' ..." echo "[*] running test '$testname' ..."
[[ -f "$tmpdir/timeout.txt" ]] && rm "$tmpdir"/timeout.txt [[ -f "$tmpdir/timeout.txt" ]] && rm "$tmpdir"/timeout.txt
[[ -f "$tmpdir/fail.txt" ]] && rm "$tmpdir"/fail.txt [[ -f "$tmpdir/fail.txt" ]] && rm "$tmpdir"/fail.txt
:>"$ruby_logfile_err"
if [[ "$testname" =~ ^client/ ]] if [[ "$testname" =~ ^client/ ]]
then then
echo "ruby client log $(date)" > "$ruby_logfile" echo "ruby client log $(date)" > "$ruby_logfile"
@ -178,8 +189,8 @@ else
echo "ddnet7 client log $(date)" > "$logdir/client.txt" echo "ddnet7 client log $(date)" > "$logdir/client.txt"
echo "ruby server log $(date)" > "$ruby_logfile" echo "ruby server log $(date)" > "$ruby_logfile"
fi fi
function run_ruby_test() { run_ruby_test() {
if ! ruby "$testname" "$kill_marker" &> "$ruby_logfile" if ! ruby "$testname" "$kill_marker" 2> "$ruby_logfile_err" 1> "$ruby_logfile"
then then
fail "test $testname finished with non zero exit code" fail "test $testname finished with non zero exit code"
fi fi
@ -196,73 +207,110 @@ fi
if [[ "$testname" =~ ^server/ ]] if [[ "$testname" =~ ^server/ ]]
then then
connect_ddnet7_client "$kill_marker" &>> "$logdir/client.txt" & connect_ddnet7_client "$kill_marker" &>> "$logdir/client.txt" &
_kill_pids+=($!) _client_pid=$!
_kill_pids+=("$_client_pid")
sleep 1 sleep 1
fi fi
timeout 6 "$kill_marker" & timeout 20 "$kill_marker" &
_timeout_pid=$! _timeout_pid=$!
function fifo() { fifo() {
local cmd="$1" local cmd="$1"
local fifo_file="$2" local fifo_file="$2"
echo "[*] $cmd >> $fifo_file" echo "[*] $cmd >> $fifo_file"
echo "$cmd" >> "$fifo_file" echo "$cmd" >> "$fifo_file"
} }
assert_in_log() {
# usage: assert_in_log string path [num_matches"
# examples:
# assert_in_log "string to find" "/path/to/log.txt"
# assert_in_log "string to find" "/path/to/log.txt" 2
local needle="$1"
local logfile_path="$2"
local num_matches="$3"
if ! grep -q "$needle" "$logfile_path"
then
echo "[-] Error: did not find expected string in logs"
echo "[-]"
echo "[-] expected: $needle"
echo "[-] in file: $ruby_logfile"
echo "[-]"
fail "assert failed"
fi
if [ "$num_matches" != "" ]
then
local actual_matches
actual_matches="$(grep -c "$needle" "$logfile_path")"
if [ "$actual_matches" != "$num_matches" ]
then
echo "[-] Error: found string unexpected amount of times in log file"
echo "[-]"
echo "[-] expected: $needle"
echo "[-] in file: $ruby_logfile"
echo "[-]"
echo "[-] expected num hits: $num_matches"
echo "[-] got num hits: $actual_matches"
echo "[-]"
fail "assert failed"
fi
fi
echo "[*] $needle .. OK"
}
if [ "$testname" == "client/chat.rb" ] if [ "$testname" == "client/chat.rb" ]
then then
if ! grep -q 'hello world' "$logdir/server.txt" if ! grep -q 'hello world' "$logdir/server.txt"
then then
fail "Error: did not find chat message in server log" fail "did not find chat message in server log"
fi fi
elif [ "$testname" == "client/reconnect.rb" ] elif [ "$testname" == "client/reconnect.rb" ]
then then
if ! grep -q 'bar' "$logdir/server.txt" if ! grep -q 'bar' "$logdir/server.txt"
then then
fail "Error: did not find 2nd chat message in server log" fail "did not find 2nd chat message in server log"
fi fi
elif [ "$testname" == "client/rcon.rb" ] elif [ "$testname" == "client/rcon.rb" ]
then then
sleep 1 sleep 1
if pgrep -f "$tw_srv_bin $srvcfg" if pgrep -f "$tw_srv_bin $srvcfg"
then then
fail "Error: server still running rcon shutdown failed" fail "server still running rcon shutdown failed"
fi fi
elif [ "$testname" == "client/srv_say.rb" ] elif [ "$testname" == "client/srv_say.rb" ]
then then
if ! grep -q '^\[chat\].*hello' "$logdir/ruby_client.txt" if ! grep -q '^\[chat\].*hello' "$logdir/ruby_client.txt"
then then
fail "Error: missing 'hello' chat message in client log" fail "missing 'hello' chat message in client log"
fi fi
elif [ "$testname" == "client/multiple_blocks.rb" ] elif [ "$testname" == "client/multiple_blocks.rb" ]
then then
sleep 1 sleep 1
if pgrep -f "$tw_srv_bin $srvcfg" if pgrep -f "$tw_srv_bin $srvcfg"
then then
fail "Error: server still running rcon shutdown failed (2 blocks)" fail "server still running rcon shutdown failed (2 blocks)"
fi fi
block1_ln="$(grep -n "block 1" "$ruby_logfile" | cut -d':' -f1)" block1_ln="$(grep -n "block 1" "$ruby_logfile" | cut -d':' -f1)"
block2_ln="$(grep -n "block 2" "$ruby_logfile" | cut -d':' -f1)" block2_ln="$(grep -n "block 2" "$ruby_logfile" | cut -d':' -f1)"
if [ "$block1_ln" == "" ] if [ "$block1_ln" == "" ]
then then
fail "Error: 'block 1' not found in client log" fail "'block 1' not found in client log"
fi fi
if [ "$block2_ln" == "" ] if [ "$block2_ln" == "" ]
then then
fail "Error: 'block 2' not found in client log" fail "'block 2' not found in client log"
fi fi
if [[ ! "$block1_ln" =~ ^[0-9]+$ ]] if [[ ! "$block1_ln" =~ ^[0-9]+$ ]]
then then
fail "Error: failed to parse line number of 'block 1' got='$block1_ln'" fail "failed to parse line number of 'block 1' got='$block1_ln'"
fi fi
if [[ ! "$block2_ln" =~ ^[0-9]+$ ]] if [[ ! "$block2_ln" =~ ^[0-9]+$ ]]
then then
fail "Error: failed to parse line number of 'block 2' got='$block2_ln'" fail "failed to parse line number of 'block 2' got='$block2_ln'"
fi fi
# ensure block call order matches definition order # ensure block call order matches definition order
if [ "$block1_ln" -gt "$block2_ln" ] if [ "$block1_ln" -gt "$block2_ln" ]
then then
fail "Error: 'block 1' found after 'block 2' in client log" fail "'block 1' found after 'block 2' in client log"
fi fi
elif [ "$testname" == "server/connect.rb" ] elif [ "$testname" == "server/connect.rb" ]
then then
@ -271,6 +319,11 @@ then
fifo "rcon shutdown" "$cl_fifo" fifo "rcon shutdown" "$cl_fifo"
sleep 1 sleep 1
fifo "quit" "$cl_fifo" fifo "quit" "$cl_fifo"
# ddnet quitting can get stuck so send a kill to ensure it dies
kill "$_client_pid"
assert_in_log "'test_client' joined the game" "$ruby_logfile" 1
assert_in_log "rcon='shutdown'" "$ruby_logfile" 1
else else
echo "Error: unkown test '$testname'" echo "Error: unkown test '$testname'"
exit 1 exit 1

2
lib/teeworlds_server.rb
View file

@ -188,7 +188,7 @@ class TeeworldsServer
@game_server.on_rcon_cmd(chunk, packet) @game_server.on_rcon_cmd(chunk, packet)
when NETMSG_RCON_AUTH when NETMSG_RCON_AUTH
@game_server.on_rcon_auth(chunk, packet) @game_server.on_rcon_auth(chunk, packet)
when NETSMSG_NULL when NETMSG_NULL
nil # TODO: ddnet ex messages nil # TODO: ddnet ex messages
else else
puts "Unsupported system msg: #{chunk.msg}" puts "Unsupported system msg: #{chunk.msg}"