Replace GoldManager with mock in all tests

hrishikeshshekhar · hrishikeshshekhar · commit d9ca32834cf4 · 2019-02-09T01:28:02.000+05:30
- Removing GoldManager dependency in all tests and adding GoldManagerMock
diff --git a/src/main/main.cpp b/src/main/main.cpp
@@ -10,6 +10,7 @@
 #include "state/actor/soldier.h"
 #include "state/actor/villager.h"
 #include "state/command_giver.h"
+#include "state/gold_manager/gold_manager.h"
 #include "state/map/map.h"
 #include "state/path_planner/path_planner.h"
 #include "state/player_state.h"
diff --git a/src/state/include/state/actor/actor.h b/src/state/include/state/actor/actor.h
@@ -6,7 +6,7 @@
 #pragma once
 
 #include "physics/vector.hpp"
-#include "state/gold_manager/gold_manager.h"
+#include "state/interfaces/i_gold_manager.h"
 #include "state/interfaces/i_updatable.h"
 #include "state/state_export.h"
 #include "state/utilities.h"
@@ -18,7 +18,10 @@ namespace state {
  * Actor base class
  */
 
-class GoldManager;
+/**
+ * Forward declaration of IGoldManager
+ */
+class IGoldManager;
 
 class STATE_EXPORT Actor : public IUpdatable {
   protected:
@@ -61,13 +64,13 @@ class STATE_EXPORT Actor : public IUpdatable {
 	/**
 	 * Gold manager instance to perform transactions
 	 */
-	GoldManager *gold_manager;
+	IGoldManager *gold_manager;
 
   public:
 	Actor();
 
 	Actor(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-	      int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager);
+	      int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager);
 
 	virtual ~Actor() {}
 
@@ -121,7 +124,7 @@ class STATE_EXPORT Actor : public IUpdatable {
 	 *
 	 * @return     gold_manager  Unit's GoldManager Pointer
 	 */
-	GoldManager *GetGoldManager();
+	IGoldManager *GetGoldManager();
 
 	/**
 	 * Get the maximum hp of the actor
diff --git a/src/state/include/state/actor/factory.h b/src/state/include/state/actor/factory.h
@@ -79,7 +79,7 @@ class STATE_EXPORT Factory : public Actor {
 	Factory();
 
 	Factory(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-	        int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager,
+	        int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager,
 	        int64_t construction_complete, int64_t construction_total,
 	        ActorType production_state, int64_t villager_frequency,
 	        int64_t soldier_frequency,
diff --git a/src/state/include/state/actor/soldier.h b/src/state/include/state/actor/soldier.h
@@ -29,7 +29,7 @@ class STATE_EXPORT Soldier : public Unit {
 	Soldier();
 
 	Soldier(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-	        int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager,
+	        int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager,
 	        PathPlanner *path_planner, int64_t speed, int64_t attack_range,
 	        int64_t attack_damage);
 
diff --git a/src/state/include/state/actor/unit.h b/src/state/include/state/actor/unit.h
@@ -79,7 +79,7 @@ class STATE_EXPORT Unit : public Actor {
 	Unit();
 
 	Unit(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-	     int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager,
+	     int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager,
 	     PathPlanner *path_planner, int64_t speed, int64_t attack_range,
 	     int64_t attack_damage);
 
diff --git a/src/state/include/state/actor/villager.h b/src/state/include/state/actor/villager.h
@@ -9,7 +9,6 @@
 #include "state/actor/factory.fwd.h"
 #include "state/actor/unit.h"
 #include "state/actor/villager_states/villager_state.h"
-#include "state/gold_manager/gold_manager.h"
 
 namespace state {
 
@@ -62,7 +61,7 @@ class STATE_EXPORT Villager : public Unit {
 	Villager();
 
 	Villager(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-	         int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager,
+	         int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager,
 	         PathPlanner *path_planner, int64_t speed, int64_t attack_range,
 	         int64_t attack_damage, int64_t build_effort, int64_t build_range,
 	         int64_t mine_range);
diff --git a/src/state/include/state/state.h b/src/state/include/state/state.h
@@ -10,8 +10,8 @@
 #include "state/actor/factory.h"
 #include "state/actor/soldier.h"
 #include "state/actor/villager.h"
-#include "state/gold_manager/gold_manager.h"
 #include "state/interfaces/i_command_taker.h"
+#include "state/interfaces/i_gold_manager.h"
 #include "state/interfaces/i_updatable.h"
 #include "state/map/map.h"
 #include "state/path_planner/path_planner.h"
@@ -33,7 +33,7 @@ class STATE_EXPORT State : public ICommandTaker {
 	/**
 	 * Gold Manager instance to maintain player gold
 	 */
-	std::unique_ptr<GoldManager> gold_manager;
+	std::unique_ptr<IGoldManager> gold_manager;
 
 	/**
 	 * Path Planner instance
@@ -119,7 +119,7 @@ class STATE_EXPORT State : public ICommandTaker {
 	/**
 	 * Constructor
 	 */
-	State(std::unique_ptr<Map> map, std::unique_ptr<GoldManager> gold_manager,
+	State(std::unique_ptr<Map> map, std::unique_ptr<IGoldManager> gold_manager,
 	      std::unique_ptr<PathPlanner> path_planner,
 	      std::array<std::vector<std::unique_ptr<Soldier>>, 2> soldiers,
 	      std::array<std::vector<std::unique_ptr<Villager>>, 2> villagers,
diff --git a/src/state/src/actor/actor.cpp b/src/state/src/actor/actor.cpp
@@ -14,7 +14,7 @@ Actor::Actor() {
 }
 
 Actor::Actor(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-             int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager)
+             int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager)
     : id(id), player_id(player_id), actor_type(actor_type), hp(hp),
       max_hp(max_hp), position(position), gold_manager(gold_manager) {}
 
@@ -34,7 +34,7 @@ PlayerId Actor::GetPlayerId() { return player_id; }
 
 ActorType Actor::GetActorType() { return actor_type; }
 
-GoldManager *Actor::GetGoldManager() { return gold_manager; }
+IGoldManager *Actor::GetGoldManager() { return gold_manager; }
 
 int64_t Actor::GetHp() { return hp; }
 
diff --git a/src/state/src/actor/factory.cpp b/src/state/src/actor/factory.cpp
@@ -14,7 +14,7 @@ Factory::Factory() {}
 
 Factory::Factory(ActorId id, PlayerId player_id, ActorType actor_type,
                  int64_t hp, int64_t max_hp, DoubleVec2D position,
-                 GoldManager *gold_manager, int64_t construction_complete,
+                 IGoldManager *gold_manager, int64_t construction_complete,
                  int64_t construction_total, ActorType production_state,
                  int64_t villager_frequency, int64_t soldier_frequency,
                  UnitProductionCallback unit_production_callback)
diff --git a/src/state/src/actor/soldier.cpp b/src/state/src/actor/soldier.cpp
@@ -16,7 +16,7 @@ Soldier::Soldier() {
 }
 Soldier::Soldier(ActorId id, PlayerId player_id, ActorType actor_type,
                  int64_t hp, int64_t max_hp, DoubleVec2D position,
-                 GoldManager *gold_manager, PathPlanner *path_planner,
+                 IGoldManager *gold_manager, PathPlanner *path_planner,
                  int64_t speed, int64_t attack_range, int64_t attack_damage)
     : Unit(id, player_id, actor_type, hp, max_hp, position, gold_manager,
            path_planner, speed, attack_range, attack_damage),
diff --git a/src/state/src/actor/unit.cpp b/src/state/src/actor/unit.cpp
@@ -15,7 +15,7 @@ Unit::Unit() {
 }
 
 Unit::Unit(ActorId id, PlayerId player_id, ActorType actor_type, int64_t hp,
-           int64_t max_hp, DoubleVec2D position, GoldManager *gold_manager,
+           int64_t max_hp, DoubleVec2D position, IGoldManager *gold_manager,
            PathPlanner *path_planner, int64_t speed, int64_t attack_range,
            int64_t attack_damage)
     : Actor(id, player_id, actor_type, hp, max_hp, position, gold_manager),
diff --git a/src/state/src/actor/villager.cpp b/src/state/src/actor/villager.cpp
@@ -18,7 +18,7 @@ Villager::Villager() {
 }
 Villager::Villager(ActorId id, PlayerId player_id, ActorType actor_type,
                    int64_t hp, int64_t max_hp, DoubleVec2D position,
-                   GoldManager *gold_manager, PathPlanner *path_planner,
+                   IGoldManager *gold_manager, PathPlanner *path_planner,
                    int64_t speed, int64_t attack_range, int64_t attack_damage,
                    int64_t build_effort, int64_t build_range,
                    int64_t mine_range)
diff --git a/src/state/src/state.cpp b/src/state/src/state.cpp
@@ -10,7 +10,7 @@
 namespace state {
 
 State::State(std::unique_ptr<Map> map,
-             std::unique_ptr<GoldManager> gold_manager,
+             std::unique_ptr<IGoldManager> gold_manager,
              std::unique_ptr<PathPlanner> path_planner,
              std::array<std::vector<std::unique_ptr<Soldier>>, 2> soldiers,
              std::array<std::vector<std::unique_ptr<Villager>>, 2> villagers,
diff --git a/test/logger/logger_test.cpp b/test/logger/logger_test.cpp
@@ -1,5 +1,6 @@
 #include "constants/constants.h"
 #include "logger/logger.h"
+#include "state/mocks/gold_manager_mock.h"
 #include "state/mocks/state_mock.h"
 #include "state/utilities.h"
 #include "gtest/gtest.h"
@@ -21,7 +22,7 @@ class LoggerTest : public testing::Test {
 	std::unique_ptr<StateMock> state;
 	std::unique_ptr<Logger> logger;
 
-	std::unique_ptr<GoldManager> gold_manager;
+	std::unique_ptr<GoldManagerMock> gold_manager;
 	std::unique_ptr<PathPlanner> path_planner;
 	std::array<int64_t, 2> player_gold;
 	int64_t max_gold;
@@ -36,7 +37,8 @@ class LoggerTest : public testing::Test {
 	      logger(make_unique<Logger>(state.get(), PLAYER_INSTRUCTION_LIMIT_TURN,
 	                                 PLAYER_INSTRUCTION_LIMIT_GAME,
 	                                 SOLDIER_MAX_HP, VILLAGER_MAX_HP,
-	                                 FACTORY_MAX_HP)) {
+	                                 FACTORY_MAX_HP)),
+	      gold_manager(make_unique<GoldManagerMock>()) {
 		auto map_matrix = vector<vector<TerrainType>>{{
 		    {L, L, L, L, L},
 		    {L, L, L, L, L},
@@ -49,14 +51,6 @@ class LoggerTest : public testing::Test {
 		player_gold[0] = 5000;
 		player_gold[1] = 5000;
 		max_gold = 10000;
-
-		std::vector<std::unique_ptr<GoldMine>> gold_mines;
-
-		this->gold_manager = make_unique<GoldManager>(
-		    player_gold, max_gold, SOLDIER_KILL_REWARD_AMOUNT,
-		    VILLAGER_KILL_REWARD_AMOUNT, FACTORY_KILL_REWARD_AMOUNT,
-		    FACTORY_SUICIDE_PENALTY, VILLAGER_COST, SOLDIER_COST, FACTORY_COST,
-		    MINING_REWARD, std::move(gold_mines));
 	}
 };
 
diff --git a/test/state/factory_test.cpp b/test/state/factory_test.cpp
@@ -3,7 +3,7 @@
 #include "state/actor/factory.h"
 #include "state/actor/soldier.h"
 #include "state/actor/villager.h"
-#include "state/gold_manager/gold_manager.h"
+#include "state/mocks/gold_manager_mock.h"
 #include "gtest/gtest.h"
 
 using namespace std;
@@ -22,7 +22,7 @@ class FactoryTest : public Test {
 	Soldier model_soldier;
 	Villager model_villager;
 
-	unique_ptr<GoldManager> gold_manager;
+	unique_ptr<GoldManagerMock> gold_manager;
 	unique_ptr<PathPlanner> path_planner;
 	unique_ptr<Factory> factory;
 
@@ -77,11 +77,7 @@ class FactoryTest : public Test {
 
 		std::vector<std::unique_ptr<GoldMine>> gold_mines;
 
-		this->gold_manager = make_unique<GoldManager>(
-		    player_gold, max_gold, soldier_kill_reward_gold,
-		    villager_kill_reward_gold, factory_kill_reward_gold,
-		    FACTORY_SUICIDE_PENALTY, VILLAGER_COST, SOLDIER_COST, FACTORY_COST,
-		    MINING_REWARD, std::move(gold_mines));
+		this->gold_manager = make_unique<GoldManagerMock>();
 
 		villager_list = std::vector<std::unique_ptr<Villager>>{};
 		soldier_list = std::vector<std::unique_ptr<Soldier>>{};
diff --git a/test/state/mocks/gold_manager_mock.h b/test/state/mocks/gold_manager_mock.h
@@ -0,0 +1,21 @@
+#pragma once
+
+#include "gmock/gmock.h"
+#include "state/interfaces/i_gold_manager.h"
+
+using namespace state;
+
+class GoldManagerMock : public IGoldManager {
+  public:
+	MOCK_METHOD2(Increase, void(PlayerId, int64_t));
+	MOCK_METHOD2(Decrease, void(PlayerId, int64_t));
+	MOCK_METHOD1(RewardKill, void(Actor *));
+	MOCK_METHOD1(GetCreateUnitCost, int64_t(ActorType));
+	MOCK_METHOD2(DeductUnitCreateCost, void(PlayerId, Actor *));
+	MOCK_METHOD1(GetBalance, int64_t(PlayerId));
+	MOCK_METHOD0(GetMaxGold, int64_t());
+	MOCK_METHOD1(DeductFactorySuicidePenalty, void(PlayerId));
+	MOCK_METHOD3(RewardMineGold, void(PlayerId, GoldMine *, int64_t));
+	MOCK_METHOD2(AddBuildRequest, void(PlayerId, Vec2D));
+	MOCK_METHOD0(AssignGold, void());
+};
diff --git a/test/state/state_syncer_test.cpp b/test/state/state_syncer_test.cpp
@@ -4,6 +4,7 @@
 #include "state/interfaces/i_state_syncer.h"
 #include "state/mocks/command_giver_mock.h"
 #include "state/mocks/command_taker_mock.h"
+#include "state/mocks/gold_manager_mock.h"
 #include "state/player_state.h"
 #include "state/state.h"
 #include "state/state_syncer.h"
@@ -47,7 +48,7 @@ class StateSyncerTest : public Test {
 	array<player_state::State, 2> player_states;
 
 	// Creating a gold manager
-	unique_ptr<GoldManager> gold_manager;
+	unique_ptr<GoldManagerMock> gold_manager;
 
 	StateSyncerTest() {
 		// Creating 2 player states
@@ -57,9 +58,10 @@ class StateSyncerTest : public Test {
 		player_states[0] = player_state1;
 		player_states[1] = player_state2;
 
-		// Creating a mock command giver and taker
+		// Creating a mock command giver, command taker and gold manager
 		auto command_taker = make_unique<CommandTakerMock>();
 		auto command_giver = make_unique<CommandGiverMock>();
+		auto gold_manager = make_unique<GoldManagerMock>();
 
 		this->command_taker = command_taker.get();
 		this->command_giver = command_giver.get();
diff --git a/test/state/state_test.cpp b/test/state/state_test.cpp
@@ -1,6 +1,7 @@
 #include "constants/gold_manager.h"
 #include "constants/state.h"
 #include "gmock/gmock.h"
+#include "state/mocks/gold_manager_mock.h"
 #include "state/state.h"
 #include "gtest/gtest.h"
 #include <memory>
@@ -29,7 +30,7 @@ class StateTest : public Test {
 	std::vector<std::unique_ptr<Villager>> temp_villager_list;
 	std::vector<std::unique_ptr<Soldier>> temp_soldier_list;
 
-	unique_ptr<GoldManager> gold_manager;
+	unique_ptr<GoldManagerMock> gold_manager;
 	unique_ptr<PathPlanner> path_planner;
 	Villager model_villager;
 	Soldier model_soldier;
@@ -62,13 +63,7 @@ class StateTest : public Test {
 		this->villager_kill_reward_gold = VILLAGER_KILL_REWARD_AMOUNT;
 		this->factory_kill_reward_gold = FACTORY_KILL_REWARD_AMOUNT;
 
-		std::vector<std::unique_ptr<GoldMine>> gold_mines;
-
-		this->gold_manager = make_unique<GoldManager>(
-		    player_gold, max_gold, soldier_kill_reward_gold,
-		    villager_kill_reward_gold, factory_kill_reward_gold,
-		    FACTORY_SUICIDE_PENALTY, VILLAGER_COST, SOLDIER_COST, FACTORY_COST,
-		    MINING_REWARD, std::move(gold_mines));
+		gold_manager = make_unique<GoldManagerMock>();
 
 		this->path_planner = make_unique<PathPlanner>(map.get());
 
@@ -188,8 +183,9 @@ TEST_F(StateTest, CreateFactoryTest) {
 	ASSERT_EQ(curr_factories[0].size(), 1);
 	ASSERT_EQ(curr_factories[0].front()->GetState(), FactoryStateName::UNBUILT);
 
-	auto gold_manager = curr_villagers[0].front()->GetGoldManager();
-	ASSERT_EQ(gold_manager->GetBalance(PlayerId::PLAYER1), 5000 - FACTORY_COST);
+	//This is a gold manager test
+	// auto gold_manager = curr_villagers[0].front()->GetGoldManager();
+	// ASSERT_EQ(gold_manager->GetBalance(PlayerId::PLAYER1), 5000 - FACTORY_COST);
 }
 
 TEST_F(StateTest, BuildFactoryTest) {
diff --git a/test/state/villager_test.cpp b/test/state/villager_test.cpp

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ Soldier::Soldier() {`
`16`	`16`	`}`
`17`	`17`	`Soldier::Soldier(ActorId id, PlayerId player_id, ActorType actor_type,`
`18`	`18`	`int64_t hp, int64_t max_hp, DoubleVec2D position,`
`19`		`- GoldManager gold_manager, PathPlanner path_planner,`
	`19`	`+ IGoldManager gold_manager, PathPlanner path_planner,`
`20`	`20`	`int64_t speed, int64_t attack_range, int64_t attack_damage)`
`21`	`21`	`: Unit(id, player_id, actor_type, hp, max_hp, position, gold_manager,`
`22`	`22`	`path_planner, speed, attack_range, attack_damage),`