sync

Author: Lucas McDonald

DynamoDbEncryption/runtimes/python/test/requests.py

@@ -260,6 +260,17 @@ def base_exhaustive_scan_request(item):
     }
 
 
+# No exhaustive requests for:
+# - transact_write_items
+# - transact_get_items
+# - batch_write_item
+# - batch_get_item
+# - batch_execute_statement
+# - execute_statement
+# - execute_transaction
+# The base requests sufficiently test the conversion of the request between client and resource formats
+# for items.
+
 # DDB format request functions
 
 

DynamoDbEncryption/runtimes/python/test/responses.py

@@ -154,16 +154,109 @@ def basic_transact_write_items_response(items):
     }
 
 
+# No exhaustive response for transact_write_items;
+# The basic_transact_write_items_response is sufficient
+
+
 def basic_transact_get_items_response(items):
     """Get a transact_get_items response in resource (ddb) format for any items."""
     return {"Responses": [{"Item": item} for item in items]}
 
 
+# No exhaustive response for transact_get_items;
+# The basic_transact_get_items_response is sufficient
+
+
 def basic_update_item_response(item):
     """Get an update_item response in resource (ddb) format for any item."""
     return {"Attributes": item}
 
 
+def exhaustive_update_item_response(item):
+    """
+    Get an update_item response in resource (ddb) format for any item.
+    This is not intended to be a real response that DynamoDB would return,
+    but the response should contain additional attributes that DynamoDB could return.
+    This is only intended to exhaustively test the conversion of the request between client and resource formats.
+    """
+    base = basic_update_item_response(item)
+    additional_keys = {
+        "ItemCollectionMetrics": {
+            "ItemCollectionKey": {"partition_key": item["partition_key"]},
+        },
+    }
+    return {**base, **additional_keys}
+
+
 def basic_delete_item_response(item):
     """Get a delete_item response in resource (ddb) format for any item."""
     return {"Attributes": item}
+
+
+def exhaustive_delete_item_response(item):
+    """
+    Get a delete_item response in resource (ddb) format for any item.
+    This is not intended to be a real response that DynamoDB would return,
+    but the response should contain additional attributes that DynamoDB could return.
+    This is only intended to exhaustively test the conversion of the request between client and resource formats.
+    """
+    base = basic_delete_item_response(item)
+    additional_keys = {
+        "ItemCollectionMetrics": {
+            "ItemCollectionKey": {"partition_key": item["partition_key"]},
+        },
+    }
+    return {**base, **additional_keys}
+
+
+def basic_execute_statement_response(items):
+    """Get an execute_statement response in resource (ddb) format for any items."""
+    return {"Items": items}
+
+
+def exhaustive_execute_statement_response(items):
+    """
+    Get an execute_statement response in resource (ddb) format for any items.
+    This is not intended to be a real response that DynamoDB would return,
+    but the response should contain additional attributes that DynamoDB could return.
+    This is only intended to exhaustively test the conversion of the request between client and resource formats.
+    """
+    base = basic_execute_statement_response(items)
+    additional_keys = {
+        "LastEvaluatedKey": {
+            "partition_key": items[-1]["partition_key"],
+            "sort_key": items[-1]["sort_key"],
+        },
+    }
+    return {**base, **additional_keys}
+
+
+def basic_execute_transaction_response(items):
+    """Get an execute_transaction response in resource (ddb) format for any items."""
+    return {"Responses": [{"Item": item} for item in items]}
+
+
+# No exhaustive response for execute_transaction;
+# The basic_execute_transaction_response is sufficient
+
+
+def basic_batch_execute_statement_response(items):
+    """Get a batch_execute_statement response in resource (ddb) format for any items."""
+    return {"Responses": [{"Item": item} for item in items]}
+
+
+def exhaustive_batch_execute_statement_response(items):
+    """
+    Get a batch_execute_statement response in resource (ddb) format for any items.
+    This is not intended to be a real response that DynamoDB would return,
+    but the response should contain additional attributes that DynamoDB could return.
+    This is only intended to exhaustively test the conversion of the request between client and resource formats.
+    """
+    base = basic_batch_execute_statement_response(items)
+    base["Responses"][0]["Error"] = {
+        "Item": {
+            "partition_key": items[0]["partition_key"],
+            "sort_key": items[0]["sort_key"],
+        }
+    }
+    return base

DynamoDbEncryption/runtimes/python/test/unit/internal/README.md

@@ -0,0 +1,39 @@
+The `test_client_to_resource.py` and `test_resource_to_client.py` files
+in this directory verify that DBESDK's boto3 resource/client conversion methods
+correctly convert between resource/client shapes for all operations
+supported by DBESDK.
+
+The only shapes that require conversion are
+* `AttributeValue`s (DDB items or keys)
+  * Client format example: `{"S": "some string"}`
+  * Resource format example: `"some string"`
+* ConditionExpressions (`KeyConditionExpression` or `FilterExpression`; only resource-to-client)
+  * Client shape ex.:
+    * KeyConditionExpression: `"attr : :value"`
+    * ExpressionAttributeValues: `{":value" : {"S" : "some value}}`
+  * Resource shape ex.:
+    * KeyConditionExpression: `Attr("attr").eq("some value")`
+    * (Resources also support the client-style string expression)
+
+The conversion logic will recursively traverse inpuyt/output shapes to find shapes that require conversion, then convert them.
+(ex. for boto3 Table [put_item](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/dynamodb/table/put_item.html)),
+the following kwargs MUST be converted from resource to client format:
+* `["Item"]`
+* `["Expected"][<table_name>]["Value"]`
+* `["Expected"][<table_name>]["AttributeValueList"]`
+* `["ConditionExpression"]`
+* `["ExpressionAttributeValues"]`
+
+The requests, responses, and items in the parent directory are shared between the integ tests and these unit tests.
+The integ tests send the exact request that whose client/resource conversion is tested in the unit tests,
+and the integ tests receive the exact response whose conversion is tested in the unit tests.
+
+The integration tests verify that the basic forms of these requests and responses are authoritative. The unit tests verify that DBESDK’s conversion logic exactly transforms one shape format into the other.
+
+Note: The conversion logic is generated by Smithy-Dafny Python
+and the shape traversals are derived from the MPL's DynamoDB Smithy model.
+As a result, the correctness of this conversion logic is primarily depends on the correctness of the Smithy codegen logic and the correctness of the DynamoDB Smithy model.
+
+Originally, the conversion logic was hand-written,
+so these tests go beyond smoke testing to provide extra guarantees,
+even though basic smoke testing should suffice now that the logic is machine-generated.

DynamoDbEncryption/runtimes/python/test/unit/internal/test_client_to_resource.py

@@ -55,22 +55,29 @@
     exhaustive_scan_request_dict,
 )
 from ...responses import (
+    basic_batch_execute_statement_response,
     basic_batch_get_item_response,
     basic_batch_write_item_put_response,
     basic_delete_item_response,
+    basic_execute_statement_response,
+    basic_execute_transaction_response,
     basic_get_item_response,
     basic_put_item_response,
     basic_query_response,
     basic_scan_response,
     basic_transact_get_items_response,
     basic_transact_write_items_response,
     basic_update_item_response,
+    exhaustive_batch_execute_statement_response,
     exhaustive_batch_get_item_response,
     exhaustive_batch_write_item_put_response,
+    exhaustive_delete_item_response,
+    exhaustive_execute_statement_response,
     exhaustive_get_item_response,
     exhaustive_put_item_response,
     exhaustive_query_response,
     exhaustive_scan_response,
+    exhaustive_update_item_response,
 )
 
 client_to_resource_converter = ClientShapeToResourceShapeConverter()
@@ -560,15 +567,13 @@ def test_GIVEN_test_transact_get_items_response_WHEN_client_to_resource_THEN_ret
 def test_update_item_request_ddb():
     # Select unsigned attribute without loss of generality;
     # resource/client logic doesn't care about signed attributes
-    # TODO: Add exhaustive request
     return basic_update_item_request_ddb_unsigned_attribute
 
 
 @pytest.fixture
 def test_update_item_request_dict():
     # Select unsigned attribute without loss of generality;
     # resource/client logic doesn't care about signed attributes
-    # TODO: Add exhaustive request
     return basic_update_item_request_dict_unsigned_attribute
 
 
@@ -584,8 +589,9 @@ def test_GIVEN_test_update_item_request_WHEN_client_to_resource_THEN_returns_dic
 
 
 @pytest.fixture
-def test_update_item_response():
-    # TODO: Add exhaustive response
+def test_update_item_response(use_exhaustive_request):
+    if use_exhaustive_request:
+        return exhaustive_update_item_response
     return basic_update_item_response
 
 
@@ -616,14 +622,22 @@ def test_GIVEN_test_execute_statement_request_WHEN_client_to_resource_THEN_retur
     assert dict_item == test_execute_statement_request(test_dict_item)
 
 
-def test_GIVEN_test_execute_statement_response_WHEN_client_to_resource_THEN_raises_NotImplementedError():
+@pytest.fixture
+def test_execute_statement_response(use_exhaustive_request):
+    if use_exhaustive_request:
+        return exhaustive_execute_statement_response
+    return basic_execute_statement_response
+
+
+def test_GIVEN_test_execute_statement_response_WHEN_client_to_resource_THEN_returns_dict_value(
+    test_execute_statement_response, test_ddb_item, test_dict_item
+):
     # Given: Execute statement response
-    # TODO: this
-    ddb_response = {}
+    ddb_response = test_execute_statement_response([test_ddb_item])
     # When: Converting to resource format
     resource_response = client_to_resource_converter.execute_statement_response(ddb_response)
     # Then: Returns dict value
-    assert resource_response == {}
+    assert resource_response == test_execute_statement_response([test_dict_item])
 
 
 @pytest.fixture
@@ -642,18 +656,24 @@ def test_GIVEN_test_execute_transaction_request_WHEN_client_to_resource_THEN_ret
     assert dict_item == test_execute_transaction_request(test_dict_item)
 
 
-def test_GIVEN_test_execute_transaction_response_WHEN_client_to_resource_THEN_returns_dict_value():
+@pytest.fixture
+def test_execute_transaction_response():
+    return basic_execute_transaction_response
+
+
+def test_GIVEN_test_execute_transaction_response_WHEN_client_to_resource_THEN_returns_dict_value(
+    test_execute_transaction_response, test_ddb_item, test_dict_item
+):
     # Given: Execute transaction response
-    # TODO: this
-    ddb_response = {}
+    ddb_response = test_execute_transaction_response([test_ddb_item])
     # When: Converting to resource format
     resource_response = client_to_resource_converter.execute_transaction_response(ddb_response)
     # Then: Returns dict value
-    assert resource_response == {}
+    assert resource_response == test_execute_transaction_response([test_dict_item])
 
 
 @pytest.fixture
-def test_batch_execute_statement_request():
+def test_batch_execute_statement_request(use_exhaustive_request):
     return basic_batch_execute_statement_request_encrypted_table
 
 
@@ -668,14 +688,22 @@ def test_GIVEN_test_batch_execute_statement_request_WHEN_client_to_resource_THEN
     assert dict_item == test_batch_execute_statement_request()
 
 
-def test_GIVEN_test_batch_execute_statement_response_WHEN_client_to_resource_THEN_raises_NotImplementedError():
+@pytest.fixture
+def test_batch_execute_statement_response(use_exhaustive_request):
+    if use_exhaustive_request:
+        return exhaustive_batch_execute_statement_response
+    return basic_batch_execute_statement_response
+
+
+def test_GIVEN_test_batch_execute_statement_response_WHEN_client_to_resource_THEN_returns_dict_value(
+    test_batch_execute_statement_response, test_ddb_item, test_dict_item
+):
     # Given: Batch execute statement response
-    # TODO: this
-    ddb_response = {}
+    ddb_response = test_batch_execute_statement_response([test_ddb_item])
     # When: Converting to resource format
     resource_response = client_to_resource_converter.batch_execute_statement_response(ddb_response)
     # Then: Returns dict value
-    assert resource_response == {}
+    assert resource_response == test_batch_execute_statement_response([test_dict_item])
 
 
 @pytest.fixture
@@ -700,7 +728,9 @@ def test_GIVEN_test_delete_item_request_WHEN_client_to_resource_THEN_returns_dic
 
 
 @pytest.fixture
-def test_delete_item_response():
+def test_delete_item_response(use_exhaustive_request):
+    if use_exhaustive_request:
+        return exhaustive_delete_item_response
     return basic_delete_item_response