test_mp_connect.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2013 - 2025
    by Andrius Silinskas <silinskas.andrius@gmail.com>
    Part of the Battle for Wesnoth Project https://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 "game_config_manager.hpp"
#include "game_display.hpp"
#include "game_initialization/connect_engine.hpp"
#include "hotkey/hotkey_manager.hpp"
#include "mt_rng.hpp"
#include "saved_game.hpp"
#include "tests/utils/fake_display.hpp"
 
/* Definitions */
 
class test_connect_engine : public ng::connect_engine {
public:
    test_connect_engine(saved_game& gamestate) :
        ng::connect_engine(gamestate, true, nullptr)
        {}
};
 
/* Global fixture */
 
struct mp_connect_fixture {
    mp_connect_fixture()
        : dummy_args({"wesnoth", "--noaddons"})
        , cmdline_opts(dummy_args)
        , config_manager(cmdline_opts)
    {
        test_utils::set_test_resolution(1000, 500);
        config_manager.init_game_config(game_config_manager::NO_FORCE_RELOAD);
 
        state.classification().type = campaign_type::type::multiplayer;
        state.classification().era_id = "era_default";
        config_manager.load_game_config_for_game(state.classification(), state.get_scenario_id());
 
        state.mp_settings().name = "multiplayer_The_Freelands";
        state.mp_settings().use_map_settings = true;
        state.mp_settings().saved_game = saved_game_mode::type::no;
 
        state.set_scenario(config_manager.game_config().find_mandatory_child("multiplayer", "id", state.mp_settings().name));
 
        state.mp_settings().num_turns = state.get_starting_point()["turns"].to_int();
    }
    ~mp_connect_fixture()
    {
    }
    std::vector<std::string> dummy_args;
    commandline_options cmdline_opts;
    hotkey::manager hotkey_manager;
    game_config_manager config_manager;
    saved_game state;
    randomness::mt_rng rng;
};
 
 
/* Test classes creation utilities */
 
static ng::side_engine create_side_engine(const config& defaults,
    test_connect_engine& connect_engine)
{
    config side_cfg = connect_engine.scenario().mandatory_child("side");
    side_cfg.remove_attributes("faction");
    side_cfg.clear_children("default_faction");
    side_cfg.clear_children("leader");
    side_cfg.append(defaults);
 
    return { side_cfg, connect_engine, 0 };
}
 
 
/* Tests */
 
BOOST_FIXTURE_TEST_SUITE( mp_connect, mp_connect_fixture )
 
 
BOOST_AUTO_TEST_CASE( flg_map_settings2 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Recruit list with no faction.
    side["recruit"] = "Elvish Archer";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.new_config()["recruit"], "Elvish Archer");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings3 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Custom faction, no recruits.
    side["faction"] = "Custom";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().current_faction()["id"], "Custom");
    BOOST_CHECK_EQUAL(side_engine.new_config()["recruit"].empty(), true);
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings4 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Random faction.
    side["faction"] = "Random";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().current_faction()["id"], "Random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings5 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Valid faction.
    side["faction"] = "Rebels";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().current_faction()["id"], "Rebels");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings6 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Invalid faction.
    side["faction"] = "ThisFactionDoesNotExist";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_factions().size() > 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_faction()["id"], "Random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings7 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Faction and recruit list.
    side["recruit"] = "Elvish Archer";
    side["faction"] = "Undead";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings8 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Carried over recruits.
    side["previous_recruits"] = "Elvish Archer";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.new_config()["previous_recruits"], "Elvish Archer");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings9 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Valid leader unit.
    auto side = config {
        "leader", config {
            "type", "Shadow",
        },
    };
 
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "Shadow");
    BOOST_CHECK_EQUAL(side_engine.new_config().mandatory_child("leader")["type"], "Shadow");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings10 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Invalid leader unit.
    auto side = config {
        "leader", config {
            "type", "ThisUnitDoesNotExist",
        },
    };
 
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "null");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings11 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // No leader, Custom faction.
    side["faction"] = "Custom";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_leaders().size() > 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings12 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // No leader, Random faction.
    side["faction"] = "Random";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "null");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings14 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // No leader, regular faction.
    side["faction"] = "Undead";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_leaders().size() > 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings15 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Carried over leader.
    auto side = config {
        "leader", config {
            "type", "Elvish Archer",
            "id", "LeaderID",
        },
        "unit", config {
            "type", "Elvish Ranger",
            "id", "LeaderID",
        },
    };
 
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "Elvish Ranger");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings17 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Random leader.
    auto side = config {
        "leader", config {
            "type", "random",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings18 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Leader with both genders.
    auto side = config {
        "leader", config {
            "type", "Elvish Archer",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_genders().size(), 3);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings19 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Leader with only male gender.
    auto side = config {
        "leader", config {
            "type", "Swordsman",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_genders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "male");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings20 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Leader with only female gender.
    auto side = config {
        "leader", config {
            "type", "Elvish Druid",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_genders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "female");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings21 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Valid leader with valid gender.
    auto side = config {
        "leader", config {
            "type", "White Mage",
            "gender", "female",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "female");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings22 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Valid leader with invalid gender.
    auto side = config {
        "leader", config {
            "type", "Troll",
            "gender", "female",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_genders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "male");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings23 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Leader with random gender.
    auto side = config {
        "leader", config {
            "type", "White Mage",
            "gender", "random",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "random");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings25 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // No leader.
    side["leader_lock"] = true;
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK_EQUAL(side_engine.flg().choosable_leaders().size(), 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "null");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings26 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Resolve random faction.
    side["faction"] = "Random";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.resolve_random(rng);
    BOOST_CHECK(side_engine.flg().current_faction()["id"] != "Random");
    BOOST_CHECK(side_engine.flg().current_leader() != "random" && side_engine.flg().current_leader() != "null");
    BOOST_CHECK(side_engine.flg().current_gender() != "random" && side_engine.flg().current_gender() != "null");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings27 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Resolve random faction with default leader.
    auto side = config {
        "faction" , "Random",
        "leader", config {
            "type", "Troll",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.resolve_random(rng);
    BOOST_CHECK(side_engine.flg().current_faction()["id"] != "Random");
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "Troll");
    BOOST_CHECK(side_engine.flg().current_gender() != "random" && side_engine.flg().current_gender() != "null");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings28 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Resolve random faction with default leader and gender.
    auto side = config {
        "faction" , "Random",
        "leader", config {
            "type", "White Mage",
            "gender", "male",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.resolve_random(rng);
    BOOST_CHECK(side_engine.flg().current_faction()["id"] != "Random");
    BOOST_CHECK_EQUAL(side_engine.flg().current_leader(), "White Mage");
    BOOST_CHECK_EQUAL(side_engine.flg().current_gender(), "male");
}
 
BOOST_AUTO_TEST_CASE( flg_map_settings29 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = true;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Resolve random leader.
    auto side = config {
        "leader", config {
            "type", "random",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.resolve_random(rng);
    BOOST_CHECK(side_engine.flg().current_leader() != "random");
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings1 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Recruit list with no faction.
    side["recruit"] = "Elvish Archer";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_factions().size() > 1);
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings2 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Custom faction, no recruits.
    side["faction"] = "Custom";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_factions().size() > 1);
    BOOST_CHECK_EQUAL(side_engine.flg().current_faction()["id"], "Custom");
    BOOST_CHECK_EQUAL(side_engine.new_config()["recruit"].empty(), true);
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings3 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
    config side;
 
    // Carried over recruits.
    side["previous_recruits"] = "Elvish Archer";
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_factions().size() > 1);
    BOOST_CHECK_EQUAL(side_engine.new_config()["previous_recruits"], "Elvish Archer");
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings4 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Explicit leader for faction with multiple leaders.
    auto side = config {
        "leader", config {
            "type", "Goblin Impaler",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.flg().set_current_faction("Rebels");
    BOOST_CHECK(side_engine.flg().choosable_leaders().size() > 1);
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings5 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Duplicate leaders.
    auto side = config {
        "faction" , "Custom",
        "leader", config {
            "type", "Swordsman",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    BOOST_CHECK(side_engine.flg().choosable_leaders().size() > 1);
    const std::vector<std::string>& leaders = side_engine.flg().choosable_leaders();
    BOOST_CHECK_EQUAL(std::count(leaders.begin(), leaders.end(), "Swordsman"), 1);
}
 
BOOST_AUTO_TEST_CASE( flg_no_map_settings6 )
{
    // Set up side_engine and its dependencies.
    state.mp_settings().use_map_settings = false;
    state.mp_settings().saved_game = saved_game_mode::type::no;
    test_connect_engine connect_engine{state};
 
    // Explicit gender for unit with both genders available.
    auto side = config {
        "leader", config {
            "gender", "female",
        },
    };
    ng::side_engine side_engine = create_side_engine(side, connect_engine);
    side_engine.flg().set_current_faction("Rebels");
    side_engine.flg().set_current_leader("Elvish Ranger");
    // TODO: this this really make sense? it would be nice to know the usecases for this.
    //BOOST_CHECK_EQUAL( side_engine.flg().current_gender(), "random" );
}
 
BOOST_AUTO_TEST_SUITE_END()