robot-dynamodb 0.1.0__py3-none-any.whl

robot_dynamodb/__init__.py

@@ -0,0 +1,3 @@
+from robot_dynamodb.library import DynamoDbLibrary
+
+__all__ = ["DynamoDbLibrary"]

robot_dynamodb/library.py

@@ -0,0 +1,161 @@
+from typing import Any, Protocol, cast
+
+import boto3
+from robot.api.deco import keyword, library
+
+
+class DynamoDBTable(Protocol):
+    key_schema: list[dict[str, str]]
+
+    def put_item(self, Item: dict[str, Any], **kwargs: Any) -> dict[str, Any]: ...
+    def get_item(self, Key: dict[str, Any], **kwargs: Any) -> dict[str, Any]: ...
+    def update_item(self, Key: dict[str, Any], **kwargs: Any) -> dict[str, Any]: ...
+    def delete_item(self, Key: dict[str, Any], **kwargs: Any) -> dict[str, Any]: ...
+    def scan(self, **kwargs: Any) -> dict[str, Any]: ...
+    def query(self, **kwargs: Any) -> dict[str, Any]: ...
+    def batch_writer(self) -> Any: ...
+
+
+class DynamoDBResource(Protocol):
+    def Table(self, name: str) -> DynamoDBTable: ...
+
+
+@library(scope="SUITE")
+class DynamoDbLibrary:
+    _resource: DynamoDBResource | None
+    _table_prefix: str
+    _table_postfix: str
+
+    def __init__(self) -> None:
+        self._resource = None
+        self._table_prefix = ""
+        self._table_postfix = ""
+
+    def _get_resource(self) -> DynamoDBResource:
+        if self._resource is None:
+            raise RuntimeError("Not connected. Call 'Connect To DynamoDB' first.")
+        return self._resource
+
+    def _table(self, table_name: str) -> DynamoDBTable:
+        return self._get_resource().Table(
+            f"{self._table_prefix}{table_name}{self._table_postfix}"
+        )
+
+    @keyword
+    def connect_to_dynamodb(
+        self,
+        endpoint_url: str,
+        region: str = "us-east-1",
+        table_prefix: str = "",
+        table_postfix: str = "",
+        aws_access_key_id: str = "test",
+        aws_secret_access_key: str = "test",
+    ) -> None:
+        self._table_prefix = table_prefix
+        self._table_postfix = table_postfix
+        self._resource = cast(
+            DynamoDBResource,
+            boto3.resource(
+                "dynamodb",
+                endpoint_url=endpoint_url,
+                region_name=region,
+                aws_access_key_id=aws_access_key_id,
+                aws_secret_access_key=aws_secret_access_key,
+            ),
+        )
+
+    @keyword
+    def disconnect_from_dynamodb(self) -> None:
+        self._resource = None
+        self._table_prefix = ""
+        self._table_postfix = ""
+
+    @keyword
+    def create_dynamodb_item(self, table_name: str, item: dict[str, Any]) -> dict[str, Any]:
+        self._table(table_name).put_item(Item=item)
+        return item
+
+    @keyword
+    def get_dynamodb_item(self, table_name: str, key: dict[str, Any]) -> dict[str, Any] | None:
+        return self._table(table_name).get_item(Key=key).get("Item")
+
+    @keyword
+    def update_dynamodb_item(
+        self,
+        table_name: str,
+        key: dict[str, Any],
+        update_expression: str,
+        expression_attribute_values: dict[str, Any],
+        expression_attribute_names: dict[str, str] | None = None,
+    ) -> dict[str, Any]:
+        kwargs: dict[str, Any] = {
+            "Key": key,
+            "UpdateExpression": update_expression,
+            "ExpressionAttributeValues": expression_attribute_values,
+        }
+        if expression_attribute_names:
+            kwargs["ExpressionAttributeNames"] = expression_attribute_names
+        return self._table(table_name).update_item(**kwargs)
+
+    @keyword
+    def delete_dynamodb_item(self, table_name: str, key: dict[str, Any]) -> None:
+        self._table(table_name).delete_item(Key=key)
+
+    @keyword
+    def scan_dynamodb_table(self, table_name: str) -> list[dict[str, Any]]:
+        return self._table(table_name).scan().get("Items", [])
+
+    @keyword
+    def query_dynamodb_table(
+        self,
+        table_name: str,
+        key_condition_expression: str,
+        expression_attribute_values: dict[str, Any],
+        expression_attribute_names: dict[str, str] | None = None,
+    ) -> list[dict[str, Any]]:
+        kwargs: dict[str, Any] = {
+            "KeyConditionExpression": key_condition_expression,
+            "ExpressionAttributeValues": expression_attribute_values,
+        }
+        if expression_attribute_names:
+            kwargs["ExpressionAttributeNames"] = expression_attribute_names
+        return self._table(table_name).query(**kwargs).get("Items", [])
+
+    @keyword
+    def truncate_dynamodb_table(self, table_name: str) -> None:
+        table = self._table(table_name)
+        key_names = {k["AttributeName"] for k in table.key_schema}
+        items = table.scan().get("Items", [])
+        with table.batch_writer() as batch:
+            for item in items:
+                batch.delete_item(Key={k: v for k, v in item.items() if k in key_names})
+
+    @keyword
+    def batch_write_dynamodb_items(
+        self, table_name: str, items: list[dict[str, Any]]
+    ) -> None:
+        table = self._table(table_name)
+        with table.batch_writer() as batch:
+            for item in items:
+                batch.put_item(Item=item)
+
+    @keyword
+    def item_should_exist_in_dynamodb(
+        self, table_name: str, key: dict[str, Any]
+    ) -> dict[str, Any]:
+        item = self.get_dynamodb_item(table_name, key)
+        if item is None:
+            full = f"{self._table_prefix}{table_name}{self._table_postfix}"
+            raise AssertionError(f"Item {key} not found in table '{full}'")
+        return item
+
+    @keyword
+    def item_should_not_exist_in_dynamodb(
+        self, table_name: str, key: dict[str, Any]
+    ) -> None:
+        item = self.get_dynamodb_item(table_name, key)
+        if item is not None:
+            full = f"{self._table_prefix}{table_name}{self._table_postfix}"
+            raise AssertionError(
+                f"Item {key} found in table '{full}' but should not exist"
+            )

robot_dynamodb-0.1.0.dist-info/METADATA

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: robot-dynamodb
+Version: 0.1.0
+Summary: Robot Framework library for DynamoDB (LocalStack and AWS)
+Author-email: Leandro Santiago Gomes <leandroluk@gmail.com>
+License: MIT
+Requires-Python: >=3.14
+Requires-Dist: boto3>=1.34.0
+Requires-Dist: robotframework>=7.0.0
+Description-Content-Type: text/markdown
+
+# robot-dynamodb
+
+Robot Framework library for DynamoDB. Works with LocalStack and AWS.
+
+## Installation
+
+```bash
+pip install robot-dynamodb
+```
+
+## Usage
+
+```robot
+*** Settings ***
+Library    robot_dynamodb.DynamoDbLibrary
+
+Suite Setup       Connect To DynamoDB
+...    endpoint_url=http://localhost:4566
+...    region=sa-east-1
+...    table_prefix=dev_
+...    table_postfix=_v1
+Suite Teardown    Disconnect From DynamoDB
+
+Test Setup        Truncate DynamoDB Table    orders
+Test Teardown     Truncate DynamoDB Table    orders
+
+*** Test Cases ***
+Pedido deve ser persistido
+    Batch Write DynamoDB Items    orders    ${seed_items}
+    Item Should Exist In DynamoDB    orders    {"id": "123"}
+```
+
+## Keywords
+
+| Keyword | Descrição |
+|---|---|
+| `Connect To DynamoDB` | Cria conexão boto3 |
+| `Disconnect From DynamoDB` | Limpa estado |
+| `Create DynamoDB Item` | Insere item (`put_item`) |
+| `Get DynamoDB Item` | Busca por chave |
+| `Update DynamoDB Item` | Atualiza atributos |
+| `Delete DynamoDB Item` | Remove por chave |
+| `Scan DynamoDB Table` | Lista todos os items |
+| `Query DynamoDB Table` | Busca por partition key |
+| `Truncate DynamoDB Table` | Deleta todos os items |
+| `Batch Write DynamoDB Items` | Insere lista de items |
+| `Item Should Exist In DynamoDB` | Falha se item não encontrado |
+| `Item Should Not Exist In DynamoDB` | Falha se item encontrado |
+
+## Connect To DynamoDB Parameters
+
+| Parâmetro | Default | Descrição |
+|---|---|---|
+| `endpoint_url` | — | URL do DynamoDB / LocalStack |
+| `region` | `us-east-1` | AWS region |
+| `table_prefix` | `""` | Prefixo do nome da tabela |
+| `table_postfix` | `""` | Sufixo do nome da tabela |
+| `aws_access_key_id` | `test` | AWS / LocalStack key |
+| `aws_secret_access_key` | `test` | AWS / LocalStack secret |

robot_dynamodb-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+robot_dynamodb/__init__.py,sha256=1NJx7N8CdshADcgyp6mWM5WjoWp0-Nh18fxv6sqN9R4,82
+robot_dynamodb/library.py,sha256=09KJfud2eTpV6frV3LVQCgz9WtfMqWxrTaJq0wKD_tE,5664
+robot_dynamodb/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+robot_dynamodb-0.1.0.dist-info/METADATA,sha256=h-7hIpc51GdM2Eutso0RuxrPfALQj4DxBFwje9P_OXk,2119
+robot_dynamodb-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+robot_dynamodb-0.1.0.dist-info/RECORD,,

robot_dynamodb-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any