Add dedupe ok incoming keys

Author: jameslinnell

src/api/createProductTeam/tests/v1/test_index_v1.py

@@ -7,7 +7,10 @@
 
 from test_helpers.dynamodb import mock_table
 from test_helpers.response_assertions import _response_assertions
-from test_helpers.sample_data import CPM_PRODUCT_TEAM_NO_ID
+from test_helpers.sample_data import (
+    CPM_PRODUCT_TEAM_NO_ID,
+    CPM_PRODUCT_TEAM_NO_ID_DUPED_KEYS,
+)
 
 TABLE_NAME = "hiya"
 
@@ -110,3 +113,54 @@ def test_index_bad_payload(version):
     _response_assertions(
         result=result, expected=expected, check_body=True, check_content_length=True
     )
+
+
+@pytest.mark.parametrize(
+    "version",
+    [
+        "1",
+    ],
+)
+def test_index(version):
+    with mock_table(table_name=TABLE_NAME), mock.patch.dict(
+        os.environ,
+        {
+            "DYNAMODB_TABLE": TABLE_NAME,
+            "AWS_DEFAULT_REGION": "eu-west-2",
+        },
+        clear=True,
+    ):
+        from api.createProductTeam.index import handler
+
+        result = handler(
+            event={
+                "headers": {"version": version},
+                "body": json.dumps(CPM_PRODUCT_TEAM_NO_ID_DUPED_KEYS),
+            }
+        )
+    result_body = json_loads(result["body"])
+    expected_body = json.dumps(
+        {
+            "id": result_body["id"],
+            "name": "FOOBAR Product Team",
+            "ods_code": "F5H1R",
+            "status": "active",
+            "created_on": result_body["created_on"],
+            "updated_on": None,
+            "deleted_on": None,
+            "keys": [{"key_type": "product_team_id_alias", "key_value": "BAR"}],
+        }
+    )
+    expected = {
+        "statusCode": 201,
+        "body": expected_body,
+        "headers": {
+            "Content-Length": str(len(expected_body)),
+            "Content-Type": "application/json",
+            "Version": version,
+            "Location": None,
+        },
+    }
+    _response_assertions(
+        result=result, expected=expected, check_body=True, check_content_length=True
+    )

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

@@ -40,6 +40,43 @@ Feature: Create Product Team - success scenarios
       | partOf.identifier.system | https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations |
       | partOf.identifier.value  | F5H1R                                                          |
 
+  Scenario: Successfully create a ProductTeam with duplicated keys
+    When I make a "POST" request with "default" headers to "ProductTeam" with body:
+      | path             | value                 |
+      | name             | My Great Product Team |
+      | ods_code         | F5H1R                 |
+      | keys.0.key_type  | product_team_id_alias |
+      | keys.0.key_value | FOOBAR                |
+      | keys.1.key_type  | product_team_id_alias |
+      | keys.1.key_value | FOOBAR                |
+      | keys.2.key_type  | product_team_id_alias |
+      | keys.2.key_value | FOOBAR                |
+    Then I receive a status code "201" with body where "keys" has a length of "1"
+      | path             | key_value             |
+      | id               | << ignore >>          |
+      | name             | My Great Product Team |
+      | ods_code         | F5H1R                 |
+      | status           | active                |
+      | created_on       | << ignore >>          |
+      | updated_on       | << ignore >>          |
+      | deleted_on       | << ignore >>          |
+      | keys.0.key_type  | product_team_id_alias |
+      | keys.0.key_value | FOOBAR                |
+    And the response headers contain:
+      | name           | value            |
+      | Content-Type   | application/json |
+      | Content-Length | 288              |
+    Given I note the response field "$.id" as "product_team_id"
+    When I make a "GET" request with "default" headers to "ProductTeam/${ note(product_team_id) }"
+    Then I receive a status code "200" with body
+      | path                     | value                                                          |
+      | resourceType             | Organization                                                   |
+      | identifier.0.system      | connecting-party-manager/product-team-id                       |
+      | identifier.0.value       | ${ note(product_team_id) }                                     |
+      | name                     | My Great Product Team                                          |
+      | partOf.identifier.system | https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations |
+      | partOf.identifier.value  | F5H1R                                                          |
+
   Scenario: Successfully create a ProductTeam and view by alias
     When I make a "POST" request with "default" headers to "ProductTeam" with body:
       | path             | value                 |

src/api/tests/feature_tests/steps/steps.py

@@ -191,6 +191,35 @@ def then_response(context: Context, status_code: str):
     )
 
 
+@then(
+    'I receive a status code "{status_code}" with body where "{list_to_check}" has a length of "{count}"'
+)
+def then_response(context: Context, status_code: str, list_to_check: str, count: str):
+    expected_body = parse_table(table=context.table, context=context)
+    try:
+        response_body = context.response.json()
+    except JSONDecodeError:
+        response_body = context.response.text
+    assert len(response_body[list_to_check]) == int(count)
+    assert_many(
+        assertions=(
+            assert_equal,
+            assert_same_type,
+            assert_equal,
+        ),
+        expected=(
+            int(status_code),
+            expected_body,
+            expected_body,
+        ),
+        received=(
+            context.response.status_code,
+            response_body,
+            response_body,
+        ),
+    )
+
+
 @then(
     'I receive a status code "{status_code}" with a "{entity_type}" search body reponse that contains'
 )

src/layers/domain/request_models/tests/data/cpm-product-team-example-no-id-duped-keys.json

@@ -0,0 +1,22 @@
+{
+  "keys": [
+    {
+      "key_type": "product_team_id_alias",
+      "key_value": "BAR"
+    },
+    {
+      "key_type": "product_team_id_alias",
+      "key_value": "BAR"
+    },
+    {
+      "key_type": "product_team_id_alias",
+      "key_value": "BAR"
+    },
+    {
+      "key_type": "product_team_id_alias",
+      "key_value": "BAR"
+    }
+  ],
+  "ods_code": "F5H1R",
+  "name": "FOOBAR Product Team"
+}

src/layers/domain/request_models/tests/data/cpm-product-team-example-no-id-keys-not-allowed.json

@@ -0,0 +1,14 @@
+{
+  "keys": [
+    {
+      "key_type": "product_team_id_alias",
+      "key_value": "BAR"
+    },
+    {
+      "key_type": "product_team_alias",
+      "key_value": "FOO"
+    }
+  ],
+  "ods_code": "F5H1R",
+  "name": "FOOBAR Product Team"
+}

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

@@ -6,6 +6,8 @@
     CPM_PRODUCT_TEAM_EXTRA_PARAMS,
     CPM_PRODUCT_TEAM_ID,
     CPM_PRODUCT_TEAM_NO_ID,
+    CPM_PRODUCT_TEAM_NO_ID_DUPED_KEYS,
+    CPM_PRODUCT_TEAM_NO_ID_KEYS_NOT_ALLOWED,
 )
 
 
@@ -29,3 +31,19 @@ def test_validate_product_team_raises_no_extra_fields():
         CreateProductTeamIncomingParams(**CPM_PRODUCT_TEAM_EXTRA_PARAMS)
 
     assert exc.value.model is CreateProductTeamIncomingParams
+
+
+def test_validate_product_team_raises_no_extra_keys():
+    with pytest.raises(ValidationError) as exc:
+        CreateProductTeamIncomingParams(**CPM_PRODUCT_TEAM_NO_ID_KEYS_NOT_ALLOWED)
+
+    assert exc.value.model is CreateProductTeamIncomingParams
+
+
+def test_product_team_duped_keys():
+    product_team = CreateProductTeamIncomingParams(**CPM_PRODUCT_TEAM_NO_ID_DUPED_KEYS)
+    assert isinstance(product_team, CreateProductTeamIncomingParams)
+    assert len(product_team.keys) == 1
+    assert product_team.keys[0] == CPM_PRODUCT_TEAM_NO_ID["keys"][0]
+    assert product_team.ods_code == CPM_PRODUCT_TEAM_NO_ID["ods_code"]
+    assert product_team.name == CPM_PRODUCT_TEAM_NO_ID["name"]

src/layers/domain/request_models/v1.py

@@ -19,3 +19,10 @@ class CreateProductTeamIncomingParams(BaseModel, extra=Extra.forbid):
     ods_code: str = Field(...)
     name: str = Field(...)
     keys: list[ProductTeamKey] = Field(default_factory=list)
+
+    def __init__(self, **data):
+        super().__init__(**data)
+        # Deduplicate the list of keys
+        self.keys = list(
+            {frozenset(key.dict().items()): key for key in self.keys}.values()
+        )

src/test_helpers/sample_data.py

@@ -28,6 +28,12 @@ def _read_core_test_data(file_name: str) -> dict | list:
 CPM_PRODUCT_TEAM_NO_ID = _read_core_test_data(
     f"{PATH_TO_CORE_CPM_TEST_DATA}/cpm-product-team-example-no-id.json"
 )
+CPM_PRODUCT_TEAM_NO_ID_KEYS_NOT_ALLOWED = _read_core_test_data(
+    f"{PATH_TO_CORE_CPM_TEST_DATA}/cpm-product-team-example-no-id-keys-not-allowed.json"
+)
+CPM_PRODUCT_TEAM_NO_ID_DUPED_KEYS = _read_core_test_data(
+    f"{PATH_TO_CORE_CPM_TEST_DATA}/cpm-product-team-example-no-id-duped-keys.json"
+)
 CPM_PRODUCT_TEAM_EXTRA_PARAMS = _read_core_test_data(
     f"{PATH_TO_CORE_CPM_TEST_DATA}/cpm-product-team-example-extra.json"
 )