Merge pull request #215 from praekeltfoundation/clinic_code_validation

clinic code validation

Author: Buhle79

README.rst

@@ -33,18 +33,19 @@ To set up and run ``rp-sidekick`` locally, do the following::
 
     $ git clone [email protected]:praekeltfoundation/rp-sidekick.git
     $ cd rp-sidekick
-    $ virtualenv ve
-    $ source ve/bin/activate
-    $ pip install -e .
-    $ pip install -r requirements-dev.txt
-    $ pre-commit install
+    $ uv sync
 
 RP-Sidekick does not work with SQLite because it uses `JSONFields`_.
 This means that you will need to set up PostgreSQL locally. You can spin up a
 local db with docker, using the following command::
 
     $ docker run -d -p 5432:5432 --name=sidekick_db -e POSTGRES_DB=rp_sidekick postgres:9.6
 
+-----
+To run tests
+-----
+    $ uv run pytest
+
 -----
 Tools
 -----

momconnect/tests/test_utils.py

@@ -6,20 +6,25 @@
 class TestUtils(TestCase):
     def test_clean_clinic_code(self):
         """
-        Test that the clean_clinic_code function removes spaces from the input string.
+        Test that the clean_clinic_code function removes spaces
+        from the input string.
         """
         self.assertEqual(clean_clinic_code("123 456"), "123456")
         self.assertEqual(clean_clinic_code("  789 "), "789")
-        self.assertEqual(clean_clinic_code("abc def"), "abcdef")
+        self.assertEqual(clean_clinic_code("abc def"), "")
         self.assertEqual(clean_clinic_code(""), "")
+        self.assertEqual(clean_clinic_code("123-456"), "123456")
+        self.assertEqual(clean_clinic_code('"123456"'), "123456")
+        self.assertEqual(clean_clinic_code("123456 clinic"), "123456")
 
     def test_validate_clinic_code(self):
         """
-        Test that the validate_clinic_code function checks if the clinic code is valid.
-        A valid clinic code must be exactly 6 digits long and contain only numbers.
+        Test that the validate_clinic_code function checks if the clinic code
+         is valid.
+        A valid clinic code must be exactly 6 digits long and contain only
+         numbers.
         """
         self.assertTrue(validate_clinic_code("123456"))
-        self.assertTrue(validate_clinic_code(" 123 456 "))
         self.assertFalse(validate_clinic_code("12345"))
         self.assertFalse(validate_clinic_code("1234567"))
         self.assertFalse(validate_clinic_code("12345a"))

momconnect/tests/test_views.py

@@ -22,8 +22,8 @@ def setUp(self):
 
     def test_unauthenticated_client(self):
         """
-        Test that an unauthenticated client receives a 401 Unauthorized response
-        when attempting to access the clinic details endpoint.
+        Test that an unauthenticated client receives a 401 Unauthorized
+         response when attempting to access the clinic details endpoint.
         """
         response = self.client.get(self.url, {"clinic_code": self.clinic.value})
         self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
@@ -64,3 +64,51 @@ def test_successful_clinic_retrieval(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(response.data["code"], self.clinic.value)
         self.assertEqual(response.data["name"], self.clinic.name)
+
+    def test_clinic_code_with_space(self):
+        """
+        Test that the endpoint returns a 200 successfully retrieves clinic
+         details when a valid clinic_code is contains a space.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "123 456"})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["code"], self.clinic.value)
+        self.assertEqual(response.data["name"], self.clinic.name)
+
+    def test_clinic_code_with_clinic_name(self):
+        """
+        Test that the endpoint returns a 200 successfully retrieves clinic
+         details when a valid clinic_code is contains a clinic name.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "123456 Test Clinic"})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["code"], self.clinic.value)
+        self.assertEqual(response.data["name"], self.clinic.name)
+
+    def test_clinic_code_with_a_dash(self):
+        """
+        Test that the endpoint returns a 200 successfully retrieves clinic
+         details when a valid clinic_code is contains a dash.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "123-456"})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["code"], self.clinic.value)
+        self.assertEqual(response.data["name"], self.clinic.name)
+
+    def test_clinic_code_with_invalid_code(self):
+        """
+        Test that the endpoint returns a 400 Bad Request response
+        when the clinic code parameter is invalid.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "123 clinic"})
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertEqual(response.data, {"error": "invalid"})
+
+    def test_clinic_code_not_found(self):
+        """
+        Test that the endpoint returns a 404 Not Found response
+        when the clinic code provided does not exist.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "246 810"})
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertEqual(response.data, {"error": "clinic not found"})

momconnect/utils.py

@@ -1,7 +1,10 @@
+import re
+
+
 def clean_clinic_code(clinic_code):
-    return str(clinic_code).replace(" ", "")
+    # Remove non digit and return only digits from clinic code
+    return re.sub("[^0-9]", "", clinic_code)
 
 
 def validate_clinic_code(clinic_code):
-    clinic_code = clean_clinic_code(clinic_code)
     return clinic_code.isdigit() and len(clinic_code) == 6

momconnect/views.py

@@ -2,7 +2,7 @@
 from rest_framework.response import Response
 
 from .models import Clinic
-from .utils import validate_clinic_code
+from .utils import clean_clinic_code, validate_clinic_code
 
 
 class ClinicDetailsView(generics.RetrieveAPIView):
@@ -14,6 +14,8 @@ def get(self, request):
                 {"error": "missing clinic code"}, status.HTTP_400_BAD_REQUEST
             )
 
+        clinic_code = clean_clinic_code(clinic_code)
+
         if not validate_clinic_code(clinic_code):
             return Response({"error": "invalid"}, status.HTTP_400_BAD_REQUEST)