[feature/PI-563-read_a_questionnaire] read questionnaire

Author: jaklinger

.vscode/settings.json

@@ -11,6 +11,9 @@
   "cSpell.words": [
     "attrlist",
     "changetype",
+    "deserialise",
+    "deserialiser",
+    "DESERIALISERS",
     "filterstr",
     "firstchangenumber",
     "getbuffer",

infrastructure/swagger/05_paths.yaml

@@ -546,3 +546,29 @@ paths:
       security:
         - ${authoriser_name}: []
         - app-level0: []
+
+  /Questionnaire/{questionnaire_id}:
+    get:
+      operationId: readQuestionnaire
+      summary: readQuestionnaire endpoint for APIGEE integration
+      parameters:
+        - name: questionnaire_id
+          in: path
+          required: true
+          description: logical identifier
+          schema:
+            type: string
+        - *RequestHeaderVersion
+        - *RequestHeaderRequestId
+        - *RequestHeaderCorrelationId
+      responses:
+        "200":
+          $ref: "#/components/responses/Questionnaire"
+        "4XX":
+          <<: *Response4XX
+      x-amazon-apigateway-integration:
+        <<: *ApiGatewayIntegration
+        uri: ${method_readQuestionnaire}
+      security:
+        - ${authoriser_name}: []
+        - app-level0: []

infrastructure/swagger/12_components--responses.yaml

@@ -24,6 +24,17 @@ components:
                 enum: ["OK"]
       headers:
         <<: *ResponseHeaders
+
+    Questionnaire:
+      description: Questionnaire response body
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              tbc:
+                type: string
+
     ProductTeamResponse:
       description: Read Product Team operation successful
       content:
@@ -89,4 +100,3 @@ components:
               updated_on:
                 type: string
               deleted_on:
-                type: string

infrastructure/terraform/per_workspace/main.tf

@@ -104,7 +104,7 @@ module "lambdas" {
   environment_variables = {
     DYNAMODB_TABLE = module.table.dynamodb_table_name
   }
-  attach_policy_statements = true
+  attach_policy_statements = length((fileset("${path.module}/../../../src/api/${each.key}/policies", "*.json"))) > 0
   policy_statements = {
     for file in fileset("${path.module}/../../../src/api/${each.key}/policies", "*.json") : replace(file, ".json", "") => {
       effect    = "Allow"

src/api/readQuestionnaire/index.py

@@ -0,0 +1,16 @@
+from api_utils.api_step_chain import execute_step_chain
+from event.logging.logger import setup_logger
+
+from .src.v1.steps import steps as v1_steps
+
+versioned_steps = {"1": v1_steps}
+cache = {}
+
+
+def handler(event: dict, context=None):
+    setup_logger(service_name=__file__)
+    return execute_step_chain(
+        event=event,
+        cache=cache,
+        versioned_steps=versioned_steps,
+    )

src/api/readQuestionnaire/make/make.py

@@ -0,0 +1,4 @@
+from builder.lambda_build import build
+
+if __name__ == "__main__":
+    build(__file__)

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

@@ -0,0 +1,30 @@
+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.request_models.v1 import QuestionnairePathParams
+from domain.response.validation_errors import mark_validation_errors_as_inbound
+from event.step_chain import StepChain
+
+
+@mark_validation_errors_as_inbound
+def parse_path_params(data, cache) -> QuestionnairePathParams:
+    event = APIGatewayProxyEvent(data[StepChain.INIT])
+    return QuestionnairePathParams(**event.path_parameters)
+
+
+def read_questionnaire(data, cache) -> Questionnaire:
+    path_params: QuestionnairePathParams = data[parse_path_params]
+    repo = QuestionnaireRepository()
+    return repo.read(name=path_params.questionnaire_id)
+
+
+def questionnaire_to_dict(data, cache) -> dict:
+    questionnaire: Questionnaire = data[read_questionnaire]
+    return questionnaire.state()
+
+
+steps = [
+    parse_path_params,
+    read_questionnaire,
+    questionnaire_to_dict,
+]

src/api/readQuestionnaire/tests/test_index.py

@@ -0,0 +1,51 @@
+from event.json import json_loads
+
+TABLE_NAME = "hiya"
+ODS_CODE = "F5H1R"
+PRODUCT_TEAM_ID = "F5H1R.641be376-3954-4339-822c-54071c9ff1a0"
+PRODUCT_TEAM_NAME = "product-team-name"
+PRODUCT_ID = "P.XXX-YYY"
+PRODUCT_NAME = "cpm-product-name"
+PRODUCT_TEAM_KEYS = [{"key_type": "product_team_id_alias", "key_value": "BAR"}]
+
+
+def test_index():
+    from api.readQuestionnaire.index import handler
+
+    response = handler(
+        event={
+            "headers": {"version": "1"},
+            "pathParameters": {"questionnaire_id": "spine_endpoint"},
+        }
+    )
+    assert response["statusCode"] == 200
+
+    response_body: dict = json_loads(response["body"])
+    questions: dict = response_body.pop("questions")
+    assert response_body == {
+        "name": "spine_endpoint",
+        "version": "1",
+    }
+    assert len(questions) == 32
+
+
+def test_index_no_such_questionnaire():
+    from api.readQuestionnaire.index import handler
+
+    response = handler(
+        event={
+            "headers": {"version": "1"},
+            "pathParameters": {"questionnaire_id": "oops"},
+        }
+    )
+    assert response["statusCode"] == 404
+
+    response_body = json_loads(response["body"])
+    assert response_body == {
+        "errors": [
+            {
+                "code": "RESOURCE_NOT_FOUND",
+                "message": "Could not find Questionnaire for key ('oops')",
+            },
+        ],
+    }

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

@@ -0,0 +1,15 @@
+Feature: Read Questionnaire - failure scenarios
+  These scenarios demonstrate failure to read from the GET Questionnaire endpoint
+
+  Background:
+    Given "default" request headers:
+      | name          | value   |
+      | version       | 1       |
+      | Authorization | letmein |
+
+  Scenario: Read an existing Questionnaire
+    When I make a "GET" request with "default" headers to "Questionnaire/does-not-exist"
+    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') |

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

@@ -0,0 +1,21 @@
+Feature: Read Questionnaire - success scenarios
+  These scenarios demonstrate successful reads from the GET Questionnaire endpoint
+
+  Background:
+    Given "default" request headers:
+      | name          | value   |
+      | version       | 1       |
+      | Authorization | letmein |
+
+  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 >>         |
+
+    Examples:
+      | questionnaire_name |
+      | spine_endpoint     |
+      | spine_device       |