Repo consistency

.github/workflows/build.yaml

@@ -3,6 +3,7 @@ on:
   push:
     branches:
       - develop
+      - repo-consistency
     tags:
       - "*"
 

.github/workflows/test.yaml

@@ -24,33 +24,34 @@ jobs:
     env:
       HUB_DATABASE: postgres://postgres:postgres@localhost:5432/ndoh_hub
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Install gettext
         run: sudo apt-get install gettext
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ hashFiles('requirements.txt', 'requirements-dev.txt') }}-pip
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.9
-      - name: Install dependancies
+      - uses: abatilo/actions-poetry@v3  
+      - name: Install dependencies
+        id: install-deps
+        run: |
+          poetry install
+      - name: Check formatting
+        # Lints/tests should always run, even if other lints/tests have failed.
+        if: success() || failure() && steps.install-deps.outcome == 'success'
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt -r requirements-dev.txt
-          django-admin compilemessages
+          poetry run ruff format --check 
       - name: Lint
+        if: success() || failure() && steps.install-deps.outcome == 'success'
         run: |
-          flake8
-          python manage.py makemigrations registrations changes eventstore --dry-run | grep 'No changes detected' || (echo 'There are changes which require migrations.' && exit 1)
-          black --check .
-          isort -c -rc .
-      - name: Test
+          poetry run ruff check
+      - name: Run migrations
+        if: success() || failure() && steps.install-deps.outcome == 'success'
         run: |
-          py.test
-      - name: Coverage comment
-        id: coverage_comment
-        uses: py-cov-action/python-coverage-comment-action@v3
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          poetry run ./manage.py makemigrations registrations changes\
+           eventstore --dry-run | grep 'No changes detected' || (echo 'There\
+           are changes which require migrations.' && exit 1)
+      - name: Run tests
+        if: success() || failure() && steps.install-deps.outcome == 'success'
+        run: |
+          poetry run pytest -vv
 

Dockerfile

@@ -1,10 +1,12 @@
 FROM ghcr.io/praekeltfoundation/docker-django-bootstrap-nw:py3.9-bullseye
 
-COPY setup.py /app
-RUN pip install --no-cache-dir -e .
+RUN pip install poetry==1.8.3
 ENV DJANGO_SETTINGS_MODULE "ndoh_hub.settings"
 
 COPY . /app
+RUN poetry config virtualenvs.create false \
+    && poetry install --no-dev --no-interaction --no-ansi --no-cache
+
 RUN apt-get-install.sh gettext; \
     django-admin compilemessages; \
     apt-get-purge.sh gettext

aaq/tests/helpers.py

@@ -13,7 +13,7 @@ def post_inbound_check(self, request):
                 [
                     "26",
                     "Fainting in pregnancy",
-                    "*Fainting could mean anemia – visit the clinic to find out",
+                    "*Fainting could mean anemia - visit the clinic to find out",
                 ],
                 [
                     "114",

aaq/tests/test_utils.py

@@ -9,7 +9,6 @@
 
 
 class SearchFunctionTest(APITestCase):
-
     @responses.activate
     def test_search_function(self):
         user = get_user_model().objects.create_user("test")

aaq/tests/test_views.py

@@ -49,7 +49,7 @@ def test_get_first_page_view(self):
             "body": {
                 "1": {"text": "*Yes, pregnancy can affect your breathing", "id": "21"},
                 "2": {
-                    "text": "*Fainting could mean anemia – visit the clinic to "
+                    "text": "*Fainting could mean anemia - visit the clinic to "
                     "find out",
                     "id": "26",
                 },

aaq/views.py

@@ -172,7 +172,6 @@ def response_feedback(request, *args, **kwargs):
 @api_view(("POST",))
 @renderer_classes((JSONRenderer,))
 def aaq_search(request):
-
     serializer = SearchSerializer(data=request.data)
     serializer.is_valid(raise_exception=True)
     query_text = serializer.validated_data["query_text"]

eventstore/admin.py

@@ -42,7 +42,6 @@ class ApproximatePaginator(Paginator):
 
     @cached_property
     def count(self):
-        cursor = connection.cursor()
         with transaction.atomic(), connection.cursor() as cursor:
             cursor.execute("SET LOCAL statement_timeout TO 50")
             try:

eventstore/management/commands/migrate_to_eventstore.py

@@ -36,31 +36,24 @@ def add_arguments(self, parser):
     def execute_with_progress(self, func, iterator):
         total = 0
         start, d_print = time.time(), time.time()
-        for arg in iterator:
+        for total, arg in enumerate(iterator):
             func(arg)
             if time.time() - d_print > 1:
                 self.stdout.write(
                     f"\rProcessed {total} at {total/(time.time() - start):.0f}/s",
                     ending="",
                 )
                 d_print = time.time()
-            total += 1
         self.stdout.write("")
 
     def handle_public_registration(self, reg):
         data = reg.data or {}
-        if "whatsapp" in reg.reg_type:
-            channel = "WhatsApp"
-        else:
-            channel = "SMS"
+        channel = "WhatsApp" if "whatsapp" in reg.reg_type else "SMS"
         uuid_registrant = data.pop("uuid_registrant", None)
         operator_id = data.pop("operator_id", None)
         uuid_device = data.pop("uuid_device", None)
         language = data.pop("language", "")
-        if language in LANGUAGES:
-            language = language.rstrip("_ZA")
-        else:
-            language = ""
+        language = language.rstrip("_ZA") if language in LANGUAGES else ""
 
         PublicRegistration.objects.update_or_create(
             id=reg.id,
@@ -78,10 +71,7 @@ def handle_public_registration(self, reg):
 
     def handle_CHW_registration(self, reg):
         data = reg.data or {}
-        if "whatsapp" in reg.reg_type:
-            channel = "WhatsApp"
-        else:
-            channel = "SMS"
+        channel = "WhatsApp" if "whatsapp" in reg.reg_type else "SMS"
         uuid_registrant = data.pop("uuid_registrant", None)
         operator_id = data.pop("operator_id", None)
         uuid_device = data.pop("uuid_device", None)
@@ -91,10 +81,7 @@ def handle_CHW_registration(self, reg):
         passport_number = data.pop("passport_no", "")
         date_of_birth = data.pop("mom_dob", None)
         language = data.pop("language", "")
-        if language in LANGUAGES:
-            language = language.rstrip("_ZA")
-        else:
-            language = ""
+        language = language.rstrip("_ZA") if language in LANGUAGES else ""
 
         CHWRegistration.objects.update_or_create(
             id=reg.id,
@@ -117,10 +104,7 @@ def handle_CHW_registration(self, reg):
 
     def handle_prebirth_registration(self, reg):
         data = reg.data or {}
-        if "whatsapp" in reg.reg_type:
-            channel = "WhatsApp"
-        else:
-            channel = "SMS"
+        channel = "WhatsApp" if "whatsapp" in reg.reg_type else "SMS"
         uuid_registrant = data.pop("uuid_registrant", None)
         contact_id = reg.registrant_id or uuid_registrant
         uuid_device = data.pop("uuid_device", None)
@@ -133,10 +117,7 @@ def handle_prebirth_registration(self, reg):
         facility_code = data.pop("faccode", "")
         edd = data.pop("edd", None)
         language = data.pop("language", "")
-        if language in LANGUAGES:
-            language = language.rstrip("_ZA")
-        else:
-            language = ""
+        language = language.rstrip("_ZA") if language in LANGUAGES else ""
 
         PrebirthRegistration.objects.update_or_create(
             id=reg.id,

eventstore/models.py

@@ -1,7 +1,6 @@
 import random
 import uuid
 from datetime import date
-from typing import Text
 
 import pycountry
 from django.conf import settings
@@ -85,9 +84,7 @@ class OptOut(models.Model):
     data = models.JSONField(default=dict, blank=True, null=True)
 
     def __str__(self):
-        return "{} opt out: {} <{}>".format(
-            self.get_optout_type_display(), self.get_reason_display(), self.contact_id
-        )
+        return f"{self.get_optout_type_display()} opt out: {self.get_reason_display()} <{self.contact_id}>"
 
 
 class BabySwitch(models.Model):
@@ -348,10 +345,7 @@ def has_label(self, label):
             .get("labels", [])
         ]
 
-        if label in labels:
-            return True
-
-        return False
+        return label in labels
 
 
 class Event(models.Model):
@@ -592,9 +586,11 @@ class HCSStudyBRandomization(models.Model):
     )
 
     def process_study_b(self):
-        if self.msisdn not in settings.HCS_STUDY_B_WHITELIST:
-            if not settings.HCS_STUDY_B_ACTIVE:
-                return
+        if (
+            self.msisdn not in settings.HCS_STUDY_B_WHITELIST
+            and not settings.HCS_STUDY_B_ACTIVE
+        ):
+            return
         if self.created_by in settings.HCS_STUDY_B_CREATED_BY and not self.study_b_arm:
             self.study_b_arm = self.get_random_study_b_arm()
 
@@ -612,7 +608,7 @@ def get_random_study_b_arm(self):
         actual_total, actual_percentage = self.get_study_totals_per_province()
 
         if actual_total < target_total or actual_percentage < target_percentage:
-            return random.choice(self.STUDY_ARM_B_CHOICES)[0]
+            return random.choice(self.STUDY_ARM_B_CHOICES)[0]  # noqa: S311 - Not being used for crypto purposes
 
     def get_study_totals_per_province(self):
         all_provinces = HCSStudyBRandomization.objects.filter(
@@ -636,7 +632,7 @@ def save(self, *args, **kwargs):
 
 
 class HealthCheckUserProfileManager(models.Manager):
-    def get_or_prefill(self, msisdn: Text) -> "HealthCheckUserProfile":
+    def get_or_prefill(self, msisdn: str) -> "HealthCheckUserProfile":
         """
         Either gets the existing user profile, or creates one using data in the
         historical healthchecks
@@ -758,9 +754,11 @@ def update_post_screening_study_arms(self, risk, created_by):
         self.process_study_c(risk, created_by)
 
     def process_study_a(self, created_by):
-        if self.msisdn not in settings.HCS_STUDY_A_WHITELIST:
-            if not settings.HCS_STUDY_A_ACTIVE:
-                return
+        if (
+            self.msisdn not in settings.HCS_STUDY_A_WHITELIST
+            and not settings.HCS_STUDY_A_ACTIVE
+        ):
+            return
 
         if created_by == settings.HCS_STUDY_A_CREATED_BY and not self.hcs_study_a_arm:
             self.hcs_study_a_arm = self.get_random_study_arm()
@@ -819,10 +817,10 @@ def get_random_study_arm(self):
         actual_total, actual_percentage = self.get_study_totals_per_province()
 
         if actual_total < target_total or actual_percentage < target_percentage:
-            return random.choice(self.STUDY_ARM_CHOICES)[0]
+            return random.choice(self.STUDY_ARM_CHOICES)[0]  # noqa: S311 - Not being used for crypto purposes
 
     def get_random_study_quarantine_arm(self):
-        return random.choice(self.STUDY_ARM_QUARANTINE_CHOICES)[0]
+        return random.choice(self.STUDY_ARM_QUARANTINE_CHOICES)[0]  # noqa: S311 - Not being used for crypto purposes
 
 
 class CDUAddressUpdate(models.Model):
@@ -1052,15 +1050,15 @@ def clean(self):
             if not is_valid_edd_date(edd):
                 raise ValidationError("EDD must be between now and 9 months")
         except ValueError as e:
-            raise ValidationError(f"Invalid EDD date, {str(e)}")
+            raise ValidationError(f"Invalid EDD date, {e!s}") from e
         except TypeError:
             # Should be handled by the individual field validator
             pass
 
         try:
             date(self.baby_dob_year, self.baby_dob_month, self.baby_dob_day)
         except ValueError as e:
-            raise ValidationError(f"Invalid Baby DOB date, {str(e)}")
+            raise ValidationError(f"Invalid Baby DOB date, {e!s}") from e
         except TypeError:
             # Should be handled by the individual field validator
             pass
@@ -1081,9 +1079,10 @@ def clean(self):
             raise ValidationError("Passport country required for passport ID type")
         if self.id_type == self.IDType.PASSPORT and not self.passport_number:
             raise ValidationError("Passport number required for passport ID type")
-        if self.id_type == self.IDType.NONE:
-            if self.dob_year is None or self.dob_month is None or self.dob_year is None:
-                raise ValidationError("Date of birth required for none ID type")
+        if self.id_type == self.IDType.NONE and (
+            self.dob_year is None or self.dob_month is None or self.dob_year is None
+        ):
+            raise ValidationError("Date of birth required for none ID type")
 
         if (
             self.dob_year is not None
@@ -1093,7 +1092,7 @@ def clean(self):
             try:
                 date(self.dob_year, self.dob_month, self.dob_day)
             except ValueError as e:
-                raise ValidationError(f"Invalid date of birth date, {str(e)}")
+                raise ValidationError(f"Invalid date of birth date, {e!s}") from e
 
 
 class OpenHIMQueue(models.Model):

eventstore/serializers.py

@@ -129,7 +129,7 @@ class MSISDNField(serializers.CharField):
 
     def __init__(self, *args, **kwargs):
         self.country = kwargs.pop("country", None)
-        return super(MSISDNField, self).__init__(*args, **kwargs)
+        return super().__init__(*args, **kwargs)
 
     def to_representation(self, obj):
         number = phonenumbers.parse(obj, self.country)
@@ -139,7 +139,7 @@ def to_internal_value(self, data):
         try:
             number = phonenumbers.parse(data, self.country)
         except phonenumbers.NumberParseException as e:
-            raise serializers.ValidationError(str(e))
+            raise serializers.ValidationError(str(e)) from e
         if not phonenumbers.is_possible_number(number):
             raise serializers.ValidationError("Not a possible phone number")
         if not phonenumbers.is_valid_number(number):