Assert input to the handler is equal to the output (#531)

* Assert input to the handler is equal to the output

* Check if createOnly property is null/empty and remove it from input and output

Author: anshikg

src/rpdk/core/contract/resource_client.py

@@ -41,6 +41,35 @@ def prune_properties(document, paths):
     return document
 
 
+def prune_properties_if_not_exist_in_path(output_model, input_model, paths):
+    """Prune given properties from a document.
+
+    This assumes properties will always have an object (dict) as a parent.
+    The function returns the document after pruning the path which exists
+    in the paths tuple but not in the input_model
+    """
+    output_document = {"properties": output_model.copy()}
+    input_document = {"properties": input_model.copy()}
+    for path in paths:
+        try:
+            if not path_exists(input_document, path):
+                _prop, resolved_path, parent = traverse(output_document, path)
+                key = resolved_path[-1]
+                del parent[key]
+        except LookupError:
+            pass
+    return output_document["properties"]
+
+
+def path_exists(document, path):
+    try:
+        _prop, _resolved_path, _parent = traverse(document, path)
+    except LookupError:
+        return False
+    else:
+        return True
+
+
 def prune_properties_from_model(model, paths):
     """Prune given properties from a resource model.
 
@@ -299,7 +328,7 @@ def make_request(
         return {
             "desiredResourceState": desired_resource_state,
             "previousResourceState": previous_resource_state,
-            "logicalResourceIdentifier": None,
+            "logicalResourceIdentifier": "test",
             **kwargs,
             "region": region,
             "awsPartition": partition,

src/rpdk/core/contract/suite/handler_commons.py

@@ -1,6 +1,10 @@
 import logging
 
 from rpdk.core.contract.interface import Action, HandlerErrorCode, OperationStatus
+from rpdk.core.contract.resource_client import (
+    prune_properties_from_model,
+    prune_properties_if_not_exist_in_path,
+)
 from rpdk.core.contract.suite.contract_asserts import (
     failed_event,
     response_contains_primary_identifier,
@@ -124,3 +128,18 @@ def test_delete_failure_not_found(resource_client, current_resource_model):
         Action.DELETE, OperationStatus.FAILED, current_resource_model
     )
     return error_code
+
+
+def test_input_equals_output(resource_client, input_model, output_model):
+    input_model = prune_properties_from_model(
+        input_model, resource_client.write_only_paths
+    )
+
+    output_model = prune_properties_from_model(
+        output_model, resource_client.read_only_paths
+    )
+    output_model = prune_properties_if_not_exist_in_path(
+        output_model, input_model, resource_client.create_only_paths
+    )
+
+    assert input_model == output_model

src/rpdk/core/contract/suite/handler_create.py

@@ -15,6 +15,7 @@
     test_create_failure_if_repeat_writeable_id,
     test_create_success,
     test_delete_success,
+    test_input_equals_output,
     test_model_in_list,
     test_read_success,
 )
@@ -24,12 +25,13 @@
 
 @pytest.fixture(scope="module")
 def created_resource(resource_client):
-    request = model = resource_client.generate_create_example()
+    request = input_model = model = resource_client.generate_create_example()
     try:
         _status, response, _error = resource_client.call_and_assert(
             Action.CREATE, OperationStatus.SUCCESS, request
         )
         model = response["resourceModel"]
+        test_input_equals_output(resource_client, input_model, model)
         yield model, request
     finally:
         resource_client.call_and_assert(Action.DELETE, OperationStatus.SUCCESS, model)
@@ -38,11 +40,14 @@ def created_resource(resource_client):
 @pytest.mark.create
 @pytest.mark.delete
 def contract_create_delete(resource_client):
-    requested_model = delete_model = resource_client.generate_create_example()
+    requested_model = (
+        delete_model
+    ) = input_model = resource_client.generate_create_example()
     try:
         response = test_create_success(resource_client, requested_model)
         # check response here
         delete_model = response["resourceModel"]
+        test_input_equals_output(resource_client, input_model, delete_model)
     finally:
         test_delete_success(resource_client, delete_model)
 

src/rpdk/core/contract/suite/handler_delete.py

@@ -11,6 +11,7 @@
 from rpdk.core.contract.suite.handler_commons import (
     test_create_success,
     test_delete_failure_not_found,
+    test_input_equals_output,
     test_model_in_list,
     test_read_failure_not_found,
     test_update_failure_not_found,
@@ -24,12 +25,13 @@
 
 @pytest.fixture(scope="module")
 def deleted_resource(resource_client):
-    request = model = resource_client.generate_create_example()
+    request = input_model = model = resource_client.generate_create_example()
     try:
         _status, response, _error = resource_client.call_and_assert(
             Action.CREATE, OperationStatus.SUCCESS, request
         )
         model = response["resourceModel"]
+        test_input_equals_output(resource_client, input_model, model)
         _status, response, _error = resource_client.call_and_assert(
             Action.DELETE, OperationStatus.SUCCESS, model
         )

src/rpdk/core/contract/suite/handler_update.py

@@ -7,24 +7,31 @@
 # when being loaded by pytest
 from rpdk.core.contract.interface import Action, OperationStatus
 from rpdk.core.contract.suite.handler_commons import (
+    test_input_equals_output,
     test_model_in_list,
     test_read_success,
 )
 
 
 @pytest.fixture(scope="module")
 def updated_resource(resource_client):
-    create_request = model = resource_client.generate_create_example()
+    create_request = input_model = model = resource_client.generate_create_example()
     try:
         _status, response, _error = resource_client.call_and_assert(
             Action.CREATE, OperationStatus.SUCCESS, create_request
         )
         created_model = model = response["resourceModel"]
-        update_request = resource_client.generate_update_example(created_model)
+        test_input_equals_output(resource_client, input_model, created_model)
+
+        updated_input_model = update_request = resource_client.generate_update_example(
+            created_model
+        )
         _status, response, _error = resource_client.call_and_assert(
             Action.UPDATE, OperationStatus.SUCCESS, update_request, created_model
         )
         updated_model = response["resourceModel"]
+        test_input_equals_output(resource_client, updated_input_model, updated_model)
+
         yield create_request, created_model, update_request, updated_model
     finally:
         resource_client.call_and_assert(Action.DELETE, OperationStatus.SUCCESS, model)

tests/contract/test_resource_client.py

@@ -14,6 +14,7 @@
     override_properties,
     prune_properties,
     prune_properties_from_model,
+    prune_properties_if_not_exist_in_path,
 )
 from rpdk.core.test import (
     DEFAULT_ENDPOINT,
@@ -161,6 +162,31 @@ def test_prune_properties_from_model():
     assert document == {"one": "two", "array": ["first"]}
 
 
+def test_prune_properties_if_not_exist_in_path():
+    previous_model = {
+        "spam": "eggs",
+        "one": "two",
+        "array": ["first", "second"],
+    }
+    model = {
+        "foo": "bar",
+        "spam": "eggs",
+        "one": "two",
+        "array": ["first", "second"],
+    }
+    model = prune_properties_if_not_exist_in_path(
+        model,
+        previous_model,
+        [
+            ("properties", "foo"),
+            ("properties", "spam"),
+            ("properties", "array", "1"),
+            ("properties", "invalid"),
+        ],
+    )
+    assert model == previous_model
+
+
 def test_init_sam_cli_client():
     patch_sesh = patch(
         "rpdk.core.contract.resource_client.create_sdk_session", autospec=True
@@ -210,7 +236,7 @@ def test_make_request():
     assert request == {
         "desiredResourceState": desired_resource_state,
         "previousResourceState": previous_resource_state,
-        "logicalResourceIdentifier": None,
+        "logicalResourceIdentifier": "test",
         "clientRequestToken": token,
         "region": "us-west-2",
         "awsPartition": "aws",