CDD-3175: tests

Author: luketowell

cms/metrics_interface/field_choices_callables.py

@@ -314,6 +314,7 @@ def get_all_theme_names_and_ids() -> LIST_OF_TWO_STRING_ITEM_TUPLES:
             [(1, "immunisation"), ...]
     """
     metrics_interface = MetricsAPIInterface()
+
     return _build_id_name_tuple_choices(
         choices=metrics_interface.get_all_theme_names_and_ids()
     )
@@ -383,32 +384,6 @@ def get_all_sub_theme_names_and_ids() -> LIST_OF_TWO_STRING_ITEM_TUPLES:
     )
 
 
-def get_filtered_unique_sub_theme_names_for_parent_theme(
-    parent_theme_id,
-) -> LIST_OF_TWO_STRING_ITEM_TUPLES:
-    """Callable for the `choices` on the `theme` fields of the CMS blocks.
-
-    Notes:
-        This callable wraps the `MetricsAPIInterface`
-        and is passed to a migration for the CMS blocks.
-        This means that we don't need to create a new migration
-        whenever a new chart type is added.
-        Instead, the 1-off migration is pointed at this callable.
-        So Wagtail will pull the choices by invoking this function.
-
-    Returns:
-        A list of 2-item tuples of theme names.
-        Examples:
-            [("Infectious_disease", "Infectious_disease"), ...]
-    """
-    metrics_interface = MetricsAPIInterface()
-    return _build_id_name_tuple_choices(
-        choices=metrics_interface.get_filtered_unique_sub_theme_names_for_parent_theme(
-            parent_theme_id=parent_theme_id
-        ),
-    )
-
-
 def get_all_topic_names() -> LIST_OF_TWO_STRING_ITEM_TUPLES:
     """Callable for the `choices` on the `topic` fields of the CMS blocks.
 
@@ -462,6 +437,7 @@ def get_all_topic_names_and_ids() -> LIST_OF_TWO_STRING_ITEM_TUPLES:
             [(1, "6-in-1"), ...]
     """
     metrics_interface = MetricsAPIInterface()
+
     return _build_id_name_tuple_choices(
         choices=metrics_interface.get_all_topic_names_and_ids()
     )

cms/metrics_interface/interface.py

@@ -253,22 +253,6 @@ def get_all_unique_sub_theme_names(self) -> QuerySet:
         """
         return self.sub_theme_manager.get_all_unique_names()
 
-    def get_filtered_unique_sub_theme_names_for_parent_theme(
-        self, parent_theme_id
-    ) -> QuerySet:
-        """Get all unique sub_theme names as a flat list queryset.
-        Note this is achieved by delegating the call to the `SubThemeManager` from the Metrics API
-
-        Returns:
-            QuerySet: A queryset of the individual sub_theme names.
-                Examples:
-                    `<SubThemeQuerySet ['respiratory', ...]>
-
-        """
-        return self.sub_theme_manager.get_filtered_unique_names_related_to_theme(
-            parent_theme_id=parent_theme_id
-        )
-
     def get_all_topic_names(self) -> QuerySet:
         """Gets all available topic names as a flat list queryset.
         Note this is achieved by delegating the call to the `TopicManager` from the Metrics API

tests/factories/metrics/metric.py

@@ -1,6 +1,6 @@
 import factory
 
-from metrics.data.models.core_models import Metric
+from metrics.data.models.core_models import Metric, Topic
 
 
 class MetricFactory(factory.django.DjangoModelFactory):
@@ -10,3 +10,14 @@ class MetricFactory(factory.django.DjangoModelFactory):
 
     class Meta:
         model = Metric
+
+    @classmethod
+    def create_with_topic(
+        cls, name: str, topic: str
+    ):
+        topic, _ = Topic.objects.get_or_create(name=topic)
+
+        return cls.create(
+            name=name,
+            topic=topic,
+        )

tests/factories/metrics/sub_theme.py

@@ -1,6 +1,6 @@
 import factory
 
-from metrics.data.models.core_models import SubTheme
+from metrics.data.models.core_models import SubTheme, Theme
 
 
 class SubThemeFactory(factory.django.DjangoModelFactory):
@@ -10,3 +10,14 @@ class SubThemeFactory(factory.django.DjangoModelFactory):
 
     class Meta:
         model = SubTheme
+
+    @classmethod
+    def create_with_theme(
+        cls, name: str, theme: str
+    ):
+        theme, _ = Theme.objects.get_or_create(name=theme)
+
+        return cls.create(
+            name=name,
+            theme=theme,
+        )

tests/factories/metrics/theme.py

@@ -0,0 +1,12 @@
+import factory
+
+from metrics.data.models.core_models import Theme, SubTheme
+
+
+class ThemeFactory(factory.django.DjangoModelFactory):
+    """
+    Factory for creating `Theme` instances for tests
+    """
+
+    class Meta:
+        model = Theme

tests/factories/metrics/topic.py

@@ -1,6 +1,6 @@
 import factory
 
-from metrics.data.models.core_models import Topic
+from metrics.data.models.core_models import Topic, SubTheme
 
 
 class TopicFactory(factory.django.DjangoModelFactory):
@@ -10,3 +10,14 @@ class TopicFactory(factory.django.DjangoModelFactory):
 
     class Meta:
         model = Topic
+
+    @classmethod
+    def create_with_sub_theme(
+        cls, name: str, sub_theme: str
+    ):
+        sub_theme, _ = SubTheme.objects.get_or_create(name=sub_theme)
+
+        return cls.create(
+            name=name,
+            sub_theme=sub_theme,
+        )

tests/integration/metrics/api/views/test_geographies.py

@@ -171,7 +171,8 @@ def test_get_returns_correct_results_for_topic(self):
 
         # When
         query_params = {"topic": topic}
-        response: Response = client.get(path=self.path, query_params=query_params)
+        response: Response = client.get(
+            path=self.path, query_params=query_params)
 
         # Then
         # Geographies are returned in descending alphabetical order
@@ -244,7 +245,8 @@ def test_get_returns_correct_results_for_geography_type(self):
 
         # When
         query_params = {"geography_type": ltla}
-        response: Response = client.get(path=self.path, query_params=query_params)
+        response: Response = client.get(
+            path=self.path, query_params=query_params)
 
         # Then
         # Geographies are returned in descending alphabetical order
@@ -265,3 +267,104 @@ def test_get_returns_correct_results_for_geography_type(self):
         assert result["geographies"][2]["geography_code"] == hackney.geography_code
 
         assert len(result["geographies"]) == 3
+
+
+class TestGeographiesByGeographyTypeView:
+    @property
+    def path(self) -> str:
+        return "/api/permission-set/geographies"
+
+    @pytest.mark.django_db
+    def test_get_geographies_by_geography_type_id_should_return_geographies(self):
+
+        client = APIClient()
+        ltla = "Lower Tier Local Authority"
+
+        bexley = GeographyFactory.create_with_geography_type(
+            name="Bexley", geography_code="E09000004", geography_type=ltla
+        )
+        arun = GeographyFactory.create_with_geography_type(
+            name="Arun", geography_code="E07000224", geography_type=ltla
+        )
+        hackney = GeographyFactory.create_with_geography_type(
+            name="Hackney", geography_code="E09000012", geography_type=ltla
+        )
+        GeographyFactory.create_with_geography_type(
+            name="England", geography_code="E92000001", geography_type="Nation"
+        )
+
+        geographyTypeId = 1
+        path = f"{self.path}/{geographyTypeId}"
+        response: Response = client.get(path=path)
+        result = response.data
+        assert len(response.data["choices"]) == 3
+        assert result["choices"][0][0] == arun.geography_code
+        assert result["choices"][0][1] == arun.name
+
+        assert result["choices"][1][0] == bexley.geography_code
+        assert result["choices"][1][1] == bexley.name
+
+        assert result["choices"][2][0] == hackney.geography_code
+        assert result["choices"][2][1] == hackney.name
+
+    @pytest.mark.django_db
+    def test_get_geographies_by_geography_type_id_should_return_wildcard(self):
+
+        client = APIClient()
+        ltla = "Lower Tier Local Authority"
+
+        bexley = GeographyFactory.create_with_geography_type(
+            name="Bexley", geography_code="E09000004", geography_type=ltla
+        )
+        arun = GeographyFactory.create_with_geography_type(
+            name="Arun", geography_code="E07000224", geography_type=ltla
+        )
+        hackney = GeographyFactory.create_with_geography_type(
+            name="Hackney", geography_code="E09000012", geography_type=ltla
+        )
+        GeographyFactory.create_with_geography_type(
+            name="England", geography_code="E92000001", geography_type="Nation"
+        )
+
+        geographyTypeId = -1
+        path = f"{self.path}/{geographyTypeId}"
+        response: Response = client.get(path=path)
+        result = response.data
+
+        # Choices length should only contain wildcard option
+        assert len(response.data["choices"]) == 1
+
+        # Should return a wildcard choice
+        assert result["choices"][0][0] == "-1"
+        assert result["choices"][0][1] == "* (All geographies)"
+
+    @pytest.mark.django_db
+    def test_get_geographies_by_geography_type_id_should_return_an_error(self):
+
+        client = APIClient()
+        ltla = "Lower Tier Local Authority"
+
+        bexley = GeographyFactory.create_with_geography_type(
+            name="Bexley", geography_code="E09000004", geography_type=ltla
+        )
+        arun = GeographyFactory.create_with_geography_type(
+            name="Arun", geography_code="E07000224", geography_type=ltla
+        )
+        hackney = GeographyFactory.create_with_geography_type(
+            name="Hackney", geography_code="E09000012", geography_type=ltla
+        )
+        GeographyFactory.create_with_geography_type(
+            name="England", geography_code="E92000001", geography_type="Nation"
+        )
+
+        geographyTypeId = "string"
+        path = f"{self.path}/{geographyTypeId}"
+        response: Response = client.get(path=path)
+        result = response.data
+
+        assert response.status_code == HTTPStatus.BAD_REQUEST
+
+        # data should contain error
+
+        assert str(result["geography_type_id"][0]
+                   ) == "Geography Type must be a number or '-1'"