Merge branch 'main' of github.com:Theodo-UK/sls-test-tools into main

.release-it.json

@@ -3,7 +3,6 @@
     "release": true
   },
   "hooks": {
-    "before:init": "yarn lint",
     "after:my-plugin:bump": "./bin/my-script.sh",
     "after:bump": "yarn build",
     "after:git:release": "echo After git push, before github release",

README.md

@@ -35,14 +35,18 @@ sls-test-tools is currently being actively maintained, yet is in alpha. Your fee
 ## Assertions:
 
 ### EventBridge
-An interface to the deployed EventBridge, allowing events to be injected and intercepted via an SQS queue and EventBridge rule.
-
 ```
     expect(eventBridgeEvents).toHaveEvent();
 
     expect(eventBridgeEvents).toHaveEventWithSource("order.created");
 ```
 
+### S3
+```
+    await expect("BUCKET NAME").toHaveS3ObjectWithNameEqualTo("FILE NAME");
+    // note this is an async assertion and requires "await"
+```
+
 ## Helpers
 
 ### General
@@ -54,6 +58,7 @@ getOptions() - get options for making requests to AWS
 ```
 
 ### EventBridge
+An interface to the deployed EventBridge, allowing events to be injected and intercepted via an SQS queue and EventBridge rule.
 
 #### Static
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sls-test-tools",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.3",
   "description": "Custom Jest Assertions for Serverless Projects",
   "main": "lib/index.js",
   "directories": {

src/assertions/toHaveObjectWithNameEqualTo/index.js

@@ -0,0 +1,33 @@
+import { AWSClient } from '../../helpers/general';
+
+export default {
+  async toHaveS3ObjectWithNameEqualTo(bucketName, objectName) {
+    const s3 = new AWSClient.S3();
+    const params = {
+      Bucket: bucketName,
+      Key: objectName,
+    };
+
+    let testResult;
+    try {
+      await s3.getObject(params).promise();
+      testResult = {
+        message: () =>
+          `expected ${bucketName} to have object with name ${objectName}`,
+        pass: true,
+      };
+    } catch (error) {
+      if (error.code === 'NoSuchKey') {
+        testResult = {
+          message: () =>
+            `expected ${bucketName} to have object with name ${objectName} - not found`,
+          pass: false,
+        };
+      } else {
+        throw error;
+      }
+    }
+
+    return testResult;
+  },
+};