[feature/PI-565-questionnaire_rethink] refactor read questionnaire api

Author: jaklinger

src/api/readQuestionnaire/src/v1/steps.py

@@ -1,6 +1,6 @@
 from aws_lambda_powertools.utilities.data_classes import APIGatewayProxyEvent
-from domain.core.questionnaire.v2 import Questionnaire
-from domain.repository.questionnaire_repository import QuestionnaireRepository
+from domain.core.questionnaire.v3 import Questionnaire
+from domain.repository.questionnaire_repository.v2 import QuestionnaireRepository
 from domain.request_models.v1 import QuestionnairePathParams
 from domain.response.validation_errors import mark_validation_errors_as_inbound
 from event.step_chain import StepChain

src/api/readQuestionnaire/tests/test_index.py

@@ -15,18 +15,18 @@ def test_index():
     response = handler(
         event={
             "headers": {"version": "1"},
-            "pathParameters": {"questionnaire_id": "spine_endpoint"},
+            "pathParameters": {"questionnaire_id": "spine_mhs"},
         }
     )
     assert response["statusCode"] == 200
 
     response_body: dict = json_loads(response["body"])
-    questions: dict = response_body.pop("questions")
+    json_schema: dict = response_body.pop("json_schema")
     assert response_body == {
-        "name": "spine_endpoint",
+        "name": "spine_mhs",
         "version": "1",
     }
-    assert len(questions) == 32
+    assert len(json_schema["properties"]) == 25
 
 
 def test_index_no_such_questionnaire():

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

@@ -10,14 +10,14 @@ Feature: Read Questionnaire - success scenarios
   Scenario Outline: Read an existing Questionnaire
     When I make a "GET" request with "default" headers to "Questionnaire/<questionnaire_name>"
     Then I receive a status code "200" with body
-      | path      | value                |
-      | name      | <questionnaire_name> |
-      | version   | 1                    |
-      | questions | << ignore >>         |
+      | path        | value                |
+      | name        | <questionnaire_name> |
+      | version     | 1                    |
+      | json_schema | << ignore >>         |
 
     Examples:
       | questionnaire_name |
-      | spine_endpoint     |
-      | spine_device       |
-      | spine_ENDpoint     |
-      | SPINE_DEVICE       |
+      | spine_as           |
+      | spine_mhs          |
+      | spine_MHS          |
+      | SPINE_AS           |

src/layers/domain/core/questionnaire/v3.py

@@ -2,6 +2,7 @@
 from uuid import UUID, uuid4
 
 import jsonschema
+from domain.core.aggregate_root import AggregateRoot
 from domain.core.base import BaseModel
 from domain.core.timestamp import now
 from pydantic import Field, Json, validator
@@ -15,7 +16,7 @@ class QuestionnaireResponseValidationError(Exception): ...
 class QuestionnaireResponseMissingValue(Exception): ...
 
 
-class Questionnaire(BaseModel):
+class Questionnaire(AggregateRoot):
     name: str
     version: str
     json_schema: Json

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

@@ -28,7 +28,7 @@ def read_schema(path: Path) -> str:
 class QuestionnaireRepository:
 
     def read(self, name: str) -> Questionnaire:
-        path = get_latest_schema_path_by_name(name=name)
+        path = get_latest_schema_path_by_name(name=name.lower())
         if not path:
             raise ItemNotFound(name, item_type=Questionnaire)
         version = version_from_file_path(path)