freecol/test/src/net/sf/freecol/server/ai/mission/ScoutingMissionTest.java

/**
 *  Copyright (C) 2002-2021  The FreeCol Team
 *
 *  This file is part of FreeCol.
 *
 *  FreeCol 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.
 *
 *  FreeCol 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 FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.server.ai.mission;

import net.sf.freecol.common.model.Ability;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.IndianSettlement;
import net.sf.freecol.common.model.LostCityRumour;
import net.sf.freecol.common.model.Map;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.Role;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.Unit;
import net.sf.freecol.common.model.UnitType;
import net.sf.freecol.common.util.LogBuilder;
import net.sf.freecol.server.ServerTestHelper;
import net.sf.freecol.server.ai.AIMain;
import net.sf.freecol.server.ai.AIUnit;
import net.sf.freecol.server.model.ServerPlayer;
import net.sf.freecol.server.model.ServerUnit;
import net.sf.freecol.util.test.FreeColTestCase;


public class ScoutingMissionTest extends FreeColTestCase {

    private static final Role scoutRole
        = spec().getRole("model.role.scout");

    private static final UnitType scoutType
        = spec().getUnitType("model.unit.seasonedScout");

    private static final LogBuilder lb = new LogBuilder(0);


    @Override
    public void tearDown() throws Exception {
        ServerTestHelper.stopServerGame();
        super.tearDown();
    }


    public void testHorsesLost() {
        Game game = ServerTestHelper.startServerGame(getTestMap(true));
        Map map = game.getMap();
        AIMain aiMain = ServerTestHelper.getServer().getAIMain();

        // Create players, settlement and unit
        ServerPlayer inca = getServerPlayer(game, "model.nation.inca");
        ServerPlayer dutch = getServerPlayer(game, "model.nation.dutch");
        dutch.exploreMap(true);

        Tile settlementTile = map.getTile(2, 1);
        FreeColTestCase.IndianSettlementBuilder builder
            = new FreeColTestCase.IndianSettlementBuilder(game);
        builder.player(inca).settlementTile(settlementTile).build();
        IndianSettlement is = settlementTile.getIndianSettlement();
        Player.makeContact(inca, dutch);

        Tile unitTile = map.getTile(2, 2);
        Unit scout = new ServerUnit(game, unitTile, dutch,
                                    scoutType, scoutRole);
        assertEquals(scoutRole, scout.getRole());

        AIUnit aiUnit = aiMain.getAIUnit(scout);
        aiUnit.changeMission(null);
        assertNotNull("The scout should be an AI unit", aiUnit);
        assertEquals("Scout should have the scout role", scoutRole,
                     scout.getRole());
        assertTrue("Scout should be able to speak to chief",
                   scout.hasAbility(Ability.SPEAK_WITH_CHIEF));
        assertEquals("The Inca settlement should be a scouting target", null,
                     ScoutingMission.invalidMissionReason(aiUnit, is));
        assertEquals("The Inca settlement should be found as scouting target",
                     is, ScoutingMission.findMissionTarget(aiUnit, 10, false));
        assertEquals("Scouting mission should be assignable to scout", null,
                     ScoutingMission.invalidMissionReason(aiUnit));

        ScoutingMission mission
            = new ScoutingMission(aiMain, aiUnit, is);
        assertEquals("Scout should have been assigned the Scouting mission",
                     mission, aiUnit.getMission());
        assertEquals(null, mission.invalidReason());
        assertTrue("Scouting mission should be valid",
                   mission.isValid());
        assertEquals("Scouting mission target should be the Inca settlement",
                     is, mission.getTarget());

        // Invalidate the mission by losing the horses.
        scout.changeRole(spec().getDefaultRole(), 0);
        assertFalse("Scout should not have the scout role",
                    scout.hasAbility(Ability.SPEAK_WITH_CHIEF));
        assertNotNull("Scouting mission should be invalid",
                      aiUnit.getMission().invalidReason());
        assertNotNull("Scouting mission should be impossible for this unit",
                      ScoutingMission.invalidMissionReason(aiUnit));
        
        // Restore the horses.
        scout.changeRole(scoutRole, 1);
        assertTrue("Scouting mission should be valid again",
            aiUnit.getMission().isValid());

        // Complete the mission, should be invalid.
        is.setScouted(dutch);
        assertFalse("Scouting mission should be invalid lacking target",
            aiUnit.getMission().isValid());

        // Add an LCR.  Mission could become valid again.
        Tile lcrTile = map.getTile(2, 3);
        lcrTile.addLostCityRumour(new LostCityRumour(game, lcrTile));
        assertEquals("Scouting mission should be possible for this unit", null,
            ScoutingMission.invalidMissionReason(aiUnit));
        assertEquals("The LCR tile should be a scouting target",
            lcrTile, ScoutingMission.findMissionTarget(aiUnit, 10, false));
    }
}