DynamoDB: Item exists with specific values assertion

src/assertions/index.ts

@@ -6,6 +6,7 @@ import toHaveEventWithSource from "./toHaveEventWithSource";
 import toHaveObjectWithNameEqualTo from "./toHaveObjectWithNameEqualTo";
 import toExistInDynamoTable from "./toExistInDynamoTable";
 import toHaveCompletedExecutionWithStatus from "./toHaveCompletedExecutionWithStatus";
+import toContainItemWithValues from "./toContainItemWithValues";
 import toMatchStateMachineOutput from "./toMatchStateMachineOutput";
 
 export default {
@@ -17,5 +18,6 @@ export default {
   ...toHaveObjectWithNameEqualTo,
   ...toExistInDynamoTable,
   ...toHaveCompletedExecutionWithStatus,
+  ...toContainItemWithValues,
   ...toMatchStateMachineOutput,
 };

src/assertions/toContainItemWithValues/index.ts

@@ -0,0 +1,40 @@
+import { testResult, TestResultOutput } from "utils/testResult";
+import { AWSClient } from "helpers/general";
+
+export default {
+  async toContainItemWithValues(
+    tableName: string,
+    values: { [key: string]: unknown }
+  ): Promise<TestResultOutput> {
+    const docClient = new AWSClient.DynamoDB.DocumentClient({
+      region: "us-east-1",
+    });
+    let keys;
+    if (values["SK"] !== undefined) {
+      keys = { pk: values["PK"], sk: values["SK"] };
+    } else {
+      keys = { pk: values["PK"] };
+    }
+    const queryParams = {
+      Key: keys,
+      TableName: tableName,
+    };
+    try {
+      const result = await docClient.get(queryParams).promise();
+      Object.entries(values).forEach(([key, val]) => {
+        if (result.Item?.[key] !== val) {
+          return testResult(
+            `Item was expected to have ${key} value of ${val}, but instead had ${key} value of ${result.Item?.[key]}`,
+            false
+          );
+        }
+      });
+
+      return testResult("Item exists with expected values", true);
+    } catch (e: any) {
+      console.log(e);
+
+      return testResult("Item with specified keys does not exist.", false);
+    }
+  },
+};