tests/gui/test_save_dialog.cpp

Go to the documentation of this file.

/* $Id: test_save_dialog.cpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2008 - 2012 by Pauli Nieminen <paniemin@cc.hut.fi>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program 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 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

#define GETTEXT_DOMAIN "wesnoth-test"

#include <boost/test/unit_test.hpp>

#include <boost/test/unit_test_suite.hpp>


#include "dialogs.hpp"
#include "key.hpp"
#include "filesystem.hpp"
#include "savegame.hpp"
#include "unit_types.hpp"
//

#include "SDL.h"

#include "tests/utils/fake_event_source.hpp"
#include "tests/utils/fake_display.hpp"
#include "tests/utils/auto_parameterized.hpp"


// Linker workarounds end here

namespace test {

    struct save_dialog_fixture {
        save_dialog_fixture()
            : source()
        {
        }
        test_utils::fake_event_source source;
    };



    BOOST_FIXTURE_TEST_SUITE( save_dialog , save_dialog_fixture)

        SDLKey fake_input_keys[] =  {SDLK_KP_ENTER, SDLK_RETURN, SDLK_ESCAPE, SDLK_a};

        WESNOTH_PARAMETERIZED_TEST_CASE( test_fake_input, SDLKey,fake_input_keys, keyid)
        {
            test_utils::event_node_ptr new_keypress = source.press_key(2, keyid);
            test_utils::event_node_ptr new_keyrelease = source.release_key(4,keyid);

            // Protection against forever loop
            source.press_key(6, keyid);
            source.release_key(8,keyid);
            CKey key;

            while(true)
            {
                events::pump();

                BOOST_CHECK_EQUAL(key[keyid], new_keypress->is_fired());
                if (key[keyid])
                    break;
            }
            while(true)
            {
                events::pump();
                BOOST_CHECK_EQUAL(key[keyid], !new_keyrelease->is_fired());
                if (!key[keyid])
                    break;
            }
        }

        SDLKey dialog_get_save_name_enter_pressed[] =  {SDLK_KP_ENTER, SDLK_RETURN};

        WESNOTH_PARAMETERIZED_TEST_CASE( test_dialog_get_save_name_enter_pressed, SDLKey, dialog_get_save_name_enter_pressed, keyid )
        {
            // fill in events to be used in test
            test_utils::event_node_ptr press_return_before = source.press_key(0, keyid);
            test_utils::event_node_ptr release_return_before = source.release_key(3, keyid);
            test_utils::event_node_ptr press_return_after = source.press_key(5, keyid);
            test_utils::event_node_ptr release_return_after = source.release_key(7, keyid);

            // Protection agains for ever loop
            source.press_key(10, keyid);
            source.release_key(13, keyid);

            std::string fname("test_save");
            write_file(get_saves_dir() + "/" + fname +".gz", "böö");
            // Start test (set ticks start time)

            // Activated enter press
            events::pump();

            BOOST_CHECK_MESSAGE(press_return_before->is_fired(), "Enter wasn't activated");
            BOOST_CHECK_MESSAGE(!release_return_before->is_fired(), "Enter was released before test");


            /*
            After moving the savegame code to savegame.cpp, there need to be a lot more parameters to pass to the
            savegame class, that are not available here. Just to give an impression, this could be the code to call
            the dialog:

            game_savegame save(gamestate, level, gui, teams, units, gamestatus, map, game_preferences::compress_saves());
            save.save_game_interactive(gui, "Save game", gui::OK_CANCEL, false, false);

            This code however does not compile anymore:

            BOOST_CHECK_EQUAL(dialogs::get_save_name_oos(test_utils::get_fake_display(1024, 768),
                    "Save game?", "file", &fname,gui::OK_CANCEL, "Save game"), 0);

            Not sure how to fix it best.

            BOOST_CHECK_MESSAGE(release_return_before->is_fired(), "get_save_name returned before releasing first enter.");
            BOOST_CHECK_MESSAGE(press_return_after->is_fired(), "get_save_name returned before 2nd enter event was sent");
            BOOST_CHECK_MESSAGE(!release_return_after->is_fired(), "get_save_name returned after 2nd release event was sent");
            */
            remove((get_saves_dir() + "/" + fname + ".gz").c_str());
        }

    BOOST_AUTO_TEST_SUITE_END()
}