feat(Python): DynamoDB Resource/Client shape transforms

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/internal/client_to_resource.py

@@ -0,0 +1,147 @@
+# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from aws_cryptography_internal_dynamodb.smithygenerated.com_amazonaws_dynamodb.boto3_conversions import (
+    InternalBoto3DynamoDBFormatConverter,
+)
+from boto3.dynamodb.types import TypeDeserializer
+
+
+class ClientShapeToResourceShapeConverter:
+
+    def __init__(self, delete_table_name=True):
+        # Some callers expect the TableName kwarg to be removed from the outputs of this class.
+        # (EncryptedResource, EncryptedTable.)
+        # These callers' boto3 shapes do not include TableName.
+        # Other callers expect the TableName kwarg to be included in the outputs of this class.
+        # (EncryptedClient, EncryptedPaginator.)
+        # These callers' boto3 shapes include TableName.
+        self.delete_table_name = delete_table_name
+        self.boto3_converter = InternalBoto3DynamoDBFormatConverter(
+            item_handler=TypeDeserializer().deserialize, condition_handler=self.condition_handler
+        )
+
+    def condition_handler(self, expression_key, request):
+        """Returns the input condition/names/values as-is."""
+        # Conditions do not need to be converted from strings to boto3 Attrs.
+        # Resources accept either strings or Attrs.
+        # Return the provided condition string.
+        condition = request[expression_key]
+
+        # This conversion in client_to_resource does not update ExpressionAttributeNames or ExpressionAttributeValues.
+        # However, resource_to_client condition_handler may add new ExpressionAttributeNames and
+        # ExpressionAttributeValues.
+        # Smithy-generated code expects condition_handlers to return ExpressionAttributeNames and
+        # ExpressionAttributeValues,
+        # expecting empty dicts if there are none.
+        try:
+            names = request["ExpressionAttributeNames"]
+        except KeyError:
+            names = {}
+
+        try:
+            values = request["ExpressionAttributeValues"]
+        except KeyError:
+            values = {}
+        return condition, names, values
+
+    def put_item_request(self, put_item_request):
+        out = self.boto3_converter.PutItemInput(put_item_request)
+        # put_item requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def put_item_response(self, put_item_response):
+        return self.boto3_converter.PutItemOutput(put_item_response)
+
+    def get_item_request(self, get_item_request):
+        out = self.boto3_converter.GetItemInput(get_item_request)
+        # get_item requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def get_item_response(self, get_item_response):
+        return self.boto3_converter.GetItemOutput(get_item_response)
+
+    def query_request(self, query_request):
+        out = self.boto3_converter.QueryInput(query_request)
+        # query requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def query_response(self, query_response):
+        return self.boto3_converter.QueryOutput(query_response)
+
+    def scan_request(self, scan_request):
+        out = self.boto3_converter.ScanInput(scan_request)
+        # scan requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def scan_response(self, scan_response):
+        return self.boto3_converter.ScanOutput(scan_response)
+
+    def delete_item_request(self, delete_item_request):
+        out = self.boto3_converter.DeleteItemInput(delete_item_request)
+        # delete_item requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def delete_item_response(self, delete_item_response):
+        return self.boto3_converter.DeleteItemOutput(delete_item_response)
+
+    def update_item_request(self, update_item_request):
+        out = self.boto3_converter.UpdateItemInput(update_item_request)
+        # update_item requests on resources do not have a table name.
+        if self.delete_table_name:
+            del out["TableName"]
+        return out
+
+    def update_item_response(self, update_item_response):
+        return self.boto3_converter.UpdateItemOutput(update_item_response)
+
+    def transact_get_items_request(self, transact_get_items_request):
+        return self.boto3_converter.TransactGetItemsInput(transact_get_items_request)
+
+    def transact_get_items_response(self, transact_get_items_response):
+        return self.boto3_converter.TransactGetItemsOutput(transact_get_items_response)
+
+    def transact_write_items_request(self, transact_write_items_request):
+        return self.boto3_converter.TransactWriteItemsInput(transact_write_items_request)
+
+    def transact_write_items_response(self, transact_write_items_response):
+        return self.boto3_converter.TransactWriteItemsOutput(transact_write_items_response)
+
+    def batch_get_item_request(self, batch_get_item_request):
+        return self.boto3_converter.BatchGetItemInput(batch_get_item_request)
+
+    def batch_get_item_response(self, batch_get_item_response):
+        return self.boto3_converter.BatchGetItemOutput(batch_get_item_response)
+
+    def batch_write_item_request(self, batch_write_item_request):
+        return self.boto3_converter.BatchWriteItemInput(batch_write_item_request)
+
+    def batch_write_item_response(self, batch_write_item_response):
+        return self.boto3_converter.BatchWriteItemOutput(batch_write_item_response)
+
+    def batch_execute_statement_request(self, batch_execute_statement_request):
+        return self.boto3_converter.BatchExecuteStatementInput(batch_execute_statement_request)
+
+    def batch_execute_statement_response(self, batch_execute_statement_response):
+        return self.boto3_converter.BatchExecuteStatementOutput(batch_execute_statement_response)
+
+    def execute_statement_request(self, execute_statement_request):
+        return self.boto3_converter.ExecuteStatementInput(execute_statement_request)
+
+    def execute_statement_response(self, execute_statement_response):
+        return self.boto3_converter.ExecuteStatementOutput(execute_statement_response)
+
+    def execute_transaction_request(self, execute_transaction_request):
+        return self.boto3_converter.ExecuteTransactionInput(execute_transaction_request)
+
+    def execute_transaction_response(self, execute_transaction_response):
+        return self.boto3_converter.ExecuteTransactionOutput(execute_transaction_response)

DynamoDbEncryption/runtimes/python/src/aws_dbesdk_dynamodb/internal/resource_to_client.py

@@ -0,0 +1,155 @@
+# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from aws_cryptography_internal_dynamodb.smithygenerated.com_amazonaws_dynamodb.boto3_conversions import (
+    InternalBoto3DynamoDBFormatConverter,
+)
+from boto3.dynamodb.conditions import ConditionExpressionBuilder
+from boto3.dynamodb.types import TypeSerializer
+
+
+class ResourceShapeToClientShapeConverter:
+
+    def __init__(self, table_name=None):
+        self.boto3_converter = InternalBoto3DynamoDBFormatConverter(
+            item_handler=TypeSerializer().serialize, condition_handler=self.condition_handler
+        )
+        # TableName is optional;
+        # Some requests require it (ex. put_item, update_item, delete_item),
+        # but others do not (ex. transact_get_items, batch_write_item).
+        self.table_name = table_name
+        self.expression_builder = ConditionExpressionBuilder()
+
+    def condition_handler(self, expression_key, request):
+        """
+        Converts an object from boto3.dynamodb.conditions to a string
+        and updates ExpressionAttributeNames and ExpressionAttributeValues with any new names/values.
+        The ExpressionAttributeValues are returned in resource format (Python dictionaries).
+        """
+        condition_expression = request[expression_key]
+
+        try:
+            existing_expression_attribute_names = request["ExpressionAttributeNames"]
+        except KeyError:
+            existing_expression_attribute_names = {}
+        try:
+            existing_expression_attribute_values = request["ExpressionAttributeValues"]
+        except KeyError:
+            existing_expression_attribute_values = {}
+
+        # Only convert if the condition expression is a boto3.dynamodb.conditions object.
+        # Resources also accept strings.
+        # If condition is not from boto3.dynamodb.conditions, assume the condition is string-like, and return as-is.
+        if (
+            hasattr(condition_expression, "__module__")
+            and condition_expression.__module__ == "boto3.dynamodb.conditions"
+        ):
+            built_condition_expression = self.expression_builder.build_expression(condition_expression)
+            return (
+                built_condition_expression.condition_expression,
+                built_condition_expression.attribute_name_placeholders,
+                built_condition_expression.attribute_value_placeholders,
+            )
+        else:
+            return condition_expression, existing_expression_attribute_names, existing_expression_attribute_values
+
+    def put_item_request(self, put_item_request):
+        # put_item requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use put_item")
+        put_item_request["TableName"] = self.table_name
+        return self.boto3_converter.PutItemInput(put_item_request)
+
+    def get_item_request(self, get_item_request):
+        # get_item requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use get_item")
+        get_item_request["TableName"] = self.table_name
+        return self.boto3_converter.GetItemInput(get_item_request)
+
+    def query_request(self, query_request):
+        # query requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use query")
+        query_request["TableName"] = self.table_name
+        return self.boto3_converter.QueryInput(query_request)
+
+    def scan_request(self, scan_request):
+        # scan requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use scan")
+        scan_request["TableName"] = self.table_name
+        return self.boto3_converter.ScanInput(scan_request)
+
+    def update_item_request(self, update_item_request):
+        # update_item requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use update_item")
+        update_item_request["TableName"] = self.table_name
+        return self.boto3_converter.UpdateItemInput(update_item_request)
+
+    def delete_item_request(self, delete_item_request):
+        # delete_item requests on a boto3.resource.Table require a configured table name.
+        if not self.table_name:
+            raise ValueError("Table name must be provided to ResourceShapeToClientShapeConverter to use delete_item")
+        delete_item_request["TableName"] = self.table_name
+        return self.boto3_converter.DeleteItemInput(delete_item_request)
+
+    def transact_get_items_request(self, transact_get_items_request):
+        return self.boto3_converter.TransactGetItemsInput(transact_get_items_request)
+
+    def transact_get_items_response(self, transact_get_items_response):
+        return self.boto3_converter.TransactGetItemsOutput(transact_get_items_response)
+
+    def transact_write_items_request(self, transact_write_items_request):
+        return self.boto3_converter.TransactWriteItemsInput(transact_write_items_request)
+
+    def transact_write_items_response(self, transact_write_items_response):
+        return self.boto3_converter.TransactWriteItemsOutput(transact_write_items_response)
+
+    def batch_get_item_request(self, batch_get_item_request):
+        return self.boto3_converter.BatchGetItemInput(batch_get_item_request)
+
+    def batch_get_item_response(self, batch_get_item_response):
+        return self.boto3_converter.BatchGetItemOutput(batch_get_item_response)
+
+    def batch_write_item_request(self, batch_write_item_request):
+        return self.boto3_converter.BatchWriteItemInput(batch_write_item_request)
+
+    def batch_write_item_response(self, batch_write_item_response):
+        return self.boto3_converter.BatchWriteItemOutput(batch_write_item_response)
+
+    def batch_execute_statement_request(self, batch_execute_statement_request):
+        return self.boto3_converter.BatchExecuteStatementInput(batch_execute_statement_request)
+
+    def batch_execute_statement_response(self, batch_execute_statement_response):
+        return self.boto3_converter.BatchExecuteStatementOutput(batch_execute_statement_response)
+
+    def execute_statement_request(self, execute_statement_request):
+        return self.boto3_converter.ExecuteStatementInput(execute_statement_request)
+
+    def execute_statement_response(self, execute_statement_response):
+        return self.boto3_converter.ExecuteStatementOutput(execute_statement_response)
+
+    def execute_transaction_request(self, execute_transaction_request):
+        return self.boto3_converter.ExecuteTransactionInput(execute_transaction_request)
+
+    def execute_transaction_response(self, execute_transaction_response):
+        return self.boto3_converter.ExecuteTransactionOutput(execute_transaction_response)
+
+    def scan_response(self, scan_response):
+        return self.boto3_converter.ScanOutput(scan_response)
+
+    def query_response(self, query_response):
+        return self.boto3_converter.QueryOutput(query_response)
+
+    def get_item_response(self, get_item_response):
+        return self.boto3_converter.GetItemOutput(get_item_response)
+
+    def put_item_response(self, put_item_response):
+        return self.boto3_converter.PutItemOutput(put_item_response)
+
+    def update_item_response(self, update_item_response):
+        return self.boto3_converter.UpdateItemOutput(update_item_response)
+
+    def delete_item_response(self, delete_item_response):
+        return self.boto3_converter.DeleteItemOutput(delete_item_response)

DynamoDbEncryption/runtimes/python/test/items.py

@@ -0,0 +1,63 @@
+# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+from decimal import Decimal
+
+simple_item_ddb = {
+    "partition_key": {"S": "test-key"},
+    "sort_key": {"N": "1"},
+    "attribute1": {"S": "encrypted value"},
+    "attribute2": {"S": "signed value"},
+    ":attribute3": {"S": "unsigned value"},
+}
+
+simple_key_ddb = {"partition_key": simple_item_ddb["partition_key"], "sort_key": simple_item_ddb["sort_key"]}
+
+simple_item_dict = {
+    "partition_key": "test-key",
+    "sort_key": 1,
+    "attribute1": "encrypted value",
+    "attribute2": "signed value",
+    ":attribute3": "unsigned value",
+}
+
+simple_key_dict = {"partition_key": simple_item_dict["partition_key"], "sort_key": simple_item_dict["sort_key"]}
+
+complex_item_ddb = {
+    "partition_key": {"S": "all-types-test"},
+    "sort_key": {"N": "1"},
+    "attribute1": {
+        "M": {
+            "string": {"S": "string value"},
+            "number": {"N": "123.45"},
+            "binary": {"B": b"binary data"},
+            "string_set": {"SS": ["value1", "value2"]},
+            "number_set": {"NS": ["1", "2", "3"]},
+            "binary_set": {"BS": [b"binary1", b"binary2"]},
+            "list": {"L": [{"S": "list item 1"}, {"N": "42"}, {"B": b"list binary"}]},
+            "map": {"M": {"nested_string": {"S": "nested value"}, "nested_number": {"N": "42"}}},
+        }
+    },
+    "attribute2": {"S": "signed value"},
+    ":attribute3": {"S": "unsigned value"},
+}
+
+complex_key_ddb = {"partition_key": complex_item_ddb["partition_key"], "sort_key": complex_item_ddb["sort_key"]}
+
+complex_item_dict = {
+    "partition_key": "all-types-test",
+    "sort_key": 1,
+    "attribute1": {
+        "string": "string value",
+        "number": Decimal("123.45"),
+        "binary": b"binary data",
+        "string_set": {"value1", "value2"},
+        "number_set": {Decimal("1"), 2, Decimal("3")},
+        "binary_set": {b"binary1", b"binary2"},
+        "list": ["list item 1", 42, b"list binary"],
+        "map": {"nested_string": "nested value", "nested_number": 42},
+    },
+    "attribute2": "signed value",
+    ":attribute3": "unsigned value",
+}
+
+complex_key_dict = {"partition_key": complex_item_dict["partition_key"], "sort_key": complex_item_dict["sort_key"]}