bash-n-client.test

#!/bin/bash

# bash-n-client.test - unit tests for bash-n-client
#
# Copyright (C) 2019, 2020  Christian Garbs <mitch@cgarbs.de>
# Licensed under GNU GPL v3 or later.
#
# This file is part of bash-n.
#
# bash-n is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# bash-n is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with bash-n.  If not, see <http://www.gnu.org/licenses/>.

before_test()
{
    source bash-n-client

    # die(): overwrite exit with return, otherwise the whole test stops
    _die()
    {
	_send "!!ERROR!! $*"
	return 1
    }

    # implement simple game logic for test
    calculate_move()
    {
	return 4
    }

    # store all passed parameters for test
    record_move()
    {
	local who=$1 column=$2
	test_moves+="$who@$column,"
    }

    game_start()
    {
	test_opponent=$1
	test_moves=
    }

    game_end()
    {
	test_result_what=$1
	test_result_who=$2
	test_result_why=$3
    }
}

############################

test_initial_state_is_undefined()
{
    assert_that variable bash_n_state is UNDEFINED
}

test_start_client_sets_state_connecting()
{
    exec < /dev/null

    start_client
    
    assert_that variable bash_n_state is CONNECTING
}

test_start_client_sends_registration()
{
    exec < /dev/null

    start_client MY-NAME
    
    assert_that stdout is <<EOF
REGISTER;MY-NAME
EOF
}

test_welcome_message_with_wrong_name_exits_client()
{
    exec <<EOF
WELCOME;SOMEBODY-ELSE
EOF

    start_client MY-NAME

    assert_that stdout is <<EOF
REGISTER;MY-NAME
!!ERROR!! server sent WELCOME with bot name <SOMEBODY-ELSE> instead of <MY-NAME>
EOF
}

test_on_season_start_a_join_is_sent()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
EOF

    start_client MY-NAME
    
    assert_that stdout is <<EOF
REGISTER;MY-NAME
JOIN;58ca8b44
EOF
}

test_season_start_sets_state_season()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
EOF

    start_client MY-NAME

    assert_that variable bash_n_state is SEASON
}

test_on_game_start_nothing_is_sent()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
EOF

    start_client MY-NAME
    
    assert_that stdout is <<EOF
REGISTER;MY-NAME
JOIN;58ca8b44
EOF
}

test_game_start_sets_state_game()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
EOF

    start_client MY-NAME

    assert_that variable bash_n_state is GAME
}

test_game_start_records_opponent()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
EOF

    start_client MY-NAME

    assert_that variable test_opponent is OTHER-NAME
}

test_on_turn_a_tile_is_placed()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
YOURTURN;758f30a5
EOF

    start_client MY-NAME

    assert_that stdout is <<EOF
REGISTER;MY-NAME
JOIN;58ca8b44
INSERT;4;758f30a5
EOF
}

test_on_token_inserted_nothing_is_sent()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
TOKEN INSERTED;MY-NAME;2
TOKEN INSERTED;OTHER-NAME;4
TOKEN INSERTED;MY-NAME;3
EOF

    start_client MY-NAME

    assert_that stdout is <<EOF
REGISTER;MY-NAME
JOIN;58ca8b44
EOF
}

test_placed_tokens_are_recorded()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
TOKEN INSERTED;MY-NAME;2
TOKEN INSERTED;OTHER-NAME;4
TOKEN INSERTED;MY-NAME;3
EOF

    start_client MY-NAME

    assert_that variable test_moves is MY-NAME@2,OTHER-NAME@4,MY-NAME@3,
}

test_on_game_result_nothing_is_sent()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
RESULT;DRAW;MY-NAME;the board is full
EOF

    start_client MY-NAME

    assert_that stdout is <<EOF
REGISTER;MY-NAME
JOIN;58ca8b44
EOF
}

test_game_result_is_passed_on()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
RESULT;WIN;OTHER-NAME;a better bot
EOF

    start_client MY-NAME

    assert_that variable test_result_what is WIN
    assert_that variable test_result_who  is OTHER-NAME
    assert_that variable test_result_why  is "a better bot"
}

test_game_result_sets_state_season()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
RESULT;WIN;OTHER-NAME;a better bot
EOF

    start_client MY-NAME

    assert_that variable bash_n_state is SEASON
}

test_new_season_can_be_started_after_game_is_finished()
{
    exec <<EOF
WELCOME;MY-NAME
NEW SEASON;58ca8b44
NEW GAME;OTHER-NAME
RESULT;WIN;OTHER-NAME;a better bot
NEW SEASON;12345678
NEW GAME;OTHER-NAME
EOF

    start_client MY-NAME

    assert_that variable bash_n_state is GAME
}

############################

source bash-tests