[release/2024-10-22] fix-forward: add character reqs to read

Author: jaklinger

src/api/tests/feature_tests/features/readQuestionnaire.failure.feature

@@ -7,9 +7,27 @@ Feature: Read Questionnaire - failure scenarios
       | version       | 1       |
       | Authorization | letmein |
 
-  Scenario: Read an existing Questionnaire
-    When I make a "GET" request with "default" headers to "Questionnaire/does-not-exist"
+  Scenario Outline: Read an non-existing Questionnaire, do not fail early due to bad characters
+    When I make a "GET" request with "default" headers to "Questionnaire/<questionnaire_name>"
     Then I receive a status code "404" with body
-      | path             | value                                                   |
-      | errors.0.code    | RESOURCE_NOT_FOUND                                      |
-      | errors.0.message | Could not find Questionnaire for key ('does-not-exist') |
+      | path             | value                                                         |
+      | errors.0.code    | RESOURCE_NOT_FOUND                                            |
+      | errors.0.message | Could not find Questionnaire for key ('<questionnaire_name>') |
+
+    Examples:
+      | questionnaire_name         |
+      | has spaces in it           |
+      | has_underscores_and spaces |
+      | isMixedCase                |
+
+  Scenario Outline: Read an non-existing Questionnaire, but fail early due to bad characters
+    When I make a "GET" request with "default" headers to "Questionnaire/<questionnaire_name>"
+    Then I receive a status code "400" with body
+      | path             | value                                                                                                |
+      | errors.0.code    | VALIDATION_ERROR                                                                                     |
+      | errors.0.message | QuestionnairePathParams.questionnaire_id: string does not match regex "^[a-zA-Z0-9 _]*${ dollar() }" |
+
+    Examples:
+      | questionnaire_name   |
+      | has-hyphen-in-it     |
+      | has+other characters |

src/api/tests/feature_tests/features/readQuestionnaire.success.feature

@@ -19,3 +19,5 @@ Feature: Read Questionnaire - success scenarios
       | questionnaire_name |
       | spine_endpoint     |
       | spine_device       |
+      | spine_ENDpoint     |
+      | SPINE_DEVICE       |

src/layers/domain/repository/questionnaire_repository/__init__.py

@@ -41,7 +41,7 @@ def read_questions(path: Path):
 class QuestionnaireRepository:
 
     def read(self, name: str) -> Questionnaire:
-        path = get_latest_questions_by_name(name=name)
+        path = get_latest_questions_by_name(name=name.lower())
         if not path:
             raise ItemNotFound(name, item_type=Questionnaire)
 

src/layers/domain/request_models/tests/test_parse_questionnaire_params.py

@@ -0,0 +1,21 @@
+import pytest
+from domain.request_models.v1 import QuestionnairePathParams
+from pydantic import ValidationError
+
+
+@pytest.mark.parametrize(
+    "id",
+    ["abc123", "abc 123", " 123 ABC ", " 123_ABC "],
+)
+def test_read_questionnaire_path_params_pass(id: str):
+    params = QuestionnairePathParams(questionnaire_id=id)
+    assert params.dict() == {"questionnaire_id": id}
+
+
+@pytest.mark.parametrize(
+    "id",
+    ["#abc123", "abc-123", "~123_ABC "],
+)
+def test_read_questionnaire_path_params_fail(id: str):
+    with pytest.raises(ValidationError):
+        QuestionnairePathParams(questionnaire_id=id)

src/layers/domain/request_models/v1.py

@@ -1,6 +1,8 @@
 from domain.core.product_team_key import ProductTeamKey
 from pydantic import BaseModel, Extra, Field
 
+ALPHANUMERIC_SPACES_AND_UNDERSCORES = r"^[a-zA-Z0-9 _]*$"
+
 
 class ProductTeamPathParams(BaseModel, extra=Extra.forbid):
     product_team_id: str = Field(...)
@@ -39,4 +41,6 @@ class DeviceReferenceDataPathParams(BaseModel, extra=Extra.forbid):
 
 
 class QuestionnairePathParams(BaseModel, extra=Extra.forbid):
-    questionnaire_id: str  # NB: this maps onto the domain field Questionnaire.name
+
+    # NB: questionnaire_id maps onto the domain field Questionnaire.name
+    questionnaire_id: str = Field(regex=ALPHANUMERIC_SPACES_AND_UNDERSCORES)