Updated test_animal_territories.

tests/models/animals/conftest.py

@@ -153,7 +153,7 @@ def functional_group_list_instance(shared_datadir, constants_instance):
 
 @pytest.fixture
 def animal_model_instance(
-    data_instance,
+    animal_data_for_community_instance,
     fixture_core_components,
     functional_group_list_instance,
     constants_instance,
@@ -163,7 +163,7 @@ def animal_model_instance(
     from virtual_ecosystem.models.animal.animal_model import AnimalModel
 
     return AnimalModel(
-        data=data_instance,
+        data=animal_data_for_community_instance,
         core_components=fixture_core_components,
         functional_groups=functional_group_list_instance,
         model_constants=constants_instance,

tests/models/animals/test_animal_territories.py

@@ -21,32 +21,46 @@ def animal_territory_instance(self, get_community_by_key):
         from virtual_ecosystem.models.animal.animal_territories import AnimalTerritory
 
         return AnimalTerritory(
-            grid_cell_keys=[1, 2, 3], get_community_by_key=get_community_by_key
+            centroid=0,
+            grid_cell_keys=[1, 2, 3],
+            get_community_by_key=get_community_by_key,
         )
 
-    def test_update_territory(
-        self, mocker, animal_territory_instance, herbivore_cohort_instance
-    ):
-        """Test for update_territory method."""
-        mock_get_prey = mocker.patch.object(
-            animal_territory_instance, "get_prey", return_value=[]
-        )
-        mock_get_plant_resources = mocker.patch.object(
+    @pytest.fixture
+    def mock_get_plant_resources(self, mocker, animal_territory_instance):
+        """Mock get_plant_resources method."""
+        return mocker.patch.object(
             animal_territory_instance, "get_plant_resources", return_value=[]
         )
-        mock_get_excrement_pools = mocker.patch.object(
+
+    @pytest.fixture
+    def mock_get_excrement_pools(self, mocker, animal_territory_instance):
+        """Mock get_excrement_pools method."""
+        return mocker.patch.object(
             animal_territory_instance, "get_excrement_pools", return_value=[]
         )
-        mock_get_carcass_pool = mocker.patch.object(
-            animal_territory_instance, "get_carcass_pool", return_value=[]
+
+    @pytest.fixture
+    def mock_get_carcass_pools(self, mocker, animal_territory_instance):
+        """Mock get_carcass_pools method."""
+        return mocker.patch.object(
+            animal_territory_instance, "get_carcass_pools", return_value=[]
         )
 
+    def test_update_territory(
+        self,
+        animal_territory_instance,
+        herbivore_cohort_instance,
+        mock_get_plant_resources,
+        mock_get_excrement_pools,
+        mock_get_carcass_pools,
+    ):
+        """Test for update_territory method."""
         animal_territory_instance.update_territory(herbivore_cohort_instance)
 
-        mock_get_prey.assert_called_once_with(herbivore_cohort_instance)
         mock_get_plant_resources.assert_called_once()
         mock_get_excrement_pools.assert_called_once()
-        mock_get_carcass_pool.assert_called_once()
+        mock_get_carcass_pools.assert_called_once()
 
     def test_get_prey(
         self,
@@ -83,15 +97,75 @@ def test_get_excrement_pools(self, animal_territory_instance):
         for excrement in excrement_pools:
             assert isinstance(excrement, ExcrementPool)
 
-    def test_get_carcass_pool(self, animal_territory_instance):
+    def test_get_carcass_pools(self, animal_territory_instance):
         """Test for get carcass pool method."""
         from virtual_ecosystem.models.animal.decay import CarcassPool
 
-        carcass_pools = animal_territory_instance.get_carcass_pool()
+        carcass_pools = animal_territory_instance.get_carcass_pools()
         assert len(carcass_pools) == len(animal_territory_instance.grid_cell_keys)
         for carcass in carcass_pools:
             assert isinstance(carcass, CarcassPool)
 
+    @pytest.fixture
+    def mock_carcass_pool(self, mocker):
+        """Fixture for a mock CarcassPool."""
+        mock_pool = mocker.Mock()
+        mock_pool.scavengeable_energy = 10000.0
+        mock_pool.decomposed_energy = 0.0
+        return mock_pool
+
+    @pytest.fixture
+    def mock_community(self, mocker, mock_carcass_pool):
+        """Fixture for a mock AnimalCommunity with a carcass pool."""
+        community_mock = mocker.Mock()
+        community_mock.carcass_pool = mock_carcass_pool
+        return community_mock
+
+    @pytest.fixture
+    def mock_get_community_by_key(self, mocker, mock_community):
+        """Fixture for get_community_by_key, returning a mock community."""
+        return mocker.Mock(side_effect=lambda key: mock_community)
+
+    @pytest.fixture
+    def animal_territory_instance_1(self, mock_get_community_by_key):
+        """Fixture for the first animal territory with mock get_community_by_key."""
+        from virtual_ecosystem.models.animal.animal_territories import AnimalTerritory
+
+        return AnimalTerritory(
+            centroid=0,
+            grid_cell_keys=[1, 2, 3],
+            get_community_by_key=mock_get_community_by_key,
+        )
+
+    @pytest.fixture
+    def animal_territory_instance_2(self, mock_get_community_by_key):
+        """Fixture for the second animal territory with mock get_community_by_key."""
+        from virtual_ecosystem.models.animal.animal_territories import AnimalTerritory
+
+        return AnimalTerritory(
+            centroid=1,
+            grid_cell_keys=[2, 3, 4],
+            get_community_by_key=mock_get_community_by_key,
+        )
+
+    def test_find_intersecting_carcass_pools(
+        self,
+        animal_territory_instance_1,
+        animal_territory_instance_2,
+        mock_carcass_pool,
+    ):
+        """Test for find_intersecting_carcass_pools method."""
+        intersecting_pools = (
+            animal_territory_instance_1.find_intersecting_carcass_pools(
+                animal_territory_instance_2
+            )
+        )
+
+        # Since the same mock object is returned, we need to repeat it for the
+        # expected value.
+        expected_pools = [mock_carcass_pool, mock_carcass_pool]
+        assert intersecting_pools == expected_pools
+
 
 @pytest.mark.parametrize(
     "centroid_key, target_cell_number, cell_nx, cell_ny, expected",

virtual_ecosystem/models/animal/animal_communities.py

@@ -213,8 +213,9 @@ def populate_community(self) -> None:
     def migrate(self, migrant: AnimalCohort, destination: AnimalCommunity) -> None:
         """Function to move an AnimalCohort between AnimalCommunity objects.
 
-        This function should take a cohort and a destination community and then pop the
-        cohort from this community to the destination.
+        This function takes a cohort and a destination community, changes the
+        centroid of the cohort's territory to be the new community, and then
+        reinitializes the territory around the new centroid.
 
         TODO: travel distance should be a function of body-size or locomotion once
               multi-grid occupancy is integrated.
@@ -236,7 +237,7 @@ def migrate(self, migrant: AnimalCohort, destination: AnimalCommunity) -> None:
         )
 
     def migrate_community(self) -> None:
-        """This handles migrating all cohorts in a community.
+        """This handles migrating all cohorts with a centroid in the community.
 
         This migration method initiates migration for two reasons:
         1) The cohort is starving and needs to move for a chance at resource access
@@ -399,6 +400,8 @@ def collect_prey(
         This is a helper function for territory.get_prey, it filters suitable prey from
         the total list of animal cohorts across the territory.
 
+        TODO: possibly moved to be a territory method
+
         Args:
             consumer_cohort: The AnimalCohort for which a prey list is being collected
 

virtual_ecosystem/models/animal/animal_territories.py

@@ -43,7 +43,7 @@ def __init__(
         """A list of grid cells present in the territory."""
         self.get_community_by_key = get_community_by_key
         """A list of animal communities present in the territory."""
-        self.territory_prey: Sequence[Consumer] = []
+        # self.territory_prey: Sequence[Consumer] = []
         """A list of animal prey present in the territory."""
         self.territory_plants: Sequence[Resource] = []
         """A list of plant resources present in the territory."""
@@ -60,7 +60,7 @@ def update_territory(self, consumer_cohort: Consumer) -> None:
 
         """
 
-        self.territory_prey = self.get_prey(consumer_cohort)
+        # self.territory_prey = self.get_prey(consumer_cohort)
         self.territory_plants = self.get_plant_resources()
         self.territory_excrement = self.get_excrement_pools()
         self.territory_carcasses = self.get_carcass_pools()