X-Git-Url: https://git.cworth.org/git?p=empires-server;a=blobdiff_plain;f=test;h=646cdcabc0654af15ecbe90b1d5870c7e9846b29;hp=30dbe7f2781cd292de35b2b4112862f11af992c3;hb=771e0ce4711a7ed723d216c28ab8d1472463d3ef;hpb=d6817ef860a230cbbb694e729a400ed37ed43d68 diff --git a/test b/test index 30dbe7f..646cdca 100755 --- a/test +++ b/test @@ -1,5 +1,15 @@ #!/bin/bash +# Arrange for some cleanup to be executed if the user interrupts the +# test sutie (for example, by pressing ControlC at the controlling +# terminal). +cleanup_and_report() { + empathy_deactivate_all >/dev/null 2>&1 + TEST_REPORT + exit $? +} +trap cleanup_and_report INT + usage () { echo "Usage:$0 " @@ -60,6 +70,7 @@ TEST_END() # Print report of all previous test results TEST_REPORT() { + echo "" echo "" echo "Test Report" echo "===========" @@ -85,24 +96,64 @@ contains() grep -q "$2" <<< $1 } -# Post to a URL endpoint with optional JSON data +# POST to a URL endpoint with optional JSON data # # Usage: # -# curl_post [data] +# curl_post [data] [CURL_OPTIONS] curl_post() { - $CURL -X POST ${2:+-H 'Content-Type: application/json' -d "$2"} $URL/$1 + $CURL ${3:-} -X POST ${2:+-H 'Content-Type: application/json' -d "$2"} $URL/$1 +} + +# POST to a URL endpoint with optional JSON data using a cookie +# +# Usage: +# +# curl_post_cookie [data] [CURL_OPTIONS] +# +# Where is a string for which there is a defined variable +# named ${name}_cookie which in turn holds a value that is a filename +# of a valid cookie +curl_post_cookie() +{ + cookie=${1}_cookie + curl_post $2 "${3:-}" "-b ${!cookie} ${4:-}" } -# Get form a URL endpoint +# PUT to a URL endpoint with optional JSON data # # Usage: # -# curl_get +# curl_post [data] [CURL_OPTIONS] +curl_put() +{ + $CURL ${3:-} -X PUT ${2:+-H 'Content-Type: application/json' -d "$2"} $URL/$1 +} + +# GET from a URL endpoint +# +# Usage: +# +# curl_get [CURL_OPTIONS] curl_get() { - $CURL $URL/$1 + $CURL ${2:-} $URL/$1 +} + +# GET from a URL endpoint using a cookie +# +# Usage: +# +# curl_get_cookie [CURL_OPTIONS] +# +# Where is a string for which there is a defined variable +# named ${name}_cookie which in turn holds a value that is a filename +# of a valid cookie +curl_get_cookie() +{ + cookie=${1}_cookie + curl_get $2 "-b ${!cookie} ${3:-}" } # Create a new game of the specified engine type @@ -140,6 +191,24 @@ tictactoe_game_id=$(new_game tictactoe) test "$tictactoe_game_id" != "" TEST_END $tictactoe_game_id +TEST_SUBSECTION "Test redirects" + +TEST "Redirect of /GAMEID at top level" +redirect=$(curl_get $empires_game_id) +test "$redirect" = "Moved Permanently. Redirecting to /empires/$empires_game_id/" +TEST_END + +TEST "Redirect of lowercase /gameid at top level" +empires_game_id_lower=$(tr '[:upper:]' '[:lower:]' <<< $empires_game_id) +redirect=$(curl_get $empires_game_id_lower) +test "$redirect" = "Moved Permanently. Redirecting to /$empires_game_id/" +TEST_END + +TEST "Redirect of lowercase /empires/gameid" +redirect=$(curl_get empires/$empires_game_id_lower) +test "$redirect" = "Moved Permanently. Redirecting to /empires/$empires_game_id/" +TEST_END + TEST_SECTION "Empires game" empires_game_path=empires/$empires_game_id @@ -268,5 +337,692 @@ players=$(empires_players_string) test "$players" = "" TEST_END -TEST_REPORT +TEST_SECTION "Tic Tac Toe game" + +tictactoe_game_path=tictactoe/$tictactoe_game_id + +tictactoe_profile() +{ + curl_put /profile "{ \"nickname\": \"$1\" }" "-c .cookie-tictactoe" +} + +tictactoe_move() +{ + curl_post $tictactoe_game_path/move "{ \"move\": $1 }" "-b .cookie-tictactoe" +} + +tictactoe_player_info() +{ + curl_get $tictactoe_game_path/events "-m 0.1 -b .cookie-tictactoe" 2>&1 \ + | grep player-info -A 1 \ + | grep ^data +} + +tictactoe_player_name() +{ + curl_put $tictactoe_game_path/player "{ \"name\": \"$1\" }" "-b .cookie-tictactoe" +} + +tictactoe_player_team() +{ + curl_put $tictactoe_game_path/player "{ \"team\": \"$1\" }" "-b .cookie-tictactoe" +} + +TEST_SUBSECTION "Tic Tac Toe player-info" + +TEST "Hit LMNO /profile to set name to 'curl'" +tictactoe_profile curl +TEST_END + +TEST "Verify player-info event reports 'curl' name" +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"curl","team":""}' +TEST_END + +TEST_SUBSECTION "Tic Tac Toe /player" + +TEST "Change name to 'newname'" +tictactoe_player_name newname +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"newname","team":""}' +TEST_END + +TEST "Change team to 'X'" +tictactoe_player_team X +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"newname","team":"X"}' +TEST_END + +TEST "Change team to 'O'" +tictactoe_player_team O +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"newname","team":"O"}' +TEST_END + +TEST "Verify cannot change team to 'Z'" +tictactoe_player_team Z +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"newname","team":"O"}' +TEST_END + +TEST "Leave current team" +tictactoe_player_team "" +result=$(tictactoe_player_info) +test "$result" = 'data: {"id":1,"name":"newname","team":""}' +TEST_END + +TEST_SUBSECTION "Tic Tac Toe /move" + +TEST "First move doesn't require a team" +result=$(tictactoe_move 0) +test "$result" = '{"legal":true}' +TEST_END + +TEST "Second move does require a team" +result=$(tictactoe_move 4) +test "$result" = '{"legal":false,"message":"It'"'"'s not your turn to move"}' +TEST_END + +TEST "Illegal to move when it's not your turn" +tictactoe_player_team X +result=$(tictactoe_move 4) +test "$result" = '{"legal":false,"message":"It'"'"'s not your turn to move"}' +TEST_END + +TEST "Legal move to center square" +tictactoe_player_team O +result=$(tictactoe_move 4) +test "$result" = '{"legal":true}' +TEST_END + +TEST "Move to center square again is now illegal" +tictactoe_player_team X +result=$(tictactoe_move 4) +test "$result" = '{"legal":false,"message":"Square is already occupied"}' +TEST_END + +TEST_SECTION "Empathy game" + +TEST_SUBSECTION "Create a game and register 3 players" + +TEST "Create the game" +empathy_game_id=$(new_game empathy) +test "$empathy_game_id" != "" +TEST_END $empathy_game_id + +empathy_game_path=empathy/$empathy_game_id + +# Usage: empathy_get [curl_options] +empathy_get() +{ + curl_get_cookie $1 $empathy_game_path/$2 "${3:-}" +} + +# Usage: empathy_post [data] +empathy_post() +{ + curl_post_cookie $1 $empathy_game_path/$2 "${3:-}" +} + +# Given a player name as $1 (eg. "empathy_player_activate alice") set both +# $1_cookie and $1_pid (that is $alice_cookie and $alice_pid) to +# a filename containing a cookie and the PID of a running event-streaming +# process. +empathy_player_activate() +{ + player="$1" + player_cookie=${player}_cookie + player_pid=${player}_pid + + eval ${player_cookie}=".cookie-empathy-$player" + curl_put /profile "{ \"nickname\": \"$player\" }" "-c ${!player_cookie}" + empathy_get $player events >/dev/null 2>&1 & + eval ${player_pid}=$! + empathy_players+=($player) +} + +empathy_player_reactivate() +{ + player="$1" + player_pid=${player}_pid + + empathy_get $player events >/dev/null 2>&1 & + eval ${player_pid}=$! +} + +# Usage: empathy_player_deactivate +empathy_player_deactivate() +{ + player="$1" + player_pid=${player}_pid + if [ "${!player_pid}" != "" ]; then + pkill -P ${!player_pid} + fi + eval ${player_pid}="" +} + +empathy_deactivate_all() +{ + for player in ${empathy_players[*]}; do + empathy_player_deactivate $player + done +} + +# Pulls a single named event out of the empathy event stream +# +# Usage: empathy_get_event +empathy_get_event() +{ + empathy_get $1 events "-m 0.1" 2>&1 \ + | grep "^event: $2" -A 1 \ + | grep ^data: \ + | sed -e 's,^data: *,,' +} + +# Usage: empathy_player_name +empathy_player_name() +{ + empathy_get_event $1 player-info | jq -r .name +} + +TEST "Set 'alice' in session" +empathy_player_activate alice +test "$alice_cookie" = ".cookie-empathy-alice" +TEST_END + +TEST "Register alice and verify name" +result=$(empathy_player_name alice) +test "$result" = "alice" +TEST_END + +TEST "Register bob" +empathy_player_activate bob +result=$(empathy_player_name bob) +test "$result" = "bob" +TEST_END + +TEST "Register charlie" +empathy_player_activate charlie +result=$(empathy_player_name charlie) +test "$result" = "charlie" +TEST_END + +TEST_SUBSECTION "Category selection" + +# Usage: empathy_submit_prompt +empathy_submit_prompt() +{ + empathy_post $1 prompts "{ \"items\": $2, \"prompt\": \"$3\"}" +} + +TEST "Huge numbers are rejected" +result=$(empathy_submit_prompt alice 10000 "10,000 Maniacs") +test "$result" = '{"valid":false,"message":"Maximum number of items is 20"}' +TEST_END + +TEST "Submit a category" +prompt_id=$(empathy_submit_prompt alice 4 "4 things on a beach" | jq .id) +test "$prompt_id" = "1" +TEST_END + +# Usage: empathy_vote +empathy_vote() +{ + empathy_post $1 vote/$2 +} + +TEST "Vote on this category" +empathy_vote alice $prompt_id +test "$?" = "0" +TEST_END + +# Usage: empathy_start +empathy_start() +{ + empathy_post $1 start/$2 +} + +TEST "Start the game with this category" +empathy_start alice $prompt_id +test "$?" = "0" +TEST_END + +# Usage: empathy_answer +empathy_answer() +{ + empathy_post $1 answer/$2 "{ \"answers\": [$3]}" +} + +TEST_SUBSECTION "Submitting answers" + +TEST "Submit from a non-player fails" +bogus_cookie=/dev/null +result=$(empathy_answer bogus $prompt_id '"Sun", "Sand", "Water", "People"') +test "$result" = '{"valid":false,"message":"Player not found"}' +TEST_END + +TEST "Submit from alice succeeds" +result=$(empathy_answer alice $prompt_id '"sun", "sand", "water", "people"') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Submit from bob succeeds" +result=$(empathy_answer bob $prompt_id '"sand", "sands", "SunLight", "towels"') +test "$result" = '{"valid":true}' +TEST_END + +# Usage: empathy_ambiguities +empathy_ambiguities() +{ + empathy_get_event $1 game-state | jq .ambiguities +} + +TEST "Judging hasn't started with player unsubmitted" +result=$(echo $(empathy_ambiguities alice)) +test "$result" = "null" +TEST_END + +TEST "Submit from charlie succeeds" +result=$(empathy_answer charlie $prompt_id '"SunShine", "Grains of Sand", "wafer", "people"') +test "$result" = '{"valid":true}' +TEST_END + +TEST_SUBSECTION "Transition from answering to judging (no voting needed)" + +TEST "Judging already started" +result=$(echo $(empathy_ambiguities alice)) +test "$result" != "null" +TEST_END + +TEST_SUBSECTION "Judging answers" + +# Usage: empathy_ambiguities_list +empathy_ambiguities_list() +{ + empathy_get_event $1 game-state | jq .ambiguities[] +} + +TEST "Received all unique words" +# echo here is to strip newlines +result=$(echo $(empathy_ambiguities_list alice)) +test "$result" = '"Grains of Sand" "people" "sand" "sands" "sun" "SunLight" "SunShine" "towels" "wafer" "water"' +TEST_END + +# Usage: empathy_judged +empathy_judged() +{ + empathy_post $1 judged/$2 "{ \"word_groups\": $3}" +} + +TEST "Submit word groups from alice" +result=$(empathy_judged alice $prompt_id '[["sun","SunLight","SunShine"],["sand","sands","Grains of Sand"],["water","wafer"]]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Submit word groups from bob" +result=$(empathy_judged bob $prompt_id '[["sands","grains of sand"],["water","wafer"]]') +test "$result" = '{"valid":true}' +TEST_END + +# Usage: empathy_scores +empathy_scores() +{ + empathy_get_event $1 game-state | jq .scores +} + +TEST "Scoring hasn't started with player unsubmitted" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +TEST "Submit word groups from charlie" +result=$(empathy_judged charlie $prompt_id '[["SunLight","SunShine"],["sand","Grains of Sand"]]') +test "$result" = '{"valid":true}' +TEST_END + +TEST_SUBSECTION "Transition from judging to scoring (no voting needed)" + +TEST "Scoring already started" +result=$(echo $(empathy_scores alice)) +test "$result" != "null" +TEST_END + +# Usage: empathy_scores_names_numbers +empathy_scores_names_numbers() +{ + empathy_get_event $1 game-state | jq '.scores.scores[]|.players[],.score' +} + +TEST_SUBSECTION "Scoring" + +TEST "Verify final scores as expected" +# echo here is to strip newlines +result=$(echo $(empathy_scores_names_numbers alice)) +test "$result" = '"charlie" 9 "alice" 8 "bob" 6' +TEST_END + +# Usage: empathy_words_submitted +empathy_words_submitted() +{ + empathy_get_event $1 game-state | jq '.scores.words[].word' +} + +TEST "Verify final list of words submitted" +# echo here is to strip newlines +result=$(echo $(empathy_words_submitted alice)) +test "$result" = '"Grains of Sand/sand/sands" "SunLight/SunShine" "wafer/water" "people" "sun" "towels"' +TEST_END + +TEST_SUBSECTION "New game (using voting to advance phases)" + +empathy_reset() +{ + curl_post $empathy_game_path/reset +} + +TEST "Any post to /reset resets the game" +empathy_reset +test "$?" = "0" +TEST_END + +TEST "Verify scoring is over" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +# Usage: empathy_answering +empathy_answering() +{ + empathy_post $1 answering/$2 +} + +TEST "Start 4-player game, 3 submissions" +empathy_player_activate dale +result=$(empathy_player_name dale) +test "$result" = "dale" +prompt_id=$(empathy_submit_prompt alice 4 "3 little words" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"I", "love", "you"' >/dev/null +empathy_answer bob $prompt_id '"I", "love", "food"' >/dev/null +empathy_answer charlie $prompt_id '"food", "is", "good"' >/dev/null +result=$(empathy_answering dale $prompt_id) +test "$result" = '{"valid":true}' +TEST_END + +TEST "Judging hasn't started with player unsubmitted" +result=$(echo $(empathy_ambiguities alice)) +test "$result" = "null" +TEST_END + +# Usage: empathy_end_answers +empathy_end_answers() +{ + empathy_post $1 end-answers/$2 +} + +TEST "Minority of players vote to end answering" +empathy_end_answers alice $prompt_id +empathy_end_answers bob $prompt_id +test "$?" = "0" +TEST_END + +TEST "Judging still hasn't started" +result=$(echo $(empathy_ambiguities alice)) +test "$result" = "null" +TEST_END + +TEST "Majority of players vote to end answering" +empathy_end_answers charlie $prompt_id +test "$?" = "0" +TEST_END + +TEST "Judging has now started" +result=$(echo $(empathy_ambiguities alice)) +test "$result" != "null" +TEST_END + +# Usage: empathy_players_judging +empathy_players_judging() +{ + empathy_get_event $1 game-state | jq .players_judging[] +} + +TEST "Verify active players listed as judging" +# echo here is to strip newlines +result=$(echo $(empathy_players_judging alice)) +test "$result" = '"alice" "bob" "charlie"' +TEST_END + +TEST "Submit word groups from majority" +empathy_judged alice $prompt_id '[]' >/dev/null +result=$(empathy_judged bob $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring hasn't started with player unsubmitted" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +# Usage: empathy_end_judging +empathy_end_judging() +{ + empathy_post $1 end-judging/$2 +} + +TEST "Minority of players vote to end judging" +empathy_end_judging alice $prompt_id +test "$?" = "0" +TEST_END + +TEST "Scoring still hasn't started" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +TEST "Majority of players vote to end judging" +empathy_end_judging bob $prompt_id +test "$?" = "0" +TEST_END + +TEST "Scoring has now started" +result=$(echo $(empathy_scores alice)) +test "$result" != "null" +TEST_END + +TEST_SUBSECTION "New game (no voting needed when all answered players judge)" + +TEST "Start 4-player game, 3 submissions" +empathy_reset +prompt_id=$(empathy_submit_prompt alice 4 "1 truth or dare" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"truth"' >/dev/null +empathy_answer bob $prompt_id '"truth"' >/dev/null +empathy_answer charlie $prompt_id '"dare"' >/dev/null +empathy_end_answers alice $prompt_id +empathy_end_answers bob $prompt_id +empathy_end_answers charlie $prompt_id +test "$?" = "0" +TEST_END + +TEST "Submit word groups from 2 players" +empathy_judged alice $prompt_id '[]' >/dev/null +result=$(empathy_judged bob $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring hasn't started with player unsubmitted" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +TEST "Submit word groups from a non-answering player" +result=$(empathy_judged dale $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring still hasn't started" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +TEST "Submit word groups from last answering player" +result=$(empathy_judged charlie $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring has now started" +result=$(echo $(empathy_scores alice)) +test "$result" != "null" +TEST_END + +TEST_SUBSECTION "Non players don't affect judging requirements" + +TEST "Start 2-player game with 6 registered players" +empathy_reset +empathy_player_activate eric +empathy_player_activate fred +prompt_id=$(empathy_submit_prompt alice 4 "1 truth or dare" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"truth"' >/dev/null +empathy_answer bob $prompt_id '"true"' >/dev/null +empathy_end_answers alice $prompt_id +empathy_end_answers bob $prompt_id +test "$?" = "0" +TEST_END + +TEST "1 player votes for a match" +empathy_judged alice $prompt_id '[["truth","true"]]' >/dev/null +result=$(empathy_judged bob $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Verify the match passed the vote" +# echo here is to strip newlines +result=$(echo $(empathy_scores_names_numbers alice)) +test "$result" = '"alice" "bob" 2 "charlie" "dale" "eric" "fred" 0' +TEST_END + +echo "" +echo "NOTE: Slow tests ahead!" +echo "If you are impatient and somehow \"know\" you don't care about the" +echo "tests below then you can interrupt the test suite with Control-C" +echo "to get a summary report on the tests that have already been run." + +TEST_SUBSECTION "Inactive players don't appear in scores" + +TEST "Start 2-player game with 6 registered players" +empathy_reset +prompt_id=$(empathy_submit_prompt alice 4 "1 best pet" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"cats"' >/dev/null +empathy_answer bob $prompt_id '"dogs"' >/dev/null +empathy_end_answers alice $prompt_id +empathy_end_answers bob $prompt_id +test "$?" = "0" +TEST_END + +TEST "Deactivate 3 players" +empathy_player_deactivate dale +empathy_player_deactivate eric +empathy_player_deactivate fred +sleep 30 +test "$?" = "0" +TEST_END + +TEST "Finish game with 2 active players" +empathy_judged alice $prompt_id '[]' >/dev/null +result=$(empathy_judged bob $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Verify scores don't include inactive players" +# echo here is to strip newlines +result=$(echo $(empathy_scores_names_numbers alice)) +test "$result" = '"alice" "bob" 1 "charlie" 0' +TEST_END + +TEST_SUBSECTION "Deactivated players don't block future game phase advances" + +TEST "New 3-player game, 2 submit right away" +empathy_reset +prompt_id=$(empathy_submit_prompt charlie 4 "2 legit 2 quit" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"what", "gives?"' >/dev/null +empathy_answer bob $prompt_id '"so", "confused"' >/dev/null +test "$?" = "0" +TEST_END + +TEST "Judging hasn't started with player unsubmitted" +result=$(echo $(empathy_ambiguities alice)) +test "$result" = "null" +TEST_END + +TEST "Final active player submits" +result=$(empathy_answer charlie $prompt_id '"best", "category"') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Judging has started (don't need inactive players)" +result=$(echo $(empathy_ambiguities alice)) +test "$result" != "null" +TEST_END + +TEST "Submit word groups from 2 players" +empathy_judged alice $prompt_id '[]' >/dev/null +result=$(empathy_judged bob $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring hasn't started with player unsubmitted" +result=$(echo $(empathy_scores alice)) +test "$result" = "null" +TEST_END + +TEST "Submit word groups from last answering player" +result=$(empathy_judged charlie $prompt_id '[]') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Scoring has now started" +result=$(echo $(empathy_scores alice)) +test "$result" != "null" +TEST_END + +TEST_SUBSECTION "Reactivated player is fully active" + +TEST "The dale player is currently deactivated" +test "$dale_pid" = "" +TEST_END + +TEST "Reactivate dale" +empathy_player_reactivate dale +test "$dale_pid" != "" +TEST_END + +TEST "New 4-player game, 3 submit right away" +empathy_reset +prompt_id=$(empathy_submit_prompt alice 1 "favorite letter" | jq .id) +empathy_start alice $prompt_id +empathy_answer alice $prompt_id '"A"' >/dev/null +empathy_answer bob $prompt_id '"B"' >/dev/null +empathy_answer charlie $prompt_id '"C"' >/dev/null +test "$?" = "0" +TEST_END + +TEST "Judging hasn't started with player unsubmitted" +result=$(echo $(empathy_ambiguities alice)) +test "$result" = "null" +TEST_END + +TEST "Final active player submits" +result=$(empathy_answer dale $prompt_id '"D"') +test "$result" = '{"valid":true}' +TEST_END + +TEST "Judging has started now" +result=$(echo $(empathy_ambiguities alice)) +test "$result" != "null" +TEST_END +cleanup_and_report