#!/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 "==========="
empathy_game_path=empathy/$empathy_game_id
+# Usage: empathy_get <player_name> <endpoint> [curl_options]
+empathy_get()
+{
+ curl_get_cookie $1 $empathy_game_path/$2 "${3:-}"
+}
+
+# Usage: empathy_post <player_name> <endpoint> [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
eval ${player_cookie}=".cookie-empathy-$player"
curl_put /profile "{ \"nickname\": \"$player\" }" "-c ${!player_cookie}"
- curl_get_cookie $player $empathy_game_path/events >/dev/null 2>&1 &
+ 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()
{
- curl_get_cookie $1 $2 "-m 0.1" 2>&1 \
- | grep "^event: $3" -A 1 \
+ 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()
{
- empathy_get_event $1 $empathy_game_path/events player-info | jq -r .name
+ empathy_get_event $1 player-info | jq -r .name
}
TEST "Set 'alice' in session"
TEST_SUBSECTION "Category selection"
+# Usage: empathy_submit_prompt <player_name> <count> <prompt_string>
empathy_submit_prompt()
{
- curl_post_cookie $1 $empathy_game_path/prompts "{ \"items\": $2, \"prompt\": \"$3\"}"
+ empathy_post $1 prompts "{ \"items\": $2, \"prompt\": \"$3\"}"
}
TEST "Huge numbers are rejected"
test "$prompt_id" = "1"
TEST_END
+# Usage: empathy_vote <player_name> <prompt_id>
empathy_vote()
{
- curl_post_cookie $1 $empathy_game_path/vote/$2
+ empathy_post $1 vote/$2
}
TEST "Vote on this category"
test "$?" = "0"
TEST_END
+# Usage: empathy_start <player_name> <prompt_id>
empathy_start()
{
- curl_post_cookie $1 $empathy_game_path/start/$2
+ empathy_post $1 start/$2
}
TEST "Start the game with this category"
test "$?" = "0"
TEST_END
+# Usage: empathy_answer <player_name> <prompt_id> <answers_string>
empathy_answer()
{
- curl_post_cookie $1 $empathy_game_path/answer/$2 "{ \"answers\": [$3]}"
+ empathy_post $1 answer/$2 "{ \"answers\": [$3]}"
}
TEST_SUBSECTION "Submitting answers"
test "$result" = '{"valid":true}'
TEST_END
+# Usage: empathy_ambiguities <player_name>
empathy_ambiguities()
{
- empathy_get_event $1 $empathy_game_path/events game-state \
- | jq .ambiguities
+ empathy_get_event $1 game-state | jq .ambiguities
}
TEST "Judging hasn't started with player unsubmitted"
TEST_SUBSECTION "Judging answers"
+# Usage: empathy_ambiguities_list <player_name>
empathy_ambiguities_list()
{
- empathy_get_event $1 $empathy_game_path/events game-state \
- | jq .ambiguities[]
+ empathy_get_event $1 game-state | jq .ambiguities[]
}
TEST "Received all unique words"
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_cookie $1 $empathy_game_path/judged/$2 "{ \"word_groups\": $3}"
+ empathy_post $1 judged/$2 "{ \"word_groups\": $3}"
}
TEST "Submit word groups from alice"
test "$result" = '{"valid":true}'
TEST_END
+# Usage: empathy_scores <player_name>
empathy_scores()
{
- empathy_get_event $1 $empathy_game_path/events game-state \
- | jq .scores
+ empathy_get_event $1 game-state | jq .scores
}
TEST "Scoring hasn't started with player unsubmitted"
test "$result" != "null"
TEST_END
+# Usage: empathy_scores_names_numbers <player_name>
empathy_scores_names_numbers()
{
- empathy_get_event $1 $empathy_game_path/events game-state \
- | jq '.scores.scores[]|.player,.score'
+ empathy_get_event $1 game-state | jq '.scores.scores[]|.players[],.score'
}
TEST_SUBSECTION "Scoring"
test "$result" = '"charlie" 9 "alice" 8 "bob" 6'
TEST_END
+# Usage: empathy_words_submitted <player_name>
empathy_words_submitted()
{
- empathy_get_event $1 $empathy_game_path/events game-state \
- | jq '.scores.words[].word'
+ empathy_get_event $1 game-state | jq '.scores.words[].word'
}
TEST "Verify final list of words submitted"
test "$result" = "null"
TEST_END
+# Usage: empathy_answering <player_name> <prompt_id>
empathy_answering()
{
- curl_post_cookie $1 $empathy_game_path/answering/$2
+ empathy_post $1 answering/$2
}
TEST "Start 4-player game, 3 submissions"
test "$result" = "null"
TEST_END
+# Usage: empathy_end_answers <player_name> <prompt_id>
empathy_end_answers()
{
- curl_post_cookie $1 $empathy_game_path/end-answers/$2
+ empathy_post $1 end-answers/$2
}
TEST "Minority of players vote to end answering"
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" = "null"
TEST_END
+# Usage: empathy_end_judging <player_name> <prompt_id>
empathy_end_judging()
{
- curl_post_cookie $1 $empathy_game_path/end-judging/$2
+ empathy_post $1 end-judging/$2
}
TEST "Minority of players vote to end judging"
test "$result" != "null"
TEST_END
-pkill -P $alice_pid
-pkill -P $bob_pid
-pkill -P $charlie_pid
-pkill -P $dale_pid
+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
-TEST_REPORT
+cleanup_and_report