PioneeringMissionTest.java

/**
 *  Copyright (C) 2002-2012  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 java.util.List;

import net.sf.freecol.common.model.Colony;
import net.sf.freecol.common.model.EquipmentType;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.GoodsType;
import net.sf.freecol.common.model.Map;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.TileImprovement;
import net.sf.freecol.common.model.TileItemContainer;
import net.sf.freecol.common.model.Unit;
import net.sf.freecol.common.model.UnitType;
import net.sf.freecol.server.ServerTestHelper;
import net.sf.freecol.server.ai.AIColony;
import net.sf.freecol.server.ai.AIMain;
import net.sf.freecol.server.ai.AIUnit;
import net.sf.freecol.server.ai.EuropeanAIPlayer;
import net.sf.freecol.server.ai.TileImprovementPlan;
import net.sf.freecol.server.model.ServerPlayer;
import net.sf.freecol.server.model.ServerUnit;
import net.sf.freecol.util.test.FreeColTestCase;


public class PioneeringMissionTest extends FreeColTestCase {

    private static final GoodsType toolsGoodsType
        = spec().getGoodsType("model.goods.tools");

    private static final EquipmentType toolsEqType
        = spec().getEquipmentType("model.equipment.tools");

    private static final UnitType colonistType
        = spec().getUnitType("model.unit.freeColonist");



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


    public void testImprovementNoLongerValid() {
        final List<EquipmentType> pioneerEquipment
            = Unit.Role.PIONEER.getRoleEquipment(spec());

        Map map = getTestMap();
        Game game = ServerTestHelper.startServerGame(map);
        AIMain aiMain = ServerTestHelper.getServer().getAIMain();
        
        // Get player, colony and unit
        ServerPlayer player = (ServerPlayer) game.getPlayer("model.nation.dutch");
        EuropeanAIPlayer aiPlayer = (EuropeanAIPlayer) aiMain.getAIPlayer(player);
        Colony colony = getStandardColony();
        AIColony aiColony = aiMain.getAIColony(colony);
        Unit colonist = new ServerUnit(game, colony.getTile(), player,
            colonistType);
        AIUnit aiUnit = aiMain.getAIUnit(colonist);
        assertNotNull(aiUnit);
        aiUnit.abortMission("Test");

        // Check there are improvements to be made.
        aiColony.createTileImprovementPlans();
        List<TileImprovementPlan> improvements
            = aiColony.getTileImprovementPlans();
        assertTrue("There should be valid improvements",
            !improvements.isEmpty());
        aiPlayer.buildTipMap();
        assertTrue("The player should need pioneers",
            aiPlayer.pioneersNeeded() > 0);

        // Setup mission
        assertEquals("Pioneering should be valid (despite no tools)", null,
            PioneeringMission.invalidReason(aiUnit));
        assertNull("Pioneering should find no targets though",
            PioneeringMission.findTarget(aiUnit, false));

        // Add some tools to the colony, mission should become viable.
        colony.addGoods(toolsGoodsType, 100);
        assertTrue("Colony can provide tools",
            colony.canProvideEquipment(pioneerEquipment));
        assertEquals("Colony found", colony,
            PioneeringMission.findTarget(aiUnit, false));
        assertEquals("Pioneer has no mission", null, aiUnit.getMission());
        assertEquals("Pioneering should be valid (tools present in colony)",
            null, PioneeringMission.invalidReason(aiUnit));

        // Move tools to the unit and try again.
        colony.addGoods(toolsGoodsType, -100);
        colonist.changeEquipment(toolsEqType, 1);
        assertNotNull("TileImprovementPlan found",
            PioneeringMission.findTarget(aiUnit, false));
        assertEquals("Pioneering should be valid (unit has tools)", null,
            PioneeringMission.invalidReason(aiUnit));

        PioneeringMission mission = new PioneeringMission(aiMain, aiUnit);
        assertTrue("Mission should be valid", mission.isValid());
        TileImprovementPlan tip = mission.getTileImprovementPlan();
        assertNotNull("Mission should have a plan", tip);
        Tile target = tip.getTarget();
        assertNotNull("Plan should have a target", target);
        aiUnit.setMission(mission);

        // Simulate improvement tile getting road other than by unit
        target.setTileItemContainer(new TileItemContainer(game, target));
        TileImprovement imp = new TileImprovement(game, target, tip.getType());
        imp.setTurnsToComplete(0);
        target.getTileItemContainer().addTileItem(imp);
    }
}