#!/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 <URL-to-test>"
# Print report of all previous test results
TEST_REPORT()
{
+ echo ""
echo ""
echo "Test Report"
echo "==========="
$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 <name> <ENDPOINT> [data] [CURL_OPTIONS]
+#
+# Where <name> 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:-}"
+}
+
# PUT to a URL endpoint with optional JSON data
#
# Usage:
$CURL ${2:-} $URL/$1
}
+# GET from a URL endpoint using a cookie
+#
+# Usage:
+#
+# curl_get_cookie <name> <ENDPOINT> [CURL_OPTIONS]
+#
+# Where <name> 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
#
# Usage:
empathy_game_path=empathy/$empathy_game_id
-empathy_profile()
+# Usage: empathy_get <player_name> <endpoint> [curl_options]
+empathy_get()
{
- cookie_file=".cookie-empathy-$1"
- curl_put /profile "{ \"nickname\": \"$1\" }" "-c $cookie_file"
- echo $cookie_file
+ curl_get_cookie $1 $empathy_game_path/$2 "${3:-}"
}
-curl_get_event()
+# Usage: empathy_post <player_name> <endpoint> [data]
+empathy_post()
{
- curl_get $1 "-m 0.1 $3" 2>&1 \
+ 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 <player_name>
+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 <player_name> <event_name>
+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 <player_name>
empathy_player_name()
{
- curl_get_event $empathy_game_path/events player-info "-b $1" | jq -r .name
+ empathy_get_event $1 player-info | jq -r .name
}
TEST "Set 'alice' in session"
-alice=$(empathy_profile alice)
-test "$alice" = ".cookie-empathy-alice"
+empathy_player_activate alice
+test "$alice_cookie" = ".cookie-empathy-alice"
TEST_END
TEST "Register alice and verify name"
-result=$(empathy_player_name $alice)
+result=$(empathy_player_name alice)
test "$result" = "alice"
TEST_END
TEST "Register bob"
-bob=$(empathy_profile bob)
-result=$(empathy_player_name $bob)
+empathy_player_activate bob
+result=$(empathy_player_name bob)
test "$result" = "bob"
TEST_END
TEST "Register charlie"
-charlie=$(empathy_profile charlie)
-result=$(empathy_player_name $charlie)
+empathy_player_activate charlie
+result=$(empathy_player_name charlie)
test "$result" = "charlie"
TEST_END
TEST_SUBSECTION "Category selection"
+# Usage: empathy_submit_prompt <player_name> <count> <prompt_string>
empathy_submit_prompt()
{
- curl_post $empathy_game_path/prompts "{ \"items\": $2, \"prompt\": \"$3\"}" "-b $1"
+ empathy_post $1 prompts "{ \"items\": $2, \"prompt\": \"$3\"}"
}
TEST "Huge numbers are rejected"
-result=$(empathy_submit_prompt $alice 10000 "10,000 Maniacs")
+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)
+prompt_id=$(empathy_submit_prompt alice 4 "4 things on a beach" | jq .id)
test "$prompt_id" = "1"
TEST_END
+# Usage: empathy_vote <player_name> <prompt_id>
empathy_vote()
{
- curl_post $empathy_game_path/vote/$2 "" "-b $1"
+ empathy_post $1 vote/$2
}
TEST "Vote on this category"
-empathy_vote $alice $prompt_id
+empathy_vote alice $prompt_id
test "$?" = "0"
TEST_END
+# Usage: empathy_start <player_name> <prompt_id>
empathy_start()
{
- curl_post $empathy_game_path/start/$2 "" "-b $1"
+ empathy_post $1 start/$2
}
TEST "Start the game with this category"
-empathy_start $alice $prompt_id
+empathy_start alice $prompt_id
test "$?" = "0"
TEST_END
+# Usage: empathy_answer <player_name> <prompt_id> <answers_string>
empathy_answer()
{
- curl_post $empathy_game_path/answer/$2 "{ \"answers\": [$3]}" "-b $1"
+ 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"')
+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
-
-TEST "Submit from charlie succeeds"
-result=$(empathy_answer $charlie $prompt_id '"SunShine", "Grains of Sand", "wafer", "people"')
+result=$(empathy_answer bob $prompt_id '"sand", "sands", "SunLight", "towels"')
test "$result" = '{"valid":true}'
TEST_END
-TEST_SUBSECTION "Transition from answering to judging"
-
+# Usage: empathy_ambiguities <player_name>
empathy_ambiguities()
{
- curl_get_event $empathy_game_path/events game-state "-b $1" \
- | jq .ambiguities
+ empathy_get_event $1 game-state | jq .ambiguities
}
-TEST "Judging has not yet started"
-result=$(echo $(empathy_ambiguities $alice))
+TEST "Judging hasn't started with player unsubmitted"
+result=$(echo $(empathy_ambiguities alice))
test "$result" = "null"
TEST_END
-empathy_end_answers()
-{
- curl_post $empathy_game_path/end-answers/$2 "" "-b $1"
-}
-
-TEST "Players vote to start judging"
-empathy_end_answers $alice $prompt_id
-empathy_end_answers $bob $prompt_id
-empathy_end_answers $charlie $prompt_id
-test "$?" = "0"
+TEST "Submit from charlie succeeds"
+result=$(empathy_answer charlie $prompt_id '"SunShine", "Grains of Sand", "wafer", "people"')
+test "$result" = '{"valid":true}'
TEST_END
-TEST "Judging has now started"
-result=$(echo $(empathy_ambiguities $alice))
+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 <player_name>
empathy_ambiguities_list()
{
- curl_get_event $empathy_game_path/events game-state "-b $1" \
- | jq .ambiguities[]
+ 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))
+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 <player_name> <prompt_id> <word_groups_string>
empathy_judged()
{
- curl_post $empathy_game_path/judged/$2 "{ \"word_groups\": $3}" "-b $1"
+ 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"]]')
+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"]]')
+result=$(empathy_judged bob $prompt_id '[["sands","grains of sand"],["water","wafer"]]')
test "$result" = '{"valid":true}'
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"
-
+# Usage: empathy_scores <player_name>
empathy_scores()
{
- curl_get_event $empathy_game_path/events game-state "-b $1" \
- | jq .scores
+ empathy_get_event $1 game-state | jq .scores
}
-TEST "Scoring has not yet started"
-result=$(echo $(empathy_scores $alice))
+TEST "Scoring hasn't started with player unsubmitted"
+result=$(echo $(empathy_scores alice))
test "$result" = "null"
TEST_END
-empathy_end_judging()
-{
- curl_post $empathy_game_path/end-judging/$2 "" "-b $1"
-}
-
-TEST "Players vote to start scoring"
-empathy_end_judging $alice $prompt_id
-empathy_end_judging $bob $prompt_id
-empathy_end_judging $charlie $prompt_id
-test "$?" = "0"
+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 "Scoring has now started"
-result=$(echo $(empathy_scores $alice))
+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 <player_name>
empathy_scores_names_numbers()
{
- curl_get_event $empathy_game_path/events game-state "-b $1" \
- | jq '.scores.scores[]|.player,.score'
+ empathy_get_event $1 game-state | jq '.scores.scores[]|.player,.score'
}
TEST_SUBSECTION "Scoring"
TEST "Verify final scores as expected"
# echo here is to strip newlines
-result=$(echo $(empathy_scores_names_numbers $alice))
+result=$(echo $(empathy_scores_names_numbers alice))
test "$result" = '"charlie" 9 "alice" 8 "bob" 6'
TEST_END
+# Usage: empathy_words_submitted <player_name>
empathy_words_submitted()
{
- curl_get_event $empathy_game_path/events game-state "-b $1" \
- | jq '.scores.words[].word'
+ 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))
+result=$(echo $(empathy_words_submitted alice))
test "$result" = '"Grains of Sand/sand/sands" "SunLight/SunShine" "wafer/water" "people" "sun" "towels"'
TEST_END
-TEST_REPORT
+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 <player_name> <prompt_id>
+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 <player_name> <prompt_id>
+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 <player_name>
+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 <player_name> <prompt_id>
+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 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" 2 "bob" 2 "charlie" 0 "dale" 0 "eric" 0 "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" 1 "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
projects / empires-server / blobdiff