HOPE Add PDM

.gitignore

@@ -29,6 +29,7 @@ backend/test-results/
 backend/lint-results/
 backend/mypy-results/
 backend/screenshot/
+backend/__pypackages__/
 cypress-results/
 cypress-reports/
 

backend/.flake8

@@ -19,7 +19,8 @@ exclude =
     # This contains builds of flake8 that we don't want to check
     dist,
     migrations,
-    snapshots
+    snapshots,
+    __pypackages__,
 
 ignore =
     # black formatting related

backend/.gitignore

@@ -7,4 +7,5 @@ pytest_screenshots
 report
 archive
 output.json
-pytest_html_report.html
+pytest_html_report.html
+.pdm-python

backend/hct_mis_api/__init__.py

@@ -4,4 +4,4 @@
 def get_full_version() -> str:
     with open("pyproject.toml", mode="rb") as fp:
         config = tomli.load(fp)
-    return config["tool"]["poetry"]["version"]
+    return config["project"]["version"]

backend/hct_mis_api/api/endpoints/rdi/upload.py

@@ -238,7 +238,7 @@ def create(self, validated_data: Dict) -> Dict:
             number_of_households=info.households,
             datahub_id=str(rdi_datahub.pk),
             business_area=self.business_area,
-            program=program
+            program=program,
         )
         rdi_datahub.hct_id = rdi_mis.id
         rdi_datahub.save()

backend/hct_mis_api/apps/account/schema.py

@@ -67,7 +67,6 @@ class Meta:
 
 
 class PartnerRoleNode(DjangoObjectType):
-
     class Meta:
         model = BusinessAreaPartnerThrough
         exclude = ("id",)

backend/hct_mis_api/apps/accountability/tests/test_create_communication_message.py

@@ -113,9 +113,10 @@ def test_create_accountability_communication_message_by_target_population(self,
             self.user, [Permissions.ACCOUNTABILITY_COMMUNICATION_MESSAGE_VIEW_CREATE], self.business_area
         )
         broadcast_message_mock = MagicMock(return_value=None)
-        with patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)
-        ), patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.broadcast_message", broadcast_message_mock):
+        with (
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)),
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.broadcast_message", broadcast_message_mock),
+        ):
             self.snapshot_graphql_request(
                 request_string=self.MUTATION,
                 context={
@@ -151,9 +152,10 @@ def test_create_accountability_communication_message_by_households(self, samplin
             self.user, [Permissions.ACCOUNTABILITY_COMMUNICATION_MESSAGE_VIEW_CREATE], self.business_area
         )
         broadcast_message_mock = MagicMock(return_value=None)
-        with patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)
-        ), patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.broadcast_message", broadcast_message_mock):
+        with (
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)),
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.broadcast_message", broadcast_message_mock),
+        ):
             self.snapshot_graphql_request(
                 request_string=self.MUTATION,
                 context={

backend/hct_mis_api/apps/accountability/tests/test_create_survey.py

@@ -138,9 +138,10 @@ def test_create_survey_and_send_via_rapidpro(self) -> None:
         households = [create_household({"size": 3})[0] for _ in range(3)]
         self.tp.households.set(households)
 
-        with patch.object(django.db.transaction, "on_commit", lambda t: t()), patch(
-            "hct_mis_api.apps.accountability.celery_tasks.send_survey_to_users.delay"
-        ) as task_mock:
+        with (
+            patch.object(django.db.transaction, "on_commit", lambda t: t()),
+            patch("hct_mis_api.apps.accountability.celery_tasks.send_survey_to_users.delay") as task_mock,
+        ):
             self.snapshot_graphql_request(
                 request_string=self.CREATE_SURVEY_MUTATION,
                 context={
@@ -259,11 +260,12 @@ def test_create_survey_without_recipients(self) -> None:
         )
 
     def test_getting_available_flows(self) -> None:
-        with patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)
-        ), patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.get_flows",
-            MagicMock(return_value=[{"uuid": 123, "name": "flow2"}, {"uuid": 234, "name": "flow2"}]),
+        with (
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)),
+            patch(
+                "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.get_flows",
+                MagicMock(return_value=[{"uuid": 123, "name": "flow2"}, {"uuid": 234, "name": "flow2"}]),
+            ),
         ):
             self.snapshot_graphql_request(
                 request_string=self.AVAILABLE_FLOWS,

backend/hct_mis_api/apps/core/tests/test_core_fields.py

@@ -9,7 +9,6 @@
 
 
 class TestCoreFields(APITestCase):
-
     def setUp(self) -> None:
         self.scopes = [Scope.GLOBAL, Scope.XLSX_PEOPLE]
         super().setUp()

backend/hct_mis_api/apps/geo/compat.py

@@ -51,7 +51,7 @@ def get_choices(
         include_blank: bool = True,
         blank_choice: Optional[List[Union[Tuple[Any, Any], Tuple[str, Iterable[Tuple[Any, Any]]]]]] = None,
         *args: Any,
-        **kwargs: Any
+        **kwargs: Any,
     ) -> List:
         if self.choices and self.choices[0] == (None, None):
             self.choices = Country.objects.all().values_list("iso_code2", "name")

backend/hct_mis_api/apps/grievance/services/data_change/individual_data_update_service.py

@@ -123,9 +123,9 @@ def save(self) -> List[GrievanceTicket]:
         individual_data_with_approve_status["identities_to_remove"] = identities_to_remove_with_approve_status
         individual_data_with_approve_status["identities_to_edit"] = prepare_edit_identities(identities_to_edit)
         individual_data_with_approve_status["payment_channels"] = payment_channels_with_approve_status
-        individual_data_with_approve_status["payment_channels_to_remove"] = (
-            payment_channels_to_remove_with_approve_status
-        )
+        individual_data_with_approve_status[
+            "payment_channels_to_remove"
+        ] = payment_channels_to_remove_with_approve_status
         individual_data_with_approve_status["payment_channels_to_edit"] = prepare_edit_payment_channel(
             payment_channels_to_edit
         )
@@ -215,9 +215,9 @@ def update(self) -> GrievanceTicket:
             identities_to_remove_with_approve_status
         )
         individual_data_with_approve_status["payment_channels"] = payment_channels_with_approve_status
-        individual_data_with_approve_status["payment_channels_to_remove"] = (
-            payment_channels_to_remove_with_approve_status
-        )
+        individual_data_with_approve_status[
+            "payment_channels_to_remove"
+        ] = payment_channels_to_remove_with_approve_status
         individual_data_with_approve_status["payment_channels_to_edit"] = prepare_edit_payment_channel(
             payment_channels_to_edit
         )

backend/hct_mis_api/apps/grievance/tests/test_grievance_data_change_mutations.py

@@ -194,7 +194,7 @@ def setUpTestData(cls) -> None:
             IndividualFactory(
                 household=household_one if index % 2 else household_two,
                 program=household_one.program if index % 2 else household_two.program,
-                **individual
+                **individual,
             )
             for index, individual in enumerate(cls.individuals_to_create)
         ]

backend/hct_mis_api/apps/grievance/tests/test_grievance_es.py

@@ -362,7 +362,7 @@ def setUpTestData(cls) -> None:
             }
         )
 
-        cls.es.index(
+        cls.es.index(  # type: ignore
             index="test_es_db",
             doc_type="_doc",
             id=cls.grievance_ticket_1.id,
@@ -405,7 +405,7 @@ def setUpTestData(cls) -> None:
             }
         )
 
-        cls.es.index(
+        cls.es.index(  # type: ignore
             index="test_es_db",
             doc_type="_doc",
             id=cls.grievance_ticket_2.id,
@@ -447,7 +447,7 @@ def setUpTestData(cls) -> None:
             }
         )
 
-        cls.es.index(
+        cls.es.index(  # type: ignore
             index="test_es_db",
             doc_type="_doc",
             id=cls.grievance_ticket_3.id,

backend/hct_mis_api/apps/grievance/tests/test_grievance_update_referral_ticket.py

@@ -145,7 +145,7 @@ def test_update_referral_ticket_with_household_and_individual_extras(
     ) -> None:
         self.create_user_role_with_permissions(self.user, permissions, self.business_area)
 
-        extras = {
+        extras: Dict = {
             "household": self.id_to_base64(self.household.id, "HouseholdNode"),
             "individual": self.id_to_base64(self.individuals[0].id, "IndividualNode"),
         }

backend/hct_mis_api/apps/payment/tests/test_import_verifications.py

@@ -311,9 +311,9 @@ def test_import_valid_status_changed_received_yes_full(self) -> None:
         payment_verification = PaymentVerification.objects.get(payment_object_id=payment_record_id)
         self.assertEqual(payment_verification.status, PaymentVerification.STATUS_PENDING)
         wb.active[f"{XlsxVerificationExportService.RECEIVED_COLUMN_LETTER}2"] = "YES"
-        wb.active[f"{XlsxVerificationExportService.RECEIVED_AMOUNT_COLUMN_LETTER}2"] = (
-            payment_verification.payment_obj.delivered_quantity
-        )
+        wb.active[
+            f"{XlsxVerificationExportService.RECEIVED_AMOUNT_COLUMN_LETTER}2"
+        ] = payment_verification.payment_obj.delivered_quantity
         with NamedTemporaryFile() as tmp:
             wb.save(tmp.name)
             file = io.BytesIO(tmp.read())

backend/hct_mis_api/apps/payment/tests/test_verification_plan_status_change_services.py

@@ -166,9 +166,10 @@ def create_flow_response() -> Dict:
         post_request_mock = MagicMock()
 
         post_request_mock.side_effect = [first_flow, requests.exceptions.HTTPError("TEST")]  # type: ignore
-        with patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)
-        ), patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI._handle_post_request", post_request_mock):
+        with (
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)),
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI._handle_post_request", post_request_mock),
+        ):
             try:
                 VerificationPlanStatusChangeServices(self.verification).activate()
             except requests.exceptions.HTTPError:
@@ -227,9 +228,10 @@ def create_flow_response() -> Dict:
 
         post_request_mock = MagicMock()
         post_request_mock.side_effect = [first_flow, create_flow_response()]
-        with patch(
-            "hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)
-        ), patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI._handle_post_request", post_request_mock):
+        with (
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI.__init__", MagicMock(return_value=None)),
+            patch("hct_mis_api.apps.core.services.rapid_pro.api.RapidProAPI._handle_post_request", post_request_mock),
+        ):
             VerificationPlanStatusChangeServices(self.verification).activate()
 
         self.verification.refresh_from_db()

backend/hct_mis_api/apps/payment/xlsx/xlsx_verification_export_service.py

@@ -72,9 +72,9 @@ def _create_workbook(self) -> openpyxl.Workbook:
         return wb
 
     def _add_version(self) -> None:
-        self.ws_meta[XlsxVerificationExportService.VERSION_CELL_NAME_COORDINATES] = (
-            XlsxVerificationExportService.VERSION_CELL_NAME
-        )
+        self.ws_meta[
+            XlsxVerificationExportService.VERSION_CELL_NAME_COORDINATES
+        ] = XlsxVerificationExportService.VERSION_CELL_NAME
         self.ws_meta[XlsxVerificationExportService.VERSION_CELL_COORDINATES] = XlsxVerificationExportService.VERSION
 
     def _to_received_column(self, payment_record_verification: PaymentVerification) -> Optional[str]:
@@ -117,7 +117,7 @@ def _add_data_validation(self) -> None:
         self.dv_received = DataValidation(type="list", formula1='"YES,NO"', allow_blank=False)
         self.dv_received.add(f"B2:B{len(self.ws_export_list['B'])}")
         self.ws_export_list.add_data_validation(self.dv_received)
-        self.ws_export_list["B2" :f"B{len(self.ws_export_list['B'])}"]
+        self.ws_export_list["B2":f"B{len(self.ws_export_list['B'])}"]
 
     def generate_workbook(self) -> openpyxl.Workbook:
         self._create_workbook()

backend/hct_mis_api/apps/reporting/tests/test_report_service.py

@@ -201,11 +201,14 @@ def test_report_types(
             report.save()
 
         report_service = self.GenerateReportService(report)
-        with patch(
-            "hct_mis_api.apps.reporting.services.generate_report_service.GenerateReportService.save_wb_file_in_db"
-        ) as mock_save_wb_file_in_db, patch(
-            "hct_mis_api.apps.reporting.services.generate_report_service.GenerateReportService.generate_workbook"
-        ) as mock_generate_workbook:
+        with (
+            patch(
+                "hct_mis_api.apps.reporting.services.generate_report_service.GenerateReportService.save_wb_file_in_db"
+            ) as mock_save_wb_file_in_db,
+            patch(
+                "hct_mis_api.apps.reporting.services.generate_report_service.GenerateReportService.generate_workbook"
+            ) as mock_generate_workbook,
+        ):
             report_service.generate_report()
             assert mock_generate_workbook.called
             assert mock_save_wb_file_in_db.called

backend/hct_mis_api/apps/targeting/services/xlsx_export_targeting_service.py

@@ -60,9 +60,9 @@ def generate_workbook(self) -> Workbook:
         return self.workbook
 
     def _add_version(self) -> None:
-        self.ws_meta[XlsxExportTargetingService.VERSION_CELL_NAME_COORDINATES] = (
-            XlsxExportTargetingService.VERSION_CELL_NAME
-        )
+        self.ws_meta[
+            XlsxExportTargetingService.VERSION_CELL_NAME_COORDINATES
+        ] = XlsxExportTargetingService.VERSION_CELL_NAME
         self.ws_meta[XlsxExportTargetingService.VERSION_CELL_COORDINATES] = XlsxExportTargetingService.VERSION
 
     def _create_workbook(self) -> openpyxl.Workbook:

backend/hct_mis_api/apps/targeting/tests/test_xlsx_export_targeting_service.py

@@ -0,0 +1,36 @@
+from hct_mis_api.apps.core.base_test_case import APITestCase
+from hct_mis_api.apps.core.fixtures import create_afghanistan
+from hct_mis_api.apps.targeting.fixtures import TargetPopulationFactory
+from hct_mis_api.apps.targeting.models import TargetPopulation
+from hct_mis_api.apps.targeting.services.xlsx_export_targeting_service import (
+    XlsxExportTargetingService,
+)
+
+
+class TestXlsxExportTargetingService(APITestCase):
+    @classmethod
+    def setUpTestData(cls) -> None:
+        cls.business_area = create_afghanistan()
+        cls.target_population = TargetPopulationFactory(
+            business_area=cls.business_area, status=TargetPopulation.STATUS_OPEN
+        )
+
+    def test_add_version(self) -> None:
+        service = XlsxExportTargetingService(self.target_population)
+        service._create_workbook()
+        service._add_version()
+        self.assertEqual(
+            service.ws_meta[XlsxExportTargetingService.VERSION_CELL_NAME_COORDINATES].value,
+            XlsxExportTargetingService.VERSION_CELL_NAME,
+        )
+        self.assertEqual(
+            service.ws_meta[XlsxExportTargetingService.VERSION_CELL_COORDINATES].value,
+            XlsxExportTargetingService.VERSION,
+        )
+
+    def test_add_standard_columns_headers(self) -> None:
+        service = XlsxExportTargetingService(self.target_population)
+        service._create_workbook()
+        service._add_standard_columns_headers()
+        headers = [cell.value for cell in service.ws_individuals[1]]
+        self.assertEqual(headers, ["Household unicef_id", "unicef_id", "Linked Households", "Bank account information"])

backend/hct_mis_api/apps/utils/tests/test_get_version.py

@@ -0,0 +1,22 @@
+from typing import Any
+from unittest.mock import mock_open, patch
+
+from django.test import TestCase
+
+from hct_mis_api import get_full_version
+
+
+class TestUtils(TestCase):
+    @patch("builtins.open", new_callable=mock_open, read_data=b'[project]\n version = "2.3.4"')
+    def test_get_full_version(self, mock_file_open: Any) -> None:
+        self.assertEqual(get_full_version(), "2.3.4")
+
+    @patch("builtins.open", side_effect=FileNotFoundError)
+    def test_file_not_found(self, mock_file_open: Any) -> None:
+        with self.assertRaises(FileNotFoundError):
+            get_full_version()
+
+    @patch("builtins.open", new_callable=mock_open, read_data=b'[project]\n wrong_key = "empty_version_XD"')
+    def test_key_not_found(self, mock_file_open: Any) -> None:
+        with self.assertRaises(KeyError):
+            get_full_version()